Add type hints to APIs

Author: sethmlarson

.gitattributes

@@ -0,0 +1 @@
+*.pyi binary

MANIFEST.in

@@ -7,6 +7,7 @@ include README.rst
 include README
 include tox.ini
 include setup.py
+recursive-include elasticsearch* py.typed
 recursive-include docs *
 
 prune docs/_build

elasticsearch/__init__.pyi

@@ -0,0 +1,49 @@
+# Licensed to Elasticsearch B.V under one or more agreements.
+# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
+# See the LICENSE file in the project root for more information
+
+import sys
+from typing import Tuple
+
+from .client import Elasticsearch as Elasticsearch
+from .transport import Transport as Transport
+from .connection_pool import (
+    ConnectionPool as ConnectionPool,
+    ConnectionSelector as ConnectionSelector,
+    RoundRobinSelector as RoundRobinSelector,
+)
+from .serializer import JSONSerializer as JSONSerializer
+from .connection import (
+    Connection as Connection,
+    RequestsHttpConnection as RequestsHttpConnection,
+    Urllib3HttpConnection as Urllib3HttpConnection,
+)
+from .exceptions import (
+    ImproperlyConfigured as ImproperlyConfigured,
+    ElasticsearchException as ElasticsearchException,
+    SerializationError as SerializationError,
+    TransportError as TransportError,
+    NotFoundError as NotFoundError,
+    ConflictError as ConflictError,
+    RequestError as RequestError,
+    ConnectionError as ConnectionError,
+    SSLError as SSLError,
+    ConnectionTimeout as ConnectionTimeout,
+    AuthenticationException as AuthenticationException,
+    AuthorizationException as AuthorizationException,
+    ElasticsearchDeprecationWarning as ElasticsearchDeprecationWarning,
+)
+
+try:
+    if sys.version_info < (3, 6):
+        raise ImportError
+
+    from ._async.http_aiohttp import AIOHttpConnection as AIOHttpConnection
+    from ._async.transport import AsyncTransport as AsyncTransport
+    from ._async.client import AsyncElasticsearch as AsyncElasticsearch
+except (ImportError, SyntaxError):
+    pass
+
+VERSION: Tuple[int, int, int]
+__version__: Tuple[int, int, int]
+__versionstr__: str

elasticsearch/_async/_extra_imports.py

@@ -0,0 +1,23 @@
+# Licensed to Elasticsearch B.V under one or more agreements.
+# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
+# See the LICENSE file in the project root for more information
+
+# type: ignore
+
+# This file exists for the sole reason of making mypy not
+# complain about type issues to do with 'aiohttp' and 'yarl'.
+# We're in a catch-22 situation:
+# - If we use 'type: ignore' on 'import aiohttp' and it's not installed
+#   mypy will complain that the annotation is unnecessary.
+# - If we don't use 'type: ignore' on 'import aiohttp' and it
+#   it's not installed mypy will complain that it can't find
+#   type hints for aiohttp.
+# So to make mypy happy we move all our 'extra' imports here
+# and add a global 'type: ignore' which mypy never complains
+# about being unnecessary.
+
+import aiohttp
+import aiohttp.client_exceptions as aiohttp_exceptions
+import yarl
+
+__all__ = ["aiohttp", "aiohttp_exceptions", "yarl"]