Skip to main content

Chain together multiple (disparate) QuerySets to treat them as a single QuerySet.

Project description

https://img.shields.io/pypi/v/django-querysetsequence.svg https://github.com/clokep/django-querysetsequence/actions/workflows/main.yml/badge.svg Documentation Status

django-querysetsequence adds helpers for treating multiple disparate QuerySet obejcts as a single QuerySet. This is useful for passing into APIs that only accepted a single QuerySet.

The QuerySetSequence wrapper is used to combine multiple QuerySet instances.

Overview

QuerySetSequence aims to provide the same behavior as Django’s QuerySets, but applied across multiple QuerySet instances.

Supported features:

  • Methods that take a list of fields (e.g. filter(), exclude(), get(), order_by()) must use fields that are common across all sub-QuerySets.

  • Relationships across related models work (e.g. 'foo__bar', 'foo', or 'foo_id'). syntax).

  • The sub-QuerySets are evaluated as late as possible (e.g. during iteration, slicing, pickling, repr()/len()/list()/bool() calls).

  • Public QuerySet API methods that are untested/unimplemented raise NotImplementedError.

Getting Started

Install the package using pip.

pip install --upgrade django-querysetsequence

Basic Usage

# Import QuerySetSequence
from queryset_sequence import QuerySetSequence

# Create QuerySets you want to chain.
from .models import SomeModel, OtherModel

# Chain them together.
query = QuerySetSequence(SomeModel.objects.all(), OtherModel.objects.all())

# Use query as if it were a QuerySet! E.g. in a ListView.

Project Information

django-querysetsequence is released under the ISC license, its documentation lives on Read the Docs, the code on GitHub, and the latest release on PyPI. It supports Python 3.9+, Django 4.2/5.1/5.2, and is optionally compatible with Django REST Framework 3.11+.

Some ways that you can contribute:

  • Check for open issues or open a fresh issue to start a discussion around a feature idea or a bug.

  • Fork the repository on GitHub to start making your changes.

  • Write a test which shows that the bug was fixed or that the feature works as expected.

  • Send a pull request and bug the maintainer until it gets merged and published.

Project details


Download files

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

Source Distribution

django_querysetsequence-0.18.tar.gz (30.4 kB view details)

Uploaded Source

Built Distribution

django_querysetsequence-0.18-py3-none-any.whl (16.3 kB view details)

Uploaded Python 3

File details

Details for the file django_querysetsequence-0.18.tar.gz.

File metadata

  • Download URL: django_querysetsequence-0.18.tar.gz
  • Upload date:
  • Size: 30.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for django_querysetsequence-0.18.tar.gz
Algorithm Hash digest
SHA256 008435bd44cf291de21238d26efda4a14f4dcb5f01adb19da8339f634f3a9338
MD5 2e5f93146a2fe8d75863f67cc8211bab
BLAKE2b-256 cef622906bc0d74b17bd8203e7038b1159f8b228426a3ad24b0912388dcf980e

See more details on using hashes here.

File details

Details for the file django_querysetsequence-0.18-py3-none-any.whl.

File metadata

File hashes

Hashes for django_querysetsequence-0.18-py3-none-any.whl
Algorithm Hash digest
SHA256 8e63956ecb272430cb5d302179b4baa1361f11078eba9f1d45f37227d691676e
MD5 316540a923ac9c98fbc951cade5ca6cd
BLAKE2b-256 effc57279c6ec7046b25cc09f4920c0322c9fc14f6aa7797623ae6a3ec807cd8

See more details on using hashes here.

Supported by

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