使用mypy对python程序进行静态检查

目录
  • 前言
  • 1、安装
  • 2、执行
  • 3、常用的内置类型
  • 4、配置文件
  • 最后的话

前言

在此之前，我认为 Python 的类型提示就是一个花瓶，看起来好看，但并没有实质的作用，因为即使类型写错了，或者传错了，程序仍然可以运行，直到我发现了 mypy 这个工具。今天就来聊一聊 mypy。

mypy 是 Python 中的静态类型检查器。写完带有类型提示的代码之后，先别运行行，用 mypy 命令来检查下你的代码，如果有错误，会提示你，这让 Python 的类型提示有了真正的作用。后续开发的过程中可以强制 mypy 检查无误后才能上线，借此提高代码的可读性和可维护性。

嗯，很实用，不是吗？下面分享一下如何使用 mypy。

1、安装

这个很简单了，pip install mypy 就搞定了。

2、执行

假如有这样一个 Python 程序，名称叫 demo1.py，内容如下：

def greeting(name: str) -> str: #这里提示有问题    print (f'Hello { name }')

x: str = 'xxx' y: int = "yyy" #这里应该提示有问题greeting(x) greeting(y) #这里应该提示有问题

代码我已经指出了两处错误，现在让 mypy 检查一下：

果然，mypy 发现了三处错误，并一一提示，非常好用啊。

如果不希望检查某一行，可以在注释上加上"# type: ignore"：

y: int = "yyy" # type: ignore

mypy 具有强大且易于使用的类型系统，具有很多优秀的特性，例如类型推断、泛型、可调用类型、元组类型、联合类型和结构子类型。

3、常用的内置类型

4、配置文件

mypy 将依次查找当前目录下配置文件

mypy.ini

.mypy.ini

pyproject.toml

setup.cfg

如果还找不到，则依次寻找下面的配置文件：

$XDG_CONFIG_HOME/mypy/config

~/.config/mypy/config

~/.mypy.ini

此外，你也可以使用​​--config-file​​ 指定配置文件。

一个典型的 mypy.ini 配置文件如下：

# Global options:

[mypy]
python_version = 3.7
warn_return_any = True
warn_unused_configs = True

# Per-module options:

[mypy-mycode.foo.*]
disallow_untyped_defs = True

[mypy-mycode.bar]
warn_return_any = False

[mypy-somelibrary]
ignore_missing_imports = True

配置文件的详细说明，见官方文档：https://mypy.readthedocs.io/en/stable/

常见配置项：

files 逗号分隔的路径列表，如果命令行上没有给出，则应由 mypy 检查，支持递归。

exclude 应忽略检查的文件名、目录名和路径

ignore_missing_imports 禁止有关无法解析的导入的错误消息。

disallow_untyped_defs 不允许定义没有类型注释或类型注释不完整的函数。

plugins 逗号分隔的 mypy 插件列表

最后的话

mypy 是自动化测试中很重要的一部分，可以帮助我们检查 Python 语言的类型提示是否正确，减少代码的 bug，Python 开发的朋友们一定要用一用。

到此这篇关于使用mypy对python程序进行静态检查的文章就介绍到这了,更多相关mypy静态检查内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们！

赞 (0)

相关推荐

  • 深入了解Python 方法之类方法 & 静态方法

    写在之前 这几天的阅读量蜜汁低,是什么原因我也没搞清楚,如果你们觉得我哪里写的有问题,或者是哪里不好,欢迎后台或者微信告知我,先行谢过. 昨天的文章 详解类方法之绑定方法与非绑定方法 中写了方法中的绑定方法和非绑定方法,今天我们继续来学习剩下的「类方法」和「静态方法」. 类方法 & 静态方法 在开始之前,先让我们来看下面一段代码: class Sample: language = "C++" def __init__(self): self.language = "p

  • Python实例方法、类方法、静态方法区别详解

    1.关于参数的区别 实例方法:定义实例方法是最少有一个形参 ---> 实例对象,通常用 self 类方法:定义类方法的时候最少有一个形参 ---> 类对象,通常用 cls 静态方法:定义静态方法的时候可以不定义形参 2.关于方法定义时候添加装饰器的区别 实例方法:不需要添加装饰器 类方法:需要添加装饰器 ----> @classmethod 静态方法:需要添加装饰器 ---> @staticmethod 3.调用: 1.实例方法可以通过对象直接调用 2.但是用类名调用的时候,需要创

  • 浅谈python 类方法/静态方法

    1.类方法 类方法是从属于"类对象"的方法.类对象可以通过装饰器@classmethod来定义,具体格式如下: @classmethod def 类方法名(cls [, 形参列表]): 方法体 要点如下: @classmethod必须位于方法的上面一行 第一个参数cls(class的缩写,和前面笔记介绍的self类似),必须要有,代指"类对象"本身. 调用类方法格式:类名.类方法名(参数列表).参数列表中不需要也不能给cls参数进行传值,解释器会自动赋值. 类方法中

  • python如何设置静态变量

    众所周知,Python语言并不支持静态变量,比如下面这样一个应用场景: void foo() {     static int count = 0;     count ++; } 在Python中无法自然实现这个功能.换个角度来看这个问题,函数中的静态变量其实可以看做是函数的一个内部变量,而不是调用期间生成的局部变量.所以这里介绍一种使用装饰器的方法给函数添加这样的内部变量. def static_vars(**kwargs):     def decorate(func):         

  • 使用mypy对python程序进行静态检查

    使用mypy对python程序进行静态检查

    目录 前言 1.安装 2.执行 3.常用的内置类型 4.配置文件 最后的话 前言 在此之前,我认为 Python 的类型提示就是一个花瓶,看起来好看,但并没有实质的作用,因为即使类型写错了,或者传错了,程序仍然可以运行,直到我发现了 mypy 这个工具.今天就来聊一聊 mypy. mypy 是 Python 中的静态类型检查器.写完带有类型提示的代码之后,先别运行行,用 mypy 命令来检查下你的代码,如果有错误,会提示你,这让 Python 的类型提示有了真正的作用.后续开发的过程中可以强制

  • 使用Pyrex来扩展和加速Python程序的教程

    Pyrex 是一种专门设计用来编写 Python 扩展模块的语言.根据 Pyrex Web 站点的介绍,"它被设计用来在友好易用的高级 Python 世界和凌乱的低级 C 世界之间搭建一个桥梁."虽然几乎所有的 Python 代码都可以作为有效的 Pyrex 代码使用,但是您可以在 Pyrex 代码中添加可选的静态类型声明,从而使得这些声明过的对象以 C 语言的速度运行. 加速 Python 从某种意义上来说,Pyrex 只是不断发展的 Python 类语言系列的一个部分:Jython

  • 教你用Type Hint提高Python程序开发效率

    简介 Type Hint(或者叫做PEP-484)提供了一种针对Python程序的类型标注标准. 为什么使用Type Hint?对于动态语言而言,常常出现的情况是当你写了一段代码后,隔段时间你可能忘记这个方法的原型是什么样子的了,你也不清楚具体应该传入什么类型的参数,这样往往需要你去阅读代码才能定义每个类型具体是什么.或者当你使用一个文档并不是特别完全的第三方库,你不知道这个库应该如何使用,这都会很痛苦. 现在,借助Type Hint,你可以实现: 1.实现类型检查,防止运行时出现的类型不符合情

  • Python程序慢的重要原因

    Python慢的重要原因: 1.python是动态性语言不是静态性语言 在python程序执行的时候,编译器不知道变量的类型. 2.python是解释性语言而不是编译性语言 解释型语言与编译型语言它们本身的区别也会造成程序在执行的时候的速度差异.一个智能化的编译器可以预测并针对重复和不需要的操作进行优化.这也会提升程序执行的速度. 3. python的对象模型会导致访问内存效率低下 相对于C语言,在python中对整数进行操作会有一个额外的类型信息层. 当有很多的整数并且希望进行某种批操作时,在

  • 提升Python程序运行效率的6个方法

    Python是一个很酷的语言,因为你可以在很短的时间内利用很少的代码做很多事情.不仅如此,它还能轻松地支持多任务,比如多进程等.Python批评者有时会说Python执行缓慢.本文将尝试介绍6个技巧,可加速你的Python应用程序. 1.让关键代码依赖于外部包 虽然Python让许多编程任务变得容易,但它可能并不总能为紧急的任务提供最佳性能.你可以为紧急的任务使用C.C++或机器语言编写的外部包,这样可以提高应用程序的性能.这些包都是不能跨平台的,这意味着你需要根据你正在使用的平台,寻找合适的包

  • 浅要分析Python程序与C程序的结合使用

    浅要分析Python程序与C程序的结合使用

    Python 是一种用于快速开发软件的编程语言,它的语法比较简单,易于掌握,但存在执行速度慢的问题,并且在处理某些问题时存在不足,如对计算机硬件系统的访问,对媒体文件的访问等.而作为软件开发的传统编程语言 C 语言,却能在这些问题上很好地弥补 Python 语言的不足.因此,本文通过实例研究如何在 Python 程序中整合既有的 C 语言模块,包括用 C 语言编写的源程序和动态链接库等,从而充分发挥 Python 语言和 C 语言各自的优势. 概览 背景知识介绍 Python 语言的特点 Pyt

  • 使用C语言来扩展Python程序和Zope服务器的教程

    有几个原因使您可能想用 C 扩展 Zope.最可能的是您有一个已能帮您做些事的现成的 C 库,但是您对把它转换成 Python 却不感兴趣.此外,由于 Python 是解释性语言,所以任何被大量调用的 Python 代码都将降低您的速度.因此,即使您已经用 Python 写了一些扩展,您仍然要考虑把其中最常被调用的部分改用 C 来写.不论哪种方式,扩展 Zope 都是从扩展 Python 开始.此外,扩展 Python 会给您带来其它的好处,因为您的代码将可以从任何 Python 脚本访问,而不

  • Python实现单词拼写检查

    这几天在翻旧代码时发现以前写的注释部分有很多单词拼写错误,这些单词错得不算离谱,应该可以用工具自动纠错绝大部分.用 Python 写个拼写检查脚本很容易,如果能很好利用 aspell/ispell 这些现成的小工具就更简单了. 要点 1.输入一个拼写错误的单词,调用 aspell -a 后得到一些候选正确单词,然后用距离编辑进一步嗮选出更精确的词.比如运行 aspell -a,输入 'hella' 后得到如下结果: hell, Helli, hello, heal, Heall, he'll,

  • 用Python编写分析Python程序性能的工具的教程

    用Python编写分析Python程序性能的工具的教程

    虽然并非你编写的每个 Python 程序都要求一个严格的性能分析,但是让人放心的是,当问题发生的时候,Python 生态圈有各种各样的工具可以处理这类问题. 分析程序的性能可以归结为回答四个基本问题: 正运行的多快 速度瓶颈在哪里 内存使用率是多少 内存泄露在哪里 下面,我们将用一些神奇的工具深入到这些问题的答案中去. 用 time 粗粒度的计算时间 让我们开始通过使用一个快速和粗暴的方法计算我们的代码:传统的 unix time 工具. $ time python yourprogram.py

  • 10种检测Python程序运行时间、CPU和内存占用的方法

    10种检测Python程序运行时间、CPU和内存占用的方法

    在运行复杂的Python程序时,执行时间会很长,这时也许想提高程序的执行效率.但该怎么做呢? 首先,要有个工具能够检测代码中的瓶颈,例如,找到哪一部分执行时间比较长.接着,就针对这一部分进行优化. 同时,还需要控制内存和CPU的使用,这样可以在另一方面优化代码. 因此,在这篇文章中我将介绍7个不同的Python工具,来检查代码中函数的执行时间以及内存和CPU的使用. 1. 使用装饰器来衡量函数执行时间 有一个简单方法,那就是定义一个装饰器来测量函数的执行时间,并输出结果: import time

随机推荐