配置值

(类来自 pyomo.common.config)

class pyomo.common.config.ConfigValue(default=None, domain=None, description=None, doc=None, visibility=0)[source]

基础类: ConfigBase

存储和操作单个配置值。

Parameters:

  • 默认值 (可选) – 如果没有提供值，此 ConfigValue 将采用的默认值。

  • domain (Callable, optional) – 域可以是任何可调用对象，它接受一个候选值并返回转换为所需类型的值，可选地执行任何数据验证。结果将存储到ConfigValue中。示例包括类型构造函数，如int或float。更复杂的域示例包括可调用对象；例如，In类，它确保值落入可接受的集合中，甚至是一个完整的ConfigDict实例。

  • 描述 (str, 可选) – 此值的简短描述

  • 文档 (str, 可选) – 此值的详细文档字符串

  • visibility (int, optional) – 在生成模板和文档时，此ConfigValue的可见性。可见性支持指定“高级”或“开发者”选项。visibility=0（默认值）的ConfigValue将始终被打印/包含。具有更高可见性值的ConfigValue仅在生成方法指定的可见性大于或等于此对象的可见性时才会被包含。

__init__(default=None, domain=None, description=None, doc=None, visibility=0)

方法

__init__([默认值, 域, 描述, ...])

declare_as_argument(*args, **kwds)

将此配置项映射到一个argparse参数。

display([content_filter, indent_spacing, ...])

domain_name()

generate_documentation([block_start, ...])

generate_yaml_template([indent_spacing, ...])

import_argparse(parsed_args)

initialize_argparse(parser)

name([fully_qualified])

reset()

set_default_value(default)

set_domain(domain)

set_value(value)

unused_user_values()

user_values()

value([accessValue])

成员文档

declare_as_argument(*args, **kwds)

将此配置项映射到一个argparse参数。

有效的参数包括所有有效的参数，这些参数适用于argparse的ArgumentParser.add_argument()，除了'default'。此外，您可以提供一个group关键字参数，以传入预定义的选项组或子解析器，或者传入组、子解析器或（子解析器，组）的字符串名称。