google.appengine.api.yaml_builder モジュール

概要

PyYAML イベント ビルダー ハンドラ

YAML リスナーからイベントを受信して、そのイベントをビルダー オブジェクトに転送し、リスナーが適切に構造化されたオブジェクトを構築できるようにします。

内容

class google.appengine.api.yaml_builder.Builderソース

ベース: オブジェクト

YAML イベントからドキュメントと型を構築するためのインターフェース。

このインターフェースを実装して、ビルダーを新規作成します。ビルダーは BuilderHandler に渡され、YAML ファイルの具体的な表現を作成するためのファクトリとアセンブラとして使用されます。

AppendTo(subject, value)ソース

シーケンス表現に値を追加します。

実装はビルダーのサブクラスによって定義されます。

パラメータ
  • subject - シーケンスを表すオブジェクト。BuildSequence から返された値

  • value - subject に追加される値。任意の値を指定できます。

BuildDocument()ソース

ドキュメントを新規作成します。

このメソッドによって構築されたオブジェクトは、ビルダー ハンドラが構築するトップレベルのエンティティになります。実際の型は Builder クラスのサブクラスによって決定されるので、本質的にどの型でも構いません。このメソッドは、パーサーが新しいドキュメントの先頭を検出すると、必ず呼び出されます。

戻り値

具体的なドキュメントを表す新しいオブジェクト インスタンスです。このインスタンスは BuilderHandler.getResults を介してユーザーに返されます。

BuildMapping(top_value)ソース

マッピング表現を新規作成します。

StartMapping イベントが受信されたときに呼び出されます。オブジェクトの型は Builder サブクラスによって決まります。

パラメータ

top_value - 新しいマッピングの親となるオブジェクト。BuildMapping または BuildSequence の前回の呼び出しから返されたオブジェクトです。

戻り値

ターゲット モデルのマッピング型を表す新しいオブジェクトのインスタンス。

BuildSequence(top_value)ソース

シーケンス表現を新規作成します。

StartSequence イベントが受信されたときに呼び出されます。オブジェクトの型は Builder サブクラスによって決まります。

パラメータ

top_value - 新しいシーケンスの親となるオブジェクト。BuildMapping または BuildSequence の前回の呼び出しから返されたオブジェクトです。

戻り値

ターゲット モデルのシーケンス型を表す新しいオブジェクトのインスタンス。

EndMapping(top_value, mapping)ソース

以前に構築されたマッピング範囲の終わりです。

マッピング ブロックの終了時に呼び出されます。クリーンアップまたは範囲終了の追加検証に役立ちます。

パラメータ
  • top_value - マッピングの親である値。

  • mapping - 範囲の終わりにあるマッピング。

EndSequence(top_value, sequence)ソース

以前に構築されたシーケンス範囲の終わりです。

シーケンス ブロックの終了時に呼び出されます。クリーンアップまたは範囲終了の追加検証に役立ちます。

パラメータ
  • top_value - シーケンスの親である値。

  • sequence - 範囲の終わりにあるシーケンス。

InitializeDocument(document, value)ソース

ドキュメントの最上位レベルからの値でドキュメントを初期化します。

このメソッドは、ルート ドキュメント要素が YAML ドキュメントの最上位レベルで検出されたときに呼び出されます。BuildDocument の直後に呼び出されます。

受信した値が None の場合、ドキュメントは空です。

パラメータ
  • document - BuildDocument で構築されたドキュメント。

  • value - ドキュメントの初期化に使用するスカラー値。

MapTo(subject, key, value)ソース

値をマッピング表現にマッピングします。

実装はビルダーのサブクラスによって定義されます。

パラメータ
  • subject - マッピングを表すオブジェクト。BuildMapping から返された値。

  • key - 値を subject にマッピングするために使用するキー。任意のスカラー値を指定できます。

  • value - subject にマッピングされる値。任意の値を指定できます。

class google.appengine.api.yaml_builder.BuilderHandler(builder)ソース

ベース: google.appengine.api.yaml_listener.EventHandler

オブジェクトの構築に使用する PyYAML イベント ハンドラ。

オブジェクト ネストが保持されるよう、解析イベントの受け取り時に状態情報を保持します。提供された Builder オブジェクトを使用して、オブジェクトを構築し、組み立てます。

YAML パーサーからイベントを受け取ると、構造トークンを表すデータのスタックを構築します。ドキュメント、マッピングおよびシーケンスの範囲が終了すると、それぞれのトークン、値のペアがスタックの先頭から取り出され、元の範囲が処理を再開できるようになります。

_KEY トークンには特殊なケースがあります。これは、マッピング内でのみ発生する一時的な値を表します。これは、関連する値が解析ストリームで検出されるとすぐにスタックから取り出されます。これを行うのは、YAML パーサーがキーと値の情報を単一のイベントに結合しないためです。

Alias(event, loader)ソース

まだ実装されていません。

パラメータ

event – 無視されます。

DocumentEnd(event, loader)ソース

ドキュメントの終わり。

パラメータ

event – 無視されます。

DocumentStart(event, loader)ソース

ドキュメントを新規作成します。

新しいドキュメントをスタックにプッシュします。

パラメータ

event – 無視されます。

GetResults()ソース

ドキュメント ストリーム処理の結果を取得します。

YAML ファイル全体を完全に解析して YAML ファイルの構築された内容を取得した後に、このメソッドを呼び出すことができます。EndStream の後に呼び出されます。

戻り値

YAML ストリームから解析されたすべてのドキュメント オブジェクトのタプル。

発生するエラー

ビルダー スタックが解析終了時までに空でない場合は InternalError。

MappingEnd(event, loader)ソース

マッピングの終了

パラメータ
  • event – 無視されます。

  • loader – 無視されます。

MappingStart(event, loader)ソース

マッピング範囲の開始。

ビルダーからマッピングを作成し、その親のコンテキストで処理します。

パラメータ
  • event - ローダーによって生成された MappingStartEvent。

  • loader - イベントを生成したローダー。

Scalar(event, loader)ソース

スカラー値を処理します

スカラー値はパーサーによって直接渡される単純な値なので、さらに処理することなく任意の値として扱います。

もちろん、キー値は特殊なものとして扱われます。トップトークンが _TOKEN_MAPPING の場合、キー値が認識されます。

パラメータ

event - スカラー値を含むイベント。

SequenceEnd(event, loader)ソース

シーケンスの終わり。

パラメータ
  • event – 無視されます。

  • loader – 無視されます。

SequenceStart(event, loader)ソース

シーケンス範囲の開始

ビルダーからシーケンスを新規作成し、その親のコンテキストで処理します。

パラメータ
  • event - ローダーによって生成された SequenceStartEvent。

  • loader - イベントを生成したローダー。

StreamEnd(event, loader)ソース

解析後にハンドラの内部状態をクリーンアップします

パラメータ

event – 無視されます。

StreamStart(event, loader)ソース

ハンドラの内部状態を初期化します

パラメータ

event – 無視されます。

このページは役立ちましたか?評価をお願いいたします。

フィードバックを送信...

Python の App Engine スタンダード環境