├── .coveragerc ├── .gitignore ├── .travis.yml ├── LICENSE ├── README.rst ├── pytest.ini ├── rql_filter ├── __init__.py ├── backend.py └── parser │ ├── Makefile │ ├── __init__.py │ ├── parser.py │ ├── rql.ebnf │ └── semantics.py ├── setup.py └── tests ├── __init__.py ├── api.py ├── base.py ├── fixtures └── test_data.json ├── migrations ├── 0001_initial.py ├── 0002_test_data.py └── __init__.py ├── models.py ├── serializers.py ├── settings.py ├── test_parser.py ├── test_queries.py ├── test_rest_framework.py └── urls.py /.coveragerc: -------------------------------------------------------------------------------- 1 | [run] 2 | omit = 3 | tests/* 4 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .coverage 2 | *.egg-info 3 | *.pyc 4 | .cache 5 | tests/test.db 6 | dist 7 | 8 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | sudo: false 2 | env: 3 | global: 4 | - DJANGO_DEBUG=True 5 | - DJANGO_SETTINGS_MODULE=tests.settings 6 | matrix: 7 | - DJANGO="django>=1.8,<1.9" 8 | - DJANGO="django>=1.9,<1.10" 9 | - DJANGO="django>=1.10,<1.11" 10 | language: python 11 | python: 12 | - '2.7' 13 | install: 14 | - travis_retry pip install $DJANGO 15 | - travis_retry pip install -e .[testing] 16 | script: 17 | - make -C rql_filter/parser 18 | - flake8 . --exclude=parser.py,migrations 19 | - django-admin migrate 20 | - py.test 21 | after_success: 22 | - codecov 23 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | The MIT License (MIT) 2 | 3 | Copyright (c) 2016 Nicolas Joyard 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy of 6 | this software and associated documentation files (the "Software"), to deal in 7 | the Software without restriction, including without limitation the rights to 8 | use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of 9 | the Software, and to permit persons to whom the Software is furnished to do so, 10 | subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS 17 | FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR 18 | COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER 19 | IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN 20 | CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 21 | -------------------------------------------------------------------------------- /README.rst: -------------------------------------------------------------------------------- 1 | django-rql-filter 2 | ================= 3 | 4 | |Build Status| |PyPi version| |codecov| 5 | 6 | This app implements a RQL/RSQL/FIQL filter backend for 7 | `django-rest-framework `__ and 8 | enables passing arbitrary conditional expressions to filter entities. 9 | 10 | Installation 11 | ------------ 12 | 13 | .. code:: sh 14 | 15 | pip install django-rql-filter 16 | 17 | Usage 18 | ----- 19 | 20 | Add ``rql_filter`` to your project ``INSTALLED_APPS``. 21 | 22 | Add the ``RQLFilterBackend`` to your viewset ``filter_backends``: 23 | 24 | .. code:: python 25 | 26 | from rql_filter.backend import RQLFilterBackend 27 | 28 | class ThingyViewSet(viewsets.ReadOnlyModelViewSet): 29 | filter_backends = ( 30 | ... 31 | RQLFilterBackend, 32 | ... 33 | ) 34 | 35 | You may now pass a RQL/RSQL/FIQL query to API URLs using the ``q`` 36 | querystring parameter: 37 | 38 | .. code:: sh 39 | 40 | curl http://my.app/api/thingies/?format=json&q=name==bob;age=gt=30 41 | 42 | Query syntax 43 | ------------ 44 | 45 | A query is made using a combination of field comparisons. Comparisons 46 | are composed by a field name, an operator and a value. 47 | 48 | +-------------------+----------------------------+-----------------------------+ 49 | | Operator | Meaning | Examples | 50 | +===================+============================+=============================+ 51 | | ``==`` | Equal to | ``name==bob`` | 52 | +-------------------+----------------------------+-----------------------------+ 53 | | ``!=`` | Not equal to | ``name!=bob`` | 54 | +-------------------+----------------------------+-----------------------------+ 55 | | ``<`` ``=lt=`` | Less than | ``age<30`` ``age=lt=30`` | 56 | +-------------------+----------------------------+-----------------------------+ 57 | | ``<=`` ``=le=`` | Less than or equal to | ``age<=30`` ``age=le=30`` | 58 | +-------------------+----------------------------+-----------------------------+ 59 | | ``>`` ``=gt=`` | Greater than | ``age>30`` ``age=gt=30`` | 60 | +-------------------+----------------------------+-----------------------------+ 61 | | ``>=`` ``=ge=`` | Greater than or equal to | ``age>=30`` ``age=ge=30`` | 62 | +-------------------+----------------------------+-----------------------------+ 63 | | ``=in=`` | Belongs to set | ``name=in=(bob,kate)`` | 64 | +-------------------+----------------------------+-----------------------------+ 65 | | ``=out=`` | Does not belong to set | ``name=out=(bob,kate)`` | 66 | +-------------------+----------------------------+-----------------------------+ 67 | 68 | Comparisons can traverse model relations by separating field names with 69 | a double underscore: ``father__name==bob``. 70 | 71 | Values must be quoted with single or double quotes when they include 72 | special characters or spaces: ``name=="bob katz"``. 73 | 74 | Comparisons may be combined using logical operators: ``;`` for a logical 75 | AND, and ``,`` for a logical OR: ``name=="bob";age>=30``. AND has 76 | priority over OR; grouping is available using parentheses: 77 | ``name=="bob";(age>=30,age<3)``. 78 | 79 | **Note:** RQL/RSQL/FIQL support is still incomplete, it will be enhanced 80 | over time. 81 | 82 | Configuration 83 | ------------- 84 | 85 | ``RQL_FILTER_QUERY_PARAM`` sets the querystring parameter name to use; 86 | it defaults to ``'q'``. 87 | 88 | Using without rest-framework 89 | ---------------------------- 90 | 91 | You may use the backend manually outside a rest-framework viewset: 92 | 93 | .. code:: python 94 | 95 | from rql_filter.backend import RQLFilterBackend 96 | 97 | # May be reused any number of times 98 | backend = RQLFilterBackend() 99 | 100 | # Fake request object 101 | class FakeRQLRequest: 102 | def __init__(self, q): 103 | self.GET = {'q': q} 104 | 105 | qs = Thingy.objects.all() 106 | filtered_qs = backend.filter_queryset( 107 | FakeRQLRequest('name==bob;age=gt=30'), 108 | qs, 109 | None 110 | ) 111 | 112 | Testing 113 | ------- 114 | 115 | Install testing dependencies: 116 | 117 | .. code:: sh 118 | 119 | pip install -e .[testing] 120 | 121 | Run tests: 122 | 123 | .. code:: sh 124 | 125 | py.test 126 | 127 | .. |Build Status| image:: https://travis-ci.org/njoyard/django-rql-filter.svg?branch=master 128 | :target: https://travis-ci.org/njoyard/django-rql-filter 129 | .. |PyPi version| image:: https://badge.fury.io/py/django-rql-filter.png 130 | :target: https://badge.fury.io/py/django-rql-filter 131 | .. |codecov| image:: https://codecov.io/gh/njoyard/django-rql-filter/branch/master/graph/badge.svg 132 | :target: https://codecov.io/gh/njoyard/django-rql-filter 133 | -------------------------------------------------------------------------------- /pytest.ini: -------------------------------------------------------------------------------- 1 | [pytest] 2 | DJANGO_SETTINGS_MODULE=tests.settings 3 | addopts = --cov=rql_filter --create-db 4 | -------------------------------------------------------------------------------- /rql_filter/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/njoyard/django-rql-filter/0a269c5edefc6ad035d49a0991a01fd26266a951/rql_filter/__init__.py -------------------------------------------------------------------------------- /rql_filter/backend.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | from django.conf import settings 4 | from rest_framework.filters import BaseFilterBackend 5 | 6 | from parser.parser import RQLParser 7 | from parser.semantics import RQLSemantics 8 | 9 | 10 | class RQLFilterBackend(BaseFilterBackend): 11 | """ 12 | Filter that uses a RQL query. 13 | 14 | The RQL query is expected to be passed as a querystring parameter. 15 | The RQL_FILTER_QUERY_PARAM setting (which defaults to 'q') specifies the 16 | name of the querystring parameter used. 17 | """ 18 | 19 | parser = RQLParser(semantics=RQLSemantics(), whitespace='') 20 | query_param = getattr(settings, 'RQL_FILTER_QUERY_PARAM', 'q') 21 | 22 | def filter_queryset(self, request, queryset, view): 23 | qs = queryset 24 | 25 | if self.query_param in request.GET: 26 | if len(request.GET[self.query_param]): 27 | condition = self.parser.parse(request.GET[self.query_param]) 28 | qs = qs.filter(condition) 29 | 30 | return qs 31 | -------------------------------------------------------------------------------- /rql_filter/parser/Makefile: -------------------------------------------------------------------------------- 1 | parser.py: rql.ebnf 2 | grako -o $@ -m RQL $< 3 | -------------------------------------------------------------------------------- /rql_filter/parser/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/njoyard/django-rql-filter/0a269c5edefc6ad035d49a0991a01fd26266a951/rql_filter/parser/__init__.py -------------------------------------------------------------------------------- /rql_filter/parser/parser.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # -*- coding: utf-8 -*- 3 | 4 | # CAVEAT UTILITOR 5 | # 6 | # This file was automatically generated by Grako. 7 | # 8 | # https://pypi.python.org/pypi/grako/ 9 | # 10 | # Any changes you make to it will be overwritten the next time 11 | # the file is generated. 12 | 13 | 14 | from __future__ import print_function, division, absolute_import, unicode_literals 15 | 16 | from grako.buffering import Buffer 17 | from grako.parsing import graken, Parser 18 | from grako.util import re, RE_FLAGS, generic_main # noqa 19 | 20 | 21 | __version__ = (2016, 8, 7, 10, 22, 21, 6) 22 | 23 | __all__ = [ 24 | 'RQLParser', 25 | 'RQLSemantics', 26 | 'main' 27 | ] 28 | 29 | KEYWORDS = set([]) 30 | 31 | 32 | class RQLBuffer(Buffer): 33 | def __init__(self, 34 | text, 35 | whitespace=None, 36 | nameguard=None, 37 | comments_re=None, 38 | eol_comments_re=None, 39 | ignorecase=None, 40 | namechars='', 41 | **kwargs): 42 | super(RQLBuffer, self).__init__( 43 | text, 44 | whitespace=whitespace, 45 | nameguard=nameguard, 46 | comments_re=comments_re, 47 | eol_comments_re=eol_comments_re, 48 | ignorecase=ignorecase, 49 | namechars=namechars, 50 | **kwargs 51 | ) 52 | 53 | 54 | class RQLParser(Parser): 55 | def __init__(self, 56 | whitespace=None, 57 | nameguard=None, 58 | comments_re=None, 59 | eol_comments_re=None, 60 | ignorecase=None, 61 | left_recursion=True, 62 | keywords=KEYWORDS, 63 | namechars='', 64 | **kwargs): 65 | super(RQLParser, self).__init__( 66 | whitespace=whitespace, 67 | nameguard=nameguard, 68 | comments_re=comments_re, 69 | eol_comments_re=eol_comments_re, 70 | ignorecase=ignorecase, 71 | left_recursion=left_recursion, 72 | keywords=keywords, 73 | namechars=namechars, 74 | **kwargs 75 | ) 76 | 77 | def parse(self, text, *args, **kwargs): 78 | if not isinstance(text, Buffer): 79 | text = RQLBuffer(text, **kwargs) 80 | return super(RQLParser, self).parse(text, *args, **kwargs) 81 | 82 | @graken() 83 | def _start_(self): 84 | self._OREXPRESSION_() 85 | self._check_eof() 86 | 87 | @graken() 88 | def _OREXPRESSION_(self): 89 | 90 | def sep0(): 91 | self._token(',') 92 | 93 | def block0(): 94 | self._ANDEXPRESSION_() 95 | self._closure(block0, sep=sep0) 96 | 97 | @graken() 98 | def _ANDEXPRESSION_(self): 99 | 100 | def sep0(): 101 | self._token(';') 102 | 103 | def block0(): 104 | self._CONSTRAINT_() 105 | self._closure(block0, sep=sep0) 106 | 107 | @graken() 108 | def _CONSTRAINT_(self): 109 | with self._choice(): 110 | with self._option(): 111 | self._GROUP_() 112 | with self._option(): 113 | self._COMPARISON_() 114 | self._error('no available options') 115 | 116 | @graken() 117 | def _GROUP_(self): 118 | self._token('(') 119 | self._OREXPRESSION_() 120 | self.name_last_node('@') 121 | self._token(')') 122 | 123 | @graken() 124 | def _COMPARISON_(self): 125 | self._SELECTOR_() 126 | self._OPERATOR_() 127 | self._ARGUMENTS_() 128 | 129 | @graken() 130 | def _SELECTOR_(self): 131 | self._pattern(r'[a-zA-Z_][a-zA-Z0-9_.]*') 132 | 133 | @graken() 134 | def _OPERATOR_(self): 135 | with self._choice(): 136 | with self._option(): 137 | self._FIQLOPERATOR_() 138 | with self._option(): 139 | self._RSQLOPERATOR_() 140 | self._error('no available options') 141 | 142 | @graken() 143 | def _FIQLOPERATOR_(self): 144 | with self._choice(): 145 | with self._option(): 146 | self._token('==') 147 | with self._option(): 148 | self._token('!=') 149 | with self._option(): 150 | self._token('=lt=') 151 | with self._option(): 152 | self._token('=gt=') 153 | with self._option(): 154 | self._token('=le=') 155 | with self._option(): 156 | self._token('=ge=') 157 | with self._option(): 158 | self._token('=in=') 159 | with self._option(): 160 | self._token('=out=') 161 | self._error('expecting one of: != == =ge= =gt= =in= =le= =lt= =out=') 162 | 163 | @graken() 164 | def _RSQLOPERATOR_(self): 165 | with self._choice(): 166 | with self._option(): 167 | self._token('<=') 168 | with self._option(): 169 | self._token('>=') 170 | with self._option(): 171 | self._token('<') 172 | with self._option(): 173 | self._token('>') 174 | self._error('expecting one of: < <= > >=') 175 | 176 | @graken() 177 | def _ARGUMENTS_(self): 178 | with self._choice(): 179 | with self._option(): 180 | self._VALUELIST_() 181 | with self._option(): 182 | self._VALUE_() 183 | self._error('no available options') 184 | 185 | @graken() 186 | def _VALUELIST_(self): 187 | self._token('(') 188 | 189 | def sep1(): 190 | self._token(',') 191 | 192 | def block1(): 193 | self._VALUE_() 194 | self._closure(block1, sep=sep1) 195 | self.name_last_node('@') 196 | self._token(')') 197 | 198 | @graken() 199 | def _VALUE_(self): 200 | with self._choice(): 201 | with self._option(): 202 | self._UNRESERVED_() 203 | with self._option(): 204 | self._SINGLEQUOTED_() 205 | with self._option(): 206 | self._DOUBLEQUOTED_() 207 | self._error('no available options') 208 | 209 | @graken() 210 | def _UNRESERVED_(self): 211 | self._pattern(r'[^\"\'();,=!~<> ]+') 212 | 213 | @graken() 214 | def _SINGLEQUOTED_(self): 215 | self._token("'") 216 | self._SINGLEQUOTEDCHARS_() 217 | self.name_last_node('@') 218 | self._token("'") 219 | 220 | @graken() 221 | def _SINGLEQUOTEDCHARS_(self): 222 | self._pattern(r"([^\\']|\\')*") 223 | 224 | @graken() 225 | def _DOUBLEQUOTED_(self): 226 | self._token('"') 227 | self._DOUBLEQUOTEDCHARS_() 228 | self.name_last_node('@') 229 | self._token('"') 230 | 231 | @graken() 232 | def _DOUBLEQUOTEDCHARS_(self): 233 | self._pattern(r'([^\\"]|\\")*') 234 | 235 | 236 | class RQLSemantics(object): 237 | def start(self, ast): 238 | return ast 239 | 240 | def OREXPRESSION(self, ast): 241 | return ast 242 | 243 | def ANDEXPRESSION(self, ast): 244 | return ast 245 | 246 | def CONSTRAINT(self, ast): 247 | return ast 248 | 249 | def GROUP(self, ast): 250 | return ast 251 | 252 | def COMPARISON(self, ast): 253 | return ast 254 | 255 | def SELECTOR(self, ast): 256 | return ast 257 | 258 | def OPERATOR(self, ast): 259 | return ast 260 | 261 | def FIQLOPERATOR(self, ast): 262 | return ast 263 | 264 | def RSQLOPERATOR(self, ast): 265 | return ast 266 | 267 | def ARGUMENTS(self, ast): 268 | return ast 269 | 270 | def VALUELIST(self, ast): 271 | return ast 272 | 273 | def VALUE(self, ast): 274 | return ast 275 | 276 | def UNRESERVED(self, ast): 277 | return ast 278 | 279 | def SINGLEQUOTED(self, ast): 280 | return ast 281 | 282 | def SINGLEQUOTEDCHARS(self, ast): 283 | return ast 284 | 285 | def DOUBLEQUOTED(self, ast): 286 | return ast 287 | 288 | def DOUBLEQUOTEDCHARS(self, ast): 289 | return ast 290 | 291 | 292 | def main( 293 | filename, 294 | startrule, 295 | trace=False, 296 | whitespace=None, 297 | nameguard=None, 298 | comments_re=None, 299 | eol_comments_re=None, 300 | ignorecase=None, 301 | left_recursion=True, 302 | **kwargs): 303 | 304 | with open(filename) as f: 305 | text = f.read() 306 | whitespace = whitespace or None 307 | parser = RQLParser(parseinfo=False) 308 | ast = parser.parse( 309 | text, 310 | startrule, 311 | filename=filename, 312 | trace=trace, 313 | whitespace=whitespace, 314 | nameguard=nameguard, 315 | ignorecase=ignorecase, 316 | **kwargs) 317 | return ast 318 | 319 | if __name__ == '__main__': 320 | import json 321 | ast = generic_main(main, RQLParser, name='RQL') 322 | print('AST:') 323 | print(ast) 324 | print() 325 | print('JSON:') 326 | print(json.dumps(ast, indent=2)) 327 | print() 328 | -------------------------------------------------------------------------------- /rql_filter/parser/rql.ebnf: -------------------------------------------------------------------------------- 1 | (* 2 | * Grako EBNF grammar for RQL 3 | * 4 | * Whitespace is forbidden in RQL (except in values), so all rules 5 | * are uppercased. 6 | *) 7 | 8 | start = 9 | OREXPRESSION $ 10 | ; 11 | 12 | OREXPRESSION = 13 | ','.{ ANDEXPRESSION } 14 | ; 15 | 16 | ANDEXPRESSION = 17 | ';'.{ CONSTRAINT } 18 | ; 19 | 20 | CONSTRAINT = 21 | GROUP | COMPARISON 22 | ; 23 | 24 | GROUP = 25 | '(' @:OREXPRESSION ')' 26 | ; 27 | 28 | COMPARISON = 29 | SELECTOR OPERATOR ARGUMENTS 30 | ; 31 | 32 | SELECTOR = 33 | /[a-zA-Z_][a-zA-Z0-9_.]*/ 34 | ; 35 | 36 | OPERATOR = 37 | FIQLOPERATOR | RSQLOPERATOR 38 | ; 39 | 40 | FIQLOPERATOR = 41 | '==' | '!=' | '=lt=' | '=gt=' | '=le=' | '=ge=' | '=in=' | '=out=' 42 | ; 43 | 44 | RSQLOPERATOR = 45 | '<=' | '>=' | '<' | '>' 46 | ; 47 | 48 | ARGUMENTS = 49 | VALUELIST | VALUE 50 | ; 51 | 52 | VALUELIST = 53 | '(' @:','.{ VALUE } ')' 54 | ; 55 | 56 | VALUE = 57 | UNRESERVED | SINGLEQUOTED | DOUBLEQUOTED 58 | ; 59 | 60 | UNRESERVED = 61 | /[^\"'();,=!~<> ]+/ 62 | ; 63 | 64 | SINGLEQUOTED = 65 | "'" @:SINGLEQUOTEDCHARS "'" 66 | ; 67 | 68 | SINGLEQUOTEDCHARS = 69 | /([^\\']|\\')*/ 70 | ; 71 | 72 | DOUBLEQUOTED = 73 | '"' @:DOUBLEQUOTEDCHARS '"' 74 | ; 75 | 76 | DOUBLEQUOTEDCHARS = 77 | /([^\\"]|\\")*/ 78 | ; 79 | -------------------------------------------------------------------------------- /rql_filter/parser/semantics.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | 3 | from django.db.models import Q 4 | 5 | 6 | class RQLSemantics: 7 | 8 | OPERATORS = { 9 | '==': 'eq', 10 | '!=': 'ne', 11 | '=ne=': 'ne', 12 | '<=': 'lte', 13 | '=le=': 'lte', 14 | '<': 'lt', 15 | '=lt=': 'lt', 16 | '>=': 'gte', 17 | '=ge=': 'gte', 18 | '>': 'gt', 19 | '=gt=': 'gt', 20 | '=in=': 'in', 21 | '=out=': 'out', 22 | } 23 | 24 | def _default(self, ast): 25 | return ast 26 | 27 | def OREXPRESSION(self, ast): 28 | return reduce(lambda a, b: a | b, ast) 29 | 30 | def ANDEXPRESSION(self, ast): 31 | return reduce(lambda a, b: a & b, ast) 32 | 33 | def COMPARISON(self, ast): 34 | field, operator, value = ast 35 | operator = self.OPERATORS[operator] 36 | negate = False 37 | 38 | if operator == 'out': 39 | operator = 'in' 40 | negate = True 41 | elif operator == 'ne': 42 | operator = 'eq' 43 | negate = True 44 | 45 | if operator != 'eq': 46 | field = '%s__%s' % (field, operator) 47 | 48 | q = Q(**{field: value}) 49 | 50 | if negate: 51 | q = ~q 52 | 53 | return q 54 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | import os 2 | from setuptools import setup 3 | 4 | 5 | def read(fname): 6 | return open(os.path.join(os.path.dirname(__file__), fname)).read() 7 | 8 | 9 | setup( 10 | name="django-rql-filter", 11 | version="0.1.3", 12 | author="Nicolas Joyard", 13 | author_email="joyard.nicolas@gmail.com", 14 | description=("A RQL-enabled filter backend for django-rest-framework"), 15 | license="MIT", 16 | keywords="django filter drf rest rql rsql fiql", 17 | url="https://github.com/njoyard/django-rql-filter", 18 | packages=[ 19 | 'rql_filter', 20 | 'rql_filter.parser' 21 | ], 22 | long_description=read('README.rst'), 23 | install_requires=[ 24 | 'djangorestframework>=3,<4', 25 | 'grako>=3.12,<3.13', 26 | ], 27 | extras_require={ 28 | 'testing': [ 29 | 'codecov>=2,<3', 30 | 'django-responsediff>=0.6,<0.7', 31 | 'flake8>=2,<3', 32 | 'pytest>=2,<3', 33 | 'pytest-cov>=2,<3', 34 | 'pytest-django>=2,<3', 35 | ] 36 | }, 37 | classifiers=[ 38 | "Development Status :: 3 - Alpha", 39 | "Framework :: Django", 40 | "Intended Audience :: Developers", 41 | "License :: OSI Approved :: MIT License", 42 | ], 43 | ) 44 | -------------------------------------------------------------------------------- /tests/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/njoyard/django-rql-filter/0a269c5edefc6ad035d49a0991a01fd26266a951/tests/__init__.py -------------------------------------------------------------------------------- /tests/api.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | from rest_framework import viewsets 4 | 5 | from rql_filter.backend import RQLFilterBackend 6 | 7 | from .serializers import ChildSerializer 8 | from .models import Child 9 | 10 | 11 | class ChildViewSet(viewsets.ReadOnlyModelViewSet): 12 | queryset = Child.objects.all() 13 | filter_backends = (RQLFilterBackend,) 14 | serializer_class = ChildSerializer 15 | -------------------------------------------------------------------------------- /tests/base.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | 4 | class RQLTestMixin(object): 5 | def do_rql_query(self, rql): 6 | raise NotImplementedError() 7 | 8 | def assert_rql_result(self, rql, expected_names): 9 | names = sorted([i['name'] for i in self.do_rql_query(rql)]) 10 | assert ', '.join(names) == ', '.join(sorted(expected_names)) 11 | 12 | def test_no_filter(self): 13 | self.assert_rql_result('', ['foo', 'bar', 'baz']) 14 | 15 | def test_eq(self): 16 | self.assert_rql_result('name==foo', ['foo']) 17 | 18 | def test_ne(self): 19 | self.assert_rql_result('name!=foo', ['bar', 'baz']) 20 | 21 | def test_in(self): 22 | self.assert_rql_result('name=in=(bar,baz)', ['bar', 'baz']) 23 | 24 | def test_out(self): 25 | self.assert_rql_result('name=out=(bar,baz)', ['foo']) 26 | 27 | def test_lt(self): 28 | self.assert_rql_result('number=lt=100', ['baz']) 29 | self.assert_rql_result('number<100', ['baz']) 30 | 31 | def test_lte(self): 32 | self.assert_rql_result('number=le=100', ['foo', 'baz']) 33 | self.assert_rql_result('number<=100', ['foo', 'baz']) 34 | 35 | def test_gt(self): 36 | self.assert_rql_result('number=gt=100', ['bar']) 37 | self.assert_rql_result('number>100', ['bar']) 38 | 39 | def test_gte(self): 40 | self.assert_rql_result('number=ge=100', ['foo', 'bar']) 41 | self.assert_rql_result('number>=100', ['foo', 'bar']) 42 | 43 | def test_and(self): 44 | self.assert_rql_result('name==foo;number>=100', ['foo']) 45 | self.assert_rql_result('name==foo;number>=200', []) 46 | 47 | def test_or(self): 48 | self.assert_rql_result('name==foo,number>=100', ['foo', 'bar']) 49 | self.assert_rql_result('name==foo,number>200', ['foo']) 50 | 51 | def test_relation(self): 52 | self.assert_rql_result('parent__name==foo-parent', ['foo', 'bar']) 53 | -------------------------------------------------------------------------------- /tests/fixtures/test_data.json: -------------------------------------------------------------------------------- 1 | [ 2 | { 3 | "fields": { 4 | "name": "foo-parent" 5 | }, 6 | "pk": 1, 7 | "model": "tests.parent" 8 | }, 9 | { 10 | "fields": { 11 | "name": "bar-parent" 12 | }, 13 | "pk": 2, 14 | "model": "tests.parent" 15 | }, 16 | { 17 | "fields": { 18 | "name": "foo", 19 | "number": 100, 20 | "parent": 1 21 | }, 22 | "pk": 1, 23 | "model": "tests.child" 24 | }, 25 | { 26 | "fields": { 27 | "name": "bar", 28 | "number": 200, 29 | "parent": 1 30 | }, 31 | "pk": 2, 32 | "model": "tests.child" 33 | }, 34 | { 35 | "fields": { 36 | "name": "baz", 37 | "number": 0, 38 | "parent": 2 39 | }, 40 | "pk": 3, 41 | "model": "tests.child" 42 | } 43 | ] 44 | -------------------------------------------------------------------------------- /tests/migrations/0001_initial.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | from __future__ import unicode_literals 3 | 4 | from django.db import migrations, models 5 | 6 | 7 | class Migration(migrations.Migration): 8 | 9 | dependencies = [ 10 | ] 11 | 12 | operations = [ 13 | migrations.CreateModel( 14 | name='Child', 15 | fields=[ 16 | ('id', models.AutoField(verbose_name='ID', serialize=False, auto_created=True, primary_key=True)), 17 | ('name', models.CharField(max_length=200)), 18 | ('number', models.IntegerField()), 19 | ], 20 | ), 21 | migrations.CreateModel( 22 | name='Parent', 23 | fields=[ 24 | ('id', models.AutoField(verbose_name='ID', serialize=False, auto_created=True, primary_key=True)), 25 | ('name', models.CharField(max_length=200)), 26 | ], 27 | ), 28 | migrations.AddField( 29 | model_name='child', 30 | name='parent', 31 | field=models.ForeignKey(related_name='children', to='tests.Parent'), 32 | ), 33 | ] 34 | -------------------------------------------------------------------------------- /tests/migrations/0002_test_data.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | import os 4 | 5 | from django.core import serializers 6 | from django.db import migrations 7 | 8 | 9 | fixture_dir = os.path.abspath(os.path.join(os.path.dirname(__file__), 10 | '../fixtures')) 11 | fixture_filename = 'test_data.json' 12 | 13 | 14 | def load_fixture(apps, schema_editor): 15 | fixture_file = os.path.join(fixture_dir, fixture_filename) 16 | 17 | fixture = open(fixture_file, 'rb') 18 | objects = serializers.deserialize('json', fixture, ignorenonexistent=True) 19 | for obj in objects: 20 | obj.save() 21 | fixture.close() 22 | 23 | 24 | class Migration(migrations.Migration): 25 | 26 | dependencies = [ 27 | ('tests', '0001_initial'), 28 | ] 29 | 30 | operations = [ 31 | migrations.RunPython(load_fixture), 32 | ] 33 | -------------------------------------------------------------------------------- /tests/migrations/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/njoyard/django-rql-filter/0a269c5edefc6ad035d49a0991a01fd26266a951/tests/migrations/__init__.py -------------------------------------------------------------------------------- /tests/models.py: -------------------------------------------------------------------------------- 1 | from django.db import models 2 | 3 | 4 | class Parent(models.Model): 5 | name = models.CharField(max_length=200) 6 | 7 | 8 | class Child(models.Model): 9 | name = models.CharField(max_length=200) 10 | number = models.IntegerField() 11 | parent = models.ForeignKey('Parent', related_name='children') 12 | -------------------------------------------------------------------------------- /tests/serializers.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | from rest_framework import serializers 4 | 5 | from .models import Child 6 | 7 | 8 | class ChildSerializer(serializers.ModelSerializer): 9 | 10 | class Meta: 11 | model = Child 12 | fields = ('id', 'name', 'number') 13 | -------------------------------------------------------------------------------- /tests/settings.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | DATABASES = { 4 | 'default': { 5 | 'ENGINE': 'django.db.backends.sqlite3', 6 | 'NAME': ':memory:' 7 | }, 8 | } 9 | 10 | INSTALLED_APPS = ( 11 | # rest framework 12 | 'django.contrib.contenttypes', 13 | 'django.contrib.auth', 14 | 'rest_framework', 15 | 16 | # filter and test project 17 | 'rql_filter', 18 | 'tests', 19 | ) 20 | 21 | SECRET_KEY = 'not_so_secret' 22 | ROOT_URLCONF = 'tests.urls' 23 | -------------------------------------------------------------------------------- /tests/test_parser.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | from django.db.models import Q 4 | 5 | from rql_filter.parser.parser import RQLParser 6 | from rql_filter.parser.semantics import RQLSemantics 7 | 8 | 9 | parser = RQLParser(semantics=RQLSemantics(), whitespace='') 10 | 11 | 12 | def assert_query(rql, qstr): 13 | ast = parser.parse(rql) 14 | assert isinstance(ast, Q) 15 | assert ast.__str__() == qstr 16 | 17 | 18 | def test_fiql_operators(): 19 | assert_query( 20 | "field==value", 21 | "(AND: (u'field', u'value'))" 22 | ) 23 | assert_query( 24 | "field!=value", 25 | "(NOT (AND: (u'field', u'value')))" 26 | ) 27 | assert_query( 28 | "field=le=value", 29 | "(AND: (u'field__lte', u'value'))" 30 | ) 31 | assert_query( 32 | "field=lt=value", 33 | "(AND: (u'field__lt', u'value'))" 34 | ) 35 | assert_query( 36 | "field=ge=value", 37 | "(AND: (u'field__gte', u'value'))" 38 | ) 39 | assert_query( 40 | "field=gt=value", 41 | "(AND: (u'field__gt', u'value'))" 42 | ) 43 | assert_query( 44 | "field=in=value", 45 | "(AND: (u'field__in', u'value'))" 46 | ) 47 | assert_query( 48 | "field=out=value", 49 | "(NOT (AND: (u'field__in', u'value')))" 50 | ) 51 | 52 | 53 | def test_rsql_operators(): 54 | assert_query( 55 | "field<=value", 56 | "(AND: (u'field__lte', u'value'))" 57 | ) 58 | assert_query( 59 | "field=value", 64 | "(AND: (u'field__gte', u'value'))" 65 | ) 66 | assert_query( 67 | "field>value", 68 | "(AND: (u'field__gt', u'value'))" 69 | ) 70 | 71 | 72 | def test_string_values(): 73 | assert_query( 74 | "field=='single < quoted > with = \"special\" ! chars'", 75 | "(AND: (u'field', u'single < quoted > with = \"special\" ! chars'))" 76 | ) 77 | assert_query( 78 | "field==\"double < quoted > with = 'special' ! chars\"", 79 | "(AND: (u'field', u\"double < quoted > with = 'special' ! chars\"))" 80 | ) 81 | 82 | 83 | def test_in_out(): 84 | assert_query( 85 | "field=in=(value1,value2,value3)", 86 | "(AND: (u'field__in', [u'value1', u'value2', u'value3']))" 87 | ) 88 | assert_query( 89 | "field=out=(value1,value2,value3)", 90 | "(NOT (AND: (u'field__in', [u'value1', u'value2', u'value3'])))" 91 | ) 92 | 93 | 94 | def test_and(): 95 | assert_query( 96 | "field1==foo;field2==bar;field3==baz", 97 | "(AND: (u'field1', u'foo'), (u'field2', u'bar'), (u'field3', u'baz'))" 98 | ) 99 | 100 | 101 | def test_or(): 102 | assert_query( 103 | "field1==foo,field2==bar,field3==baz", 104 | "(OR: (u'field1', u'foo'), (u'field2', u'bar'), (u'field3', u'baz'))" 105 | ) 106 | 107 | 108 | def test_priority(): 109 | assert_query( 110 | "field1==foo,field2==bar;field3==baz", 111 | "(OR: (u'field1', u'foo'), (AND: (u'field2', u'bar'), (u'field3', u'baz')))" # noqa 112 | ) 113 | 114 | assert_query( 115 | "field1==foo;field2==bar,field3==baz", 116 | "(OR: (AND: (u'field1', u'foo'), (u'field2', u'bar')), (u'field3', u'baz'))" # noqa 117 | ) 118 | 119 | 120 | def test_grouping(): 121 | assert_query( 122 | "(field==value)", 123 | "(AND: (u'field', u'value'))" 124 | ) 125 | assert_query( 126 | "((((field==value))))", 127 | "(AND: (u'field', u'value'))" 128 | ) 129 | assert_query( 130 | "(field1==foo,field2==bar);field3==baz", 131 | "(AND: (OR: (u'field1', u'foo'), (u'field2', u'bar')), (u'field3', u'baz'))" # noqa 132 | ) 133 | assert_query( 134 | "field1==foo;(field2==bar,field3==baz)", 135 | "(AND: (u'field1', u'foo'), (OR: (u'field2', u'bar'), (u'field3', u'baz')))" # noqa 136 | ) 137 | assert_query( 138 | "(field1==foo;(field2==bar;(field3==baz;(field4==bang))))", 139 | "(AND: (u'field1', u'foo'), (u'field2', u'bar'), (u'field3', u'baz'), (u'field4', u'bang'))" # noqa 140 | ) 141 | assert_query( 142 | "(field1==foo,(field2==bar;(field3==baz,(field4==bang))))", 143 | "(OR: (u'field1', u'foo'), (AND: (u'field2', u'bar'), (OR: (u'field3', u'baz'), (u'field4', u'bang'))))" # noqa 144 | ) 145 | -------------------------------------------------------------------------------- /tests/test_queries.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | from django import test 4 | 5 | from rql_filter.backend import RQLFilterBackend 6 | 7 | from .base import RQLTestMixin 8 | from .models import Child 9 | 10 | 11 | class FakeRequest: 12 | def __init__(self, q): 13 | self.GET = {'q': q} 14 | 15 | 16 | class TestQueries(RQLTestMixin, test.TestCase): 17 | backend = RQLFilterBackend() 18 | 19 | def do_rql_query(self, rql): 20 | return self.backend.filter_queryset( 21 | FakeRequest(rql), 22 | Child.objects.all(), 23 | None 24 | ).values('name') 25 | -------------------------------------------------------------------------------- /tests/test_rest_framework.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | import json 4 | import urllib 5 | 6 | from django import test 7 | 8 | from .base import RQLTestMixin 9 | 10 | 11 | class TestRestFramework(RQLTestMixin, test.TestCase): 12 | 13 | def do_rql_query(self, rql): 14 | url = '/api/children/?format=json' 15 | if rql: 16 | url = '%s&q=%s' % (url, urllib.quote(rql)) 17 | 18 | with self.assertNumQueries(1): 19 | return json.loads(test.client.Client().get(url).content) 20 | -------------------------------------------------------------------------------- /tests/urls.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | from django.conf.urls import include, url 4 | 5 | from rest_framework import routers 6 | 7 | from .api import ChildViewSet 8 | 9 | 10 | router = routers.DefaultRouter() 11 | router.register('children', ChildViewSet) 12 | 13 | urlpatterns = [ 14 | url('api/', include(router.urls)), 15 | ] 16 | --------------------------------------------------------------------------------