Skip to content

angee.compose.autoconfig

Autoconfig loading plus settings fragments required by the composer app.

_YamlconfErrorHandler

python
class _YamlconfErrorHandler(logging.Handler)

Turn yamlconf logged errors into composition failures.

emit

python
def emit(record: logging.LogRecord) -> None

Raise for every yamlconf error record.

fail_on_yamlconf_errors

python
@contextmanager
def fail_on_yamlconf_errors() -> Iterator[None]

Raise ImproperlyConfigured when django-yamlconf logs an error.

setting_name

python
def setting_name(attribute_name: str) -> str

Return the top-level Django setting name for one yamlconf attribute.

is_setting_name

python
def is_setting_name(name: str) -> bool

Return whether name is a top-level Django setting (public, all-caps).

The one owner of the rule that decides which namespace entries the composer treats as Django settings. The YAMLCONF_ATTRIBUTES provenance sentinel is exported alongside settings but is not itself a setting name, so callers that carry it forward OR it in explicitly.

AutoConfig

python
class AutoConfig()

Apply addon autoconfig modules to a settings namespace.

__init__

python
def __init__(namespace: MutableMapping[str, Any], *,
             reserved_settings: frozenset[str]) -> None

Store the settings namespace being mutated.

update_app

python
def update_app(app_config: AppConfig) -> None

Apply one app config's optional autoconfig module.

SETTINGS

Django settings contributed when the composer is installed.

Released under the AGPL-3.0 License.