Skip to main content

Django Utils

CI PyPI version Python versions Documentation

The data__filling dropdown filter open in the Django admin sidebar, listing Avocado, Bacon, Cheddar, Corned Beef and Turkey

Django Utils is a collection of the small Django helpers, admin power-ups and ORM utilities that most projects end up writing themselves: JSON-aware admin filters, encrypted model fields, memory-bounded queryset iteration, resumable management commands, and more. It builds on the Python Utils library. It is by no means a complete collection, but it has served production projects well and keeps growing.

Full documentation, including a "why this over the alternatives" page, is at https://django-utils-2.readthedocs.io/en/latest/.

Requirements

  • Python 3.10+
  • Django 4.2, 5.2, or 6.0

Install

  1. Run pip install django-utils2
  2. Add django_utils to your INSTALLED_APPS

If you want to run the tests, install the tests extra (pip install "django-utils2[tests]") and run pytest.

Quickstart

Filter an admin changelist on a nested JSONField value without writing a custom SimpleListFilter:

from django.contrib import admin
from django_utils.admin.filters import JSONFieldFilterDropdown

from myapp.models import Sandwich


class SandwichAdmin(admin.ModelAdmin):
    list_filter = (
        JSONFieldFilterDropdown.create('data__filling'),
    )


admin.site.register(Sandwich, SandwichAdmin)

A sidebar filter on data['filling'], no JOIN or denormalized column. The quickstart page has two more features like this.

Features

Every feature below has its own page on the docs site, with runnable examples, edge cases, and (for the admin features) screenshots or a live in-browser demo.

  • Admin dropdown / Select2 / JSON filters: dropdown, autocomplete, and JSON sub-path list filters for the changelist sidebar, plus an operator selector (gte, lte, icontains, ...) for typed comparisons. See Select / dropdown / autocomplete filters and Operator filters.
  • JSON widget: a drop-in JSONField admin widget that pretty-prints and validates JSON as you type. See JSON widget.
  • Read-only admin: turn any ModelAdmin into a read-only view: add/change/delete denied for everyone, filtering and search still work. See Read-only admin.
  • Count columns: sortable related-object count columns for list_display, without the N+1 or JOIN fan-out footguns. See Count columns.
  • Admin export: streaming CSV/JSON export actions for the changelist, memory-bounded via queryset_iterator. See Export.
  • Choices: metadata-carrying choices with dict-like access and a real enum.Enum on demand via as_enum(). See Choices.
  • PostgreSQL ENUM field: a CharField backed by a native PostgreSQL ENUM type on Postgres, plain VARCHAR everywhere else, with hand-written migration operations for creating the type and adding values. See PostgreSQL ENUM field.
  • Request/user context (ASGI-safe): access the current request/user from anywhere via contextvars, isolated per asyncio task, unlike thread-local equivalents. See Current request / user (ASGI-safe).
  • Query budgets: catch N+1 regressions in production code paths, not just in tests, with a query-counting context manager/decorator. See Query budgets.
  • Auth helpers: superuser_required/staff_required decorators and a permission_string() builder for has_perm() checks. See Auth helpers.
  • Fetch-Metadata CSRF middleware: defense-in-depth CSRF hardening using the Sec-Fetch-Site header, run alongside (not instead of) Django's own CSRF middleware. See Fetch-Metadata CSRF middleware.
  • Subquery aggregates: SubqueryCount/SubquerySum/SubqueryAvg/... annotate each aggregate in its own subquery, avoiding the JOIN fan-out that multiplies counts. See Subquery aggregates.
  • Bulk upsert: bulk_update_or_create(): one INSERT ... ON CONFLICT DO UPDATE batch instead of a racy, two-query-per-row loop. See Bulk upsert.
  • Chunked management commands: ChunkedCommand: memory-bounded, resumable processing of large querysets with progress logging and a transactional dry-run. See ChunkedCommand.
  • Encrypted model fields: EncryptedCharField/EncryptedTextField/ EncryptedJSONField: Fernet-encrypted values in a plain TEXT column, with key-rotation support. See Encrypted model fields.

Links

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django_utils2-4.1.2.tar.gz (61.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

django_utils2-4.1.2-py3-none-any.whl (77.4 kB view details)

Uploaded Python 3

File details

Details for the file django_utils2-4.1.2.tar.gz.

File metadata

  • Download URL: django_utils2-4.1.2.tar.gz
  • Upload date:
  • Size: 61.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for django_utils2-4.1.2.tar.gz
Algorithm Hash digest
SHA256 cd27162027d22f6ee0bb1b87d162de2e0f6dc3c2c6a40e08118fd25b5c6e4269
MD5 05097b7d43d2cd2b136202aab9317af3
BLAKE2b-256 49485331a499a666d84cfa53686aba19ad33a0a019ba720fde40edf03170801d

See more details on using hashes here.

Provenance

The following attestation bundles were made for django_utils2-4.1.2.tar.gz:

Publisher: publish.yml on wolph/django-utils

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file django_utils2-4.1.2-py3-none-any.whl.

File metadata

  • Download URL: django_utils2-4.1.2-py3-none-any.whl
  • Upload date:
  • Size: 77.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for django_utils2-4.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 acdeb39af8ea769770080ed4d4bf136729a8f4437ca8bb9e36799eacdc6dd976
MD5 be7f044c3a48100110b30727137f90a6
BLAKE2b-256 fdeb9ab017cdfc35a80f61494b66d86aefc17cbb04b9aa148a2d315ef66206a6

See more details on using hashes here.

Provenance

The following attestation bundles were made for django_utils2-4.1.2-py3-none-any.whl:

Publisher: publish.yml on wolph/django-utils

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

4.1.2 This release

2 files

4.1.1

2 files

4.1.0

2 files

3.0.2

2 files

3.0.1

2 files

3.0.0

2 files

2.12.1

2 files

2.12.0

2 files

2.11.3

2 files

2.11.2

2 files

2.11.1

2 files

2.11.0

2 files

2.9.0

2 files

2.8.0

2 files

2.7.0

2 files

2.6.0

2 files

2.5.4

2 files

2.5.3

2 files

2.5.2

2 files

2.5.1

2 files

2.5.0

2 files

2.4.0

2 files

2.3.0

2 files

2.2.1

2 files

2.2.0

2 files

2.1.0

1 file

2.0.1

1 file

2.0.0

1 file

1.8.1

1 file

1.8.0

1 file

1.7.1

1 file

1.7.0

1 file

1.6.1

1 file

1.6.0

1 file

1.5.1

1 file

1.1

1 file

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page