graphene_elastic.filter_backends package

Submodules

graphene_elastic.filter_backends.base module

class graphene_elastic.filter_backends.base.BaseBackend(connection_field, args=None)[source]

Bases: object

add_arg_prefix(arg_name)[source]
classmethod apply_filter(queryset, options=None, args=None, kwargs=None)[source]

Apply filter.

Parameters:
  • queryset –
  • options –
  • args –
  • kwargs –
Returns:
classmethod apply_query(queryset, options=None, args=None, kwargs=None)[source]

Apply query.

Parameters:
  • queryset –
  • options –
  • args –
  • kwargs –
Returns:
arg_belongs_to(arg_name)[source]
doc_type
field_belongs_to(field_name)[source]
filter(queryset)[source]
filter_fields
classmethod generic_fields()[source]

Generic backend specific fields.

For instance, for search filter backend it would be {'search': String()}.

Returns:
Rtype dict:
get_backend_default_fields_params()[source]

Backend default filter params.

Return type:dict
Returns:
get_backend_fields(items, is_filterable_func, get_type_func)[source]

Construct backend fields.

Parameters:
  • items –
  • is_filterable_func –
  • get_type_func –
Returns:
get_field_name(arg_name)[source]
get_field_type(field_name, field_value, base_field_type)[source]

Get field type.

Returns:
has_fields = False
prefix = None
search_fields
classmethod split_lookup_complex_multiple_value(value, maxsplit=-1)[source]

Split lookup complex multiple value.

Parameters:
  • value (str) – Value to split.
  • maxsplit (int) – The maxsplit option of string.split.
Returns:

Lookup filter split into a list.
Return type:

list
classmethod split_lookup_complex_value(value, maxsplit=-1)[source]

Split lookup complex value.

Parameters:
  • value (str) – Value to split.
  • maxsplit (int) – The maxsplit option of string.split.
Returns:

Lookup filter split into a list.
Return type:

list
classmethod split_lookup_filter(value, maxsplit=-1)[source]

Split lookup filter.

Parameters:
  • value (str) – Value to split.
  • maxsplit (int) – The maxsplit option of string.split.
Returns:

Lookup filter split into a list.
Return type:

list
classmethod split_lookup_name(value, maxsplit=-1)[source]

Split lookup value.

Parameters:
  • value (str) – Value to split.
  • maxsplit (int) – The maxsplit option of string.split.
Returns:

Lookup value split into a list.
Return type:

list

Module contents