Rename default do_type name to doc

Author: honzakral

docs/persistence.rst

@@ -9,7 +9,11 @@ layer for your application.
 Mappings
 --------
 
-The mapping definition follows a similar pattern to the query dsl:
+If you wish to create mappings manually you can use the ``Mapping`` class, for
+more advanced use cases, however, we recommend you use the :ref:`doc_type`
+abstraction in combination with :ref:`index` (or ``IndexTemplate``) to define
+index-level settings and properties. The mapping definition follows a similar
+pattern to the query dsl:
 
 .. code:: python
 
@@ -101,6 +105,8 @@ specify type (``nGram`` in our example).
  either not exist or be closed. To create multiple ``DocType``-defined
  mappings you can use the :ref:`index` object.
 
+.. _doc_type:
+
 DocType
 -------
 
@@ -198,7 +204,7 @@ explicitly:
  first.save()
 
 
-All the metadata fields (``id``, ``parent``, ``routing``, ``index`` etc) can be
+All the metadata fields (``id``, ``routing``, ``index`` etc) can be
 accessed (and set) via a ``meta`` attribute or directly using the underscored
 variant:
 
@@ -270,16 +276,12 @@ accessed through the ``_doc_type`` attribute of the class:
 
 .. code:: python
 
- # name of the type and index in elasticsearch
- Post._doc_type.name
+ # name of the index in elasticsearch
  Post._doc_type.index
 
  # the raw Mapping object
  Post._doc_type.mapping
 
- # the optional name of the parent type (if defined)
- Post._doc_type.parent
-
 The ``_doc_type`` attribute is also home to the ``refresh`` method which will
 update the mapping on the ``DocType`` from elasticsearch. This is very useful
 if you use dynamic mappings and want the class to be aware of those fields (for
@@ -351,8 +353,8 @@ In the ``Meta`` class inside your document definition you can define various
 metadata for your document:
 
 ``doc_type``
- name of the doc_type in elasticsearch. By default it will be constructed from
- the class name (MyDocument -> my_document)
+ name of the doc_type in elasticsearch. By default it will be set to ``doc``,
+ it is not recommended to change.
 
 ``index``
  default index for the document, by default it is empty and every operation
@@ -366,7 +368,7 @@ metadata for your document:
  created from the fields on the document class itself.
 
 Any attributes on the ``Meta`` class that are instance of ``MetaField`` will be
-used to control the mapping of the meta fields (``_all``, ``_parent`` etc).
+used to control the mapping of the meta fields (``_all``, ``dynamic`` etc).
 Just name the parameter (without the leading underscore) as the field you wish
 to map and pass any parameters to the ``MetaField`` class:
 
@@ -377,7 +379,6 @@ to map and pass any parameters to the ``MetaField`` class:
 
  class Meta:
  all = MetaField(enabled=False)
- parent = MetaField(type='blog')
  dynamic = MetaField('strict')
 
 .. _index:

elasticsearch_dsl/document.py

@@ -35,10 +35,8 @@ def __init__(self, name, bases, attrs):
  # default cluster alias, can be overriden in doc.meta
  self._using = getattr(meta, 'using', None)
 
- # get doc_type name, if not defined take the name of the class and
- # transform it to lower_case
- doc_type = getattr(meta, 'doc_type',
- re.sub(r'(.)([A-Z])', r'\1_\2', name).lower())
+ # get doc_type name, if not defined use 'doc'
+ doc_type = getattr(meta, 'doc_type', 'doc')
 
  # create the mapping instance
  self.mapping = getattr(meta, 'mapping', Mapping(doc_type))
@@ -63,6 +61,9 @@ def __init__(self, name, bases, attrs):
  self._using = self._using or b._doc_type._using
  self.index = self.index or b._doc_type.index
 
+ # custom method to determine if a hit belongs to this DocType
+ self._matches = getattr(meta, 'matches', None)
+
  @property
  def using(self):
  return self._using or 'default'
@@ -86,6 +87,14 @@ def init(self, index=None, using=None):
  def refresh(self, index=None, using=None):
  self.mapping.update_from_es(index or self.index, using=using or self.using)
 
+ def matches(self, hit):
+ print(self.index, self.name, hit)
+ if self._matches is not None:
+ return self._matches(hit)
+
+ print(self.index, self.name, hit)
+ return (self.index is None or self.index == hit.get('_index')) and self.name == hit.get('_type')
+
 @add_metaclass(DocTypeMeta)
 class InnerDoc(ObjectBase):
  """

elasticsearch_dsl/response/__init__.py

@@ -1,5 +1,3 @@
-from six import itervalues
-
 from ..utils import AttrDict, AttrList
 
 from .hit import Hit, HitMeta
@@ -40,46 +38,13 @@ def __setstate__(self, state):
  def success(self):
  return self._shards.total == self._shards.successful and not self.timed_out
 
- def _resolve_nested(self, field, doc_class):
- if hasattr(self._doc_class, '_doc_type'):
- nested_field = self._doc_class._doc_type.resolve_field(field)
-
- else:
- for dt in itervalues(self._search._doc_type_map):
- if not hasattr(dt, '_doc_type'):
- continue
- nested_field = dt._doc_type.resolve_field(field)
- if nested_field is not None:
- break
-
- if nested_field is not None:
- return nested_field._doc_class
-
- return doc_class
-
- def _get_result(self, hit):
- doc_class = Hit
- dt = hit.get('_type')
-
- if '_nested' in hit:
- doc_class = self._resolve_nested(hit['_nested']['field'], doc_class)
-
- elif dt in self._search._doc_type_map:
- doc_class = self._search._doc_type_map[dt]
-
- for t in hit.get('inner_hits', ()):
- hit['inner_hits'][t] = Response(self._search, hit['inner_hits'][t], doc_class=doc_class)
-
- callback = getattr(doc_class, 'from_es', doc_class)
- return callback(hit)
-
  @property
  def hits(self):
  if not hasattr(self, '_hits'):
  h = self._d_['hits']
 
  try:
- hits = AttrList(map(self._get_result, h['hits']))
+ hits = AttrList(map(self._search._get_result, h['hits']))
  except AttributeError as e:
  # avoid raising AttributeError since it will be hidden by the property
  raise TypeError("Could not parse hits.", e)

elasticsearch_dsl/search.py

@@ -92,13 +92,12 @@ def __init__(self, using='default', index=None, doc_type=None, extra=None):
  self._doc_type = []
  self._doc_type_map = {}
  if isinstance(doc_type, (tuple, list)):
- for dt in doc_type:
- self._add_doc_type(dt)
+ self._doc_type.extend(doc_type)
  elif isinstance(doc_type, collections.Mapping):
  self._doc_type.extend(doc_type.keys())
  self._doc_type_map.update(doc_type)
  elif doc_type:
- self._add_doc_type(doc_type)
+ self._doc_type.append(doc_type)
 
  self._params = {}
  self._extra = extra or {}
@@ -159,11 +158,52 @@ def index(self, *index):
 
  return s
 
- def _add_doc_type(self, doc_type):
- if hasattr(doc_type, '_doc_type'):
- self._doc_type_map[doc_type._doc_type.name] = doc_type
- doc_type = doc_type._doc_type.name
- self._doc_type.append(doc_type)
+ def _get_doc_type(self):
+ """
+ Return a list of doc_type names to be used
+ """
+ return list(set(dt._doc_type.name if hasattr(dt, '_doc_type') else dt for dt in self._doc_type))
+
+ def _resolve_nested(self, field, parent_class=None):
+ doc_class = Hit
+ if hasattr(parent_class, '_doc_type'):
+ nested_field = parent_class._doc_type.resolve_field(field)
+
+ else:
+ for dt in self._doc_type:
+ if not hasattr(dt, '_doc_type'):
+ continue
+ nested_field = dt._doc_type.resolve_field(field)
+ if nested_field is not None:
+ break
+
+ if nested_field is not None:
+ return nested_field._doc_class
+
+ return doc_class
+
+ def _get_result(self, hit, parent_class=None):
+ doc_class = Hit
+ dt = hit.get('_type')
+
+ if '_nested' in hit:
+ doc_class = self._resolve_nested(hit['_nested']['field'], parent_class)
+
+ elif dt in self._doc_type_map:
+ doc_class = self._doc_type_map[dt]
+
+ else:
+ for doc_type in self._doc_type:
+ if hasattr(doc_type, '_doc_type') and doc_type._doc_type.matches(hit):
+ doc_class = doc_type
+ break
+
+ for t in hit.get('inner_hits', ()):
+ hit['inner_hits'][t] = Response(self, hit['inner_hits'][t], doc_class=doc_class)
+
+ callback = getattr(doc_class, 'from_es', doc_class)
+ return callback(hit)
+
 
  def doc_type(self, *doc_type, **kwargs):
  """
@@ -186,8 +226,7 @@ def doc_type(self, *doc_type, **kwargs):
  s._doc_type = []
  s._doc_type_map = {}
  else:
- for dt in doc_type:
- s._add_doc_type(dt)
+ s._doc_type.extend(doc_type)
  s._doc_type.extend(kwargs.keys())
  s._doc_type_map.update(kwargs)
  return s
@@ -528,6 +567,7 @@ def highlight(self, *fields, **kwargs):
  Search().highlight('title', fragment_size=50).highlight('body', fragment_size=100)
 
  which will produce::
+
  {
  "highlight": {
  "fields": {
@@ -615,7 +655,7 @@ def count(self):
  # TODO: failed shards detection
  return es.count(
  index=self._index,
- doc_type=self._doc_type,
+ doc_type=self._get_doc_type(),
  body=d,
  **self._params
  )['count']
@@ -634,7 +674,7 @@ def execute(self, ignore_cache=False):
  self,
  es.search(
  index=self._index,
- doc_type=self._doc_type,
+ doc_type=self._get_doc_type(),
  body=self.to_dict(),
  **self._params
  )
@@ -657,12 +697,10 @@ def scan(self):
  es,
  query=self.to_dict(),
  index=self._index,
- doc_type=self._doc_type,
+ doc_type=self._get_doc_type(),
  **self._params
  ):
- callback = self._doc_type_map.get(hit['_type'], Hit)
- callback = getattr(callback, 'from_es', callback)
- yield callback(hit)
+ yield self._get_result(hit)
 
  def delete(self):
  """
@@ -675,7 +713,7 @@ def delete(self):
  es.delete_by_query(
  index=self._index,
  body=self.to_dict(),
- doc_type=self._doc_type,
+ doc_type=self._get_doc_type(),
  **self._params
  )
  )
@@ -720,7 +758,7 @@ def to_dict(self):
  if s._index:
  meta['index'] = s._index
  if s._doc_type:
- meta['type'] = s._doc_type
+ meta['type'] = s._get_doc_type()
  meta.update(s._params)
 
  out.append(meta)
@@ -737,7 +775,7 @@ def execute(self, ignore_cache=False, raise_on_error=True):
 
  responses = es.msearch(
  index=self._index,
- doc_type=self._doc_type,
+ doc_type=self._get_doc_type(),
  body=self.to_dict(),
  **self._params
  )

test_elasticsearch_dsl/test_document.py

@@ -89,7 +89,7 @@ def test_custom_field():
 
 def test_custom_field_mapping():
  assert {
- 'secret_doc': {
+ 'doc': {
  'properties': {
  'title': {'index': 'no', 'type': 'text'}
  }
@@ -186,7 +186,7 @@ class Meta:
  dynamic_templates = document.MetaField([42])
 
  assert {
- 'user': {
+ 'doc': {
  'properties': {
  'username': {'type': 'text'}
  },
@@ -277,9 +277,8 @@ def test_to_dict_ignores_empty_collections():
 def test_declarative_mapping_definition():
  assert issubclass(MyDoc, document.DocType)
  assert hasattr(MyDoc, '_doc_type')
- assert 'my_doc' == MyDoc._doc_type.name
  assert {
- 'my_doc': {
+ 'doc': {
  'properties': {
  'created_at': {'type': 'date'},
  'name': {'type': 'text'},
@@ -368,13 +367,11 @@ def test_meta_inheritance():
  assert issubclass(MyMultiSubDoc, MyDoc2)
  assert issubclass(MyMultiSubDoc, document.DocType)
  assert hasattr(MyMultiSubDoc, '_doc_type')
- # doc_type should not be inherited
- assert 'my_multi_sub_doc' == MyMultiSubDoc._doc_type.name
  # index and using should be
  assert MyMultiSubDoc._doc_type.index == MySubDoc._doc_type.index
  assert MyMultiSubDoc._doc_type.using == MySubDoc._doc_type.using
  assert {
- 'my_multi_sub_doc': {
+ 'doc': {
  'properties': {
  'created_at': {'type': 'date'},
  'name': {'type': 'keyword'},

test_elasticsearch_dsl/test_index.py

@@ -64,7 +64,7 @@ def test_registered_doc_type_included_in_to_dict():
  assert Post._doc_type.index == 'i'
  assert {
  'mappings': {
- 'post': {
+ 'doc': {
  'properties': {
  'title': {'type': 'text'},
  'published_from': {'type': 'date'},
@@ -79,7 +79,7 @@ def test_registered_doc_type_included_in_search():
 
  s = i.search()
 
- assert s._doc_type_map == {'post': Post}
+ assert s._doc_type == [Post]
 
 
 def test_aliases_add_to_object():