python - 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
,具体取决于参数。需要泛型参数 toCompletedProcess
来指示 this 的类型。
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=[], returncode=0, stdout=b'')
reveal_type(run_some_command().stdout) # note: Revealed type is 'builtins.str*'
由于只有类型提示而不是运行时subprocess.CompletedProcess
类型是通用的,因此必须引用它。
标准库的类型声明是typeshed
. 具体来说,CompletedProcess
目前定义如下:
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: ...
推荐阅读
- dynamic - 使用另一个变量的值在 Appian 中构建(过程)变量?
- excel-formula - 如何选择表格中的整列
- laravel - 使用 Eloquent 选择每组结果中的最后一行
- javascript - 在 javascript-性能杀手中使用大对象?
- mysql - 分组数据并添加新列
- arrays - 哪种类型的字符集适合图像编码?[科特林]
- forms - 无法访问从子调用的jsp方法中的表单
- php - 登录后如何重定向到结帐页面(wordpress)?
- javascript - 如何使用 keyup 事件将文本转换为英文?
- sql-loader - 如何在 sqlldr 中编写用户 ID 特殊字符?