Skip to main content

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

Project description

https://api.travis-ci.com/clokep/django-querysetsequence.svg?branch=main Documentation Status https://coveralls.io/repos/github/clokep/django-querysetsequence/badge.svg?branch=master

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.6+, Django 2.2/3.1/3.2/4.0, and is optionally compatible with Django REST Framework 3.9+.

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.15.tar.gz (28.1 kB view details)

Uploaded Source

Built Distribution

django_querysetsequence-0.15-py3-none-any.whl (30.3 kB view details)

Uploaded Python 3

File details

Details for the file django-querysetsequence-0.15.tar.gz.

File metadata

  • Download URL: django-querysetsequence-0.15.tar.gz
  • Upload date:
  • Size: 28.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for django-querysetsequence-0.15.tar.gz
Algorithm Hash digest
SHA256 19673a13867c58582c7aca343d4d7d84cdfa32a9c89444efd67ab36dd97a9dc9
MD5 ecd9383a86671e791bc331b405941d2c
BLAKE2b-256 96fcf7c22434175da61345227f2b6aed750a643b75d1745053e4c2ad73c69b73

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: django_querysetsequence-0.15-py3-none-any.whl
  • Upload date:
  • Size: 30.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for django_querysetsequence-0.15-py3-none-any.whl
Algorithm Hash digest
SHA256 537997c88dbf79c188951f77c075ded113e579a9402ad22b016a735bbaeb000b
MD5 e77817cc37e0f7234ef42296b42512f2
BLAKE2b-256 9b9c852423dbff0982960eae48e1b47413d4268e0196b30f687ada05944c33a7

See more details on using hashes here.

Provenance

Supported by

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