Add type hints for Metadata

Author: oschwald

HISTORY.rst

@@ -3,6 +3,11 @@
 History
 -------
 
+2.6.0
+++++++++++++++++++
+
+* Added type annotations for instance variables on ``Metadata``
+
 2.5.2 (2024-01-09)
 ++++++++++++++++++
 

maxminddb/reader.py

@@ -16,7 +16,7 @@
 import struct
 from ipaddress import IPv4Address, IPv6Address
 from os import PathLike
-from typing import Any, AnyStr, IO, Optional, Tuple, Union
+from typing import Any, AnyStr, Dict, IO, List, Optional, Tuple, Union
 
 from maxminddb.const import MODE_AUTO, MODE_MMAP, MODE_FILE, MODE_MEMORY, MODE_FD
 from maxminddb.decoder import Decoder
@@ -270,67 +270,55 @@ def __enter__(self) -> "Reader":
 
 
 class Metadata:
-    """Metadata for the MaxMind DB reader
+    """Metadata for the MaxMind DB reader"""
 
+    binary_format_major_version: int
+    """
+    The major version number of the binary format used when creating the
+    database.
+    """
 
-    .. attribute:: binary_format_major_version
-
-      The major version number of the binary format used when creating the
-      database.
-
-      :type: int
-
-    .. attribute:: binary_format_minor_version
-
-      The minor version number of the binary format used when creating the
-      database.
-
-      :type: int
-
-    .. attribute:: build_epoch
-
-      The Unix epoch for the build time of the database.
-
-      :type: int
-
-    .. attribute:: database_type
-
-      A string identifying the database type, e.g., "GeoIP2-City".
-
-      :type: str
-
-    .. attribute:: description
-
-      A map from locales to text descriptions of the database.
-
-      :type: dict(str, str)
-
-    .. attribute:: ip_version
-
-      The IP version of the data in a database. A value of "4" means the
-      database only supports IPv4. A database with a value of "6" may support
-      both IPv4 and IPv6 lookups.
-
-      :type: int
-
-    .. attribute:: languages
-
-      A list of locale codes supported by the databse.
-
-      :type: list(str)
+    binary_format_minor_version: int
+    """
+    The minor version number of the binary format used when creating the
+    database.
+    """
 
-    .. attribute:: node_count
+    build_epoch: int
+    """
+    The Unix epoch for the build time of the database.
+    """
 
-      The number of nodes in the database.
+    database_type: str
+    """
+    A string identifying the database type, e.g., "GeoIP2-City".
+    """
 
-      :type: int
+    description: Dict[str, str]
+    """
+    A map from locales to text descriptions of the database.
+    """
 
-    .. attribute:: record_size
+    ip_version: int
+    """
+    The IP version of the data in a database. A value of "4" means the
+    database only supports IPv4. A database with a value of "6" may support
+    both IPv4 and IPv6 lookups.
+    """
 
-      The bit size of a record in the search tree.
+    languages: List[str]
+    """
+    A list of locale codes supported by the databse.
+    """
 
-      :type: int
+    node_count: int
+    """
+    The number of nodes in the database.
+    """
 
+    record_size: int
+    """
+    The bit size of a record in the search tree.
     """
 
     # pylint: disable=too-many-instance-attributes