Add type stubs for maxminddb.extension

Author: oschwald

HISTORY.rst

@@ -11,6 +11,7 @@ History
 * The ``Metadata`` class object is now available from the C extension
   module as ``maxminddb.extension.Metadata`` rather than
   ``maxminddb.extension.extension``.
+* Type stubs have been added for ``maxminddb.extension``.
 
 2.0.3 (2020-10-16)
 ++++++++++++++++++

maxminddb/extension.pyi

@@ -0,0 +1,44 @@
+from ipaddress import IPv4Address, IPv6Address
+from os import PathLike
+from typing import Any, AnyStr, IO, Mapping, Optional, Sequence, Text, Tuple, Union
+
+from maxminddb import MODE_AUTO
+from maxminddb.errors import InvalidDatabaseError as InvalidDatabaseError
+from maxminddb.types import Record
+
+class Reader:
+    closed: bool = ...
+    def __init__(
+        self, database: Union[AnyStr, int, PathLike, IO], mode: int = MODE_AUTO
+    ) -> None: ...
+    def close(self) -> None: ...
+    def get(
+        self, ip_address: Union[str, IPv6Address, IPv4Address]
+    ) -> Optional[Record]: ...
+    def get_with_prefix_len(
+        self, ip_address: Union[str, IPv6Address, IPv4Address]
+    ) -> Tuple[Optional[Record], int]: ...
+    def metadata(self) -> "Metadata": ...
+    def __enter__(self) -> "Reader": ...
+    def __exit__(self, *args) -> None: ...
+
+class Metadata:
+    @property
+    def node_count(self) -> int: ...
+    @property
+    def record_size(self) -> int: ...
+    @property
+    def ip_version(self) -> int: ...
+    @property
+    def database_type(self) -> Text: ...
+    @property
+    def languages(self) -> Sequence[Text]: ...
+    @property
+    def binary_format_major_version(self) -> int: ...
+    @property
+    def binary_format_minor_version(self) -> int: ...
+    @property
+    def build_epoch(self) -> int: ...
+    @property
+    def description(self) -> Mapping[Text, Text]: ...
+    def __init__(self, **kwargs: Any) -> None: ...

setup.py

@@ -107,7 +107,7 @@ def run_setup(with_cext):
         long_description=README,
         url="http://www.maxmind.com/",
         packages=find_packages("."),
-        package_data={"": ["LICENSE"], "maxminddb": ["py.typed"]},
+        package_data={"": ["LICENSE"], "maxminddb": ["extension.pyi", "py.typed"]},
         package_dir={"maxminddb": "maxminddb"},
         python_requires=">=3.6",
         include_package_data=True,