DiracX Core Library

Warnings

• breaking As a pre-1.0 version library (currently 0.0.12), diracx-core's API is subject to frequent and significant breaking changes without prior deprecation warnings. Users should pin exact versions and regularly review the GitHub repository for updates.
  Fix: Pin your `diracx-core` dependency to an exact version (e.g., `diracx-core==0.0.12`) in `requirements.txt` or `pyproject.toml` to prevent unexpected breakages. Regularly check the project's GitHub for breaking changes before upgrading.
• gotcha DiracX Core is primarily designed as a foundational library to be extended by other DiracX packages, not necessarily for standalone complex application development. While it provides utilities, its core strength lies in providing base classes and structures for a larger ecosystem.
  Fix: Understand that while you can use its components, full application logic might require other DiracX components or custom wrappers. Review the specific use cases in the official DiracX ecosystem if available.
• gotcha The `BaseConfig` class, being a Pydantic `BaseModel`, relies on specific mechanisms for configuration loading and overriding (e.g., environment variables, `.env` files, or explicit instantiation). Misunderstanding the priority or source of configuration values can lead to unexpected behavior.
  Fix: Always explicitly define expected configuration sources (e.g., `os.environ.get`) or ensure `.env` files are loaded correctly if used. When debugging, print the resulting configuration object to verify loaded values.

Install

• pip install diracx-core Install stable version

Imports

• BaseConfig

  from diracx_core.config import BaseConfig

• DiracXError

  from diracx_core.errors import DiracXError

• LoggableMixin

  from diracx_core.logger import LoggableMixin

Quickstart

This quickstart demonstrates how to define and use a configuration class inheriting from `diracx_core.config.BaseConfig`. It showcases field definitions with descriptions and how to integrate environment variables for sensitive data like API keys.

import os
from diracx_core.config import BaseConfig
from pydantic import Field

class AppConfig(BaseConfig):
    app_name: str = Field('MyDiracXApp', description='Name of the application')
    api_key: str = Field(os.environ.get('DIRACX_API_KEY', ''), description='API Key for DiracX services')
    debug_mode: bool = Field(False, description='Enable debug logging')

# Example usage
# Set an environment variable for testing, e.g., export DIRACX_API_KEY="your_secret"
config = AppConfig()
print(f"Application Name: {config.app_name}")
if config.api_key:
    print("API Key loaded successfully.")
else:
    print("Warning: DIRACX_API_KEY environment variable not set. API services might not work.")

if config.debug_mode:
    print("Debug mode is ON.")