code inspection tool

Python is good everywhere, but too much indentation and too much nesting can easily cause syntax errors that are difficult to check, so we need a static checking software

Here introduces a static check tool: flake8.

Introduction to flake8

It is a wrapper for the following three tools:

PyFlakes: python source code check: redundant import; duplicate function definition; variable name conflict...

Pep8: Code Style Check

Ned Batchelder's McCabe script: Code Complexity Check

Three functions:

Python code style check, so that the project meets a good code style, and it is easy to find problems.

Some basic code checks.

git integration

flake8 use

Install: pip install flake8

Check: flake8 [python source directory or file]

Ignore rule contact, there are two main ways:

Ignore the static check of the entire file, add a comment: # flake8: noqa

Ignore certain errors, you can modify setup.cfg (eg ignore E265 rules):

[flake8]

ignore = E265

git integration: The flake8 check is automatically done before git commits, and the commit can only be done after the check is successful. Under the local git branch, perform the following two steps:

- flake8 --install-hook

- git config flake8.strict true

The principle of flake8 git integration: bury git hooks. (.git/hooks/pre-commit)

Other tools

pylint: The rules are relatively dead, and a lot of errors will be produced. It is difficult to ensure that there are no errors. It is not suitable for our project.

pycharm: comes with pep8, pyflake check, and can also integrate flake8. Recommended editor

Radon: Complexity Check.