Python：类型提示中的私有类型？

Question

我喜欢类型提示，尤其是我的方法参数。 在我当前的脚本中，一个函数应该检索argparse._SubParsersAction类型的参数。 从下划线可以看出，这是一种约定俗成的私有类型。 我想这就是为什么 PyCharm 在尝试导入它时会抱怨错误消息Cannot find reference '_SubParsersAction' in 'argparse.pyi' （尽管它在那里）。

脚本运行但感觉不对。 错误消息对我来说似乎是合理的，因为私有类型意味着......好吧，私有。 因此，我的第一个问题是为什么公共方法ArgumentParser.add_subparsers()返回一个私有类型的对象。

我一直在寻找一个公共超类或接口，并且_SubParsersAction确实从argparse.Action扩展，但这对我没有帮助，因为Action没有定义_SubParsersAction的add_parser()方法（我需要）。

所以我接下来的问题是：我可以在argparse API 中使用类型提示吗？ 或者它只是部分可能，因为 API 是在引入类型提示之前很久设计的？ 还是我打字的想法不适合 Python 的类型系统？

这是我受影响的代码片段。 它创建了一个带有子参数的参数解析器，如文档 ( https://docs.python.org/dev/library/argparse.html#sub-commands ) 中所述。

主文件

from argparse import ArgumentParser

import sub_command_foo
import sub_command_bar
import sub_command_baz


def main():
    parser = ArgumentParser()
    sub_parsers = parser.add_subparsers()

    sub_command_foo.add_sub_parser(sub_parsers)
    sub_command_bar.add_sub_parser(sub_parsers)
    sub_command_baz.add_sub_parser(sub_parsers)

    args = parser.parse_args()
    args.func(args)


if __name__ == '__main__':
    main()

sub_command_foo.py

from argparse import _SubParsersAction, Namespace


def add_sub_parser(sub_parsers: _SubParsersAction):
    arg_parser = sub_parsers.add_parser('foo')
    
    # Add arguments...

    arg_parser.set_defaults(func=run)


def run(args: Namespace):
    print('foo...')

问题在于sub_command_foo.py 。 PyCharm Cannot find reference '_SubParsersAction' in 'argparse.pyi' from argparse import _SubParsersAction, Namespace的第一行显示错误消息Cannot find reference '_SubParsersAction' in 'argparse.pyi' 。

Answer 1

我不使用pycharm ，也没有做太多类型提示，所以无法帮助你。 但我很了解argparse 。 这个模块的大部分是在 2010 年之前编写的，从那时起它就以蜗牛的速度进行了修改。 它在 OOP 意义上组织得很好，但文档更多的是美化教程而不是正式参考。 也就是说，它侧重于用户需要的功能和方法，而不是尝试正式记录所有类和方法。

我在交互式ipython会话中进行了很多测试，我可以在其中查看命令返回的对象。

在 Python 中，公共和私有类和方法之间的区别不像其他语言那样正式。 “_”前缀确实标记了“私人”的东西。 它们通常不会被记录在案，但仍然可以访问。 有时 '*' 导入会导入所有不以它开头的对象，但argparse有一个更明确的__all__列表。

argparser.ArgumentParser确实创建了一个对象实例。 但是该类继承自 2 个“私有”类。 add_argument方法创建一个Action对象，并将其放在parser._actions列表中。 它还会将其返回给用户（尽管通常会忽略该引用）。 该操作实际上是一个子类（所有这些都是“私有的”）。 add_subparsers只是这个add_argument一个专门版本。

add_parser方法创建一个ArgumentParser对象

在我看来，需要单独导入“私有”类的类型提示会适得其反。 您不应显式引用这些类，即使您的代码生成它们。 有些人（公司）担心他们可以在没有通知的情况下进行更改，从而破坏他们的代码。 知道argparse改变的速度有多慢，我不会对此过多了解。