如何检查python3中的代码规范？

  • Z时代
  • 2024-01-10
  • 分类：综合

python

代码规范是检验代码优秀与否的条件之一，毕竟python大神都代码都是让人膜拜的，我们这些基础的小白能把代码写的规范，已经是一件很成功的事情啦。光自己人工筛查代码总是有失误的时候，有的小伙伴问有没有什么工具可以解决这个问题？小编想说，当然有了！而且只要简单的安装就可以省很多事情，下面就为大家具体的解答吧。

 

代码规范检查是项目上线过程中必不可少的一环，在大多数情况下，我们都是把代码提交到代码库再进行静态检查。但是，为什么不从最源头把这个问题解决呢？

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中的代码规范？ 的全部内容， 来源链接： utcz.com/z/529087.html

回到顶部