当前位置:网站首页 > 技术博客 > 正文

python 规范



关于Python代码规范,之前写过一篇相关的文章你熟悉Python的代码规范吗?如何一键实现代码排版,大家可以先看下。

Python代码规范要遵从PEP规范,Python官方的PEP8指南:https://www.python.org/dev/peps/pep-0008/,可以回复“编码规范”获取最新pep8规范中文版。

我们知道规范的内容很多,不可能都记住,每次写完代码,也不可能一条条去检查,有没有什么好用的检查工具呢。

今天,就给大家介绍python中有两个非常好用的代码检查工具-pylintflake8

Pylint是一个Python代码分析工具,它分析 Python 代码中的错误,查找不符合代码风格标准(Pylint 默认使用的代码风格是 PEP 8)和有潜在问题的代码。

安装

安装完成后,可以查看pylint的版本信息

使用

输出:

使用pylint有如下几种提示级别Error(错误)、Warning(警告)、Refactor(重构)、Convention(规范)。

输出的结果包括:与规范冲突的位置(行列)、违反的规范编号以及具体的内容提示,还有一个有趣的地方,就是会给检查项目打分,满分10分,大家可以试试自己的项目,看看编码规范评分是多少。

从检查信息可以看到,上述代码缺少模块注释(Missing module docstring)以及函数注释(Missing function docstring),函数名不符合蛇形命名规范(全由小写字母和下划线组成,在两个单词之间用下滑线连接)。

修改后

执行:

在pycharm中配置pylint

pylint也可以关联到pycharm中,不用每次手动执行命令,配置好后,直接点击按钮执行即可。

在需要检查的项目中,右键选择pylint即可。

Flake8 是由Python官方发布的一款辅助检测Python代码是否规范的工具,相对于目前热度比较高的Pylint来说,Flake8检查规则灵活,支持集成额外插件,扩展性强。可以编写程序实现代码规范性检测。

flake安装

使用与pylint类似:

在pycharm中配置flake8

配置与pylint类似

在需要检查的项目中,右键选择Flake8即可。

关于pylint和flake8,这里只介绍了最基本的用法,更多检查的策略和配置,大家可以查看官网的介绍。

https://pylint.readthedocs.io/en/latest/

https://flake8.pycqa.org/en/latest/

版权声明


相关文章:

  • 网页系统升级中每天自动更新2024-11-29 10:30:01
  • log4net appender2024-11-29 10:30:01
  • java匿名类和匿名内部类2024-11-29 10:30:01
  • rrt算法优缺点2024-11-29 10:30:01
  • 串口调试助手官网2024-11-29 10:30:01
  • openapi工具2024-11-29 10:30:01
  • html中框架的用法2024-11-29 10:30:01
  • 适配器模式的概念2024-11-29 10:30:01
  • 左连接sql语句简单写法2024-11-29 10:30:01
  • 系统封装后怎么备份2024-11-29 10:30:01