コアイベント

以下のイベントは、xonsh自身によって定義されます。イベントの詳細については、イベントチュートリアルを参照してください

on_chdir on_envvar_change on_envvar_new
on_exit on_import_post_create_module on_import_post_exec_module
on_import_post_find_spec on_import_pre_create_module on_import_pre_exec_module
on_import_pre_find_spec on_post_cmdloop on_post_init
on_post_prompt on_post_rc on_postコマンド
on_pre_cmdloop on_pre_prompt on_pre_rc
on_precommand on_ptk_create on_transform_command

リスト

on_chdir(olddir: str, newdir: str) -> None

現在のディレクトリが何らかの理由で変更されたときに発生します。


on_envvar_change(name: str, oldvalue: Any, newvalue: Any) -> None

環境変数が変更された後に発生します。注意:ハンドラ内でenvvarsを設定すると、制限まで再帰が発生する可能性があります。


on_envvar_new(name: str, value: Any) -> None

新しい環境変数が作成された後に発生します。注意:ハンドラ内でenvvarsを設定すると、制限まで再帰が発生する可能性があります。


on_exit() -> None

ティアダウンが発生する前に、すべてのコマンドが実行された後に起動されます。

注:atexitモジュールのすべての注意事項もこのイベントに適用されます。


on_import_post_create_module(module: Module, spec: ModuleSpec) -> None

モジュールがローダーによって作成された後、ローダーがそれを返す前に発生します。ここでのパラメータは、モジュールオブジェクト自体とspecオブジェクトです。詳細については、importlibを参照してください。


on_import_post_exec_module

on_import_post_create_module(モジュール:Module) - >なし

モジュールがローダによって実行された後で、ローダがそれを返す前に発生します。唯一のパラメータはモジュール自体です。詳細については、importlibを参照してください。


on_import_post_find_spec(spec, fullname, path, target) -> None

find_spec()呼び出しがすべてインポートされた後に起動します。パラメータはここでspecと引数importlib.abc.MetaPathFinder.find_spec()です。すなわち、

specspecが見つかった場合はModuleSpecオブジェクト、そうでない場合はNoneを返します。
fullnameインポートするモジュールのフルネーム。
pathトップレベルのインポートの場合はNone、それ以外の場合__path__は親パッケージのインポート
targetパッケージ仕様に関するより良い推測をするために使用されるターゲットモジュール。

on_import_pre_create_module(spec: ModuleSpec) -> None

モジュールがローダによって作成される直前に発生します。唯一のパラメータはspecオブジェクトです。詳細については、importlibを参照してください。


on_import_pre_exec_module(module: Module) -> None

モジュールがローダーによって実行される直前に発生します。唯一のパラメータはモジュール自体です。詳細については、importlibを参照してください。


on_import_pre_find_spec(fullname: str, path: str, target: module or None) -> None

find_spec()呼び出しが実行される前に呼び出されます。ここのパラメータはimportlib.abc.MetaPathFinder.find_spec()と同じです。すなわち、

fullnameインポートするモジュールのフルネーム。
pathトップレベルのインポートの場合はNone、それ以外の場合__path__は親パッケージのインポート
targetパッケージ仕様に関するより良い推測をするために使用されるターゲットモジュール。

on_post_cmdloop() -> None

コマンドループが終了した直後に起動します。

注:atexitモジュールのすべての注意事項もこのイベントに適用されます。


on_post_init() -> None

すべての初期化が完了し、作業を行う準備が整った後に起動されます。

注:これは、ウィザードが自動的に開始される前に発生します。


on_post_prompt

on_first_prompt() - >なし

プロンプトが戻った直後に発生する


on_post_rc() -> None

rcファイルがロードされた直後に起動されます。


on_postcommand(cmd: str, rtn: int, out: str or None, ts: list) -> None

コマンドが実行された直後に発生します。議論は歴史と同じです。

パラメーター:

  • cmd:実行されたコマンド(変換後)
  • rtn:実行されたコマンドの結果(0成功の場合)
  • out:xonshがコマンド出力を格納する場合、これは出力です
  • ts:タイムスタンプ [starting, ending]

on_pre_cmdloop() -> None

コマンドループが開始される直前に起動されます。


on_pre_prompt

on_first_prompt() - >なし

プロンプトが表示される直前に発生する


on_pre_rc() -> None

rcファイルがロードされる直前に起動されます。


on_precommand(cmd: str) -> None

コマンドが実行される直前に発生します。


on_ptk_create(prompter: PromptSession, history: PromptToolkitHistory, completer: PromptToolkitCompleter, bindings: KeyBindings) ->

プロンプトツールキットが初期化された後に起動される


on_transform_command(cmd: str) -> str

xontribにコマンドラインの変換を要求するために起動します。変換されたコマンドを返します。変換がない場合は同じコマンドを返します。インタラクティブセッションでのみ実行されます。

これはコマンドごとに複数回起動され、他のトランスの入力または出力が発生する可能性があるため、このためにハンドラを慎重に設計してください。