Python 类型提示的初级入门

时间:2022-11-30 09:27:18

Python语言被认为是一种最好的“动态但强类型”语言。类型不与事物的名称相关联,而是与事物本身相关联。

这使得 Python语言对开发人员来说既灵活又方便,因为如果只是将编写一个快速切逻辑性不强的脚本,就不必严格定义和跟踪变量类型。但是对于更大的项目来说,尤其是第三方使用的库,了解哪些对象类型与哪些变量相关联是有帮助的。

一段时间以来,Python 已经能够以某种形式用类型信息“注释”名称。在 Python 3.5 中,类型提示正式成为语言的一部分(PEP 484)。使用 linter 或代码检查工具,开发人员可以跨代码库检查变量及其类型的一致性,并对以前很难或者不可能实现的代码执行静态分析。所有这些都是在代码运行之前提前完成的。

在本文中,我们将探讨 Python 类型提示的一些基本示例。但首先我们要介绍一个常见误解,即什么是Python类型提示,有什么用途。

Python 类型提示的初级入门

Python 如何使用类型提示

关于 Python 类型提示的一个主要误解是如何使用。运行时不使用Python 类型提示。事实上,在程序运行时,您提供的所有类型信息都已被删除。Python 类型提示只会被正在使用的类型检查系统(例如在编辑器或 IDE 中)提前使用。换句话说,Python 的类型提示是针对开发人员的,而不是针对运行时的。

这听起来可能有悖常理,尤其是对于使用过类型声明不是可选语言时的开发人员来说。但是 Python 的开发团队已经明确表示,类型提示并不是核心 Python 语言成为静态类型的征兆。它们是开发人员向代码库添加元数据的一种方式,以便在开发过程中更轻松地执行静态分析。

有人推测,Python类型提示能可能会产生一种静态类型的语言分支,这可能是使Python更快的一种方法。在某些方面,已经证实了这种推测。Cython 使用类型提示(尽管大部分是它自己特有的类型)从 Python 生成 C 代码, mypyc项目使用 Python 的本机类型提示来完成同样的工作。

但是,这些项目被更恰当地认为是对核心 Python 语言的补充,而不是 Python 发展方向的标志。Python 中类型提示的主要目的是为开发人员提供一种方法,使他们的代码尽可能具有自描述性,这既是为了他们自己的利益,也是为了其他开发者的利益。

Python 类型提示的语法

Python 中的类型提示在命名空间中第一次调用名称之后涉及冒号和类型声明。例如:

  1. name: str 
  2. age: int 
  3. name = input("Your name?"
  4. age = int(input("Your age?")) 

类型提示name和age的第一个声明确保将来在该名称空间中使用这些名称时,将对照这些类型进行检查。例如,此代码将无效:

  1. name: int 
  2. age: int 
  3. name = input("Your name?"
  4. age = int(input("Your age?")) 

因为我们已经声明name为一个int,并且input默认返回一个字符串,类型检查器将无法查询到。

Python 类型检查系统将尽可能地推断类型。例如,假设我们使用了以下代码,但没有前面的类型声明:

  1. name = input("Your name?"
  2. age = int(input("Your age?")) 

在这种情况下,类型检查器将能够推断出name是一个字符串(因为input()不返回任何其他内容),而age是一个int(因为int()不返回任何其他内容)。

类型提示 Python 函数

Python 函数也可以是类型提示,以便提前记录它们接受和返回的值。例如下面的代码:

  1. greeting = "Hello, {}, you're {} years old"
  2. def greet(user, age): 
  3.     return greeting.format(user, age) 
  4. name = input("Your name?"
  5. age = int(input("How old are you?")) 
  6. print(greet(name, age)) 

这段代码的一个歧义是,greet()理论上可以接受user和age的任何类型,并且可以返回任何类型。以下是我们如何使用类型提示消除歧义的方法:

  1. greeting = "Hello, {}, you're {} years old"
  2. def greet(user:str, age:int) -> str: 
  3.     return greeting.format(user, age) 
  4. name = input("Your name?"
  5. age = int(input("How old are you?")) 
  6. print(greet(name, age)) 

给定greet()的这些类型提示, 当您在代码中插入对greet()的调用时,编辑器可以提前告诉您接受哪些类型的greet()。

同样,有时 Python 可以自动推断函数返回的类型,但是如果对函数使用类型提示,最好是提示有关它的所有内容——它接受什么类型以及返回什么类型。

类型提示容器对象

如列表、字典和元组这样的对象包含其他对象,所以我们需要键入类型提示来指示它们包含什么类型的对象。为此,我们需要求助于 Python 的typing(类型化)模块,它提供了用于描述此类事物将持有的类型的工具。

  1. from typing import Dict, List 
  2. dict_of_users: Dict[int,str] = { 
  3.     1"Jerome"
  4.     2"Lewis"
  5. list_of_users: List[str] = [ 
  6.     "Jerome""Lewis"

字典由键和值组成,它们可以是不同的类型。您可以通过将字典作为列表提供给 来描述字典的类型typing.Dict。也可以通过向提供该类型来描述列表的对象类型typing.List

OptionalUnion类型

某些对象可能包含两种不同类型的对象之一。在这些情况下,可以使用Union或Optional。使用Union指示对象可以是多种类型之一,使用Optional指示对象是一种给定类型还是无。例如:

  1. from typing import Dict, Optional, Union 
  2. dict_of_users: Dict[int, Union[int,str]] = { 
  3.     1"Jerome"
  4.     2"Lewis"
  5.     332
  6. user_id: Optional[int] 
  7. user_id = None # valid
  8. user_id = 3 # also vald
  9. user_id = "Hello" # not valid! 

在本例中,我们有一个以ints 作为键,但以ints strs 作为值的字典。user_id变量(我们可以用它来比较对字典的键)可以是一个intNone(“无有效用户”),而不能是str

类型提示和类

要为类提供类型提示,只需引用与任何其他类型相同的名称:

  1. from typing import Dict 
  2. class User: 
  3.     def __init__(self, name): 
  4.         self.name = name 
  5. users: Dict[int, User] = { 
  6.     1: User("Serdar"), 
  7.     2: User("Davis"
  8. def inspect_user(user:User) -> None
  9.     print (user.name) 
  10. user1 = users[1
  11. inspect_user(user1) 

请注意,inspect_user()的返回类型为None,因为它只是打印输出而不返回任何内容。(此外,我们通常会将这样的函数变成类的方法,但在本例中,将单独对其进行说明。)

当对自定义对象使用类型提示时,我们有时需要为尚未定义的对象提供类型提示。在这种情况下,您可以使用字符串来提供对象名称:

  1. class User: 
  2.     def __init__(self, name:str, address:"Address"): 
  3.         self.name = name 
  4.         self.address = address 
  5.         # ^ because let's say for some reason we must have
  6.         # an address for each user
  7. class Address: 
  8.     def __init__(self, owner:User, address_line:str):         
  9.         self.owner = owner 
  10.         self.address_line = address_line 

【51CTO译稿,合作站点转载请注明原文译者和出处为51CTO.com】

原文链接:https://developer.51cto.com/art/202108/679340.htm#topx