Configuration¶

This guide covers configuration options for the AIBS Informatics Core library.

Environment Variables¶

The library uses environment variables for certain configurations. Here are the commonly used ones:

Logging Configuration¶

You can configure logging behavior using the logging utilities:

from aibs_informatics_core.utils.logging import get_logger, setup_logging

# Set up logging with default configuration
setup_logging()

# Get a logger for your module
logger = get_logger(__name__)
logger.info("Application started")

EnvBase Configuration¶

The EnvBase class can be configured with different environment types and names:

from aibs_informatics_core.env import EnvBase, EnvType

# Development environment
dev_env = EnvBase('dev-projectX')

# Production environment
prod_env = EnvBase.from_type_and_label(EnvType.PROD, 'projectX')

# Create prefixed names for resources
dev_env.prefixed('bucket', 'data')  # 'dev-projectX-bucket-data'
prod_env.prefixed('bucket', 'data')  # 'prod-projectX-bucket-data'

Model Serialization¶

JSON Serialization¶

Data models support JSON serialization out of the box:

from aibs_informatics_core.models.base import PydanticBaseModel

class Config(PydanticBaseModel):
    debug: bool = False
    max_retries: int = 3

config = Config(debug=True)
json_data = config.to_json()

Custom Field Types¶

The library provides custom fields for common use cases:

from aibs_informatics_core.models.base.custom_fields import IsoDateTime

Executor Configuration¶

Executors can be configured with validation schemas:

from aibs_informatics_core.executors import BaseExecutor

class ConfigurableExecutor(BaseExecutor):
    # Define request/response schemas for validation
    pass

Advanced Configuration¶

Validation¶

Use Pydantic validators to add validation to your models:

from aibs_informatics_core.models.base import PydanticBaseModel
from pydantic import model_validator

class ValidatedConfig(PydanticBaseModel):
    port: int

    @model_validator(mode="after")
    def validate_port(self) -> Self:
        if not 1 <= self.port <= 65535:
            raise ValueError("Port must be between 1 and 65535")
        return self