Skip to content

Config Descriptor

This section provides curated guidance around the core Config descriptor and its decorators. For full auto-generated API documentation see the pdoc pages linked via the pdoc: references below.

Core Class

  • Config – Descriptor managing reading/writing typed values.

Lifecycle / Initialization Helpers

Runtime Flags

Decorators

  • Config.set – Always set a value before calling a function.
  • Config.default – Set only when unset.
  • Config.with_setting – Inject an existing descriptor value as a kwarg.
  • Config.with_kwarg – (Named with_kwarg in code; often described as with_kwarg) inject by section/setting with optional rename & default.

Internal Validation (Selected)

Tip: Use the decorators for imperative flows and prefer descriptor attributes for normal configuration access.