astropy 5.0

ParametersRaisesBackRef

These objects should be created as members of ConfigNamespace subclasses, for example:

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

Parameters

defaultvalue : object, optional

The default value for this item. If this is a list of strings, this item will be interpreted as an 'options' value - this item must be one of those values, and the first in the list will be taken as the default value.

description : str or None, optional

A description of this item (will be shown as a comment in the configuration file)

cfgtype : str or None, optional

A type specifier like those used as the values of a particular key in a configspec file of configobj . If None, the type will be inferred from the default value.

module : str or None, optional

The full module name that this item is associated with. The first element (e.g. 'astropy' if this is 'astropy.config.configuration') will be used to determine the name of the configuration file, while the remaining items determine the section. If None, the package will be inferred from the package within which this object's initializer is called.

aliases : str, or list of str, optional

The deprecated location(s) of this configuration item. If the config item is not found at the new location, it will be searched for at all of the old locations.

Raises

RuntimeError

If module is :None:None:`None`, but the module this item is created from cannot be determined.

A setting and associated value stored in a configuration file.

Examples

See :

Back References

The following pages refer to to this document either explicitly or contain code examples using this.

astropy.config.configuration.ConfigNamespace astropy.config.configuration.reload_config astropy.config.configuration.generate_config

Local connectivity graph

Hover to see nodes names; edges to Self not shown, Caped at 50 nodes.

Using a canvas is more power efficient and can get hundred of nodes ; but does not allow hyperlinks; , arrows or text (beyond on hover)

SVG is more flexible but power hungry; and does not scale well to 50 + nodes.

All aboves nodes referred to, (or are referred from) current nodes; Edges from Self to other have been omitted (or all nodes would be connected to the central node "self" which is not useful). Nodes are colored by the library they belong to, and scaled with the number of references pointing them


File: /astropy/config/configuration.py#185
type: <class 'type'>
Commit: