CompletedProcess 是 mypy 的泛型

问题描述

我使用 subprocess.CompletedProcess 作为函数的返回类型。当使用 mypy 运行 --strict 时，它会抱怨 Missing type parameters for generic type "CompletedProcess"。这是出现问题的一个简短示例：

import subprocess

def run_command() -> subprocess.CompletedProcess:
    return subprocess.CompletedProcess(args=[],returncode=0,stdout='')

我不明白 CompletedProcess 是如何泛型的。我查看了参考资料 (https://docs.python.org/3.9/library/subprocess.html#subprocess.CompletedProcess)，但没有找到任何提及。

随机添加一个泛型参数，例如-> subprocess.CompletedProcess[str]，可以消除错误，但显然这不是重点。我希望能够在不定义泛型参数的情况下提示返回类型。

我使用的是 python 3.8.5 和 mypy 0.761 和 0.910（两者都给出相同的输出）。

解决方法

子流程的输出 (stdout/stderr) 可以是 str 或 bytes，具体取决于参数。 CompletedProcess 的泛型参数是必需的来指示它的类型。

import subprocess

def run_some_command() -> 'subprocess.CompletedProcess[str]':
    """Run some subprocess that captures output as ``str``"""
    return subprocess.CompletedProcess(args=[],returncode=0,stdout='')

def run_other_command() -> 'subprocess.CompletedProcess[bytes]':
    """Run some subprocess that captures output as ``bytes``"""
    return subprocess.CompletedProcess(args=[],stdout=b'')

reveal_type(run_some_command().stdout)  # note: Revealed type is 'builtins.str*'

因为只有类型提示而不是运行时 subprocess.CompletedProcess 类型是泛型的，所以它必须被引用。

标准库的类型声明是 typeshed 的一部分。具体来说，CompletedProcess is currently defined as follows：

class CompletedProcess(Generic[_T]):
    # morally: _CMD
    args: Any
    returncode: int
    # These are really both Optional,but requiring checks would be tedious
    # and writing all the overloads would be horrific.
    stdout: _T
    stderr: _T
    def __init__(self,args: _CMD,returncode: int,stdout: Optional[_T] = ...,stderr: Optional[_T] = ...) -> None: ...
    def check_returncode(self) -> None: ...
    if sys.version_info >= (3,9):
        def __class_getitem__(cls,item: Any) -> GenericAlias: ...

mypy python subprocess