Confection

1.3.3 · active · verified Wed Apr 08

Confection is a lightweight and flexible configuration system for Python, designed to handle complex nested configurations with features like interpolation, validation, and registry integration. It is currently at version 1.3.3 and maintains an active release cadence, often aligning with updates to related libraries like spaCy and Thinc.

Warnings

breaking Confection v1.1.0 and later dropped support for Pydantic for validation, reverting to custom validation logic. If you were relying on Pydantic's specific validation behaviors with older versions, your configurations might behave differently or break.
Fix: Review your configurations and update them to align with Confection's custom validation logic. Test thoroughly, especially if you had complex Pydantic validation schemas.
gotcha Prior to v1.3.3, Python-style boolean (True, False) and None literals in configuration files were silently treated as strings instead of their corresponding Python types. This could lead to type errors, especially with newer Pydantic versions.
Fix: Upgrade to confection v1.3.3 or later. If unable to upgrade, explicitly quote 'true', 'false', and 'null' as JSON-style lowercase literals in your config files, or ensure your consuming code handles string-based booleans/None.
breaking Changes in Pydantic v2 support across Confection versions (v1.0.0, v1.0.0a2, v1.1.0) could lead to compatibility issues. If you're using Pydantic in conjunction with Confection, ensure your Confection version aligns with the Pydantic version you're using.
Fix: For Pydantic v2 compatibility, Confection v1.0.0 and v1.0.0a2 aimed to support it. However, v1.1.0 reverted away from Pydantic entirely. The most stable approach is to use Confection v1.1.0 or newer if you wish to avoid Pydantic dependencies, or carefully test specific versions if Pydantic integration is critical.
gotcha When using `Config.from_str()` for loading configurations, pay close attention to the YAML/INI-like syntax. Incorrect indentation or malformed sections can lead to parsing errors. For example, top-level section references have had bug fixes.
Fix: Always validate your configuration strings carefully. Refer to the Confection documentation for the precise syntax. For older versions, be aware of potential issues with complex section references and consider upgrading to v1.2.0 or newer for bug fixes related to parsing.

Install

pip install confection Default Install

Imports

Config
```
from confection import Config
```
set_registry
```
from confection import set_registry
```

Quickstart

This quickstart demonstrates how to define a function in the registry, create a `Config` object, and resolve the configuration to execute the registered function with provided arguments. It also shows an example of loading a config from a string.

from confection import Config, set_registry

@set_registry("my_functions", "add")
def add_function(a: int, b: int):
    return a + b

config = Config({"model": {"func": {"@my_functions": "add"}, "a": 1, "b": 2}})

resolved = config.resolve()
result = resolved["model"]["func"](resolved["model"]["a"], resolved["model"]["b"])

print(f"Result: {result}")

# Example with direct config creation
config_direct = Config().from_str("""
[model]
func = @my_functions.add
a = 10
b = 20
""")
resolved_direct = config_direct.resolve()
result_direct = resolved_direct["model"]["func"](resolved_direct["model"]["a"], resolved_direct["model"]["b"])

print(f"Direct Config Result: {result_direct}")

view raw JSON →