怎样提高代码的质量、安全性和可维护性,本文作者推荐了五款工具,并从四个方面对其进行量化。并且,他还介绍了怎样将这些工具整进 CI pipeline。

为提高代码的质量、安全性和可维护性,软件工程师每天会用到无数工具。本篇文章,我列出了一些自己最喜欢的 python 工具,并从易用性(是否易于安装、运行和自动化)、质量影响(能否阻止可预见的 bug)、可维护性影响(是否让工作更轻松)和安全性影响(能否发现并阻止安全性问题)对它们进行打分,以供读者参考。

并且,我还将介绍如何将这些工具全包含进 CI pipeline,从而实现自动化和高效。

1. Pipenv

它是为 Python 设计的开发管理和依赖管理的工具,最早由 Requests 的作者 Kenneth Reitz 编写。

如果你用 python 做过一段时间的开发,那么管理环境,你可能用过 virtualenv 或 venv;依赖管理可能用过较可靠的pip freeze > requirements.txt。

https://virtualenv.pypa.io/en/latest/

https://docs.python.org/3/library/venv.html

大多数情况下,这完全没问题。但是,我发现 pipenv 更方便,且很强大,加上它通过Pipfile和Pipfile.lock近乎去掉固定依赖的做法,很大程度上替代了requirements.txt,从而带来更可靠的部署。

不过,我对 pipenv 的未来有点担忧,因为 Python 基金会已搁置对 pip 的改进。而且,pipenv 在 2019 年缺乏实质性进展。但是,我仍然认为,对大多数 python 用户来说,pipenv 是绝佳的工具。

官网:https://pipenv.kennethreitz.org/en/latest/

月下载量:2111976

备选方案:poetry、virtualenv、venv

2. Ochrona

这里,我有点私心,因为 Ochrona 是我积极开发并希望 2020 年发布的工具。不过,我还会介绍这个工具的替代方案。

Ochrona 是一款依赖分析和软件组成分析的工具,它可以用来检查你的开源依赖是否存在已知漏洞。这个领域,另一款很流行的开源工具是 pyup.io 的 Safety。

https://pyup.io/safety/

我认为,Ochrona 比 Safety 更好的地方在于:

无论是用于开源项目还是商业项目,它都提供免费方案,而且免费方案始终跟进最新的漏洞信息。

磁盘和 IO 使用非常少。不同于需要拉取整个漏洞数据库的本地工具,它是 SaaS 模式,只需调用一次公开的 API。

它提供优秀的漏洞数据并且每天更新,并比其他工具提供更多的漏洞详细信息,包括免费用户。

官网:https://ochrona.dev/

月下载量:尚未发布

备选方案:safety、snyk (收费)

3. Bandit

如果必须推荐一个可提高 python 项目安全性的工具,那我推荐 Bandit 。

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

据悉,Bandit 出自 OpenStack,但现在由 PyCQA 维护。它是一款开源的 SAST(静态应用安全测试)工具,免费、可配置且快速。从某些方面来讲,它就像是关注安全领域的 linter。

Bandit 很适合用来发现问题,比如不安全的配置、已知的不安全模块使用情况等。

官网:https://github.com/PyCQA/bandit

月下载量:575101

备选方案:pyre、pyt、dodgy

4. Black

Black 是一款独特的代码格式化工具。它能自动将你的代码更正为 Black 样式(一个 Pep-8 的超集)。

传统的 linter 通常需要你把代码改为合规代码,而 Black 可以节省不少时间。并且,Black 只需有限的配置,这意味着你如果用过 Black,其他任何项目你都会觉得眼熟。

官网:https://github.com/psf/black

月下载量:1891711

备选方案:flake8、pylint

5. Mypy

它是 python 一个可选的静态类型检查器。PEP 484 引入 python 的类型提示,Mypy 则利用这些类型提示对项目进行静态类型检查。

Python 依然有动态的 duck 类型,不过,添加静态类型检查能帮你减少测试和调试时间,更早发现错误。

目前,大公司也在跟进 python 的静态类型检查。在 Guido van Rossum 任职期间,Dropbox 用 Mypy 检查了 400 多万行代码。其他的 python 用户,比如 instagram 也开始做静态类型检查。

官网:http://mypy-lang.org/

月下载量:2487228

备选方案:pyre

https://pyre-check.org/

6. 全部集成到一起

这个例子种,我会用到 Travis-CI,配置其他 CI 工具的过程与之类似相似,只是语法上会有差异。这里,我用一个简单、不安全且有问题的 flask 应用作为例子。

https://travis-ci.com/

app.py文件如下:

from flaskimportFlask

app = Flask(__name__)

@app.route('/')

def hello_world(name: str) -> str:

returnhello_name(name)

def hello_name(name: str) -> int:

returnf"hello, {name}"

if__name__ =='__main__':

app.run(debug=True)

Pipfile如下:

[[source]]

name = "pypi"

url = "https://pypi.org/simple"

verify_ssl = true

[dev-packages]

bandit = "*"

v = {editable = true,version ="*"}

black = "*"

mypy = "*"

ochrona = "*"

[packages]

flask = "==0.12.2"

[requires]

python_version = "3.7"

最后在根目录下创建一个.travis.yml文件,内容如下:

language: python

python:

- 3.7

install:

- pip install -U pip

- pip install pipenv

- pipenv install --dev

script:

- bandit ./*

- black --check .

- ochrona

- mypy .

如果查看这里的构建,你会发现每个工具都标出错误或指出需修改的地方。

https://travis-ci.com/beatsbears/vulnerable_flask/builds/149315498

那么,我们来做一些修正,如这个 PR 所示,构建就可以通过。

https://github.com/beatsbears/vulnerable_flask/pull/2

将 Flask 升级到一个没有已知漏洞的版本

修复类型注释,禁用调试模式,规范格式

虽然这个例子只涉及一个 CI 平台,但其实和集成到其他大多数平台的方法都很相似。

下面是一个总的评分表:

【编辑推荐】

【责任编辑:张燕妮 TEL:(010)68476606】

点赞 0

十大python开发软件-5款开发安全、高质量代码的优秀Python工具相关推荐

  1. 全部python编程语言-编程语言高质量代码的优秀Python工具

    [金融特辑]光大银行科技部DBA女神带你从0到1揭秘MGR 高代码的质量.安全性和可维护性,本文作者推荐了五款工具,并从四个方面对其进行量化.并且,他还介绍了怎样将这些工具整进 CI pipeline ...

  2. 【备注】【C42】《编写高质量代码:改善Python程序的91个建议》PDF

    内容简介: 在通往"Python技术殿堂"的路上,本书将为你编写健壮.优雅.高质量的Python代码提供切实帮助!内容全部由Python编码的实践组成,从基本原则.惯用法.语法.库 ...

  3. 《编写高质量代码:改善Python程序的91个建议》读后感

    编写高质量代码:改善Python程序的91个建议  http://book.douban.com/subject/25910544/ 1.(建议16)is 用于判断两个对象的id是否相等,==才是判断 ...

  4. python编写高质量代码_用 Python 编写干净、可测试、高质量的代码

    用 Python 编写干净.可测试.高质量的代码 Noah Gift 2010 年 12 月 20 日发布 简介 编写软件是人所承担的最复杂的任务之一.AWK 编程语言和 "K and R ...

  5. 中国移动段晓东:锚定算力网络十大技术发展方向,实现算力网络高质量发展...

    近年来,随着5G.人工智能等新一代信息技术的应用普及,数字经济发展速度之快.范围之广.程度之深前所未有.算力作为数字经济的核心生产力,将直接影响数字经济的发展速度,影响社会智能的发展高度.日前,移动L ...

  6. 【Python】使用31条规则编写高质量且美丽的Python代码

    Raymond Hettinger在pycon US 2013 视频,幻灯片上的讲话. 代码示例和直接引用都来自Raymond的演讲.我在这里复制它们是为了我自己的启发和希望别人会发现它们像我一样方便 ...

  7. 编写高质量代码python_编写高质量代码:改善Python程序的91个建议

    领取成功 您已领取成功! 您可以进入Android/iOS/Kindle平台的多看阅读客户端,刷新个人中心的已购列表,即可下载图书,享受精品阅读时光啦! - | 回复不要太快哦~ 回复内容不能为空哦 ...

  8. python hello world程序编写_编写高质量代码 改善Python程序的91个建议

    建议1:理解Pythonic概念 建议2:编写Pythonic代码 建议3:理解Python与C语言的不同之处 建议4:在代码中适当添加注释 建议5:通过适当添加空行使代码布局更为优雅.合理 建议6: ...

  9. 加盟店铺管理门道多,国内十大加盟店管理软件来帮你!

    普通的数据工具.人工管理难以满足连锁店老板们的需求,正所谓"有需求就有市场",随着连锁店.加盟店如雨后春笋般在城市里出现,加盟店软件也越来越多. 究竟哪一款连锁店管理软件,才能满足 ...

最新文章

  1. 在Redhat 5.0 上安装Eclipse 3.6
  2. JavaScript 同源策略
  3. 怎么把文件放在python目录下-python – 如何将文件下载到特定目录?
  4. 用链表和数组实现HASH表,几种碰撞冲突解决方法
  5. ARMA模型的性质 1
  6. linux命令从哪里敲,Linux 笔记本基于“敲打”的命令
  7. GPIB接口的自动测试系统
  8. adminlte java_AdminLTE的使用
  9. 示坡线高程判断_地理示坡线
  10. 京东架构专家分享京东架构之路
  11. java 卫星轨道6根数实现轨道预测
  12. 计算机显示器分辨率,电脑显示器分辨率调多少合适
  13. 计算机芯片级维修包括哪些,计算机芯片级维修1
  14. wps设置默认打开方式
  15. 赛效:WPS文字(Word)插入图片后如何移动图片
  16. kaggle比赛——Jigsaw Rate Severity of Toxic Comments(NLP类型)——分析获奖模型笔记
  17. 2018电子商务证书计算机基础知识,2018银行春招笔试高频考点—常识百科之计算机基础知识...
  18. STM32G0系列将内部FLASH作为EEPROM使用,巧妙编程,可延长Flash擦写寿命上百倍,已用于量产产品。
  19. EXCEL函数VLOOKUP应用详解
  20. 抖音平台多产物代码隔离技术的实践与探索

热门文章

  1. 云服务器木马文件该如何应对,云服务器被入侵如何处理
  2. Android Studio自定义视图无法预览
  3. intel python加速效果初探
  4. 联机事务处理OLTP(on-line transaction processing)和联机分析处理OLAP(On-Line Analytical Processing)...
  5. 性能优化-Bitmap内存管理及优化
  6. 第一章 深入.NET框架
  7. C#字符ASCII码学习经验
  8. silverlight控件打印预览
  9. AnyHand——普通摄像头静态手势识别库
  10. Maven项目pom.xml报错