Class swarmauri_standard.logger_formatters.ColorFormatter.ColorFormatter

swarmauri_standard.logger_formatters.ColorFormatter.ColorFormatter

Bases: FormatterBase

A formatter that adds ANSI color codes to log messages based on log level.

This formatter enhances log readability by color-coding different log levels without requiring external dependencies. It's implemented in pure Python using ANSI escape sequences.

COLORS class-attribute

COLORS = {
    "DEBUG": "\x1b[36m",
    "INFO": "\x1b[32m",
    "WARNING": "\x1b[33m",
    "ERROR": "\x1b[31m",
    "CRITICAL": "\x1b[41m",
}

RESET class-attribute

RESET = '\x1b[0m'

format class-attribute instance-attribute

format = '[%(name)s][%(levelname)s] %(message)s'

date_format class-attribute instance-attribute

date_format = '%Y-%m-%d %H:%M:%S'

use_colors class-attribute instance-attribute

use_colors = True

include_timestamp class-attribute instance-attribute

include_timestamp = False

include_process class-attribute instance-attribute

include_process = False

include_thread class-attribute instance-attribute

include_thread = False

type class-attribute instance-attribute

type = 'ObserveBase'

model_config class-attribute instance-attribute

model_config = ConfigDict(arbitrary_types_allowed=True)

id class-attribute instance-attribute

id = Field(default_factory=generate_id)

members class-attribute instance-attribute

members = None

owners class-attribute instance-attribute

owners = None

host class-attribute instance-attribute

host = None

name class-attribute instance-attribute

name = None

version class-attribute instance-attribute

version = '0.1.0'

model_post_init

model_post_init(*args, **kwargs)

Initialize the formatter with the specified format string.

This method is called after the model is initialized and sets up the format string based on the configuration options.

Source code in swarmauri_standard/logger_formatters/ColorFormatter.py

def model_post_init(self, *args, **kwargs):
    """
    Initialize the formatter with the specified format string.

    This method is called after the model is initialized and sets up the
    format string based on the configuration options.
    """
    format_parts = []

    if self.include_timestamp:
        format_parts.append("%(asctime)s")

    format_parts.append("[%(name)s]")
    format_parts.append("[%(levelname)s]")

    if self.include_process:
        format_parts.append("Process:%(process)d")

    if self.include_thread:
        format_parts.append("Thread:%(thread)d")

    format_parts.append("%(message)s")

    self.format = " ".join(format_parts)

compile_formatter

compile_formatter()

Create and return a custom logging.Formatter that applies color codes.

RETURNS	DESCRIPTION
Formatter	logging.Formatter: A formatter instance that adds color to log messages based on their level when use_colors is True.

Source code in swarmauri_standard/logger_formatters/ColorFormatter.py

def compile_formatter(self) -> logging.Formatter:
    """
    Create and return a custom logging.Formatter that applies color codes.

    Returns:
        logging.Formatter: A formatter instance that adds color to log messages
                           based on their level when use_colors is True.
    """
    if not self.use_colors:
        # If colors are disabled, use the parent class implementation
        return super().compile_formatter()

    # Create a custom formatter class that adds color codes
    class ColoredFormatter(logging.Formatter):
        def __init__(self, fmt, datefmt, colors, reset):
            super().__init__(fmt, datefmt)
            self.colors = colors
            self.reset = reset

        def format(self, record):
            # Save the original levelname
            orig_levelname = record.levelname

            # Add color codes to the levelname if the level has a defined color
            if record.levelname in self.colors:
                # Prepend color code to levelname and append reset code
                record.levelname = (
                    f"{self.colors[record.levelname]}{record.levelname}{self.reset}"
                )

            # Format the record
            result = super().format(record)

            # Restore the original levelname for potential reuse
            record.levelname = orig_levelname

            return result

    # Return an instance of our custom formatter
    return ColoredFormatter(self.format, self.date_format, self.COLORS, self.RESET)

disable_colors

disable_colors()

Disable color output in log messages.

This method allows for runtime control of color formatting.

Source code in swarmauri_standard/logger_formatters/ColorFormatter.py

def disable_colors(self) -> None:
    """
    Disable color output in log messages.

    This method allows for runtime control of color formatting.
    """
    self.use_colors = False

enable_colors

enable_colors()

Enable color output in log messages.

This method allows for runtime control of color formatting.

Source code in swarmauri_standard/logger_formatters/ColorFormatter.py

def enable_colors(self) -> None:
    """
    Enable color output in log messages.

    This method allows for runtime control of color formatting.
    """
    self.use_colors = True

is_using_colors

is_using_colors()

Check if color formatting is currently enabled.

RETURNS	DESCRIPTION
bool	True if color formatting is enabled, False otherwise. TYPE: bool

Source code in swarmauri_standard/logger_formatters/ColorFormatter.py

def is_using_colors(self) -> bool:
    """
    Check if color formatting is currently enabled.

    Returns:
        bool: True if color formatting is enabled, False otherwise.
    """
    return self.use_colors

register_model classmethod

register_model()

Decorator to register a base model in the unified registry.

RETURNS	DESCRIPTION
Callable	A decorator function that registers the model class. TYPE: Callable[[Type[BaseModel]], Type[BaseModel]]

Source code in swarmauri_base/DynamicBase.py

@classmethod
def register_model(cls) -> Callable[[Type[BaseModel]], Type[BaseModel]]:
    """
    Decorator to register a base model in the unified registry.

    Returns:
        Callable: A decorator function that registers the model class.
    """

    def decorator(model_cls: Type[BaseModel]):
        """Register ``model_cls`` as a base model."""
        model_name = model_cls.__name__
        if model_name in cls._registry:
            glogger.warning(
                "Model '%s' is already registered; skipping duplicate.", model_name
            )
            return model_cls

        cls._registry[model_name] = {"model_cls": model_cls, "subtypes": {}}
        glogger.debug("Registered base model '%s'.", model_name)
        DynamicBase._recreate_models()
        return model_cls

    return decorator

register_type classmethod

register_type(resource_type=None, type_name=None)

Decorator to register a subtype under one or more base models in the unified registry.

PARAMETER	DESCRIPTION
resource_type	The base model(s) under which to register the subtype. If None, all direct base classes (except DynamicBase) are used. TYPE: Optional[Union[Type[T], List[Type[T]]]] DEFAULT: None
type_name	An optional custom type name for the subtype. TYPE: Optional[str] DEFAULT: None

RETURNS	DESCRIPTION
Callable	A decorator function that registers the subtype. TYPE: Callable[[Type[DynamicBase]], Type[DynamicBase]]

Source code in swarmauri_base/DynamicBase.py

@classmethod
def register_type(
    cls,
    resource_type: Optional[Union[Type[T], List[Type[T]]]] = None,
    type_name: Optional[str] = None,
) -> Callable[[Type["DynamicBase"]], Type["DynamicBase"]]:
    """
    Decorator to register a subtype under one or more base models in the unified registry.

    Parameters:
        resource_type (Optional[Union[Type[T], List[Type[T]]]]):
            The base model(s) under which to register the subtype. If None, all direct base classes (except DynamicBase)
            are used.
        type_name (Optional[str]): An optional custom type name for the subtype.

    Returns:
        Callable: A decorator function that registers the subtype.
    """

    def decorator(subclass: Type["DynamicBase"]):
        """Register ``subclass`` as a subtype."""
        if resource_type is None:
            resource_types = [
                base for base in subclass.__bases__ if base is not cls
            ]
        elif not isinstance(resource_type, list):
            resource_types = [resource_type]
        else:
            resource_types = resource_type

        for rt in resource_types:
            if not issubclass(subclass, rt):
                raise TypeError(
                    f"'{subclass.__name__}' must be a subclass of '{rt.__name__}'."
                )
            final_type_name = type_name or getattr(
                subclass, "_type", subclass.__name__
            )
            base_model_name = rt.__name__

            if base_model_name not in cls._registry:
                cls._registry[base_model_name] = {"model_cls": rt, "subtypes": {}}
                glogger.debug(
                    "Created new registry entry for base model '%s'.",
                    base_model_name,
                )

            subtypes_dict = cls._registry[base_model_name]["subtypes"]
            if final_type_name in subtypes_dict:
                glogger.warning(
                    "Type '%s' already exists under '%s'; skipping duplicate.",
                    final_type_name,
                    base_model_name,
                )
                continue

            subtypes_dict[final_type_name] = subclass
            glogger.debug(
                "Registered '%s' as '%s' under '%s'.",
                subclass.__name__,
                final_type_name,
                base_model_name,
            )

        DynamicBase._recreate_models()
        return subclass

    return decorator

model_validate_yaml classmethod

model_validate_yaml(yaml_data)

Validate a model from a YAML string.

Source code in swarmauri_base/YamlMixin.py

@classmethod
def model_validate_yaml(cls, yaml_data: str):
    """Validate a model from a YAML string."""
    try:
        # Parse YAML into a Python dictionary
        yaml_content = yaml.safe_load(yaml_data)

        # Convert the dictionary to JSON and validate using Pydantic
        return cls.model_validate_json(json.dumps(yaml_content))
    except yaml.YAMLError as e:
        raise ValueError(f"Invalid YAML data: {e}")
    except ValidationError as e:
        raise ValueError(f"Validation failed: {e}")

model_dump_yaml

model_dump_yaml(
    fields_to_exclude=None, api_key_placeholder=None
)

Return a YAML representation of the model.

Source code in swarmauri_base/YamlMixin.py

def model_dump_yaml(self, fields_to_exclude=None, api_key_placeholder=None):
    """Return a YAML representation of the model."""
    if fields_to_exclude is None:
        fields_to_exclude = []

    # Load the JSON string into a Python dictionary
    json_data = json.loads(self.model_dump_json())

    # Function to recursively remove specific keys and handle api_key placeholders
    def process_fields(data, fields_to_exclude):
        """Recursively filter fields and apply placeholders."""
        if isinstance(data, dict):
            return {
                key: (
                    api_key_placeholder
                    if key == "api_key" and api_key_placeholder is not None
                    else process_fields(value, fields_to_exclude)
                )
                for key, value in data.items()
                if key not in fields_to_exclude
            }
        elif isinstance(data, list):
            return [process_fields(item, fields_to_exclude) for item in data]
        else:
            return data

    # Filter the JSON data
    filtered_data = process_fields(json_data, fields_to_exclude)

    # Convert the filtered data into YAML using safe mode
    return yaml.safe_dump(filtered_data, default_flow_style=False)