graphene_elastic package

Subpackages

• graphene_elastic.filter_backends package
  • Subpackages
    • graphene_elastic.filter_backends.filtering package
      • Submodules
      • graphene_elastic.filter_backends.filtering.common module
      • Module contents
    • graphene_elastic.filter_backends.search package
      • Submodules
      • graphene_elastic.filter_backends.search.common module
      • Module contents
  • Submodules
  • graphene_elastic.filter_backends.base module
  • Module contents
• graphene_elastic.types package
  • Submodules
  • graphene_elastic.types.elastic_types module
  • graphene_elastic.types.json_string module
  • Module contents

Submodules

graphene_elastic.advanced_types module

class graphene_elastic.advanced_types.FileFieldType(*args, **kwargs)

Bases: graphene.types.objecttype.ObjectType

chunk_size = <graphene.types.scalars.Int object>

content_type = <graphene.types.scalars.String object>

data = <graphene.types.scalars.String object>

length = <graphene.types.scalars.Int object>

md5 = <graphene.types.scalars.String object>

resolve_chunk_size(info)

resolve_content_type(info)

resolve_data(info)

resolve_length(info)

resolve_md5(info)

class graphene_elastic.advanced_types.MultiPolygonFieldType(*args, **kwargs)

Bases: graphene_elastic.advanced_types._CoordinatesTypeField

coordinates = <graphene.types.structures.List object>

class graphene_elastic.advanced_types.PointFieldType(*args, **kwargs)

Bases: graphene_elastic.advanced_types._CoordinatesTypeField

coordinates = <graphene.types.structures.List object>

class graphene_elastic.advanced_types.PolygonFieldType(*args, **kwargs)

Bases: graphene_elastic.advanced_types._CoordinatesTypeField

coordinates = <graphene.types.structures.List object>

graphene_elastic.constants module

Constants module. Contains Elasticsearch constants, lookup constants, functional constants, suggesters, etc.

graphene_elastic.converter module

exception graphene_elastic.converter.ElasticsearchConversionError

Bases: Exception

graphene_elastic.converter.convert_elasticsearch_field(field, registry=None)

graphene_elastic.converter.convert_field_to_boolean(field, registry=None)

graphene_elastic.converter.convert_field_to_datetime(field, registry=None)

graphene_elastic.converter.convert_field_to_float(field, registry=None)

graphene_elastic.converter.convert_field_to_int(field, registry=None)

graphene_elastic.converter.convert_field_to_jsonstring(field, registry=None)

graphene_elastic.converter.convert_field_to_string(field, registry=None)

graphene_elastic.enums module

class graphene_elastic.enums.NoValue

Bases: enum.Enum

String values in enum.

Example:

>>> class Color(NoValue):
>>>     RED = 'stop'
>>>     GREEN = 'go'
>>>     BLUE = 'too fast!'

Graphene example:

>>> @graphene.Enum.from_enum
>>> class ColorOptions(NoValue):
>>>
>>>     RED = 'stop'
>>>     GREEN = 'go'
>>>     BLUE = 'too fast!'

graphene_elastic.enums.convert_list_to_enum(values, enum_name='DynamicEnum', upper=True)

Prepare list values for creating an Enum.

Example:

>>> values = ['red', 'green', 'blue']
>>> print(prepare_list_for_enum(values))
{'RED': 'red', 'GREEN': 'green', 'BLUE': 'blue'}

graphene_elastic.fields module

class graphene_elastic.fields.ElasticsearchConnectionField(type, *args, **kwargs)

Bases: graphene.relay.connection.IterableConnectionField

args

chained_resolver(resolver, is_partial, root, info, **args)

classmethod connection_resolver(resolver, connection_type, root, info, connection_field=None, **args)

default_filter_backends

default_resolver(_root, info, **args)

doc_type

document

field_args

fields

filter_backends

get_queryset(document, info, **args)

get_resolver(parent_resolver)

node_type

reference_args

registry

classmethod resolve_connection(connection_type, args, resolved, connection_field=None)

type

graphene_elastic.helpers module

graphene_elastic.helpers.to_camel_case(snake_str: str) → str

Convert snake_case to camelCase.

Capitalize the first letter of each part except the first one with the capitalize method and join all the parts together.

Adapted from this response in StackOverflow http://stackoverflow.com/a/19053800/1072990

Parameters:snake_str – Returns:

graphene_elastic.helpers.to_pascal_case(snake_str: str) → str

Convert snake_case to CapWords.

Parameters:snake_str – Returns:

graphene_elastic.registry module

class graphene_elastic.registry.Registry

Bases: object

get_converted_field(field)

get_type_for_document(document)

register(cls)

register_converted_field(field, converted)

graphene_elastic.registry.get_global_registry()

graphene_elastic.registry.reset_global_registry()

graphene_elastic.settings module

graphene_elastic.utils module

graphene_elastic.utils.get_document_fields(document, excluding=None)

graphene_elastic.utils.get_field_description(field, registry=None)

Common metadata includes verbose_name and help_text.

http://docs.mongoengine.org/apireference.html#fields

graphene_elastic.utils.get_node_from_global_id(node, info, global_id)

graphene_elastic.utils.get_type_for_document(schema, document)

graphene_elastic.utils.import_single_dispatch()

graphene_elastic.utils.is_valid_elasticsearch_document(document)

Module contents

class graphene_elastic.ElasticsearchConnectionField(type, *args, **kwargs)

Bases: graphene.relay.connection.IterableConnectionField

args

chained_resolver(resolver, is_partial, root, info, **args)

classmethod connection_resolver(resolver, connection_type, root, info, connection_field=None, **args)

default_filter_backends

default_resolver(_root, info, **args)

doc_type

document

field_args

fields

filter_backends

get_queryset(document, info, **args)

get_resolver(parent_resolver)

node_type

reference_args

registry

classmethod resolve_connection(connection_type, args, resolved, connection_field=None)

type

class graphene_elastic.ElasticsearchObjectType(*args, **kwargs)

Bases: graphene.types.objecttype.ObjectType

classmethod get_node(info, id)

id

classmethod is_type_of(root, info)

classmethod rescan_fields()

Attempts to rescan fields and will insert any not converted initially.

resolve_id(info)