配置字典
(类来自 pyomo.common.config)
- class pyomo.common.config.ConfigDict(description=None, doc=None, implicit=False, implicit_domain=None, visibility=0)[source]
基础类:
ConfigBase,Mapping存储和操作配置值的字典。
- Parameters:
描述 (str, 可选) – 此列表的简短描述
文档 (str, 可选) – 此列表的长文档字符串
implicit (bool, optional) – 如果为True,ConfigDict将允许“隐式”声明的键,即可以存储到ConfigDict中的键,这些键之前没有使用
declare()或declare_from()声明。implicit_domain (Callable, optional) – 用于任何隐式声明键的域。 遵循与
ConfigValue()的domain相同的规则。visibility (int, optional) – 在生成模板和文档时,此ConfigDict的可见性。可见性支持指定“高级”或“开发者”选项。visibility=0(默认值)的ConfigDict将始终被打印/包含。具有更高可见性值的ConfigDict仅在生成方法指定的可见性大于或等于此对象的可见性时才会被包含。
方法
__init__([描述, 文档, 隐式, ...])add(name, config)declare(name, config)declare_as_argument(*args, **kwds)将此配置项映射到一个argparse参数。
declare_from(other[, skip])display([content_filter, indent_spacing, ...])domain_name()generate_documentation([block_start, ...])generate_yaml_template([indent_spacing, ...])get(k[,d])import_argparse(parsed_args)initialize_argparse(parser)items()已弃用。
iterkeys()已弃用。
已弃用。
keys()name([fully_qualified])reset()set_default_value(default)set_domain(domain)set_value(value[, skip_implicit])setdefault(key[, default])unused_user_values()user_values()value([accessValue])values()属性
content_filters成员文档
- declare_as_argument(*args, **kwds)
将此配置项映射到一个argparse参数。
有效的参数包括所有有效的参数,这些参数适用于argparse的ArgumentParser.add_argument(),除了'default'。此外,您可以提供一个group关键字参数,以传入预定义的选项组或子解析器,或者传入组、子解析器或(子解析器,组)的字符串名称。