معرفی شرکت ها
django-rql-filter-0.1.3
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشترتوضیحات
A RQL-enabled filter backend for django-rest-framework
| ویژگی | مقدار |
|---|---|
| سیستم عامل | - |
| نام فایل | django-rql-filter-0.1.3 |
| نام | django-rql-filter |
| نسخه کتابخانه | 0.1.3 |
| نگهدارنده | [] |
| ایمیل نگهدارنده | [] |
| نویسنده | Nicolas Joyard |
| ایمیل نویسنده | joyard.nicolas@gmail.com |
| آدرس صفحه اصلی | https://github.com/njoyard/django-rql-filter |
| آدرس اینترنتی | https://pypi.org/project/django-rql-filter/ |
| مجوز | MIT |
django-rql-filter
=================
|Build Status| |PyPi version| |codecov|
This app implements a RQL/RSQL/FIQL filter backend for
`django-rest-framework <http://www.django-rest-framework.org>`__ and
enables passing arbitrary conditional expressions to filter entities.
Installation
------------
.. code:: sh
pip install django-rql-filter
Usage
-----
Add ``rql_filter`` to your project ``INSTALLED_APPS``.
Add the ``RQLFilterBackend`` to your viewset ``filter_backends``:
.. code:: python
from rql_filter.backend import RQLFilterBackend
class ThingyViewSet(viewsets.ReadOnlyModelViewSet):
filter_backends = (
...
RQLFilterBackend,
...
)
You may now pass a RQL/RSQL/FIQL query to API URLs using the ``q``
querystring parameter:
.. code:: sh
curl http://my.app/api/thingies/?format=json&q=name==bob;age=gt=30
Query syntax
------------
A query is made using a combination of field comparisons. Comparisons
are composed by a field name, an operator and a value.
+-------------------+----------------------------+-----------------------------+
| Operator | Meaning | Examples |
+===================+============================+=============================+
| ``==`` | Equal to | ``name==bob`` |
+-------------------+----------------------------+-----------------------------+
| ``!=`` | Not equal to | ``name!=bob`` |
+-------------------+----------------------------+-----------------------------+
| ``<`` ``=lt=`` | Less than | ``age<30`` ``age=lt=30`` |
+-------------------+----------------------------+-----------------------------+
| ``<=`` ``=le=`` | Less than or equal to | ``age<=30`` ``age=le=30`` |
+-------------------+----------------------------+-----------------------------+
| ``>`` ``=gt=`` | Greater than | ``age>30`` ``age=gt=30`` |
+-------------------+----------------------------+-----------------------------+
| ``>=`` ``=ge=`` | Greater than or equal to | ``age>=30`` ``age=ge=30`` |
+-------------------+----------------------------+-----------------------------+
| ``=in=`` | Belongs to set | ``name=in=(bob,kate)`` |
+-------------------+----------------------------+-----------------------------+
| ``=out=`` | Does not belong to set | ``name=out=(bob,kate)`` |
+-------------------+----------------------------+-----------------------------+
Comparisons can traverse model relations by separating field names with
a double underscore: ``father__name==bob``.
Values must be quoted with single or double quotes when they include
special characters or spaces: ``name=="bob katz"``.
Comparisons may be combined using logical operators: ``;`` for a logical
AND, and ``,`` for a logical OR: ``name=="bob";age>=30``. AND has
priority over OR; grouping is available using parentheses:
``name=="bob";(age>=30,age<3)``.
**Note:** RQL/RSQL/FIQL support is still incomplete, it will be enhanced
over time.
Configuration
-------------
``RQL_FILTER_QUERY_PARAM`` sets the querystring parameter name to use;
it defaults to ``'q'``.
Using without rest-framework
----------------------------
You may use the backend manually outside a rest-framework viewset:
.. code:: python
from rql_filter.backend import RQLFilterBackend
# May be reused any number of times
backend = RQLFilterBackend()
# Fake request object
class FakeRQLRequest:
def __init__(self, q):
self.GET = {'q': q}
qs = Thingy.objects.all()
filtered_qs = backend.filter_queryset(
FakeRQLRequest('name==bob;age=gt=30'),
qs,
None
)
Testing
-------
Install testing dependencies:
.. code:: sh
pip install -e .[testing]
Run tests:
.. code:: sh
py.test
.. |Build Status| image:: https://travis-ci.org/njoyard/django-rql-filter.svg?branch=master
:target: https://travis-ci.org/njoyard/django-rql-filter
.. |PyPi version| image:: https://badge.fury.io/py/django-rql-filter.png
:target: https://badge.fury.io/py/django-rql-filter
.. |codecov| image:: https://codecov.io/gh/njoyard/django-rql-filter/branch/master/graph/badge.svg
:target: https://codecov.io/gh/njoyard/django-rql-filter
نحوه نصب
نصب پکیج whl django-rql-filter-0.1.3:
pip install django-rql-filter-0.1.3.whl
نصب پکیج tar.gz django-rql-filter-0.1.3:
pip install django-rql-filter-0.1.3.tar.gz