Settings¶
The following settings can be added to your project’s settings.py file to customise the behaviour of Djem features.
DJEM_AUDITABLE_REQUIRE_USER_ON_SAVE¶
Changed in version 0.7: Renamed from DJEM_COMMON_INFO_REQUIRE_USER_ON_SAVE. The old setting is still available for backwards compatibility, but is considered deprecated.
Default: True
By default, the save() method of Auditable and various methods of AuditableQuerySet (e.g. create(), update(), etc) require being passed a user model instance, so they can automatically set the user_created and/or user_modified fields that Auditable provides. This behaviour can cause issues if you are using third party code that calls any of these methods, as it will not pass this required argument.
Djem provides AuditableForm and UserSavable to enable Django ModelForms to work with models making use of Auditable. But if you can’t use similar wrappers around other third party code invoking these methods, this setting can help.
Setting DJEM_AUDITABLE_REQUIRE_USER_ON_SAVE to False removes the “required” nature of this additional user argument. It will still be accepted, and will still be used as per usual if it is provided. But if it is not provided, no exception will be raised, and the fields that would ordinarily be populated by it will simply be left alone.
Warning
The user_created and user_modified fields will still be required. When creating instances of models using Auditable, and a user instance is not passed to the save() method, these fields will need to be populated manually, or an IntegrityError will be raised.
Warning
Using this setting can reduce the accuracy of user_modified, as it is no longer guaranteed to be updated by any save/update to the model instance. It will be up to you to ensure that this field is updated when necessary.
DJEM_DEFAULT_403¶
New in version 0.5.
Default: False
Specifies the default behaviour of the permission_required() decorator and djem.auth.PermissionRequired class-based view mixin when a user does not have the specified permission/s. If True, the PermissionDenied exception will be raised, invoking the 403 handler. If False, the user will be redirected to the appropriate login url.
This affects default behaviour only - individual uses of permission_required() and djem.auth.PermissionRequired can customise it.
DJEM_DEFAULT_PAGE_LENGTH¶
New in version 0.5.
Default: None
The default page length to use for the djem.pagination.get_page() helper function. Adding this setting removes the need to provide a page length argument to every djem.pagination.get_page() call. See Controlling page length for more details.
DJEM_FORM_FIELD_TAG¶
New in version 0.6.
Default: 'div'
The HTML tag to use for the wrapping element rendered around form fields when using the form_field or checkbox template tags.
DJEM_UNIVERSAL_OLP¶
New in version 0.7.
Default: False
In conjunction with a custom user model including OLPMixin, setting this to True enables support for forcing superusers to undergo the same object-level permissions checking that regular users do, allowing OLP logic to actually deny permissions to superusers where relevant.
DJEM_PERM_LOG_VERBOSITY¶
New in version 0.7.
Default: 0
In conjunction with a custom user model including OLPMixin, this setting controls the level of automatic permission logging performed by OLPMixin.has_perm():
0: No automatic logging1: Logs are automatically created for each permission check, with minimal automatic entries2: Logs are automatically created for each permission check, with more informative automatic entries
In addition to the automatic entries, a value of 1 or 2 allow manual log entries to be added from within object-level access methods with no need to manually start/finish any logs.