如何基于GitHub源码配置TensorFlow Parser解析API文档字符串

• 你调用的parser.get_obj_type、parser._get_raw_docstring两个方法的入参要求是实际的Python对象（类/函数/模块/实例均可），而非字符串形式的导入路径，这是返回空的核心原因
• 代码中存在多处拼写错误：比如Aggregation_Method多了下划线，实际名称为AggregationMethod；estimatorv多了末尾的v
• 内部类、私有类未提前导入到当前运行环境，无法被识别
• 部分路径为对外API别名，不是实际的模块导入路径

第一步：安装依赖包 #

运行命令安装所需依赖：
pip install tensorflow tensorflow-docs tensorflow-estimator

第二步：正确使用示例代码 #

先导入你需要提取文档的目标对象，再将对象本身传入parser的对应方法即可：

import tensorflow as tf
from tensorflow_docs.api_generator import parser
# 导入estimator实际模块
from tensorflow_estimator.python.estimator import estimator as est_module
# 如需提取内部类，先从对应路径导入，例如：
from tensorflow.python.ops.gradients_util import AggregationMethod

# 1. 测试tf公开API tf.AggregationMethod
print("tf.AggregationMethod 类型：", parser.get_obj_type(tf.AggregationMethod))
print("tf.AggregationMethod 文档字符串：\n", parser._get_raw_docstring(tf.AggregationMethod))

# 2. 测试autograph.to_code
print("\nautograph.to_code 类型：", parser.get_obj_type(tf.autograph.to_code))
print("autograph.to_code 文档字符串：\n", parser._get_raw_docstring(tf.autograph.to_code))

# 3. 测试estimator相关对象
print("\nestimator模块类型：", parser.get_obj_type(est_module))
print("estimator.Estimator类文档字符串：\n", parser._get_raw_docstring(est_module.Estimator))

# 4. 导出为json文件示例
parser.to_json_file(tf.autograph.to_code, "hello.json")

额外注意事项 #

• 如果需要提取TensorFlow内部非公开的类/函数，需要先找到它的实际源码路径，提前导入到当前运行环境后再传入parser方法
• 不要使用对外暴露的API别名作为导入路径，要使用源码中实际的模块层级路径

内容的提问来源于stack exchange，提问作者Nani