ConfigItem

class astropy.config.ConfigItem(defaultvalue='', description=None, cfgtype=None, module=None, aliases=None)[ソース]

ベースクラス: object

プロファイルに格納された設定および関連値。

これらのオブジェクトを作成すべきメンバーは ConfigNamespace サブクラス、例えば:

class _Conf(config.ConfigNamespace):
    unicode_output = config.ConfigItem(
        False,
        'Use Unicode characters when outputting values, and writing widgets '
        'to the console.')
conf = _Conf()
パラメータ
defaultvalue相手、オプション

この項目のデフォルト値。これが文字列リストである場合、この項は“Options”値として解釈され、この項はこれらの値のうちの1つでなければならず、リストの最初のものはデフォルト値とみなされる。

description文字列またはなし、オプション

この項目の説明(プロファイルにアノテーションとして表示される)

cfgtype文字列またはなし、オプション

タイプ説明子、使用するように 価値がある. 中の特定キーの configspec 書類名は configobj それがそうです。Noneであれば,デフォルト値からタイプを推定する.

module文字列またはなし、オプション

この項に関連する完全モジュール名.第1の要素(例えば、これが‘Astropy.configg.configuration’である場合、‘Astcopy’)は、プロファイルの名前を決定するために使用され、残りの項は、その部分を決定する。そうでなければ,その中でそのオブジェクトの初期値設定項を呼び出したパケットからパケットを推定する.

aliases文字列または文字列リスト、オプション

この配置項の破棄位置.新しい位置で構成項が見つからない場合は,すべての古い位置でその構成項を検索する.

賃上げをする
RuntimeError

もし module はい。 None しかし、このプロジェクトを作成するモジュールは決定できません。

属性要約

cfgtype \

タイプ説明子、使用するように 価値がある. 中の特定キーの configspec 書類名は configobj それがそうです。

rootname \

Rootnameは、すべての構成ファイルの基本パスを設定します。

方法要約

__call__ \()

ここに戻ります ConfigItem

reload \()

これを再ロードします ConfigItem 関連するプロファイルから。

set \(値)

これを設定します ConfigItem それがそうです。

set_temp \(値)

この項はWithブロック内でのみ指定された値に設定される.

属性文書

cfgtype = None

タイプ説明子、使用するように 価値がある. 中の特定キーの configspec 書類名は configobj それがそうです。

rootname = 'astropy'

Rootnameは、すべての構成ファイルの基本パスを設定します。

方法文書

__call__()[ソース]

ここに戻ります ConfigItem

返品
val客体.

項の値,そのタイプは cfgtype 属性です。

賃上げをする
TypeError

格納されている構成値がこの項目のタイプでない場合。

reload()[ソース]

これを再ロードします ConfigItem 関連するプロファイルから。

返品
val客体.

プロファイルからロードされた新しい値。

set(value)[ソース]

これを設定します ConfigItem それがそうです。

これはまた、記述およびタイプ情報を提供する注釈を更新する。

パラメータ
value

この項は設定すべき値である.

賃上げをする
TypeError

もし提供されたのは value これには無効だ ConfigItem それがそうです。

set_temp(value)[ソース]

この項はWithブロック内でのみ指定された値に設定される.

使用する:

ITEM = ConfigItem('ITEM', 'default', 'description')

with ITEM.set_temp('newval'):
    #... do something that wants ITEM's value to be 'newval' ...
    print(ITEM)

# ITEM is now 'default' after the with block
パラメータ
value

この項をWithブロック内部の値とする.