document_configdict

(class from pyomo.common.config)

class pyomo.common.config.document_configdict(section='Options', indent_spacing=4, width=78, visibility=None, doc=None, preamble=None)

Bases: document_kwargs_from_configdict

Class decorator for documenting classes derived from ConfigDict.

This is a wrapper around document_kwargs_from_configdict for documenting classes derived from ConfigDict with pre-declared members. See document_kwargs_from_configdict for a description of the decorator arguments.

Example

@document_configdict()
class MyConfig(ConfigDict):
    'Custom configuration object'

    def __init__(
        self,
        description=None,
        doc=None,
        implicit=False,
        implicit_domain=None,
        visibility=0,
    ):
        super().__init__(
            description=description,
            doc=doc,
            implicit=implicit,
            implicit_domain=implicit_domain,
            visibility=visibility,
        )

        self.iterlim = self.declare('iterlim', ConfigValue(
            domain=int, doc='Solver iteration limit'
        ))

        self.timeout = self.declare('timeout', ConfigValue(
            domain=float, doc='Solver (wall clock) time limit'
        ))

Will result in

>>> help(MyConfig)
Help on class MyConfig ...

class MyConfig(pyomo.common.config.ConfigDict)
 |  MyConfig(...)
 |
 |  Custom configuration object
 |
 |  Options
 |  -------
 |  iterlim: int, optional
 |
 |      Solver iteration limit
 |
 |  timeout: float, optional
 |
 |      Solver (wall clock) time limit
 |
 |  ...

__init__(section='Options', indent_spacing=4, width=78, visibility=None, doc=None, preamble=None)

Methods

__init__([section, indent_spacing, width, ...])

Member Documentation