mirror of
https://github.com/jazzband/django-auditlog.git
synced 2026-03-16 22:20:26 +00:00
53 lines
1.6 KiB
Python
53 lines
1.6 KiB
Python
import django.dispatch
|
|
|
|
accessed = django.dispatch.Signal()
|
|
|
|
|
|
pre_log = django.dispatch.Signal()
|
|
"""
|
|
Whenever an audit log entry is written, this signal
|
|
is sent before writing the log.
|
|
Keyword arguments sent with this signal:
|
|
|
|
:param class sender:
|
|
The model class that's being audited.
|
|
|
|
:param Any instance:
|
|
The actual instance that's being audited.
|
|
|
|
:param Action action:
|
|
The action on the model resulting in an
|
|
audit log entry. Type: :class:`auditlog.models.LogEntry.Action`
|
|
|
|
The receivers' return values are sent to any :func:`post_log`
|
|
signal receivers.
|
|
"""
|
|
|
|
post_log = django.dispatch.Signal()
|
|
"""
|
|
Whenever an audit log entry is written, this signal
|
|
is sent after writing the log.
|
|
Keyword arguments sent with this signal:
|
|
|
|
:param class sender:
|
|
The model class that's being audited.
|
|
|
|
:param Any instance:
|
|
The actual instance that's being audited.
|
|
|
|
:param Action action:
|
|
The action on the model resulting in an
|
|
audit log entry. Type: :class:`auditlog.models.LogEntry.Action`
|
|
|
|
:param Optional[Exception] error:
|
|
The error, if one occurred while saving the audit log entry. ``None``,
|
|
otherwise
|
|
|
|
:param List[Tuple[method,Any]] pre_log_results:
|
|
List of tuple pairs ``[(pre_log_receiver, pre_log_response)]``, where
|
|
``pre_log_receiver`` is the receiver method, and ``pre_log_response`` is the
|
|
corresponding response of that method. If there are no :const:`pre_log` receivers,
|
|
then the list will be empty. ``pre_log_receiver`` is guaranteed to be
|
|
non-null, but ``pre_log_response`` may be ``None``. This depends on the corresponding
|
|
``pre_log_receiver``'s return value.
|
|
"""
|