ConfigNamespace#

class astropy.config.ConfigNamespace[源代码]#

基类:object

配置项的命名空间。每个带有配置项的子包都应该定义这个类的一个子类,包含 ConfigItem 实例作为成员。

例如::

class Conf(_config.ConfigNamespace):
    unicode_output = _config.ConfigItem(
        False,
        'Use Unicode characters when outputting values, ...')
    use_color = _config.ConfigItem(
        sys.platform != 'win32',
        'When True, use ANSI color escape sequences when ...',
        aliases=['astropy.utils.console.USE_COLOR'])
conf = Conf()

方法总结

help([name])

打印有关配置项的信息。

items \()

迭代配置项 (name, value) 对。

keys \()

迭代配置项名称。

reload([attr])

从配置文件重新加载配置项。

reset([attr])

将配置项重置为其默认值。

set_temp(attr, value)

临时设置一个配置值。

values \()

迭代配置项值。

方法文件

help(name=None)[源代码]#

打印有关配置项的信息。

参数:
namestr ,可选可选的STR

要描述的配置项的名称。如果未提供名称,则将打印有关所有配置项的信息。

实例

>>> from astropy import conf
>>> conf.help("unicode_output")
ConfigItem: unicode_output
  cfgtype='boolean'
  defaultvalue=False
  description='When True, use Unicode characters when outputting values, and displaying widgets at the console.'
  module=astropy
  value=False
items()[源代码]#

迭代配置项 (name, value) 对。

keys()#

迭代配置项名称。

reload(attr=None)[源代码]#

从配置文件重新加载配置项。

参数:
attr : str ,可选Python:字符串,可选

要重新加载的配置参数的名称。如果未提供,请重新加载所有配置参数。

reset(attr=None)[源代码]#

将配置项重置为其默认值。

参数:
attr : str ,可选Python:字符串,可选

要重新加载的配置参数的名称。如果未提供,请重置所有配置参数。

set_temp(attr, value)[源代码]#

临时设置一个配置值。

参数:
attr : strPython :字符串

配置项名称

value : object对象

要临时设置的值。

实例

>>> import astropy
>>> with astropy.conf.set_temp('use_color', False):
...     pass
...     # console output will not contain color
>>> # console output contains color again...
values()[源代码]#

迭代配置项值。