ConfigNamespace

class astropy.config.ConfigNamespace[source]

Bases: object

A namespace of configuration items. Each subpackage with configuration items should define a subclass of this class, containing ConfigItem instances as members.

For example:

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()

Methods Summary

reload(self[, attr])

Reload a configuration item from the configuration file.

reset(self[, attr])

Reset a configuration item to its default.

set_temp(self, attr, value)

Temporarily set a configuration value.

Methods Documentation

reload(self, attr=None)[source]

Reload a configuration item from the configuration file.

Parameters
attrstr, optional

The name of the configuration parameter to reload. If not provided, reload all configuration parameters.

reset(self, attr=None)[source]

Reset a configuration item to its default.

Parameters
attrstr, optional

The name of the configuration parameter to reload. If not provided, reset all configuration parameters.

set_temp(self, attr, value)[source]

Temporarily set a configuration value.

Parameters
attrstr

Configuration item name

valueobject

The value to set temporarily.

Examples

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