Skip to content

Check for filters defined on base filterset classes #730

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

Merged
merged 4 commits into from
Aug 7, 2019
Merged
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
103 changes: 103 additions & 0 deletions graphene_django/filter/tests/test_fields.py
Original file line number Diff line number Diff line change
Expand Up @@ -818,3 +818,106 @@ class Query(ObjectType):
}
"""
)


def test_filter_filterset_based_on_mixin():
class ArticleFilterMixin(FilterSet):
@classmethod
def get_filters(cls):
filters = super(FilterSet, cls).get_filters()
filters.update(
{
"viewer__email__in": django_filters.CharFilter(
method="filter_email_in", field_name="reporter__email__in"
)
}
)

return filters

def filter_email_in(cls, queryset, name, value):
return queryset.filter(**{name: [value]})

class NewArticleFilter(ArticleFilterMixin, ArticleFilter):
pass

class NewReporterNode(DjangoObjectType):
class Meta:
model = Reporter
interfaces = (Node,)

class NewArticleFilterNode(DjangoObjectType):
viewer = Field(NewReporterNode)

class Meta:
model = Article
interfaces = (Node,)
filterset_class = NewArticleFilter

def resolve_viewer(self, info):
return self.reporter

class Query(ObjectType):
all_articles = DjangoFilterConnectionField(NewArticleFilterNode)

reporter_1 = Reporter.objects.create(
first_name="John", last_name="Doe", email="john@doe.com"
)

article_1 = Article.objects.create(
headline="Hello",
reporter=reporter_1,
editor=reporter_1,
pub_date=datetime.now(),
pub_date_time=datetime.now(),
)

reporter_2 = Reporter.objects.create(
first_name="Adam", last_name="Doe", email="adam@doe.com"
)

article_2 = Article.objects.create(
headline="Good Bye",
reporter=reporter_2,
editor=reporter_2,
pub_date=datetime.now(),
pub_date_time=datetime.now(),
)

schema = Schema(query=Query)

query = (
"""
query NodeFilteringQuery {
allArticles(viewer_Email_In: "%s") {
edges {
node {
headline
viewer {
email
}
}
}
}
}
"""
% reporter_1.email
)

expected = {
"allArticles": {
"edges": [
{
"node": {
"headline": article_1.headline,
"viewer": {"email": reporter_1.email},
}
}
]
}
}

result = schema.execute(query)

assert not result.errors
assert result.data == expected
22 changes: 13 additions & 9 deletions graphene_django/filter/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,21 +13,25 @@ def get_filtering_args_from_filterset(filterset_class, type):
args = {}
model = filterset_class._meta.model
for name, filter_field in six.iteritems(filterset_class.base_filters):
form_field = None

if name in filterset_class.declared_filters:
form_field = filter_field.field
else:
field_name = name.split("__", 1)[0]
model_field = model._meta.get_field(field_name)

if hasattr(model_field, "formfield"):
form_field = model_field.formfield(
required=filter_field.extra.get("required", False)
)
if hasattr(model, field_name):
model_field = model._meta.get_field(field_name)

if hasattr(model_field, "formfield"):
form_field = model_field.formfield(
required=filter_field.extra.get("required", False)
)

# Fallback to field defined on filter if we can't get it from the
# model field
if not form_field:
form_field = filter_field.field
# Fallback to field defined on filter if we can't get it from the
# model field
if not form_field:
form_field = filter_field.field

field_type = convert_form_field(form_field).Argument()
field_type.description = filter_field.label
Expand Down