flake8-django-on-delete-comment

一个flake8扩展，用于验证django模型中on_delete CASCADE注释的ForeignKey字段。

test_field = models.ForeignKey(  # allowed_cascade
    'TestModel',
    on_delete=models.CASCADE,
)

CASCADE可能不是安全的选择，因此这些字段应该通过注释来标记。

安装

pip install flake8-django-on-delete-comment

示例

样本文件

# test.py

first_field = models.ForeignKey(  # allowed_cascade
    'FirstModel',
    on_delete=models.CASCADE,
)

second_field = models.ForeignKey(
    'SecondModel',
    on_delete=models.CASCADE,
)

third_field = models.ForeignKey(
    'ThirdModel',
    on_delete=models.PROTECT,
)

使用

$ flake8 test.py
test.py:6:1: CD001 field needs a valid comment for on_delete

贡献

我们希望您为我们的项目做出贡献。这很简单

1. 创建一个包含你发现的错误或你提出的建议的问题。等待维护者的批准。
2. 创建一个拉取请求。确保所有检查都是绿色的。
3. 如有必要，修复审查意见。
4. 做到最好。

以下是一些有用的提示

• 你可以使用 make check 运行所有检查和测试。请在CI之前完成此操作。
• 我们使用 BestDoctor Python 风格指南。
• 我们尊重 Django 行为准则。真诚，不要胡说。