falcon-filtering 0.2.0

Falcon filtering helper

A small falcon hook to parse filtering elements from the request.

Usage

The easiest way to use this hook is the following:

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 filter[key]=value.

It will create a filters dict into the request context accessible at req.context['filters']. Inside this dict the key will be the one extracted from between the brackets. i.e. 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 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: filter.

Example:

@falcon.before(PaginationFromRequestHook(
    filtering_key='custom_filter',
))
def on_get(self, req, resp, user):
    # Get request