Collection of useful checks for Django Checks Framework
Project description
Django Extra Checks
Useful checks for Django Checks Frameworks
Settings
To enable some check define EXTRA_CHECKS
setting with a dict of
checks and its settings, eg:
EXTRA_CHECKS = {
"checks": [
# require non empty `upload_to` argument.
"field-file-upload-to",
# use dict form if check need configuration
# eg. all models must have fk to Site model
{"id": "model-attribute", "attrs": ["site"]},
# require `db_table` for all models, increase level to CRITICAL
{"id": "model-meta-attribute", "attrs": ["db_table"], "level": "CRITICAL"},
]
}
To ignore model warnings you can use ignore_checks
decorator, eg:
from extra_checks import ignore_checks, CheckID
@ignore_checks("model-attribute", "X011", CheckID.X050)
class MyModel(models.Model):
image = models.ImageField()
Checks
- extra-checks-config - settings.EXTRA_CHECKS is valid config for django-extra-checks (always enabled).
- model-attribute - Each Model in the project must have all attributes from
attrs
setting specified. - model-meta-attribute - Each Model.Meta in the project must have all attributes from
attrs
setting specified. - field-file-upload-to - FileField/ImageField must have non empty
upload_to
argument. - field-verbose-name - All model's fields must have verbose name.
- field-verbose-name-gettext - verbose_name must use gettext.
- field-verbose-name-gettext-case - Words in text wrapped with gettext must be in one case.
- field-help-text-gettext - help_text must use gettext.
- field-text-null - text fields shoudn't use
null=True
. - field-null-boolean - prefer using
BooleanField(null=True)
instead ofNullBooleanField
. - field-null-false - don't pass
null=False
to model fields (this is django default). - field-foreign-key-index - ForeignKey fields must specify
db_index
explicitly.
Development
Install dev deps in virtualenv pip install -e .[dev]
.
Credits
The project was built using ideas and code snippets from:
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
django-extra-checks-0.2.0.tar.gz
(16.0 kB
view hashes)
Built Distribution
Close
Hashes for django-extra-checks-0.2.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 96174e4a16239a375ec03efbce1f151ae40e073b9296164e87701bbbfada005e |
|
MD5 | 76a631c01f6673a2819063fcd5cca7cf |
|
BLAKE2b-256 | 8e7c27ebc2fdec90035a68c0b67e3081da62571813dbab88464d5b3e8d07e8c1 |
Close
Hashes for django_extra_checks-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | de136aee387d815d775b46a09898aa54da1a7490fc1d4340e659212381ed1392 |
|
MD5 | 4e557384324f0b8259045aa46bf4a5a8 |
|
BLAKE2b-256 | 3468efb98c37ed1d3e7fcbf0289be04246ae9f999fed9cd9d36700b1f5fdf15c |