Plugin to catch bad style specific to Django Projects
Project description
flake8-django
A flake8 plugin for Django projects.
Installation
Install from pip with:
$ pip install flake8-django
Testing
flake8-django uses pytest for tests. To run them use:
$ pytest
Run coverage report using:
$ pytest --cov=.
List of warnings
Warning | Description |
---|---|
DJ01 |
Using null=True is not recommended for some of the Django ORM fields. E.g. CharField , EmailField , ImageField , FileField , UUIDField , SlugField , TextField |
DJ03 |
Using locals() in render function is not recommended, use explicit arguments |
DJ05 |
URLs include() should set a namespace |
DJ06 |
ModelForm should not set exclude, instead it should use fields, which is an explicit list of all the fields that should be included in the form |
DJ07 |
ModelForm.Meta should not set fields to __all__ |
DJ08 |
Models that inherits from django db models should set __str__ |
DJ09 |
Model must define class Meta |
DJ10 |
Class Meta from Model has to define verbose_name |
DJ11 |
Class Meta from Model has to define verbose_name_plural |
DJ12 |
Order of model inner classes and standard methods does not follow Django style guide |
Licence
GPL
Thanks
@stummjr for teaching me AST, and what I could do with it. His blog is cool.
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
flake8-django-1.0.0.tar.gz
(6.6 kB
view hashes)
Built Distribution
flake8_django-1.0.0-py3.8.egg
(24.4 kB
view hashes)