Django contrib

Here you can find all stuff related for usage with Django Framework.

class project_composer.contrib.django.processors.DjangoSettingsProcessor(composer)

Bases: ClassProcessor

Processor for enabled application settings classes for a Django project.

get_module_path(name)

Return a Python path for a module name.

Parameters:

name (string) – Module name.

Returns:

Module name prefixed with repository path if it is not empty else returns just the module name.

Return type:

string

class project_composer.contrib.django.processors.DjangoUrlsProcessor(composer)

Bases: ClassProcessor

Processor for enabled application urls classes for a Django project.

get_module_path(name)

Return a Python path for a module name.

Parameters:

name (string) – Module name.

Returns:

Module name prefixed with repository path if it is not empty else returns just the module name.

Return type:

string

class project_composer.contrib.django.collector.ApplicationUrlCollector(settings=None)

Bases: LoggerBase

Application urls collector is a class to inherit from an Application url class to create url patterns collections.

load_urlpatterns(urlpatterns)

Method to implement by Application Url classes.

Every classes should not forget to use super().load_urlpatterns(urlpatterns) in their load_urlpatterns method implementation, commonly at the beggining.

project_composer.contrib.django.helpers.project_settings(composer, base_classes=None, name=None)

Build composed settings class for given composer.

Parameters:

composer (project_composer.compose.Composer) – Composer instance.

Keyword Arguments:

• base_classes (list) – A list of base classes inheritage to build the settings class. Default to empty list.

• name (string) – Class name to set. Default to ComposedProjectSettings.

Returns:

Composed settings class.

Return type:

object

project_composer.contrib.django.helpers.project_urls(composer, settings, base_classes=None, name=None)

Build composed urls collector class for given composer.

Parameters:

• composer (project_composer.compose.Composer) – Composer instance.

• settings (django.conf.settings) – Django settings to give to the collector.

Keyword Arguments:

• base_classes (list) – A list of base classes inheritage to build the settings class. Default to empty list.

• name (string) – Class name to set. Default to ComposedProjectSettings.

Returns:

List of collected url patterns (like django.urls.path or django.urls.re_path) from all application urls classes.

Return type:

list