Conf

class astroquery.ukidss.Conf[source]

Bases: ConfigNamespace

Configuration parameters for astroquery.ukidss.

Attributes Summary

server

Name of the UKIDSS mirror to use.

timeout

Time limit for connecting to UKIDSS server.

Methods Summary

help([name])

Print info about configuration items.

items()

Iterate over configuration item (name, value) pairs.

keys()

reload([attr])

Reload a configuration item from the configuration file.

reset([attr])

Reset a configuration item to its default.

set_temp(attr, value)

Temporarily set a configuration value.

values()

Iterate over configuration item values.

Attributes Documentation

server

Name of the UKIDSS mirror to use.

timeout

Time limit for connecting to UKIDSS server.

Methods Documentation

help(name=None)

Print info about configuration items.

Parameters:
namestr, optional

Name of the configuration item to be described. If no name is provided then info about all the configuration items will be printed.

Examples

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

Iterate over configuration item (name, value) pairs.

keys()
reload(attr=None)

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(attr=None)

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(attr, value)

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

Iterate over configuration item values.