async support for analyzer

Author: miguelgrinberg

elasticsearch_dsl/analysis.py

@@ -15,7 +15,7 @@
 #  specific language governing permissions and limitations
 #  under the License.
 
-from .connections import get_connection
+from . import async_connections, connections
 from .utils import AttrDict, DslBase, merge
 
 __all__ = ["tokenizer", "analyzer", "char_filter", "token_filter", "normalizer"]
@@ -119,20 +119,7 @@ class CustomAnalyzer(CustomAnalysisDefinition, Analyzer):
         "tokenizer": {"type": "tokenizer"},
     }
 
-    def simulate(self, text, using="default", explain=False, attributes=None):
-        """
-        Use the Analyze API of elasticsearch to test the outcome of this analyzer.
-
-        :arg text: Text to be analyzed
-        :arg using: connection alias to use, defaults to ``'default'``
-        :arg explain: will output all token attributes for each token. You can
-            filter token attributes you want to output by setting ``attributes``
-            option.
-        :arg attributes: if ``explain`` is specified, filter the token
-            attributes to return.
-        """
-        es = get_connection(using)
-
+    def _get_body(self, text, explain, attributes):
         body = {"text": text, "explain": explain}
         if attributes:
             body["attributes"] = attributes
@@ -156,7 +143,43 @@ def simulate(self, text, using="default", explain=False, attributes=None):
         if self._builtin_type != "custom":
             body["analyzer"] = self._builtin_type
 
-        return AttrDict(es.indices.analyze(body=body))
+        return body
+
+    def simulate(self, text, using="default", explain=False, attributes=None):
+        """
+        Use the Analyze API of elasticsearch to test the outcome of this analyzer.
+
+        :arg text: Text to be analyzed
+        :arg using: connection alias to use, defaults to ``'default'``
+        :arg explain: will output all token attributes for each token. You can
+            filter token attributes you want to output by setting ``attributes``
+            option.
+        :arg attributes: if ``explain`` is specified, filter the token
+            attributes to return.
+        """
+        es = connections.get_connection(using)
+        return AttrDict(
+            es.indices.analyze(body=self._get_body(text, explain, attributes))
+        )
+
+    async def async_simulate(
+        self, text, using="default", explain=False, attributes=None
+    ):
+        """
+        Use the Analyze API of elasticsearch to test the outcome of this analyzer.
+
+        :arg text: Text to be analyzed
+        :arg using: connection alias to use, defaults to ``'default'``
+        :arg explain: will output all token attributes for each token. You can
+            filter token attributes you want to output by setting ``attributes``
+            option.
+        :arg attributes: if ``explain`` is specified, filter the token
+            attributes to return.
+        """
+        es = async_connections.get_connection(using)
+        return AttrDict(
+            await es.indices.analyze(body=self._get_body(text, explain, attributes))
+        )
 
 
 class Normalizer(AnalysisBase, DslBase):

tests/test_integration/_async/test_analysis.py

@@ -0,0 +1,46 @@
+#  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.
+
+from elasticsearch_dsl import analyzer, token_filter, tokenizer
+
+
+async def test_simulate_with_just__builtin_tokenizer(async_client):
+    a = analyzer("my-analyzer", tokenizer="keyword")
+    tokens = (await a.async_simulate("Hello World!", using=async_client)).tokens
+
+    assert len(tokens) == 1
+    assert tokens[0].token == "Hello World!"
+
+
+async def test_simulate_complex(async_client):
+    a = analyzer(
+        "my-analyzer",
+        tokenizer=tokenizer("split_words", "simple_pattern_split", pattern=":"),
+        filter=["lowercase", token_filter("no-ifs", "stop", stopwords=["if"])],
+    )
+
+    tokens = (await a.async_simulate("if:this:works", using=async_client)).tokens
+
+    assert len(tokens) == 2
+    assert ["this", "works"] == [t.token for t in tokens]
+
+
+async def test_simulate_builtin(async_client):
+    a = analyzer("my-analyzer", "english")
+    tokens = (await a.async_simulate("fixes running")).tokens
+
+    assert ["fix", "run"] == [t.token for t in tokens]

tests/test_integration/test_analysis.py renamed to tests/test_integration/_sync/test_analysis.py

@@ -20,7 +20,7 @@
 
 def test_simulate_with_just__builtin_tokenizer(client):
     a = analyzer("my-analyzer", tokenizer="keyword")
-    tokens = a.simulate("Hello World!", using=client).tokens
+    tokens = (a.simulate("Hello World!", using=client)).tokens
 
     assert len(tokens) == 1
     assert tokens[0].token == "Hello World!"
@@ -33,14 +33,14 @@ def test_simulate_complex(client):
         filter=["lowercase", token_filter("no-ifs", "stop", stopwords=["if"])],
     )
 
-    tokens = a.simulate("if:this:works", using=client).tokens
+    tokens = (a.simulate("if:this:works", using=client)).tokens
 
     assert len(tokens) == 2
     assert ["this", "works"] == [t.token for t in tokens]
 
 
 def test_simulate_builtin(client):
     a = analyzer("my-analyzer", "english")
-    tokens = a.simulate("fixes running").tokens
+    tokens = (a.simulate("fixes running")).tokens
 
     assert ["fix", "run"] == [t.token for t in tokens]

utils/run-unasync.py

@@ -43,7 +43,9 @@ def main(check=False):
         "AsyncFacetedSearch": "FacetedSearch",
         "async_connections": "connections",
         "async_scan": "scan",
+        "async_simulate": "simulate",
         "async_mock_client": "mock_client",
+        "async_client": "client",
         "async_data_client": "data_client",
         "async_write_client": "write_client",
         "async_pull_request": "pull_request",