Skip to content

Commit 3d30038

Browse files
committed
Merge remote-tracking branch 'upstream/master'
2 parents 75e11a8 + bc59d0a commit 3d30038

File tree

8 files changed

+229
-14
lines changed

8 files changed

+229
-14
lines changed

README.md

-1
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,6 @@ class User(DjangoObjectType):
6767
class Query(graphene.ObjectType):
6868
users = graphene.List(User)
6969

70-
@graphene.resolve_only_args
7170
def resolve_users(self):
7271
return UserModel.objects.all()
7372

docs/authorization.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ This is easy, simply use the ``only_fields`` meta attribute.
3434
only_fields = ('title', 'content')
3535
interfaces = (relay.Node, )
3636
37-
conversely you can use ``exclude_fields`` meta atrribute.
37+
conversely you can use ``exclude_fields`` meta attribute.
3838

3939
.. code:: python
4040

docs/filtering.rst

+20
Original file line numberDiff line numberDiff line change
@@ -126,3 +126,23 @@ create your own ``Filterset`` as follows:
126126
# We specify our custom AnimalFilter using the filterset_class param
127127
all_animals = DjangoFilterConnectionField(AnimalNode,
128128
filterset_class=AnimalFilter)
129+
130+
The context argument is passed on as the `request argument <http://django-filter.readthedocs.io/en/latest/guide/usage.html#request-based-filtering>`__
131+
in a ``django_filters.FilterSet`` instance. You can use this to customize your
132+
filters to be context-dependent. We could modify the ``AnimalFilter`` above to
133+
pre-filter animals owned by the authenticated user (set in ``context.user``).
134+
135+
.. code:: python
136+
137+
class AnimalFilter(django_filters.FilterSet):
138+
# Do case-insensitive lookups on 'name'
139+
name = django_filters.CharFilter(lookup_type='iexact')
140+
141+
class Meta:
142+
model = Animal
143+
fields = ['name', 'genus', 'is_domesticated']
144+
145+
@property
146+
def qs(self):
147+
# The query context can be found in self.request.
148+
return super(AnimalFilter, self).filter(owner=self.request.user)

docs/tutorial-plain.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -445,8 +445,8 @@ We can update our schema to support that, by adding new query for ``ingredient``
445445
return Ingredient.objects.all()
446446
447447
def resolve_category(self, info, **kwargs):
448-
id = kargs.get('id')
449-
name = kargs.get('name')
448+
id = kwargs.get('id')
449+
name = kwargs.get('name')
450450
451451
if id is not None:
452452
return Category.objects.get(pk=id)
@@ -457,8 +457,8 @@ We can update our schema to support that, by adding new query for ``ingredient``
457457
return None
458458
459459
def resolve_ingredient(self, info, **kwargs):
460-
id = kargs.get('id')
461-
name = kargs.get('name')
460+
id = kwargs.get('id')
461+
name = kwargs.get('name')
462462
463463
if id is not None:
464464
return Ingredient.objects.get(pk=id)

graphene_django/filter/fields.py

+5-4
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,8 @@ def filterset_class(self):
4343
def filtering_args(self):
4444
return get_filtering_args_from_filterset(self.filterset_class, self.node_type)
4545

46-
@staticmethod
47-
def merge_querysets(default_queryset, queryset):
46+
@classmethod
47+
def merge_querysets(cls, default_queryset, queryset):
4848
# There could be the case where the default queryset (returned from the filterclass)
4949
# and the resolver queryset have some limits on it.
5050
# We only would be able to apply one of those, but not both
@@ -61,7 +61,7 @@ def merge_querysets(default_queryset, queryset):
6161
low = default_queryset.query.low_mark or queryset.query.low_mark
6262
high = default_queryset.query.high_mark or queryset.query.high_mark
6363
default_queryset.query.clear_limits()
64-
queryset = default_queryset & queryset
64+
queryset = super(cls, cls).merge_querysets(default_queryset, queryset)
6565
queryset.query.set_limits(low, high)
6666
return queryset
6767

@@ -72,7 +72,8 @@ def connection_resolver(cls, resolver, connection, default_manager, max_limit,
7272
filter_kwargs = {k: v for k, v in args.items() if k in filtering_args}
7373
qs = filterset_class(
7474
data=filter_kwargs,
75-
queryset=default_manager.get_queryset()
75+
queryset=default_manager.get_queryset(),
76+
request=context
7677
).qs
7778

7879
return super(DjangoFilterConnectionField, cls).connection_resolver(

graphene_django/filter/tests/test_fields.py

+179-1
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,18 @@
22

33
import pytest
44

5-
from graphene import Field, ObjectType, Schema, Argument, Float
5+
from graphene import Field, ObjectType, Schema, Argument, Float, Boolean, String
66
from graphene.relay import Node
77
from graphene_django import DjangoObjectType
88
from graphene_django.forms import (GlobalIDFormField,
99
GlobalIDMultipleChoiceField)
1010
from graphene_django.tests.models import Article, Pet, Reporter
1111
from graphene_django.utils import DJANGO_FILTER_INSTALLED
1212

13+
# for annotation test
14+
from django.db.models import TextField, Value
15+
from django.db.models.functions import Concat
16+
1317
pytestmark = []
1418

1519
if DJANGO_FILTER_INSTALLED:
@@ -136,6 +140,48 @@ def test_filter_shortcut_filterset_extra_meta():
136140
assert 'headline' not in field.filterset_class.get_fields()
137141

138142

143+
def test_filter_shortcut_filterset_context():
144+
class ArticleContextFilter(django_filters.FilterSet):
145+
146+
class Meta:
147+
model = Article
148+
exclude = set()
149+
150+
@property
151+
def qs(self):
152+
qs = super(ArticleContextFilter, self).qs
153+
return qs.filter(reporter=self.request.reporter)
154+
155+
class Query(ObjectType):
156+
context_articles = DjangoFilterConnectionField(ArticleNode, filterset_class=ArticleContextFilter)
157+
158+
r1 = Reporter.objects.create(first_name='r1', last_name='r1', email='[email protected]')
159+
r2 = Reporter.objects.create(first_name='r2', last_name='r2', email='[email protected]')
160+
Article.objects.create(headline='a1', pub_date=datetime.now(), reporter=r1, editor=r1)
161+
Article.objects.create(headline='a2', pub_date=datetime.now(), reporter=r2, editor=r2)
162+
163+
class context(object):
164+
reporter = r2
165+
166+
query = '''
167+
query {
168+
contextArticles {
169+
edges {
170+
node {
171+
headline
172+
}
173+
}
174+
}
175+
}
176+
'''
177+
schema = Schema(query=Query)
178+
result = schema.execute(query, context_value=context())
179+
assert not result.errors
180+
181+
assert len(result.data['contextArticles']['edges']) == 1
182+
assert result.data['contextArticles']['edges'][0]['node']['headline'] == 'a2'
183+
184+
139185
def test_filter_filterset_information_on_meta():
140186
class ReporterFilterNode(DjangoObjectType):
141187

@@ -534,3 +580,135 @@ def resolve_all_reporters(self, info, **args):
534580
assert str(result.errors[0]) == (
535581
'Received two sliced querysets (high mark) in the connection, please slice only in one.'
536582
)
583+
584+
def test_order_by_is_perserved():
585+
class ReporterType(DjangoObjectType):
586+
class Meta:
587+
model = Reporter
588+
interfaces = (Node, )
589+
filter_fields = ()
590+
591+
class Query(ObjectType):
592+
all_reporters = DjangoFilterConnectionField(ReporterType, reverse_order=Boolean())
593+
594+
def resolve_all_reporters(self, info, reverse_order=False, **args):
595+
reporters = Reporter.objects.order_by('first_name')
596+
597+
if reverse_order:
598+
return reporters.reverse()
599+
600+
return reporters
601+
602+
Reporter.objects.create(
603+
first_name='b',
604+
)
605+
r = Reporter.objects.create(
606+
first_name='a',
607+
)
608+
609+
schema = Schema(query=Query)
610+
query = '''
611+
query NodeFilteringQuery {
612+
allReporters(first: 1) {
613+
edges {
614+
node {
615+
firstName
616+
}
617+
}
618+
}
619+
}
620+
'''
621+
expected = {
622+
'allReporters': {
623+
'edges': [{
624+
'node': {
625+
'firstName': 'a',
626+
}
627+
}]
628+
}
629+
}
630+
631+
result = schema.execute(query)
632+
assert not result.errors
633+
assert result.data == expected
634+
635+
636+
reverse_query = '''
637+
query NodeFilteringQuery {
638+
allReporters(first: 1, reverseOrder: true) {
639+
edges {
640+
node {
641+
firstName
642+
}
643+
}
644+
}
645+
}
646+
'''
647+
648+
reverse_expected = {
649+
'allReporters': {
650+
'edges': [{
651+
'node': {
652+
'firstName': 'b',
653+
}
654+
}]
655+
}
656+
}
657+
658+
reverse_result = schema.execute(reverse_query)
659+
660+
assert not reverse_result.errors
661+
assert reverse_result.data == reverse_expected
662+
663+
def test_annotation_is_perserved():
664+
class ReporterType(DjangoObjectType):
665+
full_name = String()
666+
667+
def resolve_full_name(instance, info, **args):
668+
return instance.full_name
669+
670+
class Meta:
671+
model = Reporter
672+
interfaces = (Node, )
673+
filter_fields = ()
674+
675+
class Query(ObjectType):
676+
all_reporters = DjangoFilterConnectionField(ReporterType)
677+
678+
def resolve_all_reporters(self, info, **args):
679+
return Reporter.objects.annotate(
680+
full_name=Concat('first_name', Value(' '), 'last_name', output_field=TextField())
681+
)
682+
683+
Reporter.objects.create(
684+
first_name='John',
685+
last_name='Doe',
686+
)
687+
688+
schema = Schema(query=Query)
689+
690+
query = '''
691+
query NodeFilteringQuery {
692+
allReporters(first: 1) {
693+
edges {
694+
node {
695+
fullName
696+
}
697+
}
698+
}
699+
}
700+
'''
701+
expected = {
702+
'allReporters': {
703+
'edges': [{
704+
'node': {
705+
'fullName': 'John Doe',
706+
}
707+
}]
708+
}
709+
}
710+
711+
result = schema.execute(query)
712+
713+
assert not result.errors
714+
assert result.data == expected

graphene_django/tests/test_types.py

+14-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
from mock import patch
22

3-
from graphene import Interface, ObjectType, Schema
3+
from graphene import Interface, ObjectType, Schema, Connection, String
44
from graphene.relay import Node
55

66
from .. import registry
@@ -17,11 +17,23 @@ class Meta:
1717
model = ReporterModel
1818

1919

20+
class ArticleConnection(Connection):
21+
'''Article Connection'''
22+
test = String()
23+
24+
def resolve_test():
25+
return 'test'
26+
27+
class Meta:
28+
abstract = True
29+
30+
2031
class Article(DjangoObjectType):
2132
'''Article description'''
2233
class Meta:
2334
model = ArticleModel
2435
interfaces = (Node, )
36+
connection_class = ArticleConnection
2537

2638

2739
class RootQuery(ObjectType):
@@ -74,6 +86,7 @@ def test_schema_representation():
7486
type ArticleConnection {
7587
pageInfo: PageInfo!
7688
edges: [ArticleEdge]!
89+
test: String
7790
}
7891
7992
type ArticleEdge {

graphene_django/types.py

+6-2
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ class DjangoObjectType(ObjectType):
4545
@classmethod
4646
def __init_subclass_with_meta__(cls, model=None, registry=None, skip_registry=False,
4747
only_fields=(), exclude_fields=(), filter_fields=None, connection=None,
48-
use_connection=None, interfaces=(), **options):
48+
connection_class=None, use_connection=None, interfaces=(), **options):
4949
assert is_valid_django_model(model), (
5050
'You need to pass a valid Django Model in {}.Meta, received "{}".'
5151
).format(cls.__name__, model)
@@ -71,7 +71,11 @@ def __init_subclass_with_meta__(cls, model=None, registry=None, skip_registry=Fa
7171

7272
if use_connection and not connection:
7373
# We create the connection automatically
74-
connection = Connection.create_type('{}Connection'.format(cls.__name__), node=cls)
74+
if not connection_class:
75+
connection_class = Connection
76+
77+
connection = connection_class.create_type(
78+
'{}Connection'.format(cls.__name__), node=cls)
7579

7680
if connection is not None:
7781
assert issubclass(connection, Connection), (

0 commit comments

Comments
 (0)