api.constants module

Module with the constant values for the api app.

class api.constants.FilterSetups[source]

Bases: object

Namespace class for all filter setups for different field types.

TEXT: Final[list[str]] = ['icontains', 'contains', 'exact', 'iexact', 'startswith', 'istartswith', 'endswith', 'iendswith', 'regex', 'iregex', 'in']

Standard filter options for text fields.

DATETIME: Final[list[str]] = ['date', 'date__gte', 'date__lte', 'date__gt', 'date__lt', 'date__in', 'date__range', 'time', 'time__gte', 'time__lte', 'time__gt', 'time__lt', 'time__in', 'time__range', 'iso_year', 'iso_year', 'iso_year__gte', 'iso_year__lte', 'iso_year__gt', 'iso_year__lt', 'iso_year__in', 'iso_year__range', 'month', 'month__gte', 'month__lte', 'month__gt', 'month__lt', 'month__in', 'month__range', 'quarter', 'quarter__gte', 'quarter__lte', 'quarter__gt', 'quarter__lt', 'quarter__in', 'quarter__range', 'week', 'week__gte', 'week__lte', 'week__gt', 'week__lt', 'week__in', 'week__range', 'iso_week_day', 'iso_week_day__gte', 'iso_week_day__lte', 'iso_week_day__gt', 'iso_week_day__lt', 'iso_week_day__in', 'iso_week_day__range', 'day', 'day__gte', 'day__lte', 'day__gt', 'day__lt', 'day__in', 'day__range', 'hour', 'hour__gte', 'hour__lte', 'hour__gt', 'hour__lt', 'hour__in', 'hour__range', 'minute', 'minute__gte', 'minute__lte', 'minute__gt', 'minute__lt', 'minute__in', 'minute__range', 'second', 'second__gte', 'second__lte', 'second__gt', 'second__lt', 'second__in', 'second__range']
FLOAT: Final[list[str]] = ['lte', 'gte', 'range']

Standard filter options for float fields.

INT: Final[list[str]] = ['lte', 'gte', 'lt', 'gt', 'exact', 'in', 'range']

Standard filter options for integer fields.

BOOL: Final[list[str]] = ['exact']

Standard filter options for boolean fields.

CHOICE: Final[list[str]] = ['icontains', 'iexact', 'in']

Standard filter options for fields with constant choices.

JSON: Final[list[str]] = ['icontains', 'contains', 'regex', 'iregex']