python提供了一些包可以用来format代码,检查代码规范,检查类型标注是否正确等。
1、black
format代码,cd 到对应的目录,执行
black -l 120 .
2、flake8
检查代码规范,执行
flake8 .
3、mypy
检查类型标注,执行
mypy .
如果是在有很多文件的工程里,可以创建Makefile文件,将这些命令包装起来,可以指定有效的目录范围,下列代码规定只对applib/common下的代码生效
SHELL = bash
check: fmt lint
prod_build: install_poetry poetry_build
install_poetry:
@pip install poetry
fmt:
@black applib/common
@isort applib/common
lint:
@flake8 applib/common
@mypy applib/common
poetry_build:
@poetry build
clean:
@rm -rf .pytest_cache .tox bytedmypackage.egg-info
@rm -rf tests/*.pyc tests/__pycache__ .mypy_cache/
@python3 clean_files.py
.PHONY: all check install_poetry fmt lint test clean