[Typing] 生成 tensor.pyi 时添加 overload 的方法

[megemini]

PR Category

User Experience

PR Types

Bug fixes

Description

生成 tensor.pyi 时添加 overload 的方法

涉及如下方法：

• atleast_1d
• atleast_2d
• atleast_3d
• lu
• median
• nanmedian
• nonzero
• qr
• to
• unique

修改相应的文件从 typing_extensions 导入 overload

自测在本地可以正常生成，vscode 提示正确：

生成的 pyi 文件只是有个小瑕疵：

• 不带有 overload 的方法跟带有 overload 的方法不在一个地方 ～

比如：

class AbstractTensor:

    @overload
    def atleast_1d(self, *inputs: 'Tensor', name: 'str | None' = ...) -> 'list[Tensor]':
        ...

    @overload
    def atleast_1d(self, name: 'str | None' = ...) -> 'Tensor':
        ...

    @overload
    def atleast_2d(self, *inputs: 'Tensor', name: 'str | None' = ...) -> 'list[Tensor]':
        ...

    @overload
    def atleast_2d(self, name: 'str | None' = ...) -> 'Tensor':
        ...

    ...

    def atleast_1d(self, *inputs, name=None):
        r"""
        Convert inputs to tensors and return the view with at least 1-dimension. Scalar inputs are converted,
        one or high-dimensional inputs are preserved.

    ...

原因是，模板最后统一根据名称排序后插入，@overload 的方法会统一放到文件前面，没有 @overload 的方法排在后面 ～

没啥影响，只是看上去可能不太规整 ～

另外，docstring 统一只插入在不带 overload 的方法里面 ～

@SigureMo 请评审 ～

[paddle-bot]

你的PR提交成功，感谢你对开源项目的贡献!
请关注后续CI自动化测试结果，详情请参考Paddle-CI手册。
Your PR has been submitted. Thanks for your contribution!
Please wait for the result of CI firstly. See Paddle CI Manual for details.

[SigureMo]

这个 try 具体是为了捕获什么错误？以及具体是哪一行的错误呢？不然对于后续重构来说就很难轻易修改

建议将这种错误捕获限定到更小的区域，比如

def try_get_overloads(fn: types.FunctionType) -> list[types.FunctionType] | ConcreteException:
    try:
        get_overloads(fn)
    except ConcreteException as e:
        return e

def main_logic():
    ...
    maybe_overloads = try_get_overloads(fn)
    if isinstance(maybe_overloads, ConcreteException):
        warning(f"Cannot get overloads from `{fn}`, reason: `{e}`")
        return
    ...

这样语义就清晰很多了

[megemini]

原来逻辑中 method descriptor 不能使用 get_overloads 函数 ～

Traceback (most recent call last):
  File "gen_tensor_stub.py", line 629, in <module>
    main()
  File "gen_tensor_stub.py", line 625, in main
    generate_stub_file(args.input_file, args.output_file)
  File "gen_tensor_stub.py", line 596, in generate_stub_file
    tensor_members = get_tensor_members(module)
  File "gen_tensor_stub.py", line 519, in get_tensor_members
    _overloads = get_overloads(member)
  File "/home/shun/venv38dev/lib/python3.8/site-packages/typing_extensions.py", line 390, in get_overloads
    if f.__module__ not in _overload_registry:
AttributeError: 'method_descriptor' object has no attribute '__module__'

昨天有点晚了，没仔细定位，结果就被抓了 🫠🫠🫠

现在把两个逻辑分开了已经 ～

[SigureMo]

cc @HydrogenSulfate

[SigureMo]

LGTMeow

[SigureMo]

风险：方法参数里本来存在 Ellipsis 比如 XxxEllipsis，但目前可能性不大，暂时这样没啥问题