Overview

Contents

• Defining Options
  • Overview
  • Restricting the possible set values
  • Deferred values
  • Required options
  • Enum Options
• Adding Subconfigurations
  • Predefined Configurations
  • Extra Configurations
  • Shortcuts for setting subconfigurations
    • set_from_single_value
    • set_from_key
• Paths
• Global Options

The process of using ConfigBlocks usually has three distinct steps.

First all options, predefined subconfigurations and subconfiguration factories are declared. This will usually be done by whatever code is being configured and then given to the user. In this documentation this step is called declaration.

Next the user sets the values on the declared options. This step is called configuration. Configuration is done using dictionary semantics. For example an entire configuration could be loaded from a JSON file:

with open("config.json") as fp
    cfg.update(json.load(fp))

Lastly the code will process the supplied configuration, which is not handled by this package.

Nothing in the code enforces this separation: you are free to mix the declaring and setting of options as you want but for the purposes of clarity this is not recommended.