如何编写一个满足type. TextIO的类？

Question

在编写实现类文件接口的类时，我们可以从io模块继承一个抽象基类，例如TextIOBase，如图所示，使迭代器在Python中表现得像类文件对象。

另一方面，在类型注释中，我们应该使用从＜code＞类型派生的类。IO＜/code＞（例如＜code＞TextIO＜/code＞）表示这样的对象，如文件或类文件对象的类型提示所示？或io的类型检查问题。联合中的TextIOBase。

然而，这似乎并不像我预期的那样有效：

import io
import sys
import typing

class MyIO(io.TextIOBase):
    def write(self, text: str):
        pass

def hello(f: typing.TextIO):
    f.write('hello')

hello(sys.stdout)             # type checks
hello(open('temp.txt', 'w'))  # type checks
hello(MyIO())                 # does not type check

在这段代码上运行mypy时(使用Python 3.7.3和mypy 0.910)，我们得到

错误：“hello”的参数 1 具有不兼容的类型“MyIO”;预期的“文本IO”

如何编写MyIO类，使其被接受为类型type. TextIO的函数参数（不只是使用typing.cast（type. TextIO，…））？

>

使用type. TextIO作为基类是不可能的：

当使用类 MyIO（键入。文本IO）：

错误：无法实例化抽象类“MyIO”，抽象属性“__enter__”、“__exit__”，...和“写行”（抑制 15 种方法）

当使用类 MyIO（io.TextIOBase，打字。文本IO）：：

错误:基类“IOBase”中“readlines”的定义与基类“IO”中的定义不兼容

对于其他几种方法也是如此。

覆盖__new__并注释键入。TextIO作为返回类型不起作用：

def __new__(cls, *args, **kwargs) -> typing.TextIO:                        
    return super().__new__(cls, *args, **kwargs)

结果是

错误：不兼容的返回类型__new__（返回TextIO，但必须返回MyIO的子类型）
错误：不兼容的返回值类型（得到MyIO，预期的TextIO）

还是这已经可以工作了，而我使用的Python和/或mypy版本太旧了？但是，使用--python-version 3.8或3.9或3.10作为mypy的选项不会改变任何内容。

Answer 1

我认为您的第一次尝试实际上是正确的，它只需要您实现所有抽象方法（如错误所述）。您不必将实际逻辑放在那里。以下类可以解决问题：

import io
from types import TracebackType
from typing import Optional, Type, Iterator, AnyStr, Iterable, TextIO

import sys
import typing

class MyIO(typing.TextIO):
    def __enter__(self) -> TextIO:
        pass

    def close(self) -> None:
        pass

    def fileno(self) -> int:
        pass

    def flush(self) -> None:
        pass

    def isatty(self) -> bool:
        pass

    def read(self, n: int = ...) -> AnyStr:
        pass

    def readable(self) -> bool:
        pass

    def readline(self, limit: int = ...) -> AnyStr:
        pass

    def readlines(self, hint: int = ...) -> typing.List[AnyStr]:
        pass

    def seek(self, offset: int, whence: int = ...) -> int:
        pass

    def seekable(self) -> bool:
        pass

    def tell(self) -> int:
        pass

    def truncate(self, size: Optional[int] = ...) -> int:
        pass

    def writable(self) -> bool:
        pass

    def writelines(self, lines: Iterable[AnyStr]) -> None:
        pass

    def __next__(self) -> AnyStr:
        pass

    def __iter__(self) -> Iterator[AnyStr]:
        pass

    def __exit__(self, t: Optional[Type[BaseException]], value: Optional[BaseException],
                 traceback: Optional[TracebackType]) -> Optional[bool]:
        pass

    def write(self, text: str):
        pass

def hello(f: typing.TextIO):
    f.write('hello')

hello(sys.stdout)             # type checks
hello(open('temp.txt', 'w'))  # type checks
hello(MyIO())                 # does not type check

Answer 2

使用＜code＞io。改为StringIO

import io
import sys
import typing


class MyIO(io.StringIO):
    def write(self, text: str):
        pass


def hello(f: typing.TextIO):
    f.write("hello")


hello(sys.stdout)             # type checks
hello(open("temp.txt", "w"))  # type checks
hello(MyIO())                 # type checks