Source code for django_scim2_server.conf

"""
These are the available settings.

All attributes prefixed ``SCIM2_SERVER_*`` can be overridden from your Django
project's settings module by defining a setting with the same name.
"""

from __future__ import annotations

from dataclasses import dataclass
from typing import Any

from django.conf import settings as django_settings

# All attributes accessed with this prefix are possible to overwrite
# through django.conf.settings.
SETTINGS_PREFIX = "SCIM2_SERVER_"




@dataclass(frozen=True)
class AppSettings:
    """Access this instance as `.conf.app_settings`."""

    SCIM2_SERVER_USER_MODEL: str = "auth.User"
    """Target user model (app_label.ModelName)."""

    SCIM2_SERVER_GROUP_MODEL: str = "auth.Group"
    """Target group model (app_label.ModelName)."""

    SCIM2_SERVER_USER_ADAPTER: str = "django_scim2_server.adapters.DefaultUserAdapter"
    """Dotted path to the user adapter class."""

    SCIM2_SERVER_GROUP_ADAPTER: str = "django_scim2_server.adapters.DefaultGroupAdapter"
    """Dotted path to the group adapter class."""

    SCIM2_SERVER_AUTH_CHECK: str = "django_scim2_server.auth.is_superuser"
    """Dotted path to a callable ``(HttpRequest) -> bool`` for access control."""

    def __getattribute__(self, __name: str) -> Any:
        """
        Check if a Django project settings should override the app default.

        In order to avoid returning any random properties of the django settings,
        we inspect the prefix firstly.
        """
        if __name.startswith(SETTINGS_PREFIX) and hasattr(django_settings, __name):
            return getattr(django_settings, __name)

        return super().__getattribute__(__name)



app_settings = AppSettings()