maxminddb 2.5.2__tar.gz → 2.6.1__tar.gz

{maxminddb-2.5.2 → maxminddb-2.6.1}/HISTORY.rst

@@ -3,6 +3,24 @@
 History
 -------
 
+2.6.1 (2024-04-12)
+++++++++++++++++++
+
+* This release includes no source code changes. The only changes are to
+  the release workflow.
+* Binary wheels are now built on Linux for aarch64. Pull request by Kevin
+  Park. GitHub #160.
+* Binary wheels are now built on macOS for Apple silicon. Requested by
+  Kevin Park. GitHub #152.
+
+2.6.0 (2024-03-19)
+++++++++++++++++++
+
+* Added type annotations for instance variables on ``Metadata``
+* Updated type stubs for ``maxminddb.extension``.
+* ``setuptools`` is no longer listed as a runtime dependency. Pull request
+  by Lewis Collard. GitHub #155.
+
 2.5.2 (2024-01-09)
 ++++++++++++++++++
 

{maxminddb-2.5.2/maxminddb.egg-info → maxminddb-2.6.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: maxminddb
-Version: 2.5.2
+Version: 2.6.1
 Summary: Reader for the MaxMind DB format
 Author-email: Gregory Oschwald <goschwald@maxmind.com>
 License: Apache License, Version 2.0
@@ -25,7 +25,6 @@ Classifier: Topic :: Internet :: Proxy Servers
 Requires-Python: >=3.8
 Description-Content-Type: text/x-rst
 License-File: LICENSE
-Requires-Dist: setuptools>=68.2.2
 
 ========================
 MaxMind DB Python Module

{maxminddb-2.5.2 → maxminddb-2.6.1}/docs/conf.py

@@ -53,7 +53,7 @@ master_doc = "index"
 
 # General information about the project.
 project = "maxminddb"
-copyright = "2013-2023, MaxMind, Inc."
+copyright = "2013-2024, MaxMind, Inc."
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the

{maxminddb-2.5.2 → maxminddb-2.6.1}/docs/index.rst

@@ -35,6 +35,6 @@ Indices and tables
 * :ref:`modindex`
 * :ref:`search`
 
-:copyright: (c) 2013-2023 by MaxMind, Inc.
+:copyright: (c) 2013-2024 by MaxMind, Inc.
 :license: Apache License, Version 2.0
 

{maxminddb-2.5.2 → maxminddb-2.6.1}/maxminddb/__init__.py

@@ -81,7 +81,7 @@ def open_database(
 
 
 __title__ = "maxminddb"
-__version__ = "2.5.2"
+__version__ = "2.6.1"
 __author__ = "Gregory Oschwald"
 __license__ = "Apache License, Version 2.0"
-__copyright__ = "Copyright 2013-2023 MaxMind, Inc."
+__copyright__ = "Copyright 2013-2024 MaxMind, Inc."

{maxminddb-2.5.2 → maxminddb-2.6.1}/maxminddb/decoder.py

@@ -5,6 +5,7 @@ maxminddb.decoder
 This package contains code for decoding the MaxMind DB data section.
 
 """
+
 import struct
 from typing import cast, Dict, List, Tuple, Union
 

maxminddb-2.6.1/maxminddb/extension.pyi

@@ -0,0 +1,116 @@
+"""
+maxminddb.extension
+~~~~~~~~~~~~~~~~
+
+This module contains the C extension database reader and related classes.
+
+"""
+
+from ipaddress import IPv4Address, IPv6Address
+from os import PathLike
+from typing import Any, AnyStr, Dict, IO, List, Optional, Tuple, Union
+from maxminddb import MODE_AUTO
+from maxminddb.types import Record
+
+class Reader:
+    """
+    A C extension implementation of a reader for the MaxMind DB format. IP
+    addresses can be looked up using the ``get`` method.
+    """
+
+    closed: bool = ...
+
+    def __init__(
+        self, database: Union[AnyStr, int, PathLike, IO], mode: int = MODE_AUTO
+    ) -> None:
+        """Reader for the MaxMind DB file format
+
+        Arguments:
+        database -- A path to a valid MaxMind DB file such as a GeoIP2 database
+                    file, or a file descriptor in the case of MODE_FD.
+        mode -- mode to open the database with. The only supported modes are
+                MODE_AUTO and MODE_MMAP_EXT.
+        """
+
+    def close(self) -> None:
+        """Closes the MaxMind DB file and returns the resources to the system"""
+
+    def get(self, ip_address: Union[str, IPv6Address, IPv4Address]) -> Optional[Record]:
+        """Return the record for the ip_address in the MaxMind DB
+
+
+        Arguments:
+        ip_address -- an IP address in the standard string notation
+        """
+
+    def get_with_prefix_len(
+        self, ip_address: Union[str, IPv6Address, IPv4Address]
+    ) -> Tuple[Optional[Record], int]:
+        """Return a tuple with the record and the associated prefix length
+
+
+        Arguments:
+        ip_address -- an IP address in the standard string notation
+        """
+
+    def metadata(self) -> "Metadata":
+        """Return the metadata associated with the MaxMind DB file"""
+
+    def __enter__(self) -> "Reader": ...
+    def __exit__(self, *args) -> None: ...
+
+# pylint: disable=too-few-public-methods
+class Metadata:
+    """Metadata for the MaxMind DB reader"""
+
+    binary_format_major_version: int
+    """
+    The major version number of the binary format used when creating the
+    database.
+    """
+
+    binary_format_minor_version: int
+    """
+    The minor version number of the binary format used when creating the
+    database.
+    """
+
+    build_epoch: int
+    """
+    The Unix epoch for the build time of the database.
+    """
+
+    database_type: str
+    """
+    A string identifying the database type, e.g., "GeoIP2-City".
+    """
+
+    description: Dict[str, str]
+    """
+    A map from locales to text descriptions of the database.
+    """
+
+    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.
+    """
+
+    languages: List[str]
+    """
+    A list of locale codes supported by the databse.
+    """
+
+    node_count: int
+    """
+    The number of nodes in the database.
+    """
+
+    record_size: int
+    """
+    The bit size of a record in the search tree.
+    """
+
+    def __init__(self, **kwargs: Any) -> None:
+        """Creates new Metadata object. kwargs are key/value pairs from spec"""

{maxminddb-2.5.2 → maxminddb-2.6.1}/maxminddb/reader.py

@@ -5,6 +5,7 @@ maxminddb.reader
 This module contains the pure Python database reader and related classes.
 
 """
+
 try:
     import mmap
 except ImportError:
@@ -15,7 +16,7 @@ import ipaddress
 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
@@ -28,7 +29,7 @@ _IPV4_MAX_NUM = 2**32
 
 class Reader:
     """
-    Instances of this class provide a reader for the MaxMind DB format. IP
+    A pure Python implementation of a reader for the MaxMind DB format. IP
     addresses can be looked up using the ``get`` method.
     """
 
@@ -268,71 +269,59 @@ class Reader:
         return self
 
 
+# pylint: disable=too-many-instance-attributes,R0801
 class Metadata:
-    """Metadata for the MaxMind DB reader
-
-
-    .. 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.
+    """Metadata for the MaxMind DB reader"""
 
-      :type: int
-
-    .. attribute:: languages
-
-      A list of locale codes supported by the databse.
+    binary_format_major_version: int
+    """
+    The major version number of the binary format used when creating the
+    database.
+    """
 
-      :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
     def __init__(self, **kwargs) -> None:
         """Creates new Metadata object. kwargs are key/value pairs from spec"""
         # Although I could just update __dict__, that is less obvious and it

{maxminddb-2.5.2 → maxminddb-2.6.1}/maxminddb/types.py

@@ -4,6 +4,7 @@ maxminddb.types
 
 This module provides a Record type that represents a database record.
 """
+
 from typing import AnyStr, Dict, List, Union
 
 Primitive = Union[AnyStr, bool, float, int]

{maxminddb-2.5.2 → maxminddb-2.6.1/maxminddb.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: maxminddb
-Version: 2.5.2
+Version: 2.6.1
 Summary: Reader for the MaxMind DB format
 Author-email: Gregory Oschwald <goschwald@maxmind.com>
 License: Apache License, Version 2.0
@@ -25,7 +25,6 @@ Classifier: Topic :: Internet :: Proxy Servers
 Requires-Python: >=3.8
 Description-Content-Type: text/x-rst
 License-File: LICENSE
-Requires-Dist: setuptools>=68.2.2
 
 ========================
 MaxMind DB Python Module

{maxminddb-2.5.2 → maxminddb-2.6.1}/maxminddb.egg-info/SOURCES.txt

@@ -28,7 +28,6 @@ maxminddb/types.py
 maxminddb.egg-info/PKG-INFO
 maxminddb.egg-info/SOURCES.txt
 maxminddb.egg-info/dependency_links.txt
-maxminddb.egg-info/requires.txt
 maxminddb.egg-info/top_level.txt
 tests/decoder_test.py
 tests/reader_test.py

{maxminddb-2.5.2 → maxminddb-2.6.1}/pyproject.toml

@@ -1,17 +1,14 @@
 [build-system]
-requires = ["setuptools", "setuptools-scm", "wheel"]
+requires = ["setuptools>=68.2.2", "setuptools-scm", "wheel"]
 build-backend = "setuptools.build_meta"
 
 [project]
 name = "maxminddb"
-version = "2.5.2"
+version = "2.6.1"
 description = "Reader for the MaxMind DB format"
 authors = [
     {name = "Gregory Oschwald", email = "goschwald@maxmind.com"},
 ]
-dependencies = [
-    "setuptools>=68.2.2",
-]
 requires-python = ">=3.8"
 readme = "README.rst"
 license = {text = "Apache License, Version 2.0"}

maxminddb-2.5.2/maxminddb/extension.pyi

@@ -1,44 +0,0 @@
-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: ...

maxminddb-2.5.2/maxminddb.egg-info/requires.txt

@@ -1 +0,0 @@
-setuptools>=68.2.2