利用Stub File标注Python文件类型

简介: 在升级到Python 3.5+版本之后,最大的项目管理优化来自于PEP-484 Type Hint的引入。借助Type Hint,我们可以进一步提升Python代码的类型标注,保障在重构过程中避免出现一些低级失误。

在升级到Python 3.5+版本之后,最大的项目管理优化来自于PEP-484 Type Hint的引入。借助Type Hint,我们可以进一步提升Python代码的类型标注,保障在重构过程中避免出现一些低级失误。

我们可以通过高版本Python新加的新语法启用这项特性,然后通过mypy等工具检查:

def greeting(name: str) -> str:
    return 'Hello ' + name

然而,在实际实践过程中,也往往存在一些问题,这些问题来自于很多方面:

  • 你难免有一些历史性代码,这些代码需要同时支持Python2Python3
  • 你使用的Python 3 Only的第三方库没有Type Hint定义,作者看起来并不打算近期支持或者某些原因(比如你正在用的某个老版本不维护了)导致你不能贡献代码。

这些时候你往往是不能直接使用Type Hint带来的便利的,不过PEP-484中也考虑到了这种情况,包含了一种stub file的定义形式,可以通过第三方文件.pyi文件,定义函数参数类型与返回值类型。

比如官方文档中就定义了一个比较简单的stub例子。假设我们对一个名叫HttpRequest 的类进行类型标记:

# request.py


class HttpRequest:
    """A basic HTTP request."""

    def __init__(self):
        self.META = {"SERVER_NAME": "hello.com"}

    def get_raw_host(self):
        """
        Return the HTTP host using the environment or request headers. Skip
        allowed hosts protection, so may return an insecure host.
        """
        # Reconstruct the host using the algorithm from PEP 333.
        host = self.META["SERVER_NAME"]
        return host

接下来,我们可以在当前文件的文件夹下新建一个名叫bytes.pyi的文件,填写如下内容:

# request.py


class HttpRequest:
    def get_raw_host(self) -> str: ...

让我们先构建一个存在类型混淆的例子,如果你使用了mypy之类的工具进行检查,则可以快速发现下面例子中本来为int型的i被重新赋值了str类型。

checked

通过这样的方法,可以快速将已有的代码库快速添加类型。不过实际中并不是这么简单。我们之前也说过,很多项目并不是由我们自行维护的,这个时候,我们很难去修改上游仓库时,应该如何做呢?

这里,我们以mypy工具和Django这个Python常用为例去演示一下如何配置Django项目的类型检查。

这里有一个第三方提供的Django类型标注库django-stubs,我们可以通过pip命令进行安装:

pip install django-stubs

在安装完成之后,因为这个标注文件时单独发布的包,因此我们需要修改mypy的指向,让mypy使用这个包的标注。需要修改mypy.ini文件用于定义。关于这个文件的具体配置,则可以参考mypy工具的官方文档

[mypy]
plugins =
     mypy_django_plugin.main

接下来就可以使用mypy针对Django部分进行检查了。

目录
相关文章
|
11天前
|
Python
用python3快速读取30G+的txt文件
这篇文章介绍了如何使用Python分块读取大文件(如30G+的txt文件),通过设置每次读取的块大小来处理大型文本文件,以减少内存消耗并提高处理效率。
40 14
|
8天前
|
存储 Python
INI文件介绍与Python处理指南
INI文件介绍与Python处理指南
|
11天前
|
数据安全/隐私保护 Python
用python对文件内容进行加密的2种方式
这篇文章介绍了使用Python对文件内容进行加密的两种方式:利用`cryptography`库的Fernet对称加密和使用`rsa`库进行RSA非对称加密。
30 6
|
11天前
|
Python
python简单分割文件的方法(python经典案例)
这篇文章介绍了两种使用Python进行文件分割的方法:通过读取指定字节数分割大文件成小文件,以及通过行数将文本文件分割成多个小文件。
30 1
|
20小时前
|
数据处理 Python
Python 高级技巧:深入解析读取 Excel 文件的多种方法
在数据分析中,从 Excel 文件读取数据是常见需求。本文介绍了使用 Python 的三个库:`pandas`、`openpyxl` 和 `xlrd` 来高效处理 Excel 文件的方法。`pandas` 提供了简洁的接口,而 `openpyxl` 和 `xlrd` 则针对不同版本的 Excel 文件格式提供了详细的数据读取和处理功能。此外,还介绍了如何处理复杂格式(如合并单元格)和进行性能优化(如分块读取)。通过这些技巧,可以轻松应对各种 Excel 数据处理任务。
27 16
|
5天前
|
存储 Python
一文让你搞懂 Python 的 pyc 文件
一文让你搞懂 Python 的 pyc 文件
28 15
|
8天前
|
Docker Python 容器
python检测docker compose文件是否正确
python检测docker compose文件是否正确
|
7天前
|
人工智能 IDE 开发工具
Python实行任意文件的加密—解密
Python实行任意文件的加密—解密
15 2
|
9天前
|
缓存 开发者 Python
Python指定行号读取文件的方法
这种方法的优势在于它的效率和简便性,特别是当需要从同一文件中读取多行时。`linecache`会缓存文件,减少了重复读取的开销。
15 4
|
7天前
|
人工智能 IDE 开发工具
Python实行任意文件的加密—解密
Python实行任意文件的加密—解密
15 1
下一篇
无影云桌面