Module: context_settings

Expand source code

# Copyright (C) 2023-present The Project Contributors
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

from dataclasses import dataclass
from typing import List
from cl.runtime.settings.settings import Settings


@dataclass(slots=True, kw_only=True)
class ContextSettings(Settings):
    """Default context parameters."""

    context_id: str | None = None
    """Context identifier, if not specified a time-ordered UUID will be used."""

    packages: List[str]
    """List of packages to load in dot-delimited format, for example 'cl.runtime' or 'stubs.cl.runtime'."""

    log_class: str = "cl.runtime.log.file.file_log.FileLog"  # TODO: Deprecated, switch to class-specific fields
    """Default log class in module.ClassName format."""

    db_class: str  # TODO: Deprecated, switch to class-specific fields
    """Default database class in module.ClassName format."""

    db_temp_prefix: str = "temp;"
    """
    IMPORTANT: DELETING ALL RECORDS AND DROPPING THE DATABASE FROM CODE IS PERMITTED
    when both db_id and database name start with this prefix.
    """

    db_uri: str | None = None
    """Optional database URI to connect to the database. Required for basic mongo db data source."""

    def init(self) -> None:
        """Same as __init__ but can be used when field values are set both during and after construction."""

        if self.context_id is not None and not isinstance(self.context_id, str):
            raise RuntimeError(f"{type(self).__name__} field 'context_id' must be None or a string.")

        # TODO: Move to ValidationUtil or PrimitiveUtil class
        if isinstance(self.packages, list):
            pass
        elif self.packages is None:
            self.packages = []
        elif isinstance(self.packages, str):
            self.packages = [self.packages]
        elif hasattr(self.packages, "__iter__"):
            self.packages = list(self.packages)
        else:
            raise RuntimeError(f"{type(self).__name__} field 'packages' must be a string or an iterable of strings.")

        if not isinstance(self.log_class, str):
            raise RuntimeError(
                f"{type(self).__name__} field 'log_class' must be a string " f"in module.ClassName format."
            )
        if not isinstance(self.db_class, str):
            raise RuntimeError(
                f"{type(self).__name__} field 'db_class' must be a string " f"in module.ClassName format."
            )

    @classmethod
    def get_prefix(cls) -> str:
        return "runtime_context"

Classes

class ContextSettings (*, context_id: str | None = None, packages: List[str], log_class: str = 'cl.runtime.log.file.file_log.FileLog', db_class: str, db_temp_prefix: str = 'temp;', db_uri: str | None = None)

Default context parameters.

Expand source code

@dataclass(slots=True, kw_only=True)
class ContextSettings(Settings):
    """Default context parameters."""

    context_id: str | None = None
    """Context identifier, if not specified a time-ordered UUID will be used."""

    packages: List[str]
    """List of packages to load in dot-delimited format, for example 'cl.runtime' or 'stubs.cl.runtime'."""

    log_class: str = "cl.runtime.log.file.file_log.FileLog"  # TODO: Deprecated, switch to class-specific fields
    """Default log class in module.ClassName format."""

    db_class: str  # TODO: Deprecated, switch to class-specific fields
    """Default database class in module.ClassName format."""

    db_temp_prefix: str = "temp;"
    """
    IMPORTANT: DELETING ALL RECORDS AND DROPPING THE DATABASE FROM CODE IS PERMITTED
    when both db_id and database name start with this prefix.
    """

    db_uri: str | None = None
    """Optional database URI to connect to the database. Required for basic mongo db data source."""

    def init(self) -> None:
        """Same as __init__ but can be used when field values are set both during and after construction."""

        if self.context_id is not None and not isinstance(self.context_id, str):
            raise RuntimeError(f"{type(self).__name__} field 'context_id' must be None or a string.")

        # TODO: Move to ValidationUtil or PrimitiveUtil class
        if isinstance(self.packages, list):
            pass
        elif self.packages is None:
            self.packages = []
        elif isinstance(self.packages, str):
            self.packages = [self.packages]
        elif hasattr(self.packages, "__iter__"):
            self.packages = list(self.packages)
        else:
            raise RuntimeError(f"{type(self).__name__} field 'packages' must be a string or an iterable of strings.")

        if not isinstance(self.log_class, str):
            raise RuntimeError(
                f"{type(self).__name__} field 'log_class' must be a string " f"in module.ClassName format."
            )
        if not isinstance(self.db_class, str):
            raise RuntimeError(
                f"{type(self).__name__} field 'db_class' must be a string " f"in module.ClassName format."
            )

    @classmethod
    def get_prefix(cls) -> str:
        return "runtime_context"

Ancestors

Settings
abc.ABC

Class variables

var is_inside_test: Inherited from: Settings.is_inside_test

True if we are inside a test.
var process_timestamp: Inherited from: Settings.process_timestamp

Unique UUIDv7-based timestamp set during the Python process launch.

Static methods

def get_prefix() -> str: Inherited from: Settings.get_prefix

Dynaconf fields will be filtered by ‘prefix_’ before being passed to the settings class constructor …
def get_project_root() -> str: Inherited from: Settings.get_project_root

Returns absolute path of the directory containing .env file, and if not present the directory containing the first Dynaconf settings file found. Error …
def instance() -> Self: Inherited from: Settings.instance

Return singleton instance.
def normalize_path(field_name: str, field_value: str | None) -> str: Inherited from: Settings.normalize_path

Convert to absolute path if path relative to the location of .env or Dynaconf file is specified.
def normalize_paths(field_name: str, field_value: Iterable[str] | str | None) -> List[str]: Inherited from: Settings.normalize_paths

Convert to absolute path if path relative to the location of .env or Dynaconf file is specified and convert to list if single value is specified.

Fields

var context_id -> str | None: Context identifier, if not specified a time-ordered UUID will be used.
var db_class -> str: Default database class in module.ClassName format.
var db_temp_prefix -> str: IMPORTANT: DELETING ALL RECORDS AND DROPPING THE DATABASE FROM CODE IS PERMITTED when both db_id and database name start with this prefix.
var db_uri -> str | None: Optional database URI to connect to the database. Required for basic mongo db data source.
var log_class -> str: Default log class in module.ClassName format.
var packages -> List[str]: List of packages to load in dot-delimited format, for example ‘cl.runtime’ or ‘stubs.cl.runtime’.

Methods

def init(self) -> None: Same as init but can be used when field values are set both during and after construction.