minor refactoring, fixed linter and docs

Author: miguelgrinberg

elasticsearch_dsl/_async/__init__.py

@@ -0,0 +1,16 @@
+#  Licensed to Elasticsearch B.V. under one or more contributor
+#  license agreements. See the NOTICE file distributed with
+#  this work for additional information regarding copyright
+#  ownership. Elasticsearch B.V. licenses this file to you under
+#  the Apache License, Version 2.0 (the "License"); you may
+#  not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+# 	http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing,
+#  software distributed under the License is distributed on an
+#  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+#  KIND, either express or implied.  See the License for the
+#  specific language governing permissions and limitations
+#  under the License.

elasticsearch_dsl/_async/search.py

@@ -19,12 +19,12 @@
 from elasticsearch.helpers import async_scan
 
 from ..async_connections import get_connection
-from ..base_search import BaseMultiSearch, BaseSearch
 from ..response import Response
+from ..search_base import MultiSearchBase, SearchBase
 from ..utils import AttrDict
 
 
-class Search(BaseSearch):
+class Search(SearchBase):
     def __aiter__(self):
         """
         Iterate over the hits.
@@ -100,7 +100,7 @@ async def delete(self):
         )
 
 
-class MultiSearch(BaseMultiSearch):
+class MultiSearch(MultiSearchBase):
     """
     Combine multiple :class:`~elasticsearch_dsl.Search` objects into a single
     request.

elasticsearch_dsl/_sync/__init__.py

@@ -0,0 +1,16 @@
+#  Licensed to Elasticsearch B.V. under one or more contributor
+#  license agreements. See the NOTICE file distributed with
+#  this work for additional information regarding copyright
+#  ownership. Elasticsearch B.V. licenses this file to you under
+#  the Apache License, Version 2.0 (the "License"); you may
+#  not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+# 	http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing,
+#  software distributed under the License is distributed on an
+#  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+#  KIND, either express or implied.  See the License for the
+#  specific language governing permissions and limitations
+#  under the License.

elasticsearch_dsl/_sync/search.py

@@ -18,13 +18,13 @@
 from elasticsearch.exceptions import ApiError
 from elasticsearch.helpers import scan
 
-from ..base_search import BaseMultiSearch, BaseSearch
 from ..connections import get_connection
 from ..response import Response
+from ..search_base import MultiSearchBase, SearchBase
 from ..utils import AttrDict
 
 
-class Search(BaseSearch):
+class Search(SearchBase):
     def __iter__(self):
         """
         Iterate over the hits.
@@ -92,7 +92,7 @@ def delete(self):
         )
 
 
-class MultiSearch(BaseMultiSearch):
+class MultiSearch(MultiSearchBase):
     """
     Combine multiple :class:`~elasticsearch_dsl.Search` objects into a single
     request.

elasticsearch_dsl/search.py

@@ -15,5 +15,6 @@
 #  specific language governing permissions and limitations
 #  under the License.
 
-from .base_search import *
-from elasticsearch_dsl._sync.search import *
+from elasticsearch_dsl._sync.search import *  # noqa: F401, F403
+
+from .search_base import *  # noqa: F401, F403

elasticsearch_dsl/base_search.py renamed to elasticsearch_dsl/search_base.py

@@ -18,15 +18,11 @@
 import collections.abc
 import copy
 
-from elasticsearch.exceptions import ApiError
-from elasticsearch.helpers import scan
-
 from .aggs import A, AggBase
-from .connections import get_connection
 from .exceptions import IllegalOperation
 from .query import Bool, Q, Query
 from .response import Hit, Response
-from .utils import AttrDict, DslBase, recursive_to_dict
+from .utils import DslBase, recursive_to_dict
 
 
 class QueryProxy:
@@ -299,7 +295,7 @@ def _clone(self):
         return s
 
 
-class BaseSearch(Request):
+class SearchBase(Request):
     query = ProxyDescriptor("query")
     post_filter = ProxyDescriptor("post_filter")
 
@@ -807,66 +803,8 @@ def to_dict(self, count=False, **kwargs):
         d.update(recursive_to_dict(kwargs))
         return d
 
-    def count(self):
-        """
-        Return the number of hits matching the query and filters. Note that
-        only the actual number is returned.
-        """
-        if hasattr(self, "_response") and self._response.hits.total.relation == "eq":
-            return self._response.hits.total.value
-
-        es = get_connection(self._using)
-
-        d = self.to_dict(count=True)
-        # TODO: failed shards detection
-        resp = es.count(index=self._index, query=d.get("query", None), **self._params)
-        return resp["count"]
-
-    def execute(self, ignore_cache=False):
-        """
-        Execute the search and return an instance of ``Response`` wrapping all
-        the data.
-
-        :arg ignore_cache: if set to ``True``, consecutive calls will hit
-            ES, while cached result will be ignored. Defaults to `False`
-        """
-        if ignore_cache or not hasattr(self, "_response"):
-            es = get_connection(self._using)
-
-            self._response = self._response_class(
-                self,
-                es.search(index=self._index, body=self.to_dict(), **self._params).body,
-            )
-        return self._response
-
-    def scan(self):
-        """
-        Turn the search into a scan search and return a generator that will
-        iterate over all the documents matching the query.
-
-        Use ``params`` method to specify any additional arguments you with to
-        pass to the underlying ``scan`` helper from ``elasticsearch-py`` -
-        https://elasticsearch-py.readthedocs.io/en/master/helpers.html#elasticsearch.helpers.scan
-
-        """
-        es = get_connection(self._using)
-
-        for hit in scan(es, query=self.to_dict(), index=self._index, **self._params):
-            yield self._get_result(hit)
-
-    def delete(self):
-        """
-        delete() executes the query by delegating to delete_by_query()
-        """
-
-        es = get_connection(self._using)
-
-        return AttrDict(
-            es.delete_by_query(index=self._index, body=self.to_dict(), **self._params)
-        )
-
 
-class BaseMultiSearch(Request):
+class MultiSearchBase(Request):
     """
     Combine multiple :class:`~elasticsearch_dsl.Search` objects into a single
     request.
@@ -911,28 +849,3 @@ def to_dict(self):
             out.append(s.to_dict())
 
         return out
-
-    def execute(self, ignore_cache=False, raise_on_error=True):
-        """
-        Execute the multi search request and return a list of search results.
-        """
-        if ignore_cache or not hasattr(self, "_response"):
-            es = get_connection(self._using)
-
-            responses = es.msearch(
-                index=self._index, body=self.to_dict(), **self._params
-            )
-
-            out = []
-            for s, r in zip(self._searches, responses["responses"]):
-                if r.get("error", False):
-                    if raise_on_error:
-                        raise ApiError("N/A", meta=responses.meta, body=r)
-                    r = None
-                else:
-                    r = Response(s, r)
-                out.append(r)
-
-            self._response = out
-
-        return self._response