astropy 5.0

ParametersRaisesReturns
update_default_config(pkg, default_cfg_dir_or_fn, version=None, rootname='astropy')

Checks if the configuration file for the specified package exists, and if not, copy over the default configuration. If the configuration file looks like it has already been edited, we do not write over it, but instead write a file alongside it named pkg.version.cfg as a "template" for the user.

Parameters

pkg : str

The package to be updated.

default_cfg_dir_or_fn : str

The filename or directory name where the default configuration file is. If a directory name, 'pkg.cfg' will be used in that directory.

version : str, optional

The current version of the given package. If not provided, it will be obtained from pkg.__version__ .

rootname : str

Name of the root configuration directory.

Raises

AttributeError

If the version number of the package could not determined.

Returns

updated : bool

If the profile was updated, :None:None:`True`, otherwise :None:None:`False`.

deprecated

The update_default_config function is deprecated and may be removed in a future version.

Examples

See :

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#728
type: <class 'function'>
Commit: