Taking the O out of ORM.
Project description
Django model utilities for encouraging direct data access instead of unnecessary object overhead. Implemented through compatible method and operator extensions to QuerySets
and Managers
.
The goal is to provide elegant syntactic support for best practices in using Django's ORM. Specifically avoiding the inefficiencies and race conditions associated with always using objects.
Usage
Typical model usage is verbose, inefficient, and incorrect.
book = Book.objects.get(pk=pk)
book.rating = 5.0
book.save()
The correct method is generally supported, but arguably less readable.
Book.objects.filter(pk=pk).update(rating=5.0)
model_values
encourages the better approach with operator support.
Book.objects[pk]['rating'] = 5.0
Similarly for queries:
(book.rating for book in books)
books.values_list('rating', flat=True)
books['rating']
Column-oriented syntax is common in panel data layers, and the greater expressiveness cascades. QuerySets
also support aggregation and conditionals.
books.values_list('rating', flat=True).filter(rating__gt=0)
books['rating'] > 0
books.aggregate(models.Avg('rating'))['rating__avg']
books['rating'].mean()
Managers
provide a variety of efficient primary key based utilities. To enable, instantiate the Manager
in your models. As with any custom Manager
, it doesn't have to be named objects
, but it is designed to be a 100% compatible replacement.
from model_values import Manager
class Book(models.Model):
...
objects = Manager()
F
expressions are also enhanced, and can be used directly without model changes.
from model_values import F
.filter(rating__gt=0, last_modified__range=(start, end))
.filter(F.rating > 0, F.last_modified.range(start, end))
Installation
% pip install django-model-values
Tests
100% branch coverage.
% pytest [--cov]
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for django_model_values-1.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ba6a7454f6a7a0d4c1fdf5526919e91bdcb1c4591cf1afffd096ea5cf08bf4ca |
|
MD5 | 68b87c8114eb3ff6b60f9f0ceeb50998 |
|
BLAKE2b-256 | d7f09a0ad5da75fa28ccd0c4b7d00776ac06631b9a04582c73dd2a416e7a6a27 |