Types

FilterType

Bases: str, Enum

Type of filter operation.

eq class-attribute instance-attribute

eq = 'eq'

Equal

ne class-attribute instance-attribute

ne = 'ne'

Not equal

null class-attribute instance-attribute

null = 'null'

Is null

gt class-attribute instance-attribute

gt = 'gt'

Grater than

ge class-attribute instance-attribute

ge = 'ge'

Grater than or equal

lt class-attribute instance-attribute

lt = 'lt'

Lower than

le class-attribute instance-attribute

le = 'le'

Lower than or equal

like class-attribute instance-attribute

like = 'like'

Case-sensitive matching

ilike class-attribute instance-attribute

ilike = 'ilike'

Case-insensitive matching

FilterTypeLiteral module-attribute

FilterTypeLiteral: TypeAlias = Literal[
    "eq", "ne", "null", "gt", "ge", "lt", "le", "like", "ilike"
]

Literal alias for FilterType

SearchType

Bases: str, Enum

Type of search operation.

case_sensitive class-attribute instance-attribute

case_sensitive = 'case_sensitive'

Case sensitive

case_insensitive class-attribute instance-attribute

case_insensitive = 'case_insensitive'

Case insensitive

SearchTypeLiteral module-attribute

SearchTypeLiteral: TypeAlias = Literal['case_sensitive', 'case_insensitive']

Literal alias for SearchType

_suffixes_map module-attribute

_suffixes_map: Dict[str, FilterType] = {
    "eq": eq,
    "n": ne,
    "ne": ne,
    "neq": ne,
    "null": null,
    "isnull": null,
    "gt": gt,
    "ge": ge,
    "gte": ge,
    "lt": lt,
    "le": le,
    "lte": le,
    "l": like,
    "like": like,
    "il": ilike,
    "ilike": ilike,
}

get_suffixes_map

get_suffixes_map() -> Dict[str, FilterType]

Returns the standard set of synonyms defined in _suffixes_map

Source code in pydantic_filters/filter/_types.py

def get_suffixes_map() -> Dict[str, FilterType]:
    """
    Returns the standard set of synonyms defined in
    [`_suffixes_map`][pydantic_filters.filter._types._suffixes_map]
    """
    return deepcopy(_suffixes_map)