Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add status query managers that inherit methods of a custom queryset #487

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion model_utils/models.py
Original file line number Diff line number Diff line change
Expand Up @@ -92,14 +92,18 @@ def add_status_query_managers(sender, **kwargs):

default_manager = sender._meta.default_manager

status_manager_class = QueryManager.from_queryset(
queryset_class=default_manager.get_queryset().__class__,
class_name='{}StatusManager'.format(sender.__name__)
)
for value, display in getattr(sender, 'STATUS', ()):
if _field_exists(sender, value):
raise ImproperlyConfigured(
"StatusModel: Model '%s' has a field named '%s' which "
"conflicts with a status of the same name."
% (sender.__name__, value)
)
sender.add_to_class(value, QueryManager(status=value))
sender.add_to_class(value, status_manager_class(status=value))

sender._meta.default_manager_name = default_manager.name

Expand Down
17 changes: 17 additions & 0 deletions tests/models.py
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,23 @@ class StatusCustomManager(AbstractStatusCustomManager):
title = models.CharField(max_length=50)


class StatusCustomQuerySet(models.QuerySet):
def custom_exists(self):
return self.exists()

def custom_count(self):
return self.count()


class StatusCustomQuerySet(StatusModel):
STATUS = Choices(
("first_choice", _("First choice")),
("second_choice", _("Second choice")),
)

objects = StatusCustomQuerySet.as_manager()


class Post(models.Model):
published = models.BooleanField(default=False)
confirmed = models.BooleanField(default=False)
Expand Down
26 changes: 25 additions & 1 deletion tests/test_models/test_status_model.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,12 @@
from django.test.testcases import TestCase
from freezegun import freeze_time

from tests.models import Status, StatusCustomManager, StatusPlainTuple
from tests.models import (
Status,
StatusCustomManager,
StatusCustomQuerySet,
StatusPlainTuple,
)


class StatusModelTests(TestCase):
Expand Down Expand Up @@ -97,3 +102,22 @@ def test_default_manager_is_not_status_model_generated_ones(self):
# ...and this one equal to 0, because of 2 successive filters of 'first_choice'
# (default manager) and 'second_choice' (explicit filter below).
self.assertEqual(StatusCustomManager._default_manager.filter(status='second_choice').count(), 2)


class StatusModelStatusManagerTests(TestCase):

def test_manager_has_custom_qs_methods(self):
StatusCustomQuerySet.objects.create(status='first_choice')

StatusCustomQuerySet.objects.create(status='second_choice')
StatusCustomQuerySet.objects.create(status='second_choice')

self.assertTrue(StatusCustomQuerySet.first_choice.custom_exists())
self.assertEqual(StatusCustomQuerySet.first_choice.custom_count(), 1)

self.assertTrue(StatusCustomQuerySet.second_choice.custom_exists())
self.assertEqual(StatusCustomQuerySet.second_choice.custom_count(), 2)

def test_manager_class_name(self):
self.assertEqual(StatusCustomQuerySet.first_choice.__class__.__name__, 'StatusCustomQuerySetStatusManager')
self.assertEqual(StatusCustomQuerySet.second_choice.__class__.__name__, 'StatusCustomQuerySetStatusManager')