config

DEFAULT_CONFIGS module-attribute

DEFAULT_CONFIGS = APPLConfigs()

The static default configs loaded from the default config file.

APPLConfigs

Bases: BaseAPPLConfigs

Settings for the APPL.

warn_extra_fields classmethod

warn_extra_fields(values)

Warn if extra fields are provided.

Source code in src/appl/core/config.py

@model_validator(mode="before")
@classmethod
def warn_extra_fields(cls, values):
    """Warn if extra fields are provided."""
    extra_fields = set(values.keys()) - cls.model_fields.keys()
    if extra_fields:
        logger.warning(
            f"Extra configs provided for {cls.__name__}: {extra_fields}. "
            "Ignoring them."
        )
    return values

BaseAPPLConfigs

Bases: BaseModel

Base class for APPL configs.

warn_extra_fields classmethod

warn_extra_fields(values)

Warn if extra fields are provided.

Source code in src/appl/core/config.py

@model_validator(mode="before")
@classmethod
def warn_extra_fields(cls, values):
    """Warn if extra fields are provided."""
    extra_fields = set(values.keys()) - cls.model_fields.keys()
    if extra_fields:
        logger.warning(
            f"Extra configs provided for {cls.__name__}: {extra_fields}. "
            "Ignoring them."
        )
    return values

CachingSettings

Bases: BaseAPPLConfigs

Settings for caching.

warn_extra_fields classmethod

warn_extra_fields(values)

Warn if extra fields are provided.

Source code in src/appl/core/config.py

@model_validator(mode="before")
@classmethod
def warn_extra_fields(cls, values):
    """Warn if extra fields are provided."""
    extra_fields = set(values.keys()) - cls.model_fields.keys()
    if extra_fields:
        logger.warning(
            f"Extra configs provided for {cls.__name__}: {extra_fields}. "
            "Ignoring them."
        )
    return values

ConcurrencySettings

Bases: BaseAPPLConfigs

Settings for concurrency.

warn_extra_fields classmethod

warn_extra_fields(values)

Warn if extra fields are provided.

Source code in src/appl/core/config.py

@model_validator(mode="before")
@classmethod
def warn_extra_fields(cls, values):
    """Warn if extra fields are provided."""
    extra_fields = set(values.keys()) - cls.model_fields.keys()
    if extra_fields:
        logger.warning(
            f"Extra configs provided for {cls.__name__}: {extra_fields}. "
            "Ignoring them."
        )
    return values

ConfigsDict

Bases: Dict

A Nested Dictionary class.

to_yaml

to_yaml() -> str

Convert the Configs object to a YAML string.

Source code in src/appl/core/config.py

def to_yaml(self) -> str:
    """Convert the Configs object to a YAML string."""
    return yaml.dump(self.to_dict())

DefaultServersConfigs

Bases: BaseAPPLConfigs

Settings for the default servers.

warn_extra_fields classmethod

warn_extra_fields(values)

Warn if extra fields are provided.

Source code in src/appl/core/config.py

@model_validator(mode="before")
@classmethod
def warn_extra_fields(cls, values):
    """Warn if extra fields are provided."""
    extra_fields = set(values.keys()) - cls.model_fields.keys()
    if extra_fields:
        logger.warning(
            f"Extra configs provided for {cls.__name__}: {extra_fields}. "
            "Ignoring them."
        )
    return values

DisplayRichSettings

Bases: BaseAPPLConfigs

Settings for displaying the logs.

warn_extra_fields classmethod

warn_extra_fields(values)

Warn if extra fields are provided.

Source code in src/appl/core/config.py

@model_validator(mode="before")
@classmethod
def warn_extra_fields(cls, values):
    """Warn if extra fields are provided."""
    extra_fields = set(values.keys()) - cls.model_fields.keys()
    if extra_fields:
        logger.warning(
            f"Extra configs provided for {cls.__name__}: {extra_fields}. "
            "Ignoring them."
        )
    return values

LoggingDisplaySettings

Bases: BaseAPPLConfigs

Settings for displaying the logs.

warn_extra_fields classmethod

warn_extra_fields(values)

Warn if extra fields are provided.

Source code in src/appl/core/config.py

@model_validator(mode="before")
@classmethod
def warn_extra_fields(cls, values):
    """Warn if extra fields are provided."""
    extra_fields = set(values.keys()) - cls.model_fields.keys()
    if extra_fields:
        logger.warning(
            f"Extra configs provided for {cls.__name__}: {extra_fields}. "
            "Ignoring them."
        )
    return values

LoggingFileSettings

Bases: BaseAPPLConfigs

Settings for logging to a file.

warn_extra_fields classmethod

warn_extra_fields(values)

Warn if extra fields are provided.

Source code in src/appl/core/config.py

@model_validator(mode="before")
@classmethod
def warn_extra_fields(cls, values):
    """Warn if extra fields are provided."""
    extra_fields = set(values.keys()) - cls.model_fields.keys()
    if extra_fields:
        logger.warning(
            f"Extra configs provided for {cls.__name__}: {extra_fields}. "
            "Ignoring them."
        )
    return values

LoggingSettings

Bases: BaseAPPLConfigs

Settings for logging.

warn_extra_fields classmethod

warn_extra_fields(values)

Warn if extra fields are provided.

Source code in src/appl/core/config.py

@model_validator(mode="before")
@classmethod
def warn_extra_fields(cls, values):
    """Warn if extra fields are provided."""
    extra_fields = set(values.keys()) - cls.model_fields.keys()
    if extra_fields:
        logger.warning(
            f"Extra configs provided for {cls.__name__}: {extra_fields}. "
            "Ignoring them."
        )
    return values

MessageColorSettings

Bases: BaseAPPLConfigs

Settings for message colors.

warn_extra_fields classmethod

warn_extra_fields(values)

Warn if extra fields are provided.

Source code in src/appl/core/config.py

@model_validator(mode="before")
@classmethod
def warn_extra_fields(cls, values):
    """Warn if extra fields are provided."""
    extra_fields = set(values.keys()) - cls.model_fields.keys()
    if extra_fields:
        logger.warning(
            f"Extra configs provided for {cls.__name__}: {extra_fields}. "
            "Ignoring them."
        )
    return values

MessagesSettings

Bases: BaseAPPLConfigs

Settings for messages.

warn_extra_fields classmethod

warn_extra_fields(values)

Warn if extra fields are provided.

Source code in src/appl/core/config.py

@model_validator(mode="before")
@classmethod
def warn_extra_fields(cls, values):
    """Warn if extra fields are provided."""
    extra_fields = set(values.keys()) - cls.model_fields.keys()
    if extra_fields:
        logger.warning(
            f"Extra configs provided for {cls.__name__}: {extra_fields}. "
            "Ignoring them."
        )
    return values

MiscSettings

Bases: BaseAPPLConfigs

Settings for miscellaneous.

warn_extra_fields classmethod

warn_extra_fields(values)

Warn if extra fields are provided.

Source code in src/appl/core/config.py

@model_validator(mode="before")
@classmethod
def warn_extra_fields(cls, values):
    """Warn if extra fields are provided."""
    extra_fields = set(values.keys()) - cls.model_fields.keys()
    if extra_fields:
        logger.warning(
            f"Extra configs provided for {cls.__name__}: {extra_fields}. "
            "Ignoring them."
        )
    return values

PromptsConfigs

Bases: BaseAPPLConfigs

Settings for the prompts.

warn_extra_fields classmethod

warn_extra_fields(values)

Warn if extra fields are provided.

Source code in src/appl/core/config.py

@model_validator(mode="before")
@classmethod
def warn_extra_fields(cls, values):
    """Warn if extra fields are provided."""
    extra_fields = set(values.keys()) - cls.model_fields.keys()
    if extra_fields:
        logger.warning(
            f"Extra configs provided for {cls.__name__}: {extra_fields}. "
            "Ignoring them."
        )
    return values

SettingsConfigs

Bases: BaseAPPLConfigs

Settings for the settings.

warn_extra_fields classmethod

warn_extra_fields(values)

Warn if extra fields are provided.

Source code in src/appl/core/config.py

@model_validator(mode="before")
@classmethod
def warn_extra_fields(cls, values):
    """Warn if extra fields are provided."""
    extra_fields = set(values.keys()) - cls.model_fields.keys()
    if extra_fields:
        logger.warning(
            f"Extra configs provided for {cls.__name__}: {extra_fields}. "
            "Ignoring them."
        )
    return values

TracingSettings

Bases: BaseAPPLConfigs

Settings for tracing.

warn_extra_fields classmethod

warn_extra_fields(values)

Warn if extra fields are provided.

Source code in src/appl/core/config.py

@model_validator(mode="before")
@classmethod
def warn_extra_fields(cls, values):
    """Warn if extra fields are provided."""
    extra_fields = set(values.keys()) - cls.model_fields.keys()
    if extra_fields:
        logger.warning(
            f"Extra configs provided for {cls.__name__}: {extra_fields}. "
            "Ignoring them."
        )
    return values

load_config

load_config(
    file: str, *args: Any, **kwargs: Any
) -> ConfigsDict

Load a config file and return the data as a dictionary.

Source code in src/appl/core/config.py

def load_config(file: str, *args: Any, **kwargs: Any) -> ConfigsDict:
    """Load a config file and return the data as a dictionary."""
    ext = get_ext(file)
    if ext not in [".json", ".yaml", ".yml", ".toml"]:
        raise ValueError(f"Unsupported config file type {ext}")
    content = load_file(file, *args, **kwargs)
    return ConfigsDict(content)