API Reference¶
Filters¶
Filterset¶
-
class
filteralchemy.filterset.
FilterSet
(query=None)[source]¶ Example usage:
from models import Album, session from webargs.flaskparser import parser from filteralchemy import FilterSet class AlbumFilterSet(FilterSet): class Meta: model = Album query = session.query(Album) parser = parser query = AlbumFilterSet().filter()
Parameters: query – Optional SQLAlchemy query; if not provided, use query defined on options class -
class
Meta
[source]¶ Available options:
model
: SQLAlchemy model classquery
: Query onmodel
fields
: Sequence of model field names to include, or a callable that
accepts a
FilterSet
subclass and returns a sequence of fields -exclude
: Tuple or list of model field names to exclude, or a callable that accepts aFilterSet
subclass and returns a sequence of fields -list_class
: List field class; defaults toList
-converter
:ModelConverter
instance; defaults toModelConverter()
-operators
: Tuple or list ofOperator
classes -default_operator
: Default operator; non-default operators will includeoperator labels in auto-generated filter names
-
class