配置列表

(类来自 pyomo.common.config)

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

基础类: ConfigBase, Sequence

存储和操作配置值的列表。

Parameters:

  • default (可选) – 如果没有提供值，此ConfigList将采用的默认值。如果默认值是列表或ConfigList，则每个成员将被转换为ConfigList的域以构建默认值，否则默认值将被转换为域并形成一个包含单个元素的默认列表。

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

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

  • 文档 (str, 可选) – 此列表的长文档字符串

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

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

方法

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

add([value])

已弃用。

append([value])

count(value)

declare_as_argument(*args, **kwds)

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

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

domain_name()

generate_documentation([block_start, ...])

generate_yaml_template([indent_spacing, ...])

get(key[, default])

import_argparse(parsed_args)

index(value, [start, [stop]])

如果值不存在，则引发ValueError。

initialize_argparse(parser)

name([fully_qualified])

reset()

set_default_value(default)

set_domain(domain)

set_value(value)

unused_user_values()

user_values()

value([accessValue])

成员文档

add(value=NOTSET)[source]

已弃用。

将指定的值附加到列表中，必要时进行类型转换。

自版本5.7.2起已弃用：ConfigList.add() 已被弃用。请使用 append()

count(value) → integer -- return number of occurrences of value
declare_as_argument(*args, **kwds)

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

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

index(value[, start[, stop]]) → integer -- return first index of value.

如果值不存在，则引发ValueError。

支持开始和停止参数是可选的，但建议这样做。