astropy:docs

config.ConfigAlias

config.ConfigAlias [edit on github]

A class that exists to support backward compatibility only.

This is an alias for a ConfigItem that has been moved elsewhere. It inherits from ConfigItem only because it implements the same interface, not because any of the methods are reused.

Parameters:

since : str

The version in which the configuration item was moved.

old_name : str

The old name of the configuration item. This should be the name of the variable in Python, not in the configuration file.

new_name : str

The new name of the configuration item. This is both the name of the item in Python and in the configuration file (since as of astropy 0.4, those are always the same thing).

old_module : str, optional

A fully-qualified, dot-separated path to the module in which the configuration item used to be defined. If not provided, it is the name of the module in which ConfigAlias is called.

new_module : str, optional

A fully-qualified, dot-separated path to the module in which the configuration item is now defined. If not provided, it is the name of the module in which ConfigAlias is called. This string should not contain the .conf object. For example, if the new configuration item is in astropy.conf.use_unicode, this value only needs to be 'astropy'.

Page Contents