Skip to main content

Falcon filtering helper

Project description Updates

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


The easiest way to use this hook is the following:

class Resource:
    filtering_fields = ("foo", "bar")  # List of fields allowed for filtering

    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.


def on_get(self, req, resp, user):
    # Get request

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

falcon_filtering-0.2.0.tar.gz (3.2 kB view hashes)

Uploaded source

Built Distribution

falcon_filtering-0.2.0-py3-none-any.whl (4.1 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page