如何让AnyStr.join(Iterable[AnyStr])通过Pyright类型检查？

我写了一个简单的字符串/字节拼接函数：

from typing import AnyStr, Iterable

def joiner(delim: AnyStr, objs: Iterable[AnyStr]) -> AnyStr:
    return delim.join(objs)

这段代码在MyPy中类型检查完全通过，但Pyright会抛出两个类型错误：

/tmp/type_demo.py
  /tmp/type_demo.py:7:27 - error: Argument of type "Iterable[AnyStr@joiner]" cannot be assigned to parameter "__iterable_of_bytes" of type "Iterable[ReadableBuffer]" in function "join"
   "Iterable[AnyStr@joiner]" is incompatible with "Iterable[ReadableBuffer]"
    TypeVar "_T_co@Iterable" is covariant
      Type "str* | bytes*" cannot be assigned to type "ReadableBuffer"
        "str*" is incompatible with protocol "ReadableBuffer"
          "__buffer__" is not present (reportGeneralTypeIssues)
  /tmp/type_demo.py:9:27 - error: Argument of type "Iterable[AnyStr@joiner]" cannot be assigned to parameter "__iterable" of type "Iterable[str]" in function "join"
   "Iterable[AnyStr@joiner]" is incompatible with "Iterable[str]"
    TypeVar "_T_co@Iterable" is covariant
      Type "str* | bytes*" cannot be assigned to type "str"
        "bytes*" is incompatible with "str" (reportGeneralTypeIssues)
2 errors, 0 warnings, 0 informations

我推测错误源于Iterable[bytes]和Iterable[ReadableBuffer]的类型不匹配，请问有没有能避免报错的函数声明方式？

解决方案 #

方法1：使用函数重载（推荐） #

通过@overload分别定义str和bytes场景的函数签名，让类型检查器明确匹配两种不同的join参数要求：

from typing import AnyStr, Iterable, overload, ReadableBuffer

@overload
def joiner(delim: str, objs: Iterable[str]) -> str: ...

@overload
def joiner(delim: bytes, objs: Iterable[ReadableBuffer]) -> bytes: ...

def joiner(delim: AnyStr, objs: Iterable[str] | Iterable[ReadableBuffer]) -> AnyStr:
    return delim.join(objs)

这种方式同时兼容MyPy和Pyright，还能正确支持bytes.join对ReadableBuffer类型（如bytearray）的兼容。

方法2：简化TypeVar绑定 #

如果不想用重载，可以重新定义绑定str | bytes的TypeVar，调整参数类型以匹配Pyright的严格检查：

from typing import Iterable, TypeVar

T = TypeVar("T", str, bytes)

def joiner(delim: T, objs: Iterable[str] | Iterable[bytes]) -> T:
    return delim.join(objs)

注意这种方式仅支持bytes类型的元素，不支持bytearray等其他ReadableBuffer类型。

错误原因说明 #

Pyright对AnyStr的联合类型处理更严格：str.join要求元素必须是str，而bytes.join要求元素是ReadableBuffer（包含bytes、bytearray等）。原代码中Iterable[AnyStr]会被解析为Iterable[str | bytes]，无法同时满足两种join方法的参数要求，因此触发类型错误。

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