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

问题描述

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

脚本运行，但是感觉不对。对于我来说，错误消息似乎是合理的，因为私有类型本来应该是...私有的。 因此，我的第一个问题是为什么公用方法_SubParsersAction首先返回私有类型的对象。

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

接下来的问题是：我可以在argparse API中使用类型提示吗？还是因为API在引入类型提示之前就已经设计好了，所以它是否只能部分实现？还是我的输入方式不适合Python的类型系统？

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

main.py

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。

解决方法

我不使用pycharm，并且对类型提示的处理不多，因此无法为您提供帮助。但是我很了解argparse。该模块的大部分内容是在2010年之前编写的，此后便以蜗牛的速度进行了修改。从OOP的角度来看，它组织得很好，但是文档更像是华丽的教程，而不是正式的参考书。也就是说，它着重于用户所需的功能和方法，而不是试图正式记录所有类和方法。

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

在Python中，公共类和私有类与方法之间的区别并不像其他语言那么正式。 “ _”前缀确实标记了“私有”事物。它们通常没有文档记录，但是仍然可以访问。有时，“ *”导入会导入所有不以其开头的对象，但是argparse的列表__all__更为明确。

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

add_parser方法创建一个ArgumentParser对象

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