組み込み関数（xonsh.built_ins）

xonshビルトイン。

このモジュールは、特別なPython組み込みモジュールと混同しないように、 'built_ins'という名前になっています。

class xonsh.built_ins.DeprecationWarningProxy（oldname、newname ）

プロキシはアクセスしますが、処理中に警告します。

warn（）

非推奨警告を発行します。

obj

オブジェクトを動的に把握する

クラスxonsh.built_ins.DynamicAccessProxy（refname、objname ）

プロキシは動的にアクセスします。

パラメーター：

refname ： str

'.'ユーザーがアクセスする新しい参照名を表す分離文字列。

objname ： str

'.'- refnameが指し示すターゲットオブジェクトが実際に存在する名前を表す分離文字列です。

obj

オブジェクトを動的に把握する

クラスxonsh.built_ins.SubprocSpec（CMD、*、CLS = <クラス'subprocess.Popen'> 、STDIN =なし、STDOUT =なし、標準エラー=なし、universal_newlines = Falseを、捕捉=偽）

サブプロセスコマンドの実行方法を指定するためのコンテナ。

パラメーター：

cmd ： strのリスト

実行するコマンド。

cls ： Popen-like

サブプロセスを実行するクラス。

stdin ： ファイルのような

stdinのファイル記述子またはフラグをポップします。

stdout ： ファイルのような

stdoutのファイル記述子またはフラグをポップします。

stderr ： ファイルのような

stderrのファイル記述子またはフラグをポップします。

universal_newlines ： bool

ユニバーサル改行を使用するかどうか。

取り込み ： boolまたはstr、オプション

サブプロセスがキャプチャされた場合のフラグは、$ []に対するFalse、$（）に対する 'stdout'、！[]に対する 'hiddenobject'、！（）の 'object'のいずれかです。

属性：

args ： strのリスト

最初に提供された引数。

エイリアス ： str、callable、またはNoneのリスト

このコマンドで解決されたエイリアス（存在する場合）。

binary_loc ： strまたはNone

実行するバイナリへのパス。

is_proxy ： bool

サブプロセスがプロキシとして実行されるかどうか。

背景 ： ブール

サブプロセスをバックグラウンドで起動するかどうか。

スレッド可能 ： bool

サブプロセスをメインスレッドではなく、バックグラウンドスレッドで実行できるかどうか。

pipeline_index ： intまたはなし

セットアップ中のパイプラインへのsepcのインデックス番号。

last_in_pipeline ： bool

サブプロセスが実行パイプラインの最後であるかどうか。

captured_stdout ： ファイルのような

キャプチャした標準入力を処理する

captured_stderr ： ファイルのような

捕らえられた標準エラー出力を処理する

stack ： FrameInfo名前付きタプルのリストまたはなし

エイリアスのコールサイトのスタック（エイリアスに必要な場合）。そうでない場合はなし。

classmethod build（cmd、*、cls = <class 'subprocess.Popen'>、** kwargs ）

受け取った実際のcmdに基づいて、変更および調整を加えて、サブプロセスコマンドのインスタンスを作成します。

prep_env（kwargs ）

サブプロセスで使用する環境を準備します。

prep_preexec_fn（kwargs、pipeline_group = None ）

'preexec_fn'キーワード引数を準備する

redirect_leading（）

'<input.txt COMMAND'などのリダイレクト先を管理します。

redirect_trailing（）

末尾のリダイレクトを管理します。

resolve_alias（）

該当する場合、コマンドにエイリアスを設定します。

resolve_alias_cls（）

エイリアスを実行するプロキシクラスを決定します。

resolve_auto_cd（）

AUTO_CD機能を実装します。

resolve_binary_loc（）

バイナリの場所を設定します。

resolve_executable_commands（）

該当する場合、コマンド実行ファイルを解決します。

resolve_stack（）

必要に応じて、コール可能エイリアスのコールサイトのスタックを計算します。

run（*、pipeline_group = None ）

サブプロセスを起動し、オブジェクトを返します。

kwnames=（ 'stdin'、 'stdout'、 'stderr'、 'universal_newlines'）

stderr

stdin

stdout

クラスxonsh.built_ins.XonshSession（execer = None、ctx = None ）

すべてのコンポーネントがxonshセッションを定義します。

実行者： 実行者、オプション

Xonsh実行オブジェクト。開始するにはNone

ctx ： マッピング、オプション

xonshセッションを開始するためのコンテキスト。

link_builtins（execer = None ）

load（execer = None、ctx = None ）

セッションをデフォルト値でロードします。

実行者： 実行者、オプション

Xonsh実行オブジェクト。開始するにはNone

ctx ： マッピング、オプション

xonshセッションを開始するためのコンテキスト。

unlink_builtins（）

xonsh.built_ins.call_macro（f、raw_args、glbs、locs ）

関数をマクロとして呼び出し、その結果を返します。

パラメーター：

f ： 呼び出し可能なオブジェクト

として呼ばれる関数f(*args)。

raw_args ： strのタプル

それらの引数のstr表現がマクロに渡されました。これらの文字列は、fの注釈に応じて解析、コンパイル、評価、または文字列として残されます。

glbs ： マッピング

コールサイトのグローバル。

locs ： マッピングまたはなし

コールサイトの地元の人。

xonsh.built_ins.cmds_to_specs（cmds、captured = False ）

cmdsのリストを、実行準備ができているSubprocSpecオブジェクトのリストに変換します。

xonsh.built_ins.convert_macro_arg（raw_arg、kind、glbs、locs、*、name = '<arg>'、macroname = '<macro>' ）

要求された種類に基づいて文字列マクロ引数を変換します。

パラメーター：

raw_arg ： str

マクロ引数のstr表現。

種類 ： オブジェクト

引数を変換する方法を表すフラグまたは型。

glbs ： マッピング

コールサイトのグローバル。

locs ： マッピングまたはなし

コールサイトの地元の人。

名前 ： str、オプション

マクロの引数名。

macroname ： str、オプション

マクロ自体の名前。

戻り値：

変換された引数

xonsh.built_ins.default_signal_pauser（n、f ）

必要に応じて信号を一時停止します。

xonsh.built_ins.ensure_list_of_strs（x ）

xが文字列のリストであることを保証します。

xonsh.built_ins.enter_macro（obj、raw_block、glbs、locs ）

マクロブロック、グローバル、およびローカルの内容をオブジェクトに添付して、コンテキストマネージャーマクロを入力する準備をします。これらの変更はその場で行われ、元のオブジェクトが返されます。

パラメーター：

obj ： コンテキストマネージャ

with文を使用して入力しようとしているオブジェクト。

raw_block ： str

コンテキスト本体であるブロックのstr。この文字列は、obj .__ enter__の戻り注釈に応じて解析、コンパイル、評価、または文字列として残されます。

glbs ： マッピング

コンテキストサイトからのグローバル。

locs ： マッピングまたはなし

コンテキストサイトの現地人。

戻り値：

obj ： コンテキストマネージャ

同じコンテキストマネージャーで、新しいマクロ情報が適用されています。

xonsh.built_ins.get_script_subproc_command（fname、args ）

パス外のスクリプトの名前が与えられた場合、スクリプトを実行するための適切なサブプロセスコマンドを表すリストを返します。スクリプトが実行可能でない場合、PermissionErrorを発生させます。

xonsh.built_ins.globsearch（s ）

xonsh.built_ins.helper（x、name = '' ）

ヘルプを表示し、その変数を返します。

xonsh.built_ins.in_macro_call（f、glbs、locs ）

マクログローバルおよびローカルを一時的に接続してコンテキストマネージャとして機能させます。

パラメーター：

f ： 呼び出し可能なオブジェクト

として呼ばれる関数f(*args)。

glbs ： マッピング

コールサイトのグローバル。

locs ： マッピングまたはなし

コールサイトの地元の人。

xonsh.built_ins.list_of_list_of_strs_outer_product（x ）

文字列のリストの外積をとります。

xonsh.built_ins.list_of_strs_or_callables（x ）

xが文字列または関数のリストであることを保証する

xonsh.built_ins.load_builtins（execer = None、ctx = None ）

xonsh組み込み関数をPython組み込み関数にロードします。BUILTINS_LOADED変数をTrueに設定します。

xonsh.built_ins.load_proxies（）

ダイナミックアクセスプロキシにロードされます。また、__ xonsh _ * __ builtinsのために一時的なシムを配置します。

xonsh.built_ins.no_pg_xonsh_preexec_fn（）

既存のパイプライングループが存在しない場合のデフォルトのサブプロセスpreexec機能。

xonsh.built_ins.path_literal（s ）

xonsh.built_ins.pathsearch（func、s、pymode = False、pathobj = False ）

文字列をとり、一致するファイルパスのリスト（regex、glob、または任意の検索関数）を返します。pathobj = Trueの場合、戻り値は文字列ではなくpathlib.Pathオブジェクトのリストです。

xonsh.built_ins.regexsearch（s ）

xonsh.built_ins.reglob（path、parts = None、i = None ）

正規表現ベースのグロブ。

xonsh.built_ins.resetting_signal_handle（sig、f ）

新しいハンドルがセットされたら、古い値を自動的に復元する新しいシグナルハンドルを設定します。

xonsh.built_ins.run_subproc（cmds、captured = False ）

サブプロセスは多くの形式で実行されます。これは、コマンドライン引数のリスト、または特殊な接続文字を表す文字列である 'コマンド'のリストを取ります。例えば：

$ ls | grep wakka

次のcmdsで表されます。

[['ls'], '|', ['grep', 'wakka']]

最後に、キャプチャされた引数は最後の実際のコマンドにのみ影響します。

xonsh.built_ins.safe_close（x ）

オブジェクトを安全に閉じようとします。

xonsh.built_ins.safe_open（fname、mode、buffering = -1 ）

xonshサブプロセス用のファイルを安全に開こうとします。

xonsh.built_ins.subproc_captured_hiddenobject（* cmds ）

サブプロセスを実行し、出力をキャプチャします。完了したコマンドを表すHiddenCommandPipelineのインスタンスを返します。

xonsh.built_ins.subproc_captured_inject（* cmds ）

サブプロセスを実行し、出力をキャプチャします。生成されたstdoutの空白で区切られた文字列のリストを返します。文字列は、Pythonのstr.split（）またはshlex.split（）ではなくxonshのレクサーを使用して分割されます。

xonsh.built_ins.subproc_captured_object（* cmds ）

サブプロセスを実行し、出力をキャプチャします。完了したコマンドを表すCommandPipelineのインスタンスを返します。

xonsh.built_ins.subproc_captured_stdout（* cmds ）

サブプロセスを実行し、出力をキャプチャします。strとして生成されたstdoutを返します。

xonsh.built_ins.subproc_uncaptured（* cmds ）

出力をキャプチャすることなく、サブプロセスを実行します。strとして生成されたstdoutを返します。

xonsh.built_ins.superhelper（x、name = '' ）

ヘルプを表示し、その変数を返します。

xonsh.built_ins.unload_builtins（）

xonsh組み込み関数をPython組み込み関数から削除します.BUILTINS_LOADEDがTrueの場合はBUILTINS_LOADEDをFalseに設定して返します。

xonsh.built_ins.unload_proxies（）

Pythonの組み込み関数からxonsh組み込み関数（プロキシ）を削除します。

xonsh.built_ins.xonsh_builtins（execer = None ）

限られた範囲でのみxonsh組み込み関数を使用するためのコンテキストマネージャー。テストに役立つ可能性があります。