sphinx_gallery.backreferences#

逆参照ジェネレーター。

使用されている関数を追跡するために、サンプルファイルコードを解析します。

関数#

sphinx_gallery.backreferences.identify_names(script_blocks, ref_regex, global_variables=None, node='')[ソース]#

使用されている名前を識別して解決することにより、codeobj の概要を構築します。

パラメータ:

  • script_blocks (list) – (label, content, line_number) 各要素が、ラベル ('text' または 'code')、ブロックの対応するコンテンツ文字列、および先頭の行番号を持つタプルのリスト。

  • ref_regex (str) – Python オブジェクトへの参照を見つけるための正規表現。

  • example_globals (Optional[Dict[str, Any]]) – サンプル用のグローバル変数。デフォルト = None

  • node (ast.Module or str) – 解析されたノード。デフォルト = ""。

戻り値:

example_code_obj – サンプルで見つかったすべてのコード オブジェクト参照に関する情報を含む辞書。辞書には次のキーが含まれています

  • example_code_obj['name'] : 関数またはクラス名 (str)

  • example_code_obj['module'] : モジュール名 (str)

  • example_code_obj['module_short'] : 短縮されたモジュール名 (str)

  • example_code_obj['is_class'] : オブジェクトがクラスかどうか (bool)

  • example_code_obj['is_explicit']オブジェクトが明示的かどうか

    逆参照 (sphinx マークアップによって参照される) (bool)

戻り値の型:

Dict[str, Any]

クラス#

class sphinx_gallery.backreferences.NameFinder(global_variables=None)[ソース]#

コード内の変数名の最長形式とそのインポートを検索します。

インポートされたモジュールからの名前のみを保持します。

get_mapping()[ソース]#

AST ノードを使用して、コードで使用される名前を完全修飾名にマッピングします。

戻り値:

options – accessed_name に関する次の情報を含むタプルのリスト

アクセスされた名前: str、完全修飾名: str、クラス属性である場合 (つまり、プロパティまたはメソッド): bool、クラスである場合: bool、明示的な逆参照である場合: bool (ここでは常に false)

戻り値の型:

List[Tuple[str]]

visit_Attribute(node)[ソース]#

プレフィックスを含めて、属性を accessed_names に追加します。

visit_Import(node, prefix='')[ソース]#

「import」の場合、ノード名を imported_names に追加します。

visit_ImportFrom(node)[ソース]#

「from import」の場合、モジュール プレフィックスを含めて、ノード名を imported_names に追加します。

visit_Name(node)[ソース]#

ノード ID を accessed_names に追加します。

このページの内容