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) – 文件路径

返回值:

sphinx_gallery.py_source_parser.remove_config_comments(code_block)#

返回code_block的内容，其中删除了文件内的配置注释。

模式为‘# sphinx_gallery_[option] = [val]’的注释行将被删除，但周围的空行将被保留。

sphinx_gallery.py_source_parser.remove_ignore_blocks(code_block)#

返回code_block的内容，其中删除了忽略的区域。

忽略块以 # sphinx_gallery_start_ignore 开头，以 # sphinx_gallery_end_ignore 结尾。这些行以及它们之间的所有内容将被删除，但周围的空行将被保留。

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 节点。

class sphinx_gallery.py_source_parser.Block(type, content, lineno)#