Metadata-Version: 1.1
Name: falcon_filtering
Version: 0.2.0
Summary: Falcon filtering helper
Home-page: https://github.com/darkheir/falcon-filtering-hook
Author: Raphael Cohen
Author-email: raphael.cohen.utt@gmail.com
License: MIT
Description: falcon-filtering-hook
        ======================
        
        .. image:: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
            :target: LICENSE
        .. image:: https://travis-ci.org/Darkheir/falcon-filtering-hook.svg?branch=master
            :target: https://travis-ci.org/Darkheir/falcon-filtering-hook
        .. image:: https://codecov.io/gh/Darkheir/falcon-filtering-hook/branch/master/graph/badge.svg
            :target: https://codecov.io/gh/Darkheir/falcon-filtering-hook
        .. image:: https://api.codacy.com/project/badge/Grade/151e8f92301d431eb6144cf7915ef897
            :target: https://www.codacy.com/app/Darkheir/falcon-filtering-hook?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=Darkheir/falcon-filtering-hook&amp;utm_campaign=Badge_Grade
        .. image:: https://pyup.io/repos/github/Darkheir/falcon-filtering-hook/shield.svg
            :target: https://pyup.io/repos/github/Darkheir/falcon-filtering-hook/
            :alt: Updates
        
        
        A small falcon hook to parse filtering elements from the request.
        
        Usage
        -----
        
        The easiest way to use this hook is the following:
        
        .. code:: python
        
            class Resource:
                filtering_fields = ("foo", "bar")  # List of fields allowed for filtering
        
                @falcon.before(FilteringHook())
                def on_get(self, req, resp, user):
                    # Here req['context']['filters'] is set
        
        The Hook will look in the query parameters for parameters looking like :code:`filter[key]=value`.
        
        It will create a filters dict into the request context accessible at :code:`req.context['filters']`.
        Inside this dict the key will be the one extracted from between the brackets.
        i.e. :code:`key` in the example above.
        
        Configuration options
        ---------------------
        
        Allowing fields to be filtered
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        For security reasons, the fields allowed for filtering must be specified in the :code:`filtering_fields` attribute of the resource.
        
        All the fields not defined in it will be discarded by the hook.
        
        
        Hook configuration
        ~~~~~~~~~~~~~~~~~~
        
        One parameter can be passed to the hook:
        
        * filtering_key : The base name of the key used for the filters. Default: :code:`filter`.
        
        Example:
        
        .. code:: python
        
            @falcon.before(PaginationFromRequestHook(
                filtering_key='custom_filter',
            ))
            def on_get(self, req, resp, user):
                # Get request
        
        
Keywords: falcon filtering filter filters api
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Software Development :: Libraries
