イベント（xonsh.events）

xonshのイベント。

おそらく、あなたはbuiltins.eventsが必要です

イベントを宣言する最善の方法は次のようなものです：

events.doc('on_spam', "Comes with eggs")

class xonsh.events.AbstractEvent

ハンドラが登録できるイベント。

使徒MutableSet登録ハンドラの。

注文は保証されません。

add（値）

要素を追加します。

clear（）

これは遅いです（N個の新しいイテレータを作成しますが効果的です）。

discard（値）

要素を削除します。不在の場合は例外を発生させないでください。

fire（** kwargs ）

指定された引数を持つハンドラを呼び出してイベントを発生させます。

パラメーター：

** kwargs：

各ハンドラに渡すキーワード引数

isdisjoint（その他）

2つのセットにnull交差がある場合はTrueを返します。

pop（）

ポップされた値を返します。空の場合はKeyErrorを発生させます。

remove（値）

要素を削除します。メンバーでない場合は、KeyErrorを発生させます。

species

イベントの種（基本的に、クラス）

class xonsh.events.Event

通知および分散収集イベントのイベント種。

add（item ）

セットに要素を追加します。

要素がすでに存在する場合、これは効果がありません。

clear（）

これは遅いです（N個の新しいイテレータを作成しますが効果的です）。

discard（item ）

メンバーがメンバーであれば、セットから要素を削除します。

要素がメンバーでない場合は、何もしないでください。

fire（** kwargs ）

指定された引数を持つハンドラを呼び出してイベントを発生させます。結果の一意でない反復可能性が返されます。

各ハンドラは直ちに呼び出されます。例外は警告に変わります。

パラメーター：

** kwargs：

各ハンドラに渡すキーワード引数

戻り値：

vals ： iterable

各ハンドラの値を返します。複数のハンドラが同じ値を返す場合は、複数回表示されます。

isdisjoint（その他）

2つのセットにnull交差がある場合はTrueを返します。

pop（）

ポップされた値を返します。空の場合はKeyErrorを発生させます。

remove（値）

要素を削除します。メンバーでない場合は、KeyErrorを発生させます。

species

イベントの種（基本的に、クラス）

class xonsh.events.EventManager

システム内のすべてのイベントのコンテナ。

シングルトンであることを意味するが、それ自体を強制するものではない。

各イベントは単なる属性です。最初の使用時に動的に作成されます。

doc（name、docstring ）

ドキュメントストリングをイベントに適用します。

パラメーター：

名前 ： str

イベントの名前（例： "on_precommand"）

docstring ： str

イベントに適用するdocstring

transmogrify（名前、種）

1つの種から別の種にイベントを変換し、ハンドラとドキュメントストリングを保存します。

注：一部の種は特殊な状態を維持しています。これは、形質転換において失われる。

パラメーター：

名前 ： str

イベントの名前（例： "on_precommand"）

種 ： AbstractEventのサブクラス

イベントをにする型。

class xonsh.events.LoadEvent

イベントが発生した直後か、ハンドラが登録された直後（どちらか遅い方）の直後に、各ハンドラが正確に1回呼び出されるイベント種。追加の発火は無視されます。

注：スキャッタ/ギャザーをサポートしていないのは、すべてのハンドラをいつ持っているかわからないためです。

注：将来のハンドラを追加した場合のpargs / kwargsへの強い参照を維持します。

注：これは現在スレッドセーフではありません。

add（item ）

セットに要素を追加します。

要素がすでに存在する場合、これは効果がありません。

clear（）

これは遅いです（N個の新しいイテレータを作成しますが効果的です）。

discard（item ）

メンバーがメンバーであれば、セットから要素を削除します。

要素がメンバーでない場合は、何もしないでください。

fire（** kwargs ）

指定された引数を持つハンドラを呼び出してイベントを発生させます。

パラメーター：

** kwargs：

各ハンドラに渡すキーワード引数

isdisjoint（その他）

2つのセットにnull交差がある場合はTrueを返します。

pop（）

ポップされた値を返します。空の場合はKeyErrorを発生させます。

remove（値）

要素を削除します。メンバーでない場合は、KeyErrorを発生させます。

species

イベントの種（基本的に、クラス）

xonsh.events.debug_level（）

xonsh.events.has_kwargs（func ）