pyicontract-lint 2.1.4

pyicontract-lint

pyicontract-lint 检查Python代码中用icontract库定义的合约。

执行以下检查

用法

Pyicontract-lint 解析代码并尝试使用 astroid 库 推断导入的模块和函数。因此，在调用 pyicontract-lint 之前，您需要确保导入的模块在您的 PYTHONPATH 中。

设置环境后，使用路径列表作为位置参数调用 pyicontract-lint。

pyicontract-lint \
    /path/to/some/directory/some-file.py \
    /path/to/some/directory/another-file.py

您还可以对目录进行操作。Pyicontract-lint 将递归搜索 *.py 文件（包括子目录）并验证文件。

pyicontract-lint \
    /path/to/some/directory

默认情况下，pyicontract-lint 以详尽且易于阅读的格式输出错误。如果您更喜欢 JSON，请提供 --format 参数。

pyicontract-lint \
    --format json \
    /path/to/some/directory

如果有一个或多个检查失败，则返回码将非零。如果您希望即使有一个或多个检查失败也返回零，则可以指定 --dont_panic 参数。

pyicontract-lint \
    --dont_panic \
    /path/to/some/directory

要禁用文件上的任何 pyicontract-lint 检查，请将单独一行 # pyicontract-lint: disabled 添加到文件中。这在递归检查目录中的文件时很有用，并且希望排除某些文件。

import pathlib
import sys

import icontract_lint

errors = icontract_lint.check_paths(paths=[
    pathlib.Path('/some/directory/file.py'),
    pathlib.Path('/yet/yet/another/directory'),
    pathlib.Path('/another/directory/another_file.py'),
    pathlib.Path('/yet/another/directory'),
])

output_verbose(errors=errors, stream=sys.stdout)

安装

• 使用 pip 安装 pyicontract-lint。

pip3 install pyicontract-lint

开发

• 查看存储库。

• 在存储库根目录中创建虚拟环境

python3 -m venv venv3

• 激活虚拟环境

source venv3/bin/activate

• 安装开发依赖项

pip3 install -e .[dev]

• 我们使用 tox 进行测试和打包发行版。运行

tox

• 我们还提供了一套预提交检查，用于检查和格式化代码。从激活的虚拟环境中带有开发依赖项的本地运行它们。

./precommit.py

• 预提交脚本还可以自动格式化代码

./precommit.py  --overwrite

版本控制

我们遵循 语义版本控制。版本 X.Y.Z 表示

• X 是主要版本（不兼容向后），

• Y 是次要版本（兼容向后），

• Z 是补丁版本（兼容向后错误修复）。