Python标准库typing类型标注支持

用户定义的泛型类型¶

用户定义的类可以定义为泛型类。

fromtypingimportTypeVar,Generic
fromloggingimportLogger
T=TypeVar('T')
classLoggedVar(Generic[T]):
def__init__(self,value:T,name:str,logger:Logger)->None:
self.name=name
self.logger=logger
self.value=value
defset(self,new:T)->None:
self.log('Set '+repr(self.value))
self.value=new
defget(self)->T:
self.log('Get '+repr(self.value))
returnself.value
deflog(self,message:str)->None:
self.logger.info('%s: %s',self.name,message)

Generic[T] 作为基类定义了类 LoggedVar 采用单个类型参数 T。这也使得 T 作为类体内的一个类型有效。

Generic 基类定义了 __class_getitem__() ，使得 LoggedVar[t] 作为类型有效：

fromtypingimportIterable
defzero_all_vars(vars:Iterable[LoggedVar[int]])->None:
forvarinvars:
var.set(0)

泛型类型可以有任意数量的类型变量，并且类型变量可能会受到限制:

fromtypingimportTypeVar,Generic
...
T=TypeVar('T')
S=TypeVar('S',int,str)
classStrangePair(Generic[T,S]):
...

Generic 每个参数的类型变量必须是不同的。这是无效的:

fromtypingimportTypeVar,Generic
...
T=TypeVar('T')
classPair(Generic[T,T]):# INVALID
...

您可以对 Generic 使用多重继承:

fromtypingimportTypeVar,Generic,Sized
T=TypeVar('T')
classLinkedList(Sized,Generic[T]):
...

从泛型类继承时，某些类型变量可能是固定的:

fromtypingimportTypeVar,Mapping
T=TypeVar('T')
classMyDict(Mapping[str,T]):
...

在这种情况下，MyDict 只有一个参数，T。

在不指定类型参数的情况下使用泛型类别会为每个位置假设 Any。在下面的例子中，MyIterable 不是泛型，但是隐式继承自 Iterable[Any]:

fromtypingimportIterable
classMyIterable(Iterable):# Same as Iterable[Any]

用户定义的通用类型别名也受支持。例子:

fromtypingimportTypeVar,Iterable,Tuple,Union
S=TypeVar('S')
Response=Union[Iterable[S],int]
# Return type here is same as Union[Iterable[str], int]
defresponse(query:str)->Response[str]:
...
T=TypeVar('T',int,float,complex)
Vec=Iterable[Tuple[T,T]]
definproduct(v:Vec[T])->T:# Same as Iterable[Tuple[T, T]]
returnsum(x*yforx,yinv)

一个用户定义的泛型类能够使用抽象基本类作为基类，而不会发生元类冲突。泛型元类不再被支持。参数化泛型的结果会被缓存，并且在 typing 模块中的大部分类型是可哈希且可比较相等性的。

Any 类型¶

Any 是一种特殊的类型。静态类型检查器将所有类型视为与 Any 兼容，反之亦然， Any 也与所有类型相兼容。

这意味着可对类型为 Any 的值执行任何操作或方法调用，并将其赋值给任何变量:

fromtypingimportAny
a=None# type: Any
a=[]# OK
a=2# OK
s=''# type: str
s=a# OK
deffoo(item:Any)->int:
# Typechecks; 'item' could be any type,
# and that type might have a 'bar' method
item.bar()
...

需要注意的是，将 Any 类型的值赋值给另一个更具体的类型时，Python不会执行类型检查。例如，当把 a 赋值给 s 时，即使 s 被声明为 str 类型，在运行时接收到的是 int 值，静态类型检查器也不会报错。

此外，所有返回值无类型或形参无类型的函数将隐式地默认使用 Any 类型:

deflegacy_parser(text):
...
returndata
# A static type checker will treat the above
# as having the same signature as:
deflegacy_parser(text:Any)->Any:
...
returndata

当需要混用动态类型和静态类型的代码时，上述行为可以让 Any 被用作 应急出口 。

Any 和 object 的行为对比。与 Any 相似，所有的类型都是 object 的子类型。然而不同于 Any，反之并不成立： object不是 其他所有类型的子类型。

这意味着当一个值的类型是 object 的时候，类型检查器会拒绝对它的几乎所有的操作。把它赋值给一个指定了类型的变量（或者当作返回值）是一个类型错误。比如说：

defhash_a(item:object)->int:
# Fails; an object does not have a 'magic' method.
item.magic()
...
defhash_b(item:Any)->int:
# Typechecks
item.magic()
...
# Typechecks, since ints and strs are subclasses of object
hash_a(42)
hash_a("foo")
# Typechecks, since Any is compatible with all types
hash_b(42)
hash_b("foo")

使用 object 示意一个值可以类型安全地兼容任何类型。使用 Any 示意一个值地类型是动态定义的。

类,函数和修饰器.¶

这个模块定义了如下的类,模块和修饰器.

class typing.TypeVar¶

类型变量

用法:

T=TypeVar('T')# Can be anything
A=TypeVar('A',str,bytes)# Must be str or bytes

Type variables exist primarily for the benefit of static type

checkers. They serve as the parameters for generic types as well

as for generic function definitions. See class Generic for more

information on generic types. Generic functions work as follows:

defrepeat(x:T,n:int)->Sequence[T]:
"""Return a list containing n references to x."""
return[x]*n
deflongest(x:A,y:A)->A:
"""Return the longest of two strings."""
returnxiflen(x)>=len(y)elsey

本质上，后例的签名重载了 (str,str)->str 与 (bytes,bytes)->bytes。注意，参数是 str 子类的实例时，返回类型仍是纯 str。

isinstance(x,T) 会在运行时抛出 TypeError 异常。一般地说， isinstance() 和 issubclass() 不应该和类型一起使用。

通过 covariant=True 或 contravariant=True 可以把类型变量标记为协变量或逆变量。详见 PEP 484。默认情况下，类型变量是不变量。类型变量还可以用 bound=<type> 指定上限。这里的意思是，（显式或隐式地）取代类型变量的实际类型必须是限定类型的子类，详见 PEP 484。

class typing.Generic¶

用于泛型类型的抽象基类。

泛型类型一般通过继承含一个或多个类型变量的类实例进行声明。例如，泛型映射类型定义如下：

classMapping(Generic[KT,VT]):
def__getitem__(self,key:KT)->VT:
...
# Etc.

这个类之后可以被这样用:

X=TypeVar('X')
Y=TypeVar('Y')
deflookup_name(mapping:Mapping[X,Y],key:X,default:Y)->Y:
try:
returnmapping[key]
exceptKeyError:
returndefault

class typing.Type(Generic[CT_co])¶

一个注解为 C 的变量可以接受一个类型为 C 的值。相对地，一个注解为 Type[C] 的变量可以接受本身为类的值 —— 更精确地说它接受 C 的 类对象 ，例如：

a=3# Has type 'int'
b=int# Has type 'Type[int]'
c=type(a)# Also has type 'Type[int]'

注意 Type[C] 是协变的：

classUser:...
classBasicUser(User):...
classProUser(User):...
classTeamUser(User):...
# Accepts User, BasicUser, ProUser, TeamUser, ...
defmake_new_user(user_class:Type[User])->User:
# ...
returnuser_class()

 Type[C] 是协变的这一事实暗示了任何 C 的子类应当实现与 C 相同的构造器签名和类方法签名。类型检查器应当标记违反的情况，但应当也允许子类中调用构造器符合指示的基类。类型检查器被要求如何处理这种情况可能会在 PEP 484 将来的版本中改变。

 Type 合法的参数仅有类、 Any 、类型变量 以及上述类型的联合类型。例如：

defnew_non_team_user(user_class:Type[Union[BaseUser,ProUser]]):...

 Type[Any] 等价于 Type，因此继而等价于 type，它是 Python 的元类层级的根部。

3.5.2 新版功能.

class typing.Iterable(Generic[T_co])¶

collections.abc.Iterable 的泛型版本。

class typing.Iterator(Iterable[T_co])¶

collections.abc.Iterator 的泛型版本。

class typing.Reversible(Iterable[T_co])¶

collections.abc.Reversible 的泛型版本。

class typing.SupportsInt¶

含抽象方法 __int__ 的抽象基类。

class typing.SupportsFloat¶

含抽象方法 __float__ 的抽象基类。

class typing.SupportsComplex¶

含抽象方法 __complex__ 的抽象基类。

class typing.SupportsBytes¶

含抽象方法 __bytes__ 的抽象基类（ABC）

class typing.SupportsAbs¶

含抽象方法 __abs__ 的抽象基类（ABC）是其返回类型里的协变量。

class typing.SupportsRound¶

含抽象方法 __round__ 的抽象基类，是其返回类型的协变量。

class typing.Container(Generic[T_co])¶

collections.abc.Container 的泛型版本。

class typing.Hashable¶

collections.abc.Hashable 的别名。

class typing.Sized¶

collections.abc.Sized 的别名。

class typing.Collection(Sized, Iterable[T_co], Container[T_co])¶

collections.abc.Collection 的泛型版本。

3.6.0 新版功能.

class typing.AbstractSet(Sized, Collection[T_co])¶

collections.abc.Set 的泛型版本。

class typing.MutableSet(AbstractSet[T])¶

collections.abc.MutableSet 的泛型版本。

class typing.Mapping(Sized, Collection[KT], Generic[VT_co])¶

collections.abc.Mapping 的泛型版本。这个类型可以如下使用:

defget_position_in_index(word_list:Mapping[str,int],word:str)->int:
returnword_list[word]

class typing.MutableMapping(Mapping[KT, VT])¶

collections.abc.MutableMapping 的泛型版本。

class typing.Sequence(Reversible[T_co], Collection[T_co])¶

collections.abc.Sequence 的泛型版本。

class typing.MutableSequence(Sequence[T])¶

collections.abc.MutableSequence 的泛型版本。

class typing.ByteString(Sequence[int])¶

collections.abc.ByteString 的泛型版本。

This type represents the types bytes, bytearray,

and memoryview.

作为该类型的简称，bytes 可用于标注上述任意类型的参数。

class typing.Deque(deque, MutableSequence[T])¶

collections.deque 的泛型版本。

3.5.4 新版功能.

3.6.1 新版功能.

class typing.List(list, MutableSequence[T])¶

list 的泛型版本。适用于注解返回类型。注解参数时，最好使用 Sequence 或 Iterable 等抽象容器类型。

这个类型可以这样用:

T=TypeVar('T',int,float)
defvec2(x:T,y:T)->List[T]:
return[x,y]
defkeep_positives(vector:Sequence[T])->List[T]:
return[itemforiteminvectorifitem>0]

class typing.Set(set, MutableSet[T])¶

builtins.set 的泛型版本。适用于注解返回类型。注解参数时，最好使用 AbstractSet 等抽象容器类型。

class typing.FrozenSet(frozenset, AbstractSet[T_co])¶

builtins.frozenset 的泛型版本。

class typing.MappingView(Sized, Iterable[T_co])¶

collections.abc.MappingView 的泛型版本。

class typing.KeysView(MappingView[KT_co], AbstractSet[KT_co])¶

collections.abc.KeysView 的泛型版本。

class typing.ItemsView(MappingView, Generic[KT_co, VT_co])¶

collections.abc.ItemsView 的泛型版本。

class typing.ValuesView(MappingView[VT_co])¶

collections.abc.ValuesView 的泛型版本。

class typing.Awaitable(Generic[T_co])¶

collections.abc.Awaitable 的泛型版本。

3.5.2 新版功能.

class typing.Coroutine(Awaitable[V_co], Generic[T_co T_contra, V_co])¶

collections.abc.Coroutine 的泛型版本。类型变量的的差异和顺序与 Generator 的内容相对应，例如：

fromtypingimportList,Coroutine
c=None# type: Coroutine[List[str], str, int]
...
x=c.send('hi')# type: List[str]
asyncdefbar()->None:
x=awaitc# type: int

3.5.3 新版功能.

class typing.AsyncIterable(Generic[T_co])¶

collections.abc.AsyncIterable 的泛型版本。

3.5.2 新版功能.

class typing.AsyncIterator(AsyncIterable[T_co])¶

collections.abc.AsyncIterator 的泛型版本。

3.5.2 新版功能.

class typing.ContextManager(Generic[T_co])¶

contextlib.AbstractContextManager 的泛型版本。

3.5.4 新版功能.

3.6.0 新版功能.

class typing.AsyncContextManager(Generic[T_co])¶

contextlib.AbstractAsyncContextManager 的泛型版本。

3.5.4 新版功能.

3.6.2 新版功能.

class typing.Dict(dict, MutableMapping[KT, VT])¶

dict 的泛型版本。对标注返回类型比较有用。如果要标注参数的话，使用如 Mapping 的抽象容器类型是更好的选择。

这个类型可以这样使用:

defcount_words(text:str)->Dict[str,int]:
...

class typing.DefaultDict(collections.defaultdict, MutableMapping[KT, VT])¶

collections.defaultdict 的泛型版本。

3.5.2 新版功能.

class typing.OrderedDict(collections.OrderedDict, MutableMapping[KT, VT])¶

collections.OrderedDict 的泛型版本。

3.7.2 新版功能.

class typing.Counter(collections.Counter, Dict[T, int])¶

collections.Counter 的泛型版本。

3.5.4 新版功能.

3.6.1 新版功能.

class typing.ChainMap(collections.ChainMap, MutableMapping[KT, VT])¶

collections.ChainMap 的泛型版本。

3.5.4 新版功能.

3.6.1 新版功能.

class typing.Generator(Iterator[T_co], Generic[T_co, T_contra, V_co])¶

生成器可以由泛型类型 Generator[YieldType,SendType,ReturnType] 注解。例如：

defecho_round()->Generator[int,float,str]:
sent=yield0
whilesent>=0:
sent=yieldround(sent)
return'Done'

注意，与 typing 模块里的其他泛型不同， Generator 的``SendType`` 的操作是逆变的， 不是协变，也是不变。

如果生成器只生成值，可将 SendType 与 ReturnType 设为 None：

definfinite_stream(start:int)->Generator[int,None,None]:
whileTrue:
yieldstart
start+=1

另外，把生成器注解为返回类型

definfinite_stream(start:int)->Iterator[int]:
whileTrue:
yieldstart
start+=1

class typing.AsyncGenerator(AsyncIterator[T_co], Generic[T_co, T_contra])¶

异步生成器可由泛型类型 AsyncGenerator[YieldType,SendType] 注解。例如：

asyncdefecho_round()->AsyncGenerator[int,float]:
sent=yield0
whilesent>=0.0:
rounded=awaitround(sent)
sent=yieldrounded

与常规生成器不同，异步生成器不能返回值，因此没有 ReturnType 类型参数。 与 Generator 类似，SendType 也属于逆变行为。

如果生成器只产生值，可将 SendType 设置为 None：

asyncdefinfinite_stream(start:int)->AsyncGenerator[int,None]:
whileTrue:
yieldstart
start=awaitincrement(start)

此外，可用 AsyncIterable[YieldType] 或 AsyncIterator[YieldType] 注解生成器的类型：

asyncdefinfinite_stream(start:int)->AsyncIterator[int]:
whileTrue:
yieldstart
start=awaitincrement(start)

3.6.1 新版功能.

class typing.Text¶

Text 是 str 的别名。提供了对 Python 2 代码的向下兼容：Python 2 中，Text 是``unicode`` 的别名。

用

defadd_unicode_checkmark(text:Text)->Text:
returntext+u' \u2713'

3.5.2 新版功能.

class typing.IO¶

class typing.TextIO¶

class typing.BinaryIO¶

泛型类型 IO[AnyStr] 及其子类 TextIO(IO[str]) 与 BinaryIO(IO[bytes]) 表示 I/O 流的类型，例如 open() 所返回的对象。

class typing.Pattern¶

class typing.Match¶

这些类型对应的是从 re.compile() 和 re.match() 返回的类型。 这些类型（及相应的函数）是 AnyStr 中的泛型并可通过编写 Pattern[str], Pattern[bytes], Match[str] 或 Match[bytes] 来具体指定。

class typing.NamedTuple¶

collections.namedtuple() 的类型版本。

用法:

classEmployee(NamedTuple):
name:str
id:int

这相当于:

Employee=collections.namedtuple('Employee',['name','id'])

为字段提供默认值，要在类体内赋值：

classEmployee(NamedTuple):
name:str
id:int=3
employee=Employee('Guido')
assertemployee.id==3

带默认值的字段必须在不带默认值的字段后面。

The resulting class has two extra attributes: _field_types,

giving a dict mapping field names to types, and _field_defaults, a dict

mapping field names to default values. (The field names are in the

_fields attribute, which is part of the namedtuple API.)

NamedTuple 子类也支持文档字符串与方法：

classEmployee(NamedTuple):
"""Represents an employee."""
name:str
id:int=3
def__repr__(self)->str:
returnf'<Employee {self.name}, id={self.id}>'

反向兼容用法：

Employee=NamedTuple('Employee',[('name',str),('id',int)])

在 3.6 版更改: 添加了对 PEP 526 中变量注解句法的支持。

在 3.6.1 版更改: 添加了对默认值、方法、文档字符串的支持。

class typing.ForwardRef¶

用于字符串前向引用的内部类型表示的类。 例如，List["SomeClass"] 会被隐式转换为 List[ForwardRef("SomeClass")]。 这个类不应由用户来实例化，但可以由内省工具使用。

typing.NewType(typ)¶

A helper function to indicate a distinct types to a typechecker,

see NewType. At runtime it returns a function that returns

its argument. Usage:

UserId=NewType('UserId',int)
first_user=UserId(1)

3.5.2 新版功能.

typing.cast(typ, val)¶

把值强制转换为类型。

不变更返回值。对类型检查器来说，这代表了返回值具有指定的类型，但在运行时，故意不做任何检查（目的是让该检查速度尽量快）。

typing.get_type_hints(obj[, globals[, locals]])¶

返回一个字典，字典内含有函数、方法、模块或类对象的类型提示。

一般情况下，与 obj.__annotations__ 相同。此外，可通过在 globals 与 locals 命名空间里进行评估，以此来处理编码为字符串字面量的前向引用。如有需要，在默认值设置为 None``时，可为函数或方法注解添加``Optional[t]。对于类 C，则返回一个由所有 __annotations__ 与 C.__mro__ 逆序合并而成的字典。

@typing.overload¶

@overload 装饰器可以修饰支持多个不同参数类型组合的函数或方法。@overload - 装饰定义的系列必须紧跟一个非 @overload-装饰定义（用于同一个函数/方法）。@overload-装饰定义仅是为了协助类型检查器， 因为该装饰器会被非 @overload-装饰定义覆盖，后者用于运行时，而且会被类型检查器忽略。在运行时直接调用 @overload 装饰的函数会触发 NotImplementedError。下面的重载示例给出了比联合类型或类型变量更精准的类型：

@overload
defprocess(response:None)->None:
...
@overload
defprocess(response:int)->Tuple[int,str]:
...
@overload
defprocess(response:bytes)->str:
...
defprocess(response):
<actualimplementation>

详见 PEP 484，与其他类型语义进行对比。

@typing.no_type_check¶

用于指明标注不是类型提示的装饰器。

此 decorator 装饰器生效于类或函数上。如果作用于类上的话，它会递归地作用于这个类的所定义的所有方法上（但是对于超类或子类所定义的方法不会生效）。

此方法会就地地修改函数。

@typing.no_type_check_decorator¶

使其它装饰器起到 no_type_check() 效果的装饰器。

本装饰器用 no_type_check() 里的装饰函数打包其他装饰器。

@typing.type_check_only¶

标记一个类或函数在运行时内不可用的装饰器。

在运行时，该装饰器本身不可用。实现返回了私有类实例时，它主要是用于标记在类型存根文件中定义的类。

@type_check_only
classResponse:# private or not available at runtime
code:int
defget_header(self,name:str)->str:...
deffetch_response()->Response:...

注意，不建议返回私有类的实例，最好将这些类设为公共类。

typing.Any¶

特殊类型，表明类型没有任何限制。

• 每一个类型都对 Any 兼容。

• Any 对每一个类型都兼容。

typing.NoReturn¶

标记一个函数没有返回值的特殊类型。比如说:

fromtypingimportNoReturn
defstop()->NoReturn:
raiseRuntimeError('no way')

3.5.4 新版功能.

3.6.2 新版功能.

typing.Union¶

联合类型； Union[X,Y] 意味着：要不是 X，要不是 Y。

使用形如 Union[int,str] 的形式来定义一个联合类型。细节如下:

• 参数必须是类型，而且必须至少有一个参数。

• 联合类型的联合类型会被展开打平，比如:

  Union[Union[int,str],float]==Union[int,str,float]
  

• 仅有一个参数的联合类型会坍缩成参数自身，比如:

  Union[int]==int# The constructor actually returns int
  

• 多余的参数会被跳过，比如:

  Union[int,str,int]==Union[int,str]
  

• 在比较联合类型的时候，参数顺序会被忽略，比如:

  Union[int,str]==Union[str,int]
  

• 你不能继承或者实例化一个联合类型。

• 你不能写成 Union[X][Y] 。

• 你可以使用 Optional[X] 作为 Union[X,None] 的缩写。

在 3.7 版更改: 不要在运行时内从联合类型中移除显式说明的子类。

typing.Optional¶

可选类型。

 Optional[X] 等价于 Union[X,None] 。

请注意，这与可选参数并非相同的概念。可选参数是一个具有默认值的参数。可选参数的类型注解并不因为它是可选的就需要 Optional 限定符。例如：

deffoo(arg:int=0)->None:
...

另一方面，如果允许显式地传递值 None ， 使用 Optional 也是正当的，无论该参数是否是可选的。例如：

deffoo(arg:Optional[int]=None)->None:
...

typing.Tuple¶

元组类型； Tuple[X,Y] 标注了一个二元组类型，其第一个元素的类型为 X 且第二个元素的类型为 Y。空元组的类型可写作 Tuple[()] 。

举例： Tuple[T1,T2] 是一个二元组，类型分别为 T1 和 T2。 Tuple[int,float,str] 是一个由整数、浮点数和字符串组成的三元组。

为表达一个同类型元素的变长元组，使用省略号字面量，如 Tuple[int,...] 。单独的一个 Tuple 等价于 Tuple[Any,...]，进而等价于 tuple 。

typing.Callable¶

可调用类型； Callable[[int],str] 是一个函数，接受一个 int 参数，返回一个 str 。

下标值的语法必须恰为两个值：参数列表和返回类型。参数列表必须是一个类型和省略号组成的列表；返回值必须是单一一个类型。

不存在语法来表示可选的或关键词参数，这类函数类型罕见用于回调函数。 Callable[...,ReturnType] （使用字面省略号）能被用于提示一个可调用对象，接受任意数量的参数并且返回 ReturnType。单独的 Callable 等价于 Callable[...,Any] ，并且进而等价于 collections.abc.Callable 。

typing.ClassVar¶

特殊的类型构造器，用以标记类变量。

在 PEP 526 中被引入，ClassVar 包裹起来的变量注解指示了给定属性预期用于类变量，并且不应在类的实例上被设置。用法：

classStarship:
stats:ClassVar[Dict[str,int]]={}# class variable
damage:int=10# instance variable

ClassVar 仅接受类型，并且不能被再次下标。

ClassVar 本身并不是一个类，并且不应与 isinstance() or issubclass() 一起使用。 ClassVar 并不改变 Python 运行时行为，但它可以被用于第三方类型检查器。例如，某个类型检查器可能会标记以下代码为错误的：

enterprise_d=Starship(3000)
enterprise_d.stats={}# Error, setting class variable on instance
Starship.stats={}# This is OK

3.5.3 新版功能.

typing.AnyStr¶

AnyStr 类型变量的定义为 AnyStr=TypeVar('AnyStr',str,bytes)。

这里指的是，它可以接受任意同类字符串，但不支持混用不同类别的字符串。例如：

defconcat(a:AnyStr,b:AnyStr)->AnyStr:
returna+b
concat(u"foo",u"bar")# Ok, output has type 'unicode'
concat(b"foo",b"bar")# Ok, output has type 'bytes'
concat(u"foo",b"bar")# Error, cannot mix unicode and bytes

typing.TYPE_CHECKING¶

被第三方静态类型检查器假定为 True 的特殊常量。 在运行时为 False。 用法如下:

ifTYPE_CHECKING:
importexpensive_mod
deffun(arg:'expensive_mod.SomeType')->None:
local_var:expensive_mod.AnotherType=other_fun()

Note that the first type annotation must be enclosed in quotes, making it a

"forward reference", to hide the expensive_mod reference from the

interpreter runtime. Type annotations for local variables are not

evaluated, so the second annotation does not need to be enclosed in quotes.

3.5.2 新版功能.