django-filter-stubs

What it is and what it does

django-filter-stubs is a type stub package that adds PEP-484 type annotations for the django-filter library, allowing static type checkers like mypy to understand and validate code that uses django-filter. It acts as a bridge between the untyped django-filter library and Python's static type-checking ecosystem, working alongside mypy, django-stubs, and djangorestframework-stubs to provide type safety for Django filter operations.

However, this package is archived and abandoned as of March 2023. The maintainers explicitly recommend using types-django-filter instead, which is the active successor. Installing this package will provide type stubs but will not receive bug fixes, compatibility updates, or support for newer versions of its dependencies.

Use it for:

• Add type checking to existing Django projects using django-filter without waiting for upstream type support.
• Enable IDE autocomplete and type hints for django-filter QuerySet filtering operations in typed codebases.
• Integrate django-filter into a mypy-checked codebase to catch filter-related type errors at development time.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Provides PEP-484 type stubs for django-filter to enable static type checking with mypy and other type checkers.

No. The package is archived and abandoned; the maintainers recommend types-django-filter as the active replacement. Installing this will provide type stubs but receive no maintenance, bug fixes, or updates. Use types-django-filter instead.

Install

django-filter-stubs on PyPI

pip install django-filter-stubs

uv add django-filter-stubs

poetry add django-filter-stubs

Installing django-filter-stubs

Before you install

Low install friction, but the package is archived and abandoned as of 2023-03-28. The repository is marked archived and the maintainers recommend using types-django-filter instead.

License in practice

MIT license permits commercial and private use with minimal restrictions, though the package's abandoned status means no future license updates or clarifications will be provided.

Quickstart

pip install django-filter-stubs

import django_filter
from mypy import api
# Type checking now available for django-filter code

Package is archived and no longer maintained; types-django-filter is the recommended replacement.

Verify before relying

• Whether types-django-filter provides equivalent or superior type coverage compared to this archived package.
• Compatibility with modern versions of mypy, django-stubs, and djangorestframework-stubs beyond what the fact sheet indicates.

Package facts

Evidence: django_filter_stubs-0.1.3-py3-none-any.whl

Tags

More Quality Assurance packages