config

The Pyomo configuration system.

This module provides classes and methods for building standardized hierarchical configuration objects based on the ConfigDict, ConfigList, and ConfigValue classes.

See the Pyomo Configuration System for a more detailed discussion.

Enums

ConfigEnum(value)

DEPRECATED.

Classes

ConfigBase([default, domain, description, ...])
ConfigBlock	alias of ConfigDict
ConfigDict([description, doc, implicit, ...])	Store and manipulate a dictionary of configuration values.
ConfigFormatter()
ConfigList([default, domain, description, ...])	Store and manipulate a list of configuration values.
ConfigValue([default, domain, description, ...])	Store and manipulate a single configuration value.
DynamicImplicitDomain(callback)	Implicit domain that can return a custom domain based on the key.
ImmutableConfigValue(*args, **kwds)
In(domain[, cast])	Domain validation class admitting a Container of possible values
InEnum(domain)	Domain validation class admitting an enum value/name.
IsInstance(*bases[, document_full_base_names])	Domain validator for type checking.
LaTeX_ConfigFormatter()
ListOf(itemtype[, domain, string_lexer])	Domain validator for lists of a specified type
MarkImmutable(*args)	Mark instances of ConfigValue as immutable.
Module([basePath, expandPath])	Domain validator for modules.
Path([basePath, expandPath])	Domain validator for a path-like object.
PathList([basePath, expandPath])	Domain validator for a list of path-like objects.
String_ConfigFormatter(block_start, ...)
UninitializedMixin()	Mixin class to support delayed data initialization.
document_class_CONFIG([section, ...])
document_configdict([section, ...])	A simplified wrapper around document_kwargs_from_configdict for documenting classes derived from ConfigDict.
document_kwargs_from_configdict(config[, ...])	Decorator to append the documentation of a ConfigDict to the docstring
numpydoc_ConfigFormatter()

Functions

Bool(val)	Domain validator for bool-like objects.
Integer(val)	Domain validation function admitting integers
NegativeFloat(val)	Domain validation function admitting strictly negative numbers
NegativeInt(val)	Domain validation function admitting strictly negative integers
NonNegativeFloat(val)	Domain validation function admitting numbers greater than or equal to 0
NonNegativeInt(val)	Domain validation function admitting integers >= 0
NonPositiveFloat(val)	Domain validation function admitting numbers less than or equal to 0
NonPositiveInt(val)	Domain validation function admitting integers <= 0
PositiveFloat(val)	Domain validation function admitting strictly positive numbers
PositiveInt(val)	Domain validation function admitting strictly positive integers
add_docstring_list(docstring, configdict[, ...])	DEPRECATED.