json complex backend #321

ferrants · 2019-11-16T04:42:45Z

No description provided.

codecov-io · 2019-11-16T05:29:23Z

Codecov Report

Merging #321 into master will increase coverage by 0.02%.
The diff coverage is 100%.

ferrants · 2019-11-16T05:31:11Z

@philipn , we found the existing Complex Backend to be too annoying to integrate with because of the double encodings and the order of and and or wasn't explicit enough. We are using this in our app instead and thought we could contribute it back.

tests/testapp/urls.py

FlipperPA · 2019-12-13T15:47:45Z

tests/testapp/views.py

@@ -52,6 +52,19 @@ class pagination_class(pagination.PageNumberPagination):
        page_size_query_param = 'page_size'


+class ComplexJsonFilterFieldsUserViewSet(FilterFieldsUserViewSet):


PEP-8 nitpick: ComplexJSONFilterFieldsUserViewSet JSON (and all acronyms) should be capitalized: Note: When using acronyms in CapWords, capitalize all the letters of the acronym. Thus HTTPServerError is better than HttpServerError.

FlipperPA · 2019-12-13T15:48:51Z

This looks fantastic, @ferrants - thank you for the contribution.

@rpkilby - what do you think about this direction? I'm hesitant to use it until it receives your blessing going forward. Thanks!

README.rst

FlipperPA · 2019-12-13T15:50:27Z

rest_framework_filters/backends.py

@@ -94,3 +98,60 @@ def get_filtered_querysets(self, querystrings, request, queryset, view):
        if errors:
            raise ValidationError(errors)
        return querysets
+
+
+class ComplexJsonFilterBackend(RestFrameworkFilterBackend):


ComplexJsonFilterBackend -> ComplexJSONFilterBackend

tests/test_backends.py

FlipperPA · 2019-12-13T19:29:08Z

@ferrants A total nitpick, but one that was pointing out to me on one of my projects recently, so I figured I'd pay it forward! This really looks excellent, I'm hoping for a merge.

rgs258 · 2020-03-26T21:17:21Z

bump

ferrants · 2020-03-26T21:28:56Z

Considering making another package that can be installed that will include this. This repo isn't very active.

FlipperPA · 2020-03-27T13:16:59Z

We'd be happy to help test out and contribute where we can, @ferrants!

softzer0 · 2020-05-07T20:09:41Z

This project is so inactive that even the pip package has older version in it. When this will be merged into the main branch and repository for pip updated, @rpkilby, @philipn, anyone? I need it for my project to properly include it into requirements file.

ferrants · 2020-05-07T20:21:07Z

@Soft0 , you can probably copy the code for the ComplexJSONFilterBackend into your project and it should work. I doubt this will get merged, this project isn't active.

softzer0 · 2020-05-07T20:26:49Z

What a shame. Maybe you should continue on this project from your fork and create a new pip package from it?
My workaround is that I have just specified your repository and branch (git+https://github.com/ferrants/django-rest-framework-filters.git@json-filter) in requirements file.

softzer0 · 2020-05-10T12:46:26Z

Hey @ferrants, it would be really nice if annotation exists along this filter. It would be then the complete solution.
For example, this:

User.objects.annotate(
  foo=Sum(Case(When(
      Q(history__action__name='argle') | Q(history__action__name='bargle'),
      history__since__lte=now,
      history__until__gte=now,
      then=1
  ), output_field=IntegerField()))
)

To be translated from this JSON query:

{
    "foo": {
        "type": "Sum",
        "value": {
            "type": "Case",
            "When": [
                {
                    "and": [
                        {
                            "or": [
                                {
                                    "history__action__name": "argle"
                                },
                                {
                                    "history__action__name": "bargle"
                                }
                            ]
                        },
                        {
                            "history__since__lte": "2020-05-10T09:50:54.018Z",
                            "history__until__gte": "2020-05-10T09:50:54.018Z"
                        }
                    ],
                    "then": 1
                }
            ],
            "output_field": "IntegerField"
        }
    }
}

ferrants · 2020-05-10T18:08:57Z

@Soft0 , looks cool. Maybe you should make a library that would do this.

softzer0 · 2020-05-11T08:50:32Z

Unfortunately I don't have much experience to work on it, that's why I proposed to you. Maybe if it's much needed in the future I would need to knock off some sloppy implementation. Until then I will stick to this and make annotation queries directly in the code of the view.

auvipy

please fix the small merge conflict. the works looks great

pabrrs · 2022-08-05T15:32:28Z

Nice work on this!
Up 👍

ferrants added 9 commits November 15, 2019 21:41

json complex backend

ec90ed2

no string interpolation

cee0727

fixes

deb0a21

handle parsing json

ad0b1ca

fixes

ab5d0a9

fixes

2df4b12

linting fixes

b5191d5

fix code block and indentation

599bc5e

fix long line

73c5661

more comprehensive example

14e1224

ferrants mentioned this pull request Nov 26, 2019

Support nested queries for ComplexFilterBackend #312

Open

fix error with combining other query params and complex one

201c48f

FlipperPA reviewed Dec 13, 2019

View reviewed changes

tests/testapp/urls.py Outdated Show resolved Hide resolved

FlipperPA reviewed Dec 13, 2019

View reviewed changes

README.rst Outdated Show resolved Hide resolved

FlipperPA reviewed Dec 13, 2019

View reviewed changes

tests/test_backends.py Outdated Show resolved Hide resolved

ferrants added 3 commits December 13, 2019 10:17

Json -> JSON

6252a94

Json -> JSON

84a1a5a

Json -> JSON

c51d12e

auvipy suggested changes Oct 7, 2021

View reviewed changes

Merge branch 'master' into json-filter

ad5c2e6

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

json complex backend #321

json complex backend #321

ferrants commented Nov 16, 2019

codecov-io commented Nov 16, 2019

ferrants commented Nov 16, 2019 •

edited

Loading

FlipperPA Dec 13, 2019

FlipperPA commented Dec 13, 2019

FlipperPA Dec 13, 2019

FlipperPA commented Dec 13, 2019

rgs258 commented Mar 26, 2020

ferrants commented Mar 26, 2020

FlipperPA commented Mar 27, 2020

softzer0 commented May 7, 2020

ferrants commented May 7, 2020

softzer0 commented May 7, 2020 •

edited

Loading

softzer0 commented May 10, 2020 •

edited

Loading

ferrants commented May 10, 2020

softzer0 commented May 11, 2020

auvipy left a comment

pabrrs commented Aug 5, 2022

		@@ -52,6 +52,19 @@ class pagination_class(pagination.PageNumberPagination):
		page_size_query_param = 'page_size'


		class ComplexJsonFilterFieldsUserViewSet(FilterFieldsUserViewSet):

json complex backend #321

Are you sure you want to change the base?

json complex backend #321

Conversation

ferrants commented Nov 16, 2019

codecov-io commented Nov 16, 2019

Codecov Report

ferrants commented Nov 16, 2019 • edited Loading

FlipperPA Dec 13, 2019

Choose a reason for hiding this comment

FlipperPA commented Dec 13, 2019

FlipperPA Dec 13, 2019

Choose a reason for hiding this comment

FlipperPA commented Dec 13, 2019

rgs258 commented Mar 26, 2020

ferrants commented Mar 26, 2020

FlipperPA commented Mar 27, 2020

softzer0 commented May 7, 2020

ferrants commented May 7, 2020

softzer0 commented May 7, 2020 • edited Loading

softzer0 commented May 10, 2020 • edited Loading

ferrants commented May 10, 2020

softzer0 commented May 11, 2020

auvipy left a comment

Choose a reason for hiding this comment

pabrrs commented Aug 5, 2022

ferrants commented Nov 16, 2019 •

edited

Loading

softzer0 commented May 7, 2020 •

edited

Loading

softzer0 commented May 10, 2020 •

edited

Loading