`duck.settings.loaded`¶

Module for loading objects defined in settings.py or in the Duck application configuration. Provides functions to retrieve various components and configurations dynamically.

Module Contents¶

Classes¶

Loaded

Loaded settings’s objects.

Functions¶

`get_asgi`	Returns the loaded ASGI application defined in `settings.py`.
`get_automation_dispatcher`	Returns the automation dispatcher defined in `settings.py`.
`get_blueprints`	Returns necessary loaded blueprints.
`get_content_compression_settings`	Returns the content compression settings defined in `settings.py`.
`get_file_upload_handler`	Returns the file upload handler defined in `settings.py`.
`get_normalizers`	Returns loaded normalizers set in settings.py
`get_preferred_log_style`	Returns the preferred log style based on `setting.py`.
`get_proxy_handlers`	Returns loaded proxy handler classes, i.e. synchronous & asynchronous handlers…
`get_request_class`	Returns the request class defined in `settings.py`.
`get_request_handling_task_executor`	Returns the request handling callable for executing request handling threads and coroutines.
`get_session_storage`	Returns the session storage class defined in settings.py.
`get_session_store`	Returns the session store class.
`get_triggers_and_automations`	Returns all triggers and their corresponding automations defined in `settings.py`.
`get_user_middlewares`	Loads and optionally adapts user-defined middleware classes listed in settings.
`get_user_templatetags`	Returns a list of template tags and filters defined in the settings.py.
`get_user_urlpatterns`	Returns urlpatterns defined in URLPATTERNS_MODULE in settings.py
`get_wsgi`	Returns the loaded WSGI application defined in `settings.py`.

Data¶

SettingsLoaded

API¶

class duck.settings.loaded.Loaded¶

Loaded settings’s objects.

Initialization

duck.settings.loaded.SettingsLoaded¶: ‘Lazy(…)’

duck.settings.loaded.get_asgi() → Any¶

Returns the loaded ASGI application defined in settings.py.

Raises:: SettingsError – If ASGI is not defined or cannot be imported.

duck.settings.loaded.get_automation_dispatcher() → duck.automation.dispatcher.AutomationDispatcher¶

Returns the automation dispatcher defined in settings.py.

Raises:: SettingsError – If AUTOMATION_DISPATCHER is not properly defined.

duck.settings.loaded.get_blueprints() → List[duck.routes.Blueprint]¶

Returns necessary loaded blueprints.

… admonition:: Notes

In condition that the user hasn’t defined urlpatterns and blueprints, or all of the defined blueprints are builtins, Duck’s default site blueprint will be added blueprints list.

duck.settings.loaded.get_content_compression_settings()¶

Returns the content compression settings defined in settings.py.

Raises:: SettingsError – If CONTENT_COMPRESSION is not defined or cannot be imported.

duck.settings.loaded.get_file_upload_handler() → Any¶

Returns the file upload handler defined in settings.py.

Raises:: SettingsError – If FILE_UPLOAD_HANDLER is not defined or cannot be imported.

duck.settings.loaded.get_normalizers()¶: Returns loaded normalizers set in settings.py

duck.settings.loaded.get_preferred_log_style() → str¶: Returns the preferred log style based on setting.py.

duck.settings.loaded.get_proxy_handlers() → List[Type[Any]]¶: Returns loaded proxy handler classes, i.e. synchronous & asynchronous handlers…

duck.settings.loaded.get_request_class() → Type[Any]¶

Returns the request class defined in settings.py.

Raises:: SettingsError – If REQUEST_CLASS is not defined or cannot be imported.

duck.settings.loaded.get_request_handling_task_executor()¶: Returns the request handling callable for executing request handling threads and coroutines.

duck.settings.loaded.get_session_storage()¶: Returns the session storage class defined in settings.py.

duck.settings.loaded.get_session_store()¶: Returns the session store class.

duck.settings.loaded.get_triggers_and_automations() → List[Tuple[duck.automation.trigger.AutomationTrigger, duck.automation.Automation]]¶

Returns all triggers and their corresponding automations defined in settings.py.

Raises:: SettingsError – If any trigger or automation is invalid or improperly configured.

duck.settings.loaded.get_user_middlewares() → List[Type]¶

Loads and optionally adapts user-defined middleware classes listed in settings.

Middleware classes must define classmethods such as process_request, process_response, and get_error_response.

Returns:: List of middleware classes, optionally patched for compatibility.
Return type:: List[Type]

duck.settings.loaded.get_user_templatetags() → List[duck.template.templatetags.TemplateTag | duck.template.templatetags.TemplateFilter]¶: Returns a list of template tags and filters defined in the settings.py.

duck.settings.loaded.get_user_urlpatterns()¶: Returns urlpatterns defined in URLPATTERNS_MODULE in settings.py

duck.settings.loaded.get_wsgi() → Any¶

Returns the loaded WSGI application defined in settings.py.

Raises:: SettingsError – If WSGI is not defined or cannot be imported.

duck.settings.loaded¶