Build Sphinx with Type Stubs Dependency

问题描述 投票:0回答:0

我正在尝试通过

sphinx-build
在一个使用熊猫的诗歌项目中为一个包构建狮身人面像文档。 Pandas 本身没有类型,但它的类型存根位于不同的包 pandas-stubs 中。虽然代码在 sphinx 之外编译,但无法构建文档,因为它无法使用联合运算符识别 pandas 类型提示。我可以确认这是在 python 3.10+ 环境中运行的,其他带有联合运算符的类型提示和非熊猫类型在 sphinx 中正常运行。

示例源码:

import pandas as pd

def my_func(input_arg: pd.DataFrame | None) -> None:
    pass

错误示例:

  File "test.py", line 3
    input_arg: pd.DataFrame | None,
TypeError: unsupported operand type(s) for |: 'DataFrame' and 'NoneType'

有没有办法确保

sphinx-build
正在使用 pandas-stubs 包,以便它在解析函数定义时可以识别这些类型?

python python-3.x python-sphinx python-typing
© www.soinside.com 2019 - 2024. All rights reserved.