ConfigItem

class astropy.config.ConfigItem(defaultvalue='', description=None, cfgtype=None, module=None, aliases=None)

基类：object

存储在配置文件中的一种设置和相关联的值。

这些对象应创建为 ConfigNamespace 子类，例如：

class _Conf(config.ConfigNamespace):
    unicode_output = config.ConfigItem(
        False,
        'Use Unicode characters when outputting values, and writing widgets '
        'to the console.')
conf = _Conf()

参数:

defaultvalue : object ，可选对象，可选

此项的默认值。如果这是一个字符串列表，则此项将被解释为“选项”值-此项必须是这些值之一，并且列表中的第一个值将作为默认值。

description : str 或 None ，可选PYTHON：字符串或PYTHON：无，可选

此项的说明（将在配置文件中显示为注释）

cfgtype : str 或 None ，可选PYTHON：字符串或PYTHON：无，可选

与用作 价值观 在一个 configspec 文件 configobj . 如果没有，则从默认值推断类型。

module : str 或 None ，可选PYTHON：字符串或PYTHON：无，可选

与此项关联的完整模块名。第一个元素（例如“astropy”如果这是'astropy.config.configuration配置'）将用于确定配置文件的名称，而其余项确定节。如果没有，则将从调用此对象的初始值设定项的包中推断包。

aliases : str ，或 list 的 str ，可选PYTHON：STR，或PYTHON：LIST OF PYTHON：STR，可选

此配置项的已弃用位置。如果在新位置找不到配置项，将在所有旧位置搜索它。

加薪:

RuntimeError

如果 module 是 None ，但无法确定创建此项的源模块。

属性摘要

cfgtype	与用作 价值观 在一个 configspec 文件 configobj .
rootname	Rootname设置所有配置文件的基本路径。

方法总结

__call__ \()	返回此对象的值 ConfigItem 。
reload \()	重新加载此值 ConfigItem 从相关配置文件。
set \(值)	设置此的当前值 ConfigItem .
set_temp \(值)	仅在with块内将此项设置为指定值。

属性文档

cfgtype = None

与用作 价值观 在一个 configspec 文件 configobj .

rootname = 'astropy'

Rootname设置所有配置文件的基本路径。

方法文件

__call__()

返回此对象的值 ConfigItem 。

返回:

val : object对象

此项的值，其类型由 cfgtype 属性。

加薪:

TypeError

如果存储的配置值不是此项的类型。

reload()

重新加载此值 ConfigItem 从相关配置文件。

返回:

val : object对象

从配置文件加载的新值。

set(value)

设置此的当前值 ConfigItem .

这也会更新提供说明和类型信息的注释。

参数:

value

此项应设置为的值。

加薪:

TypeError

如果提供 value 对此无效 ConfigItem .

set_temp(value)

仅在with块内将此项设置为指定值。

用作：

ITEM = ConfigItem('ITEM', 'default', 'description')

with ITEM.set_temp('newval'):
    #... do something that wants ITEM's value to be 'newval' ...
    print(ITEM)

# ITEM is now 'default' after the with block

参数:

value

将此项设置为with块内部的值。