Skip to content

Config

Ramifice settings.

The settings class contains the following parameters:

  • DEBUG - Condition for the verification code.
  • MONGO_HOST - Mongo host.
  • MONGO_CLIENT - Mongo client.
  • MONGO_DATABASE - Mongo database.
  • DATABASE_NAME - Batabase name.
  • SUPER_COLLECTION_NAME - Super collection name.
  • MEDIA_ROOT - Absolute filesystem path to the directory that will hold user-uploaded files.
  • MEDIA_URL - URL that handles the media served from MEDIA_ROOT, used for managing stored files.
  • STATIC_ROOT - The absolute path to the directory where static files are located.
  • STATIC_URL - URL to use when referring to static files located in STATIC_ROOT.
  • UTC_TIMEZONE - UTC timezone object.
  • DATEPARSER_SETTINGS - Settings for dateparser.parser.
  • REGEX - Patterns of regular expression.

Config

Ramifice settings.

Source code in src/ramifice/config.py 
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
@final
class Config:
    """Ramifice settings."""

    # Condition for the verification code.
    # For block the verification code, at the end of the migration to the database.
    DEBUG: ClassVar[bool] = True
    # Mongo host.
    MONGO_HOST: ClassVar[str | None] = None
    # Mongo client.
    MONGO_CLIENT: ClassVar[AsyncMongoClient | None] = None
    # Mongo database.
    MONGO_DATABASE: ClassVar[AsyncDatabase | None] = None
    # Database name.
    DATABASE_NAME: ClassVar[str | None] = None
    # Super collection name.
    # Store technical data for Models migration into a database.
    # Store dynamic field data for simulate relationship Many-to-One and Many-to-Manyю.
    SUPER_COLLECTION_NAME: ClassVar[str] = "SUPER_COLLECTION"
    # Absolute filesystem path to the
    # directory that will hold user-uploaded files.
    MEDIA_ROOT: ClassVar[str] = "public/media"
    # URL that handles the media served from MEDIA_ROOT,
    # used for managing stored files.
    MEDIA_URL: ClassVar[str] = "/media"
    # The absolute path to the
    # directory where static files are located.
    STATIC_ROOT: ClassVar[str] = "public/static"
    # URL to use when referring to
    # static files located in STATIC_ROOT.
    STATIC_URL: ClassVar[str] = "/static"
    # UTC timezone object.
    UTC_TIMEZONE: ClassVar[tzinfo] = get_timezone("UTC")
    # Settings for `dateparser.parser`
    DATEPARSER_SETTINGS: ClassVar[dict[str, Any]] = {
        "TIMEZONE": "UTC",
        "RETURN_AS_TIMEZONE_AWARE": True,
    }
    # Patterns of regular expression.
    REGEX: ClassVar[dict[str, re.Pattern]] = {
        "database_name": re.compile(r"^[a-zA-Z][-_a-zA-Z0-9]{0,59}$"),
        "service_name": re.compile(r"^[A-Z][a-zA-Z0-9]{0,24}$"),
        "model_name": re.compile(r"^[A-Z][a-zA-Z0-9]{0,24}$"),
        "color_code": re.compile(
            r"^(?:#|0x)(?:[a-f0-9]{3}|[a-f0-9]{6}|[a-f0-9]{8})\b|(?:rgb|hsl)a?\([^\)]*\)$",
            re.I,  # ruff:ignore[regex-flag-alias]
        ),
        "password": re.compile(r'^[-._!"`\'#%&,:;<>=@{}~\$\(\)\*\+\/\\\?\[\]\^\|a-zA-Z0-9]{8,256}$'),
    }