How openai/chz works
Project type and purpose
• Project type: A Python library/tool (open-source) focused on configuration management and command-line parsing.
• Purpose: Provide a declarative object model for configuration, support validation, partial application (“blueprints”), presets, serialization/deserialization, and generate a user-friendly CLI interface.
File structure
Top level:
• chz/ ← main Python package
– blueprint/ ← “blueprint” sub-package (core API surface for creating reusable config blueprints)
• _argmap.py ← mapping CLI args to blueprint fields
• _argv.py ← parsing argv arrays
• _blueprint.py ← blueprint class definitions & logic
• _entrypoint.py ← tying blueprint to an executable entrypoint
• _lazy.py ← lazy evaluation utilities
• _wildcard.py ← handling variadic args/fields
– data_model.py ← declarative object model & immutability support
– field.py ← field descriptor API
– validators.py ← validation rules & type checking
– mungers.py ← data-munging pipeline (transformers)
– factories.py ← creating instances of the data model from raw inputs
– tiepin.py ← user-facing CLI entrypoint runner
– universal.py ← cross-cutting utilities
– util.py ← general helper functions
• docs/ ← conceptual and user documentation
• tests/ ← unit tests for every major module
• pyproject.toml ← build & dependency configuration
README for additional insights
• Highlights features: quickstart, declarative model, immutability, validation, CLI parsing, help/discoverability, partial application, presets, serialization
• No external runtime (no database, no network services)—all in-process library
Elements
– Blue for user-facing components (tiepin.py, blueprint API)
– Green for core engine (factories, data_model, validators, mungers)
– Gray for utilities/support (util, universal, lazy, wildcard)