Discovery

provide.foundation.config.discovery

Configuration schema discovery system.

This module provides functionality to discover and introspect all configuration classes registered with the Foundation Hub. It enables programmatic access to configuration schemas, environment variable mappings, and metadata.

Classes

ConsolidatedSchema

Consolidated schema containing all configuration schemas.

Attributes:

Name	Type	Description
schemas	dict[str, ConfigSchema]	Mapping of config class names to their schemas
metadata	dict[str, dict[str, Any]]	Additional metadata about each config class

Functions

get_all_env_vars

get_all_env_vars(
    show_sensitive: bool = False,
) -> list[EnvVarInfo]

Extract all environment variables from all schemas.

Parameters:

Name	Type	Description	Default
show_sensitive	bool	Whether to include sensitive fields	False

Returns:

Type	Description
list[EnvVarInfo]	List of environment variable information

Source code in provide/foundation/config/discovery.py

def get_all_env_vars(self, show_sensitive: bool = False) -> list[EnvVarInfo]:
    """Extract all environment variables from all schemas.

    Args:
        show_sensitive: Whether to include sensitive fields

    Returns:
        List of environment variable information

    """
    env_vars = []

    for config_name, schema in self.schemas.items():
        meta = self.metadata.get(config_name, {})
        category = meta.get("category", "core")

        for field in schema.fields:
            # Skip if no env var mapping
            if not field.env_var:
                continue

            # Skip sensitive fields unless explicitly requested
            if field.sensitive and not show_sensitive:
                continue

            # Get type name
            type_name = "Any"
            if field.field_type is not None:
                type_name = getattr(field.field_type, "__name__", str(field.field_type))

            env_vars.append(
                EnvVarInfo(
                    config_class=config_name,
                    field_name=field.name,
                    env_var=field.env_var,
                    field_type=type_name,
                    default=field.default,
                    required=field.required,
                    description=field.description,
                    sensitive=field.sensitive,
                    category=category,
                )
            )

    return env_vars

get_by_category

get_by_category(category: str) -> dict[str, ConfigSchema]

Filter schemas by category.

Parameters:

Name	Type	Description	Default
category	str	Category to filter by (e.g., "logger", "transport")	required

Returns:

Type	Description
dict[str, ConfigSchema]	Filtered schemas matching the category

Source code in provide/foundation/config/discovery.py

def get_by_category(self, category: str) -> dict[str, ConfigSchema]:
    """Filter schemas by category.

    Args:
        category: Category to filter by (e.g., "logger", "transport")

    Returns:
        Filtered schemas matching the category

    """
    result = {}
    for name, schema in self.schemas.items():
        meta = self.metadata.get(name, {})
        if meta.get("category") == category:
            result[name] = schema
    return result

get_categories

get_categories() -> set[str]

Get all unique categories.

Returns:

Type	Description
set[str]	Set of all categories

Source code in provide/foundation/config/discovery.py

def get_categories(self) -> set[str]:
    """Get all unique categories.

    Returns:
        Set of all categories

    """
    return {meta.get("category", "core") for meta in self.metadata.values()}

EnvVarInfo

Information about an environment variable and its configuration field.

Attributes:

Name	Type	Description
config_class	str	Name of the configuration class
field_name	str	Name of the field in the config class
env_var	str	Environment variable name
field_type	str	Type of the field
default	Any	Default value
required	bool	Whether the field is required
description	str | None	Field description
sensitive	bool	Whether the field contains sensitive data
category	str	Configuration category (e.g., "logger", "transport")

Functions

discover_all_config_schemas

discover_all_config_schemas() -> (
    dict[str, type[BaseConfig]]
)

Get all registered configuration schemas from the Hub.

This function retrieves all configuration classes that have been registered with the Foundation Hub under the CONFIG_SCHEMA dimension.

Returns:

Type	Description
dict[str, type[BaseConfig]]	Mapping of config class names to their types

Source code in provide/foundation/config/discovery.py

def discover_all_config_schemas() -> dict[str, type[BaseConfig]]:
    """Get all registered configuration schemas from the Hub.

    This function retrieves all configuration classes that have been
    registered with the Foundation Hub under the CONFIG_SCHEMA dimension.

    Returns:
        Mapping of config class names to their types

    """
    from provide.foundation.hub import get_hub
    from provide.foundation.hub.categories import ComponentCategory

    hub = get_hub()

    # Get all entry names in the CONFIG_SCHEMA dimension
    config_names = hub._component_registry.list_dimension(ComponentCategory.CONFIG_SCHEMA.value)

    # Retrieve each config class
    result = {}
    for name in config_names:
        entry = hub._component_registry.get_entry(name, ComponentCategory.CONFIG_SCHEMA.value)
        if entry:
            result[name] = entry.value

    return result

get_config_metadata

get_config_metadata() -> dict[str, dict[str, Any]]

Get metadata for all registered config schemas.

Returns:

Type	Description
dict[str, dict[str, Any]]	Mapping of config class names to their metadata

Source code in provide/foundation/config/discovery.py

def get_config_metadata() -> dict[str, dict[str, Any]]:
    """Get metadata for all registered config schemas.

    Returns:
        Mapping of config class names to their metadata

    """
    from provide.foundation.hub import get_hub
    from provide.foundation.hub.categories import ComponentCategory

    hub = get_hub()

    config_names = hub._component_registry.list_dimension(ComponentCategory.CONFIG_SCHEMA.value)

    result = {}
    for name in config_names:
        entry = hub._component_registry.get_entry(name, ComponentCategory.CONFIG_SCHEMA.value)
        if entry:
            result[name] = entry.metadata

    return result

get_consolidated_schema

get_consolidated_schema() -> ConsolidatedSchema

Get consolidated schema with all configuration options.

This function discovers all registered configuration classes, generates schemas for each, and consolidates them into a single schema object with full metadata.

Returns:

Type	Description
ConsolidatedSchema	Consolidated schema with all config options

Source code in provide/foundation/config/discovery.py

def get_consolidated_schema() -> ConsolidatedSchema:
    """Get consolidated schema with all configuration options.

    This function discovers all registered configuration classes,
    generates schemas for each, and consolidates them into a single
    schema object with full metadata.

    Returns:
        Consolidated schema with all config options

    """
    config_classes = discover_all_config_schemas()
    metadata = get_config_metadata()
    schemas = {}

    for name, config_cls in config_classes.items():
        try:
            schemas[name] = ConfigSchema.from_config_class(config_cls)
        except Exception:
            # If schema generation fails for any class, skip it
            # but continue processing others
            continue

    return ConsolidatedSchema(schemas=schemas, metadata=metadata)