Django Coding Practices

Django Coding Practices

Application skill for Django official coding style ingest (awesome-guidelines). Generic Python: python-coding-practices. Framework architecture: skills/django-foundation.

Core Principle

Django code reads as one codebase, black-formatted Python, isort import groups, disciplined templates, ordered models, lazy settings in reusable modules, and i18n-ready strings verified by pre-commit.

When to Use / NOT

• Django apps: models, views, forms, templates, tests.
• Contributing to or mirroring django/django conventions in private projects.
• Setting up pre-commit for Django repos.

NOT when:

• Non-Django Python, python-coding-practices.
• ORM/query design, middleware architecture, skills/django-foundation.
• Django admin JavaScript, Django JS style doc (separate).

Workflow

1. Python/imports, black, isort, tests (django-style-python-imports.md).
2. Templates/views, DTL + request (django-style-templates-views.md).
3. Models/settings, field order, choices, lazy settings (django-style-models-settings.md).
4. Misc/verify, i18n, hygiene, pre-commit (django-style-misc-verify.md).

Red Flags

• Unformatted or non-black Python in Django app
• f-strings for translatable user messages
• Complex expressions inside f-string braces
• camelCase model fields or methods
• Meta class before model fields
• Multi-dot relative imports
• Deep import when convenience import exists
• {% load %} before {% extends %}
• {{user}} or {%tag%} spacing violations
• Unnamed {% endblock %} on its own line
• View first parameter not named request
• Import-time settings.FOO in reusable module
• User-visible strings without gettext
• Author name in source file header
• Trailing whitespace in patches
• pre-commit/flake8 failures on changed files

Verification

• pre-commit run on changed files (black, isort, flake8)
• python manage.py test for touched apps
• Template extends/spacing manual or linter check
• Model structure checklist on changed models
• i18n grep on new user-facing strings

References

• awesome-guidelines/references/django-style-learning-note.md
• awesome-guidelines/references/django-style-python-imports.md
• awesome-guidelines/references/django-style-templates-views.md
• awesome-guidelines/references/django-style-models-settings.md
• awesome-guidelines/references/django-style-misc-verify.md

Related skills

• python-coding-practices, PEP 8/Google baseline
• skills/django-foundation, Django framework patterns
• frontend-markup-practices, non-DTL HTML/CSS