環境（xonsh.environ）

xonshシェルの環境。

クラスxonsh.environ.Ensurer

環境変数の検証、変換、切り捨てを表す関数である名前付きタプル。

Ensurerの新しいインスタンスを作成する（検証、変換、デタイプ）

count（値） →整数 - 値の出現回数を返す

index（value [、start [、stop ] ] ） →整数 - 最初の値のインデックスを返します。

値が存在しない場合、ValueErrorを発生させます。

convert

フィールド番号1の別名

detype

フィールド番号2の別名

validate

フィールド番号0の別名

クラスxonsh.environ.Env（* args、** kwargs ）

変数の型が制限されているxonsh環境（BASHとは異なります）。ほとんどの変数は、デフォルトでは文字列（BASHなど）です。ただし、variable-nameに基づいて以下の規則が適用されます。

• PATH：名前がPATHで終わる変数はすべて文字列のリストです。
• XONSH_HISTORY_SIZE：この変数は（int | float、str）タプルです。
• LC_ *（ロケールカテゴリ）：ロケールカテゴリ名は、locale.getlocale（）およびlocale.setlocale（）関数を介してPythonロケールを取得/設定します。

Envインスタンスは、サブプロセスでの使用に適したタイプのないバージョンに変換できます。

初期環境が与えられていない場合は、os_environが使用されます。

clear（） →なし Dからすべてのアイテムを削除する

detype（）

静的detypeable（val ）

get（key、default = None ）

ここでデフォルト値が指定されていない場合、環境はデフォルト値をデフォルト値から検索します。

get_docs（キー、デフォルト= VarDocs（docstr = '<ドキュメントなし>、設定可能= True、デフォルト= <xonsh.tools.DefaultNotGivenTypeオブジェクト>、store_as_str = False））

環境変数のドキュメントを取得します。

get_ensurer（key、デフォルト=保証人（validate = <function always_true>、変換=なし、detype = <function ensure_string>））

指定されたキーの保証者を取得します。

help（キー）

特定の環境変数に関する情報を取得します。

is_manually_set（varname ）

環境変数が手動で設定されているかどうかをチェックします。

items（） →Dのアイテムのビューを提供する集合的なオブジェクト

keys（） →Dのキーのビューを提供する集合的なオブジェクト

pop（k [、d ] ） →v、指定されたキーを削除し、対応する値を返します。

keyが見つからなければ、与えられればdが返され、そうでなければKeyErrorが発生します。

popitem（） →（k、v）、いくつかの（キー、値）ペアを取り除いて返す

2タプルとして; Dが空の場合はKeyErrorを上げます。

replace_env（）

os_environの内容を、xonsh環境の自動化されたバージョンに置き換えます。

setdefault（k [、d ] ） →D.get（k、d）また、D [k] = dならkをDに入れない

swap（other = None、** kwargs ）

特定の環境変数を他の値と一時的に交換するためのコンテキストマネージャを提供します。コンテキストマネージャを終了すると、元の値が復元されます。

undo_replace_env（）

os_environの内容を、xonsh環境の自動化されたバージョンに置き換えます。

update（[ E、] ** F ） →なし。マッピング/イテラブルEとFからDを更新する

もしEが存在し、.keys（）メソッドを持っていれば、Eの中のk：D [k] = E [k]どちらの場合も、次のようになります。F.items（）のkに対してv：D [k] = v

values（） →Dの値のビューを提供するオブジェクト

クラスxonsh.environ.VarDocs

環境変数のドキュメント化のための名前付きタプル

パラメーター：

docstr ： str

環境変数docstring。

設定可能 ： bool、オプション

環境変数が設定可能かどうかのフラグ。

デフォルト ： str、オプション

複雑なデフォルトのデフォルト値のカスタム文書化。これはDefaultNotGivenですか？デフォルトはDEFAULT_VALUESから検索され、strに変換されます。

store_as_str ： bool、オプション

環境変数を文字列として格納するかどうかを示すフラグ。これは、JSONをシリアル化できない変数を設定ファイルに永続化するときに使用されます。たとえば、セット、frozensets、および潜在的に他の重要なデータ型。デフォルトはFalseです。

VarDocsの新しいインスタンスを作成する（docstr、configurable、default、store_as_str）

count（値） →整数 - 値の出現回数を返す

index（value [、start [、stop ] ] ） →整数 - 最初の値のインデックスを返します。

値が存在しない場合、ValueErrorを発生させます。

configurable

フィールド番号1の別名

default

フィールド番号2の別名

docstr

フィールド番号0の別名

store_as_str

フィールド番号3の別名

xonsh.environ.default_env（env = None ）

デフォルトのxonsh環境を構築します。

xonsh.environ.default_value（f ）

呼び出し可能なデフォルト値を作成するためのデコレータ。

xonsh.environ.default_xonshrc（env ）

デフォルトのxonshrcタプルの新しいインスタンスを作成します。

xonsh.environ.foreign_env_fixes（ctx ）

すべてのオペレーティングシステムの環境修正

xonsh.environ.is_callable_default（x ）

値が呼び出し可能なデフォルトであるかどうかをチェックします。

xonsh.environ.locale_convert（キー）

ロケールキー用のコンバータを作成します。

xonsh.environ.locate_binary（名前）

ファイルシステム上で実行可能ファイルを探します。

xonsh.environ.make_args_env（args = None ）

$ ARGSおよび$ ARG <N>環境変数を含む辞書を作成します。指定されたARGSがNoneの場合、sys.argvが使用されます。

xonsh.environ.to_debug（x ）

to_bool_or_int（）を使用して値を変換し、この値を実行者のデバッグレベルとして設定します。

xonsh.environ.windows_foreign_env_fixes（ctx ）

Windows用の環境修正。インプレースで動作します。

xonsh.environ.xonsh_append_newline（env ）

対話モードの場合に改行を追加する

xonsh.environ.xonsh_config_dir（env ）

$ XONSH_CONFIG_DIRを保証して返します

xonsh.environ.xonsh_data_dir（env ）

$ XONSH_DATA_DIRを保証して返します

xonsh.environ.xonsh_script_run_control（filename、ctx、env、execer = None、login = True ）

xonshファイルをロードし、実行制御として適用します。

xonsh.environ.xonshconfig（env ）

$ XONSHCONFIGを保証して返します

xonsh.environ.xonshrc_context（rcfiles = None、execer = None、ctx = None、env = None、login = True ）

すべてのxonshrcファイルを読み込み、コンテキストを返そうとします。