fixit1 0.1.4

入门

要安装Fixit

pip install fixit

Fixit提供CLI命令。要在现有代码上运行内置的Fixit规则以获取代码质量建议

python -m fixit.cli.run_rules

要应用自动修复到现有代码

python -m fixit.cli.apply_fix

您可以通过我们的教程了解更多关于如何 配置Fixit、构建代码检查规则、测试代码检查规则 的信息。尝试使用我们的 笔记本示例。

进一步阅读

• 大规模静态分析：Instagram的故事。

开发

首先设置并激活一个虚拟环境

git clone git@github.com:Instagram/Fixit.git fixit
cd fixit
python3 -m venv ../fixit-env/  # just an example, put this wherever you want
source ../fixit-env/bin/activate
pip install --upgrade pip  # optional, if you have an old system version of pip
pip install -r requirements.txt -r requirements-dev.txt
# If you're done with the virtualenv, you can leave it by running:
deactivate

我们使用 isort 和 black 来格式化代码。要使更改符合规范，请在根目录下运行以下命令：

tox -e autofix

要运行所有测试，您需要安装 tox 并在根目录下执行以下操作：（使用py37，py38从Python 3.7或3.8中选择版本）

tox -e py38

您还可以通过指定模块来运行单个单元测试，如下所示

tox -e py38 -- fixit.common.tests.test_report

运行特定规则（例如 NoInheritFromObjectRule）的所有测试用例

tox -e py38 -- fixit.tests.NoInheritFromObjectRule

有关运行测试的更多示例，请参阅unittest文档。

我们使用Pyre进行类型检查。为了验证库的类型，请在根目录中执行以下操作

pyre --preserve-pythonpath check

生成文档，请在根目录中执行以下操作

tox -e docs