这篇文章给大家分享的是有关如何检查python3中的代码规范的内容。小编觉得挺实用的,因此分享给大家做个参考。一起跟随小编过来看看吧。
代码规范检查是项目上线过程中必不可少的一环,在大多数情况下,我们都是把代码提交到代码库再进行静态检查。但是,为什么不从最源头把这个问题解决呢?
pre-commit是一款由Python开发的git hooks工具,它能够在合入代码,提交commit时对代码进行规范检查和格式化,这样就能够从根源上解决代码规范的问题,而不是把代码合入到代码库中再统一解决,这样不仅耗时,而且繁琐。
我们下面以Python项目中使用为例进行介绍,但是,它不仅适用于Python,它能够适用于所有编程语言。
安装
pip install pre-commit
配置文件
安装之后需要修改一下配置文件,.pre-commit-config.yaml,
repos: - repo: https://github.com/pre-commit/pre-commit-hooks rev: v2.3.0 hooks: - id: check-yaml - id: end-of-file-fixer - id: trailing-whitespace - repo: https://github.com/psf/black rev: 19.3b0 hooks: - id: black
使用
pre-commit install git commit -m "Add super awesome feature"
提交commit之后就可以看到,它会用到两个工具black和flake8。black我在第七期介绍过这款工具,它是一款高效的代码格式化工具,用于修改代码格式。flake8是一款格式检查工具。
感谢各位的阅读!关于如何检查python3中的代码规范就分享到这里了,希望以上内容可以对大家有一定的帮助,让大家可以学到更多知识。如果觉得文章不错,可以把它分享出去让更多的人看到吧!
免责声明:本站发布的内容(图片、视频和文字)以原创、转载和分享为主,文章观点不代表本网站立场,如果涉及侵权请联系站长邮箱:is@yisu.com进行举报,并提供相关证据,一经查实,将立刻删除涉嫌侵权内容。