sphinx_gallery.py_source_parser#
Pythonソースファイルのパーサー。
関数#
- sphinx_gallery.py_source_parser.extract_file_config(content)#
ドキュメンテーション文字列で指定されたファイル固有の設定を抽出します。
- sphinx_gallery.py_source_parser.parse_source_file(filename)#
ソースファイルをASTノードに解析します。
- パラメータ:
filename (str) – ファイルパス
- 戻り値:
node (ASTノード)
content (utf-8エンコードされた文字列)
- sphinx_gallery.py_source_parser.remove_config_comments(code_block)#
code_block の内容から、ファイル内設定コメントを削除して返します。
「# sphinx_gallery_[option] = [val]」というパターンのコメント行は削除されますが、周囲の空行は保持されます。
- パラメータ:
code_block (str) – コードセグメント。
- sphinx_gallery.py_source_parser.remove_ignore_blocks(code_block)#
code_block の内容から、無視領域を削除して返します。
無視ブロックは # sphinx_gallery_start_ignore で始まり、# sphinx_gallery_end_ignore で終わります。これらの行とそれらの間のすべては削除されますが、周囲の空行は保持されます。
- パラメータ:
code_block (str) – コードセグメント。
- sphinx_gallery.py_source_parser.split_code_and_text_blocks(source_file, return_node=False)#
ソースファイルをコードブロックとテキストブロックに分割したリストを返します。
- パラメータ:
- 戻り値:
file_conf (dict) – ソースファイルのコメントで指定されたファイル固有の設定（
# sphinx_gallery_<name> = <value>）。blocks (list) – (label, content, line_number) リスト。各要素は、ラベル ('text' または 'code')、対応するブロックのコンテンツ文字列、および先頭の行番号を持つタプルです。
node (ast.Module) – 解析されたastノード。
