configblock package

Submodules

• configblock.configblock module
  • ConfigBlock
    • ConfigBlock.activate()
    • ConfigBlock.active
    • ConfigBlock.add_enum_option()
    • ConfigBlock.add_global_option()
    • ConfigBlock.add_option()
    • ConfigBlock.add_subconfig()
    • ConfigBlock.add_subconfig_type()
    • ConfigBlock.clear()
    • ConfigBlock.default_subconfig_type
    • ConfigBlock.full_path
    • ConfigBlock.get_option_data()
    • ConfigBlock.get_option_value()
    • ConfigBlock.get_subconfig()
    • ConfigBlock.globals
    • ConfigBlock.is_extra_subconfig()
    • ConfigBlock.is_option()
    • ConfigBlock.is_option_set()
    • ConfigBlock.is_predefined_subconfig()
    • ConfigBlock.is_root
    • ConfigBlock.is_set_from_key()
    • ConfigBlock.is_set_from_single_value()
    • ConfigBlock.is_subconfig()
    • ConfigBlock.iter_option_data()
    • ConfigBlock.iter_paths()
    • ConfigBlock.iter_predefined_subconfigs()
    • ConfigBlock.iter_subconfig_types()
    • ConfigBlock.iter_subconfigs()
    • ConfigBlock.key_in_parent
    • ConfigBlock.n_extra_subconfig_types
    • ConfigBlock.n_extra_subconfigs
    • ConfigBlock.n_options
    • ConfigBlock.n_predefined_subconfigs
    • ConfigBlock.n_subconfigs
    • ConfigBlock.parent
    • ConfigBlock.remove_extra_subconfig()
    • ConfigBlock.remove_option()
    • ConfigBlock.remove_option_value()
    • ConfigBlock.remove_subconfig()
    • ConfigBlock.remove_subconfig_type()
    • ConfigBlock.reset_predefined_subconfig()
    • ConfigBlock.root
    • ConfigBlock.set()
    • ConfigBlock.set_default_subconfig_type()
    • ConfigBlock.set_from_key()
    • ConfigBlock.set_from_single_value()
    • ConfigBlock.set_option_value()
    • ConfigBlock.set_parent()
    • ConfigBlock.set_subconfig()
    • ConfigBlock.to_dict()
    • ConfigBlock.valid_key()
    • ConfigBlock.validate()
  • ConfigBlockFactory
  • DeferredValue
  • GlobalConfigBlock
    • GlobalConfigBlock.add_option()
    • GlobalConfigBlock.add_subconfig_type()
    • GlobalConfigBlock.log
    • GlobalConfigBlock.merge()
  • GlobalOption
  • OptionData
    • OptionData.choices
    • OptionData.default
    • OptionData.detail
    • OptionData.help
    • OptionData.required
    • OptionData.type
    • OptionData.validator
  • OptionReference
    • OptionReference.description
    • OptionReference.path
  • OptionValidator
  • recurse()
• configblock.dictwriter module
  • DictWriter
    • DictWriter.begin_globals()
    • DictWriter.begin_subcfg()
    • DictWriter.convert_value()
    • DictWriter.current_dict
    • DictWriter.end_globals()
    • DictWriter.end_subcfg()
    • DictWriter.visit()
    • DictWriter.visit_option()
• configblock.docprinter module
  • DocPrinter
    • DocPrinter.begin()
    • DocPrinter.begin_globals()
    • DocPrinter.begin_options()
    • DocPrinter.begin_subcfg()
    • DocPrinter.begin_subcfg_types()
    • DocPrinter.begin_subcfgs()
    • DocPrinter.detail
    • DocPrinter.end_options()
    • DocPrinter.end_subcfg_types()
    • DocPrinter.end_subcfgs()
    • DocPrinter.visit_default_subcfg_type()
    • DocPrinter.visit_globals()
    • DocPrinter.visit_option()
    • DocPrinter.visit_subcfg_type()
  • get_short_doc()
• configblock.path module
  • Path
    • Path.absolute
    • Path.has_tail
    • Path.head
    • Path.refers_to_current_location
    • Path.refers_upward
    • Path.segments
    • Path.tail
• configblock.templatebuilder module
  • TemplateBuilder
    • TemplateBuilder.begin_block()
    • TemplateBuilder.begin_subcfg()
    • TemplateBuilder.visit_option()
• configblock.utils module
  • find_blocks()
  • find_option_on_block_of_type()
  • find_option_on_matching_block()
  • mk_optional()
  • wrap_deferred_func()
• configblock.visitorbase module
  • Section
    • Section.Options
    • Section.SubconfigTypes
    • Section.Subconfigs
  • VisitorBase
    • VisitorBase.begin()
    • VisitorBase.begin_block()
    • VisitorBase.begin_globals()
    • VisitorBase.begin_options()
    • VisitorBase.begin_subcfg()
    • VisitorBase.begin_subcfg_types()
    • VisitorBase.begin_subcfgs()
    • VisitorBase.current_block
    • VisitorBase.depth
    • VisitorBase.end()
    • VisitorBase.end_block()
    • VisitorBase.end_globals()
    • VisitorBase.end_options()
    • VisitorBase.end_subcfg()
    • VisitorBase.end_subcfg_types()
    • VisitorBase.end_subcfgs()
    • VisitorBase.only_active
    • VisitorBase.root
    • VisitorBase.section_order
    • VisitorBase.stack_block()
    • VisitorBase.stack_factory()
    • VisitorBase.visit()
    • VisitorBase.visit_block()
    • VisitorBase.visit_default_subcfg_type()
    • VisitorBase.visit_globals()
    • VisitorBase.visit_option()
    • VisitorBase.visit_options()
    • VisitorBase.visit_subcfg_type()
    • VisitorBase.visit_subcfg_types()
    • VisitorBase.visit_subcfgs()

Module contents

Hierarchical, self documenting configuration structure