generate types for the Elasticsearch response

Author: miguelgrinberg

elasticsearch_dsl/response/__init__.py

@@ -44,7 +44,7 @@
 
 
 class Response(AttrDict[Any], Generic[_R]):
-    """An Elasticsearch response.
+    """An Elasticsearch search response.
 
     :arg took: (required)
     :arg timed_out: (required)

utils/generator.py

@@ -99,6 +99,15 @@ def add_not_set(type_):
     return type_
 
 
+# def add_optional(type_):
+#     """Add Optional to a Python type hint."""
+#     if type_.startswith("Union["):
+#         type_ = f"{type_[:-1]}, None]"
+#     else:
+#         type_ = f"Union[{type_}, None]"
+#     return type_
+
+
 class ElasticsearchSchema:
     """Operations related to the Elasticsearch schema."""
 

utils/templates/response.__init__.py.tpl

@@ -44,7 +44,7 @@ __all__ = ["Response", "AggResponse", "UpdateByQueryResponse", "Hit", "HitMeta"]
 
 
 class Response(AttrDict[Any], Generic[_R]):
-    """An Elasticsearch _search response.
+    """An Elasticsearch search response.
 
     {% for arg in response.args %}
         {% for line in arg.doc %}