利用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部分进行检查了。

目录
相关文章
|
9天前
|
安全 项目管理 Python
使用Python shutil库进行文件和目录操作
使用Python shutil库进行文件和目录操作
使用Python shutil库进行文件和目录操作
|
23天前
|
前端开发 Python
使用Python+openpyxl实现导出自定义样式的Excel文件
本文介绍了如何使用Python的openpyxl库导出具有自定义样式的Excel文件,包括设置字体、对齐方式、行列宽高、边框和填充等样式,并提供了完整的示例代码和运行效果截图。
24 1
使用Python+openpyxl实现导出自定义样式的Excel文件
|
13天前
|
数据挖掘 数据处理 数据格式
Python读取.nc文件的方法与技术详解
通过上述方法,用户可以根据需求选择合适的库来读取.nc文件,并根据实际情况进行必要的数据操作,这是科学数据处理和分析中的一个重要技能。
45 10
|
9天前
|
Python
像导入Python模块一样导入ipynb文件
像导入Python模块一样导入ipynb文件
|
9天前
|
Ubuntu Linux 数据安全/隐私保护
使用Cython库包对python的py文件(源码)进行加密,把python的.py文件生成.so文件并调用
本文介绍了在Linux系统(Ubuntu 18.04)下将Python源代码(`.py文件`)加密为`.so文件`的方法。首先安装必要的工具如`python3-dev`、`gcc`和`Cython`。然后通过`setup.py`脚本使用Cython将`.py文件`转化为`.so文件`,从而实现源代码的加密保护。文中详细描述了从编写源代码到生成及调用`.so文件`的具体步骤。此方法相较于转化为`.pyc文件`提供了更高的安全性。
25 2
|
9天前
|
移动开发 Java 编译器
什么是pyc文件,把python的py文件编译成pyc文件,把pyc文件反编译成py文件。以及python编译的如何设置不生成pyc文件
什么是pyc文件,把python的py文件编译成pyc文件,把pyc文件反编译成py文件。以及python编译的如何设置不生成pyc文件
11 1
|
11天前
|
SQL JSON 关系型数据库
n种方式教你用python读写excel等数据文件
n种方式教你用python读写excel等数据文件
|
17天前
|
JSON C语言 数据格式
Python导出隐马尔科夫模型参数到JSON文件C语言读取
Python导出隐马尔科夫模型参数到JSON文件C语言读取
13 1
|
9天前
|
TensorFlow 算法框架/工具 C++
Python exe文件打包神器-Nuitka!
Python exe文件打包神器-Nuitka!
|
9天前
|
存储 安全 Python
Python中临时文件的妙用
Python中临时文件的妙用
下一篇
DDNS