mindtrace-core 0.12.0

Core functionality for Mindtrace

Mindtrace Core

The Core module provides the foundational abstractions, configuration, logging, observability, typing, and utility helpers used across the Mindtrace ecosystem.

Features

• Base abstractions with Mindtrace and MindtraceABC
• Configuration management with a single Config (a pydantic_settings.BaseSettings subclass)
• Task typing with TaskSchema
• Logging and operation tracking with standard and structured logging support
• Observability primitives with EventBus, ObservableContext, and ContextListener
• Shared utility helpers for dynamic loading, networking, timing, hashing, and metrics

Quick Start

from pydantic import BaseModel

from mindtrace.core import Mindtrace, TaskSchema, ifnone


class EchoInput(BaseModel):
    message: str


class EchoOutput(BaseModel):
    echoed: str


echo_task = TaskSchema(
    name="echo",
    input_schema=EchoInput,
    output_schema=EchoOutput,
)


class EchoComponent(Mindtrace):
    def echo(self, payload: EchoInput) -> EchoOutput:
        return EchoOutput(echoed=ifnone(payload.message, ""))


component = EchoComponent()
print(component.echo(EchoInput(message="Hello")))
print(component.config.MINDTRACE_DIR_PATHS.TEMP_DIR)
component.logger.info("Core component ready")

This example shows the typical role of mindtrace-core: it gives you a common base class, typed task contracts, configuration access, logging, and small utility helpers that other Mindtrace modules build on.

Mindtrace

Mindtrace is the main base class for shared Mindtrace components. It provides:

• a consistent logger on both instances and classes (self.logger / cls.logger)
• access to the shared Config (self.config / cls.config)
• context-manager support

Example:

from mindtrace.core import Mindtrace


class DataProcessor(Mindtrace):
    def process(self, values: list[int]) -> list[int]:
        self.logger.info("Processing values")
        return [value * 2 for value in values]


with DataProcessor() as processor:
    print(processor.process([1, 2, 3]))

If you need an abstract base class with the same Mindtrace behavior, use MindtraceABC.

Config

Config is the shared configuration container in mindtrace-core. It is a pydantic_settings.BaseSettings subclass with the standard Mindtrace sections (MINDTRACE_DIR_PATHS, MINDTRACE_DEFAULT_HOST_URLS, MINDTRACE_API_KEYS, ...) declared as typed fields.

Values are loaded from (highest to lowest precedence):

1. Constructor kwargs
2. Environment variables (SECTION__KEY delimiter)
3. .env file
4. config.ini bundled with the package

Features:

• attribute-style access (config.MINDTRACE_DIR_PATHS.TEMP_DIR)
• dict-style access (config["MINDTRACE_DIR_PATHS"]["TEMP_DIR"])
• ~ expansion on string fields
• secret masking on repr(); reveal with get_secret(...) or model_dump_json()

from mindtrace.core import Config


config = Config()

print(config.MINDTRACE_DIR_PATHS.TEMP_DIR)
print(config["MINDTRACE_DEFAULT_HOST_URLS"]["SERVICE"])

# Reveal a single secret
api_key = config.get_secret("MINDTRACE_API_KEYS", "OPENAI")

Override via environment variable (most common):

export MINDTRACE_DEFAULT_HOST_URLS__SERVICE=http://custom:8080

Config() will pick that up automatically.

TaskSchema

TaskSchema is the small but important typed contract used across the Mindtrace ecosystem. It describes:

• the task name
• the input model
• the output model

This is especially useful in higher-level packages such as mindtrace-services, where the same schema is used for endpoint validation and client generation.

Example:

from pydantic import BaseModel

from mindtrace.core import TaskSchema


class SummarizeInput(BaseModel):
    text: str


class SummarizeOutput(BaseModel):
    summary: str


summarize_task = TaskSchema(
    name="summarize",
    input_schema=SummarizeInput,
    output_schema=SummarizeOutput,
)

Logging

mindtrace-core provides both standard logging and structured logging support.

Standard logger

Use get_logger() when you want a ready-to-use logger with Mindtrace defaults.

from mindtrace.core.logging.logger import get_logger


logger = get_logger("core.example")
logger.info("Logger configured")

By default all loggers write to a single rotating file at ~/.cache/mindtrace/logs/mindtrace.log (plus the console stream). To also get a per-module file at logs/modules/<logger-name>.log, set MINDTRACE_LOGGER__PER_MODULE_FILES=true — records are then written to both the unified file and the per-module one.

Structured logger

If enabled, the same logging helpers can produce structured logs using structlog.

from mindtrace.core.logging.logger import get_logger


logger = get_logger(
    "core.example",
    use_structlog=True,
    structlog_bind={"service": "demo"},
)
logger.info("Structured log event", user_id="123")

track_operation

Use track_operation() when you want explicit operation-level logging around a specific unit of work. It is useful for things like:

• measuring how long an operation took
• attaching structured context such as a batch ID or file name
• recording optional system metrics alongside the operation
• producing start / completed / failed log events in a consistent format

from mindtrace.core.logging.logger import track_operation


@track_operation("load_data", include_system_metrics=True, dataset="train")
def load_data() -> list[int]:
    return [1, 2, 3]

With this pattern, the logs can include fields such as:

• the operation name
• whether it started, completed, or failed
• duration / duration_ms
• any extra context you bound, such as dataset="train"
• optional system metrics, such as CPU or memory usage

That makes track_operation() a good fit when you care about observability of a specific workflow step, not just generic function logging.

Observables

The observables utilities support lightweight eventing and reactive state updates.

EventBus

EventBus is a simple publish-subscribe mechanism for dispatching events by name.

from mindtrace.core import EventBus


bus = EventBus()


def handler(**kwargs):
    print(kwargs)


bus.subscribe(handler, "data_loaded")
bus.emit("data_loaded", records=3)
bus.unsubscribe(handler, "data_loaded")

ObservableContext

ObservableContext is a class decorator that turns selected attributes into observable fields.

from mindtrace.core import ObservableContext


@ObservableContext(vars=["status"])
class JobContext:
    def __init__(self):
        self.status = "created"


ctx = JobContext()
ctx.status = "running"

ContextListener

ContextListener is a Mindtrace-aware helper for listening to observable context changes.

from mindtrace.core import ContextListener, ObservableContext


@ObservableContext(vars={"progress": int})
class JobContext:
    def __init__(self):
        self.progress = 0


ctx = JobContext()
ctx.subscribe(ContextListener(autolog=["progress"]))
ctx.progress = 50

Utility Helpers

mindtrace-core also provides a collection of lower-level helpers used across the ecosystem.

Dynamic loading

from mindtrace.core import instantiate_target


instance = instantiate_target(
    "my_package.my_module.MyClass",
    **{"config_path": "settings.json", "debug": True},
)

Network helpers

from mindtrace.core import get_free_port, wait_for_service


port = get_free_port(start_port=8000, end_port=8100)
print(port)

# Wait for something to start listening on that port
wait_for_service("localhost", port, timeout=5.0)

Timers and timeout helpers

from mindtrace.core import Timeout


def eventually_ready():
    return "ready"


timeout = Timeout(timeout=5)
print(timeout.run(eventually_ready))

Hashing and metrics

from mindtrace.core import SystemMetricsCollector, compute_dir_hash


collector = SystemMetricsCollector()
print(collector())
print(compute_dir_hash("./some-directory"))

Examples

See these examples and related docs in the repo for more end-to-end reference:

• Core echo task sample
• Core configuration examples
• Core logging examples

Testing

If you are working in the full Mindtrace repo, run tests for this module specifically:

git clone https://github.com/Mindtrace/mindtrace.git && cd mindtrace
uv sync --dev --all-extras

# Run the core test suite
ds test: core

# Run only unit tests for core
ds test: --unit core

Stress / benchmark plugins

Timed workloads use mindtrace.core.testing: BenchTestSuite, TestRunner, and mindtrace-bench. See docs/core/benchmarks.md for registering suites, running shipped benches, and adding application-specific benchmarks.

Practical Notes and Caveats

• Config is a pydantic_settings.BaseSettings.
• Secret configuration values are masked on repr(); use config.get_secret(...) or model_dump_json() when you need the real value.
• TaskSchema is a typed contract, not an execution engine by itself.
• track_operation() attaches structured per-operation context (duration, start/completed/failed, system metrics).
• Many helpers in core are intentionally low-level building blocks; the README should help you discover them, while the code docs remain the detailed reference.