如何编写满足typing.TextIO类型要求的Python类文件对象类？

原因说明 #

你遇到的报错是因为typing.TextIO和io.TextIOBase是两套独立的类型体系，mypy不会默认将继承io.TextIOBase的类识别为typing.TextIO的子类型，且你当前实现的MyIO只提供了write方法，没有满足typing.TextIO的完整接口要求。

方案1：缩小参数类型（推荐） #

如果你的函数仅用到文件对象的部分方法（如示例中仅用到write），无需用typing.TextIO作为参数类型，自定义Protocol即可。基于结构子类型规则，只要你的类实现了Protocol定义的方法且签名匹配，就会被类型检查器自动认定为符合类型要求：

import io
import sys
from typing import Protocol

# 定义仅包含所需方法的Protocol
class SupportsStrWrite(Protocol):
    def write(self, text: str) -> int: ...

class MyIO(io.TextIOBase):
    # 注意write方法按规范需返回写入的字符数，补充返回值匹配签名
    def write(self, text: str) -> int:
        return len(text)

def hello(f: SupportsStrWrite):
    f.write('hello')

hello(sys.stdout)             # 类型检查通过
hello(open('temp.txt', 'w'))  # 类型检查通过
hello(MyIO())                 # 类型检查通过

该方案符合类型安全的最小化原则，不会引入不必要的接口约束。

方案2：实现完整typing.TextIO接口 #

如果你必须让MyIO被识别为typing.TextIO的子类型，需要实现typing.TextIO要求的所有接口方法，不需要显式继承typing.TextIO，mypy会自动通过结构匹配识别子类型关系。不需要用到的方法可以抛出NotImplementedError，只要方法签名匹配即可：

import io
import sys
import typing

class MyIO(io.TextIOBase):
    # 核心业务方法
    def write(self, text: str) -> int:
        return len(text)
    
    # 以下为typing.TextIO要求的配套方法，签名匹配即可
    def read(self, n: int = -1) -> str: raise NotImplementedError
    def readline(self, limit: int = -1) -> str: raise NotImplementedError
    def readlines(self, hint: int = -1) -> list[str]: raise NotImplementedError
    def __enter__(self) -> typing.TextIO: return self
    def __exit__(self, *args) -> None: pass
    def close(self) -> None: pass
    @property
    def closed(self) -> bool: return False
    def flush(self) -> None: pass
    def isatty(self) -> bool: return False
    def readable(self) -> bool: return False
    def seek(self, offset: int, whence: int = 0) -> int: raise NotImplementedError
    def seekable(self) -> bool: return False
    def tell(self) -> int: raise NotImplementedError
    def truncate(self, size: int | None = None) -> int: raise NotImplementedError
    def writable(self) -> bool: return True
    def writelines(self, lines: typing.Iterable[str]) -> None: pass
    @property
    def buffer(self) -> typing.BinaryIO: raise NotImplementedError
    @property
    def encoding(self) -> str: return 'utf-8'
    @property
    def errors(self) -> str | None: return None
    @property
    def line_buffering(self) -> bool: return False
    @property
    def newlines(self) -> typing.Any: return None

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

hello(sys.stdout)             # 类型检查通过
hello(open('temp.txt', 'w'))  # 类型检查通过
hello(MyIO())                 # 类型检查通过

内容的提问来源于stack exchange，提问作者mkrieger1