Skip to content

context

django_spire.history.activity.context

DeleteActivityEntry = tuple[type[models.Model], int, str] module-attribute

ACTIVITY_VERB_ATTRIBUTE = '_activity_verb' module-attribute

activity_user

Source code in django_spire/history/activity/context.py 
27
28
29
30
31
32
33
34
@contextmanager
def activity_user(user: User | None) -> Iterator[None]:
    token = set_current_user(user)

    try:
        yield
    finally:
        reset_current_user(token)

get_current_user

Source code in django_spire/history/activity/context.py 
37
38
39
40
41
42
43
44
45
46
def get_current_user() -> User | None:
    user = _current_user.get()

    if user is None:
        return None

    if not user.is_authenticated:
        return None

    return user

set_current_user

Source code in django_spire/history/activity/context.py 
49
50
def set_current_user(user: User | None) -> Token[User | None]:
    return _current_user.set(user)

reset_current_user

Source code in django_spire/history/activity/context.py 
53
54
def reset_current_user(token: Token[User | None]) -> None:
    _current_user.reset(token)

get_delete_activity_entries

Source code in django_spire/history/activity/context.py 
57
58
def get_delete_activity_entries() -> list[DeleteActivityEntry] | None:
    return _delete_activity_entries.get()

start_delete_activity_collection

Source code in django_spire/history/activity/context.py 
61
62
def start_delete_activity_collection() -> Token[list[DeleteActivityEntry] | None]:
    return _delete_activity_entries.set([])

reset_delete_activity_collection

Source code in django_spire/history/activity/context.py 
65
66
67
68
def reset_delete_activity_collection(
    token: Token[list[DeleteActivityEntry] | None]
) -> None:
    _delete_activity_entries.reset(token)