classconfig

Contents:

  • Usage
    • Installation
    • Basic Usage
    • Configuration Files
      • Generating Configuration
      • Loading Configuration
    • Dataclasses
    • Advanced Features
      • Configurable Attributes
      • Mixins
      • Validators
      • Transformers
    • Comprehensive Example
    • Why YAML?
  • Examples
    • 1. Basic Configuration
    • 2. Nested Configuration
    • 3. Polymorphism with Subclass Factory
    • 4. List of Polymorphic Objects
    • 5. Dataclasses
    • 6. Validation
    • 7. Transformation (Enums)
    • 8. Relative Paths
    • 9. Delayed Initialization
    • 10. Inheritance
    • 11. Omit Attributes in Factory
    • 12. Overriding User Defaults
    • 13. Creatable Mixin
  • classconfig package
    • Submodules
    • classconfig.base module
      • AttributeTransformer
      • ConfigurableAttribute
        • ConfigurableAttribute.member_name
      • Validator
    • classconfig.classes module
      • ConfigurableDataclassMixin
        • ConfigurableDataclassMixin.DESC_METADATA
      • dataclass_field_2_configurable_attribute()
      • get_configurable_attributes()
      • is_configurable()
      • sub_cls_from_its_name()
      • subclasses()
    • classconfig.configurable module
      • Config
        • Config.bool_arg_convertor()
        • Config.config_from_object()
        • Config.configurable_values_from_object()
        • Config.create_arg_parser()
        • Config.generate_md_documentation()
        • Config.generate_yaml_config()
        • Config.generate_yaml_for_configurable_factory()
        • Config.generate_yaml_for_configurable_subclass_factory()
        • Config.generate_yaml_for_configurable_value()
        • Config.generate_yaml_for_list_of_configurable_factories()
        • Config.get_values_from_arguments()
        • Config.load()
        • Config.load_itself()
        • Config.pass_omit()
        • Config.save()
        • Config.to_md()
        • Config.trans_and_val()
        • Config.trans_and_val_configurable_factory()
        • Config.trans_and_val_configurable_subclass_factory()
        • Config.trans_and_val_configurable_value()
        • Config.trans_and_val_list_of_configurable_subclass_factory()
      • ConfigError
      • ConfigurableFactory
        • ConfigurableFactory.create()
        • ConfigurableFactory.merge_omits()
        • ConfigurableFactory.should_omit()
      • ConfigurableMixin
      • ConfigurableSubclassFactory
        • ConfigurableSubclassFactory.create()
      • ConfigurableValue
      • CreatableMixin
        • CreatableMixin.create()
      • DelayedFactory
        • DelayedFactory.create()
      • ListOfConfigurableSubclassFactoryAttributes
        • ListOfConfigurableSubclassFactoryAttributes.create()
      • LoadedConfig
        • LoadedConfig.parent_config
        • LoadedConfig.untransformed
      • UsedConfig
    • classconfig.transforms module
      • CPUWorkersTransformer
      • EnumTransformer
      • RelativePathTransformer
      • SubclassTransformer
      • TransformIfNotNone
      • TryTransforms
    • classconfig.validators module
      • AllValidator
      • AnyValidator
      • BoolValidator
        • BoolValidator.TYPE
        • BoolValidator.TYPE_NAME
      • CollectionOfTypesValidator
      • FilePathValidator
      • FloatValidator
        • FloatValidator.TYPE
        • FloatValidator.TYPE_NAME
      • IntegerValidator
        • IntegerValidator.TYPE
        • IntegerValidator.TYPE_NAME
      • IsNoneValidator
      • ListOfTypesValidator
      • MinValueFloatValidator
      • MinValueIntegerValidator
      • StringValidator
        • StringValidator.TYPE
        • StringValidator.TYPE_NAME
      • TypeValidator
        • TypeValidator.TYPE
        • TypeValidator.TYPE_NAME
      • ValueInIntervalFloatValidator
      • ValueInIntervalIntegerValidator
    • classconfig.yaml module
      • YAML
        • YAML.dumps()
    • Module contents
classconfig
  • Search

© Copyright 2023, Martin Dočekal.

Built with Sphinx using a theme provided by Read the Docs.