CGM_Public/pretix_cgo
1
0
Fork 0
forked from CGM_Public/pretix_original
Code Pull Requests Actions Activity

improve formatting of documentation

Browse Source
This commit is contained in:
Mira Weller
2025-01-13 13:12:35 +01:00
parent e2ae0b6780
commit 0c41dcb2ed
2 changed files with 16 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
doc/development/implementation/logging.rst
View File

@@ -100,17 +100,19 @@ Customizing log entry display
The base ``LogEntryType`` classes allow for varying degree of customization in their descendants. The base ``LogEntryType`` classes allow for varying degree of customization in their descendants.
If you want to add another log message for an existing core object (e.g. an ``Order``, ``Item``, or ``Voucher``), you can inherit If you want to add another log message for an existing core object (e.g. an :class:`Order <pretix.base.models.Order>`,
from its predefined `LogEntryType`, e.g. `OrderLogEntryType`, and just specify a new plaintext string. You can use format :class:`Item <pretix.base.models.Item>`, or :class:`Voucher <pretix.base.models.Voucher>`), you can inherit
strings to insert information from the LogEntry's `data` object as shown in the section above. from its predefined :class:`LogEntryType <pretix.base.logentrytypes.LogEntryType>`, e.g.
:class:`OrderLogEntryType <pretix.base.logentrytypes.OrderLogEntryType>`, and just specify a new plaintext string.
You can use format strings to insert information from the LogEntry's `data` object as shown in the section above.
If you define a new model object in your plugin, you should make sure proper object links in the user interface are If you define a new model object in your plugin, you should make sure proper object links in the user interface are
displayed for it. If your model object belongs logically to a pretix `Event`, you can inherit from `EventLogEntryType`, displayed for it. If your model object belongs logically to a pretix :class:`Event <pretix.base.models.Event>`, you can inherit from :class:`EventLogEntryType <pretix.base.logentrytypes.EventLogEntryType>`,
and set the `object_link_*` fields accordingly. `object_link_viewname` refers to a django url name, which needs to and set the ``object_link_*`` fields accordingly. ``object_link_viewname`` refers to a django url name, which needs to
accept the arguments `organizer` and `event`, containing the respective slugs, and an argument named by `object_link_argname`. accept the arguments `organizer` and `event`, containing the respective slugs, and an argument named by ``object_link_argname``.
The latter will contain the ID of the model object, if not customized by overriding `object_link_argvalue`. The latter will contain the ID of the model object, if not customized by overriding ``object_link_argvalue``.
If you want to customize the name displayed for the object (instead of the result of calling `str()` on it), If you want to customize the name displayed for the object (instead of the result of calling ``str()`` on it),
overwrite `object_link_display_name`. overwrite ``object_link_display_name``.
.. code-block:: python .. code-block:: python
@@ -125,7 +127,7 @@ overwrite `object_link_display_name`.
def object_link_display_name(self, order): def object_link_display_name(self, order):
return order.code return order.code
To show more sophisticated message strings, e.g. varying the message depending on information from the LogEntry's To show more sophisticated message strings, e.g. varying the message depending on information from the :class:`LogEntry <pretix.base.models.log.LogEntry>`'s
`data` object, override the `display` method: `data` object, override the `display` method:
.. code-block:: python .. code-block:: python
@@ -145,7 +147,7 @@ To show more sophisticated message strings, e.g. varying the message depending o
.. automethod:: pretix.base.logentrytypes.LogEntryType.display .. automethod:: pretix.base.logentrytypes.LogEntryType.display
If your new model object does not belong to an `Event`, you need to inherit directly from ``LogEntryType`` instead If your new model object does not belong to an :class:`Event <pretix.base.models.Event>`, you need to inherit directly from ``LogEntryType`` instead
of ``EventLogEntryType``, providing your own implementation of ``get_object_link_info`` if object links should be of ``EventLogEntryType``, providing your own implementation of ``get_object_link_info`` if object links should be
displayed. displayed.

4
src/pretix/base/logentrytypes.py
View File

@@ -117,11 +117,11 @@ class LogEntryType:
def get_object_link_info(self, logentry) -> dict: def get_object_link_info(self, logentry) -> dict:
""" """
Return information to generate a link to the content_object of a given logentry. Return information to generate a link to the `content_object` of a given log entry.
Not implemented in the base class, causing the object link to be omitted. Not implemented in the base class, causing the object link to be omitted.
:return: `dict` with the keys `href` (containing a URL to view/edit the object) and `val` (containing the :return: Dictionary with the keys ``href`` (containing a URL to view/edit the object) and ``val`` (containing the
escaped text for the anchor element) escaped text for the anchor element)
""" """
pass pass