maxminddb 2.6.3__tar.gz → 2.7.0__tar.gz

{maxminddb-2.6.3 → maxminddb-2.7.0}/HISTORY.rst

@@ -3,6 +3,17 @@
 History
 -------
 
+2.7.0 (2025-05-05)
+++++++++++++++++++
+
+* IMPORTANT: Python 3.9 or greater is required. If you are using an older
+  version, please use an earlier release.
+* The vendored ``libmaxminddb`` has been updated to 1.12.2.
+* The C extension now checks that the database metadata lookup was
+  successful.
+* A theoretical segmentation fault with the C extension when doing lookups
+  on a corrupt or invalid database was fixed.
+
 2.6.3 (2025-01-09)
 ++++++++++++++++++
 

{maxminddb-2.6.3/maxminddb.egg-info → maxminddb-2.7.0}/PKG-INFO

@@ -1,9 +1,9 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: maxminddb
-Version: 2.6.3
+Version: 2.7.0
 Summary: Reader for the MaxMind DB format
 Author-email: Gregory Oschwald <goschwald@maxmind.com>
-License: Apache License, Version 2.0
+License-Expression: Apache-2.0
 Project-URL: Homepage, https://www.maxmind.com/
 Project-URL: Documentation, https://maxminddb.readthedocs.org/
 Project-URL: Source Code, https://github.com/maxmind/MaxMind-DB-Reader-python
@@ -12,10 +12,8 @@ Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Web Environment
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: System Administrators
-Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
@@ -23,9 +21,10 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Internet
 Classifier: Topic :: Internet :: Proxy Servers
-Requires-Python: >=3.8
+Requires-Python: >=3.9
 Description-Content-Type: text/x-rst
 License-File: LICENSE
+Dynamic: license-file
 
 ========================
 MaxMind DB Python Module
@@ -43,18 +42,18 @@ subnets (IPv4 or IPv6).
 Installation
 ------------
 
-To install maxminddb, type:
+To install ``maxminddb```, type:
 
 .. code-block:: bash
 
     $ pip install maxminddb
 
-If you are not able to use pip, you may also use easy_install from the
+If you are not able to install from PyPI, you may also use ``pip`` from the
 source directory:
 
 .. code-block:: bash
 
-    $ easy_install .
+    $ python -m pip install .
 
 The installer will attempt to build the C extension. If this fails, the
 module will fall-back to the pure Python implementation.
@@ -126,7 +125,7 @@ invalid IP address or an IPv6 address in an IPv4 database.
 Requirements
 ------------
 
-This code requires Python 3.8+. Older versions are not supported. The C
+This code requires Python 3.9+. Older versions are not supported. The C
 extension requires CPython.
 
 Versioning

{maxminddb-2.6.3 → maxminddb-2.7.0}/README.rst

@@ -14,18 +14,18 @@ subnets (IPv4 or IPv6).
 Installation
 ------------
 
-To install maxminddb, type:
+To install ``maxminddb```, type:
 
 .. code-block:: bash
 
     $ pip install maxminddb
 
-If you are not able to use pip, you may also use easy_install from the
+If you are not able to install from PyPI, you may also use ``pip`` from the
 source directory:
 
 .. code-block:: bash
 
-    $ easy_install .
+    $ python -m pip install .
 
 The installer will attempt to build the C extension. If this fails, the
 module will fall-back to the pure Python implementation.
@@ -97,7 +97,7 @@ invalid IP address or an IPv6 address in an IPv4 database.
 Requirements
 ------------
 
-This code requires Python 3.8+. Older versions are not supported. The C
+This code requires Python 3.9+. Older versions are not supported. The C
 extension requires CPython.
 
 Versioning

{maxminddb-2.6.3 → maxminddb-2.7.0}/docs/conf.py

@@ -1,5 +1,4 @@
 #!/usr/bin/env python3
-# -*- coding: utf-8 -*-
 #
 # maxminddb documentation build configuration file, created by
 # sphinx-quickstart on Tue Apr  9 13:34:57 2013.
@@ -12,8 +11,8 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-import sys
 import os
+import sys
 
 sys.path.insert(0, os.path.abspath(".."))
 import maxminddb

{maxminddb-2.6.3 → maxminddb-2.7.0}/docs/index.rst

@@ -8,20 +8,28 @@
 
 .. include:: ../README.rst
 
-=======
-Modules
-=======
+======
+Module
+======
 
 .. automodule:: maxminddb
     :members:
     :undoc-members:
     :show-inheritance:
 
+======
+Errors
+======
+
 .. automodule:: maxminddb.errors
     :members:
     :undoc-members:
     :show-inheritance:
 
+===============
+Database Reader
+===============
+
 .. automodule:: maxminddb.reader
     :members:
     :undoc-members:

{maxminddb-2.6.3 → maxminddb-2.7.0}/examples/benchmark.py

@@ -1,13 +1,13 @@
 #!/usr/bin/python
-# -*- coding: utf-8 -*-
 
 import argparse
-import maxminddb
 import random
 import socket
 import struct
 import timeit
 
+import maxminddb
+
 parser = argparse.ArgumentParser(description="Benchmark maxminddb.")
 parser.add_argument("--count", default=250000, type=int, help="number of lookups")
 parser.add_argument("--mode", default=0, type=int, help="reader mode to use")
@@ -19,9 +19,9 @@ random.seed(0)
 reader = maxminddb.open_database(args.file, args.mode)
 
 
-def lookup_ip_address():
+def lookup_ip_address() -> None:
     ip = socket.inet_ntoa(struct.pack("!L", random.getrandbits(32)))
-    record = reader.get(str(ip))
+    reader.get(str(ip))
 
 
 elapsed = timeit.timeit(
@@ -30,4 +30,4 @@ elapsed = timeit.timeit(
     number=args.count,
 )
 
-print("{:,}".format(int(args.count / elapsed)), "lookups per second")
+print(f"{int(args.count / elapsed):,}", "lookups per second")

{maxminddb-2.6.3 → maxminddb-2.7.0}/extension/libmaxminddb/src/data-pool.c

@@ -158,9 +158,13 @@ int main(void) {
 }
 
 static void test_can_multiply(void) {
-    { ok(can_multiply(SIZE_MAX, 1, SIZE_MAX), "1*SIZE_MAX is ok"); }
+    {
+        ok(can_multiply(SIZE_MAX, 1, SIZE_MAX), "1*SIZE_MAX is ok");
+    }
 
-    { ok(!can_multiply(SIZE_MAX, 2, SIZE_MAX), "2*SIZE_MAX is not ok"); }
+    {
+        ok(!can_multiply(SIZE_MAX, 2, SIZE_MAX), "2*SIZE_MAX is not ok");
+    }
 
     {
         ok(can_multiply(SIZE_MAX, 10240, sizeof(MMDB_entry_data_list_s)),

{maxminddb-2.6.3 → maxminddb-2.7.0}/extension/libmaxminddb/src/maxminddb.c

@@ -1636,6 +1636,8 @@ int MMDB_get_metadata_as_entry_data_list(
 
 int MMDB_get_entry_data_list(MMDB_entry_s *start,
                              MMDB_entry_data_list_s **const entry_data_list) {
+    *entry_data_list = NULL;
+
     MMDB_data_pool_s *const pool = data_pool_new(MMDB_POOL_INIT_SIZE);
     if (!pool) {
         return MMDB_OUT_OF_MEMORY_ERROR;

{maxminddb-2.6.3 → maxminddb-2.7.0}/extension/maxminddb.c

@@ -351,7 +351,14 @@ static PyObject *Reader_metadata(PyObject *self, PyObject *UNUSED(args)) {
     }
 
     MMDB_entry_data_list_s *entry_data_list;
-    MMDB_get_metadata_as_entry_data_list(mmdb_obj->mmdb, &entry_data_list);
+    int status =
+        MMDB_get_metadata_as_entry_data_list(mmdb_obj->mmdb, &entry_data_list);
+    if (status != MMDB_SUCCESS) {
+        PyErr_Format(MaxMindDB_error,
+                     "Error decoding metadata. %s",
+                     MMDB_strerror(status));
+        return NULL;
+    }
     MMDB_entry_data_list_s *original_entry_data_list = entry_data_list;
 
     PyObject *metadata_dict = from_entry_data_list(&entry_data_list);
@@ -744,10 +751,7 @@ static PyObject *from_map(MMDB_entry_data_list_s **entry_data_list) {
     const uint32_t map_size = (*entry_data_list)->entry_data.data_size;
 
     uint32_t i;
-    // entry_data_list cannot start out NULL (see from_entry_data_list). We
-    // check it in the loop because it may become NULL.
-    // coverity[check_after_deref]
-    for (i = 0; i < map_size && entry_data_list; i++) {
+    for (i = 0; i < map_size && *entry_data_list; i++) {
         *entry_data_list = (*entry_data_list)->next;
 
         PyObject *key = PyUnicode_FromStringAndSize(
@@ -785,10 +789,7 @@ static PyObject *from_array(MMDB_entry_data_list_s **entry_data_list) {
     }
 
     uint32_t i;
-    // entry_data_list cannot start out NULL (see from_entry_data_list). We
-    // check it in the loop because it may become NULL.
-    // coverity[check_after_deref]
-    for (i = 0; i < size && entry_data_list; i++) {
+    for (i = 0; i < size && *entry_data_list; i++) {
         *entry_data_list = (*entry_data_list)->next;
         PyObject *value = from_entry_data_list(entry_data_list);
         if (value == NULL) {

{maxminddb-2.6.3 → maxminddb-2.7.0}/maxminddb/__init__.py

@@ -1,3 +1,5 @@
+"""Module for reading MaxMind DB files."""
+
 # pylint:disable=C0111
 import os
 from typing import IO, AnyStr, Union, cast
@@ -21,13 +23,13 @@ except ImportError:
 
 
 __all__ = [
-    "InvalidDatabaseError",
     "MODE_AUTO",
     "MODE_FD",
     "MODE_FILE",
     "MODE_MEMORY",
     "MODE_MMAP",
     "MODE_MMAP_EXT",
+    "InvalidDatabaseError",
     "Reader",
     "open_database",
 ]
@@ -37,7 +39,7 @@ def open_database(
     database: Union[AnyStr, int, os.PathLike, IO],
     mode: int = MODE_AUTO,
 ) -> Reader:
-    """Open a MaxMind DB database
+    """Open a MaxMind DB database.
 
     Arguments:
         database -- A path to a valid MaxMind DB file such as a GeoIP2 database
@@ -51,6 +53,7 @@ def open_database(
                         a path. This mode implies MODE_MEMORY.
             * MODE_AUTO - tries MODE_MMAP_EXT, MODE_MMAP, MODE_FILE in that
                           order. Default mode.
+
     """
     if mode not in (
         MODE_AUTO,
@@ -70,7 +73,7 @@ def open_database(
 
     if not has_extension:
         raise ValueError(
-            "MODE_MMAP_EXT requires the maxminddb.extension module to be available"
+            "MODE_MMAP_EXT requires the maxminddb.extension module to be available",
         )
 
     # The C type exposes the same API as the Python Reader, so for type
@@ -81,7 +84,7 @@ def open_database(
 
 
 __title__ = "maxminddb"
-__version__ = "2.6.3"
+__version__ = "2.7.0"
 __author__ = "Gregory Oschwald"
 __license__ = "Apache License, Version 2.0"
 __copyright__ = "Copyright 2013-2025 MaxMind, Inc."

{maxminddb-2.6.3 → maxminddb-2.7.0}/maxminddb/const.py

@@ -1,4 +1,4 @@
-"""Constants used in the API"""
+"""Constants used in the API."""
 
 MODE_AUTO = 0
 MODE_MMAP_EXT = 1

{maxminddb-2.6.3 → maxminddb-2.7.0}/maxminddb/decoder.py

@@ -1,13 +1,7 @@
-"""
-maxminddb.decoder
-~~~~~~~~~~~~~~~~~
-
-This package contains code for decoding the MaxMind DB data section.
-
-"""
+"""Decoder for the MaxMind DB data section."""
 
 import struct
-from typing import cast, Dict, List, Tuple, Union
+from typing import Union, cast
 
 try:
     # pylint: disable=unused-import
@@ -23,7 +17,7 @@ from maxminddb.types import Record
 
 
 class Decoder:  # pylint: disable=too-few-public-methods
-    """Decoder for the data section of the MaxMind DB"""
+    """Decoder for the data section of the MaxMind DB."""
 
     def __init__(
         self,
@@ -31,46 +25,47 @@ class Decoder:  # pylint: disable=too-few-public-methods
         pointer_base: int = 0,
         pointer_test: bool = False,
     ) -> None:
-        """Created a Decoder for a MaxMind DB
+        """Created a Decoder for a MaxMind DB.
 
         Arguments:
         database_buffer -- an mmap'd MaxMind DB file.
         pointer_base -- the base number to use when decoding a pointer
         pointer_test -- used for internal unit testing of pointer code
+
         """
         self._pointer_test = pointer_test
         self._buffer = database_buffer
         self._pointer_base = pointer_base
 
-    def _decode_array(self, size: int, offset: int) -> Tuple[List[Record], int]:
+    def _decode_array(self, size: int, offset: int) -> tuple[list[Record], int]:
         array = []
         for _ in range(size):
             (value, offset) = self.decode(offset)
             array.append(value)
         return array, offset
 
-    def _decode_boolean(self, size: int, offset: int) -> Tuple[bool, int]:
+    def _decode_boolean(self, size: int, offset: int) -> tuple[bool, int]:
         return size != 0, offset
 
-    def _decode_bytes(self, size: int, offset: int) -> Tuple[bytes, int]:
+    def _decode_bytes(self, size: int, offset: int) -> tuple[bytes, int]:
         new_offset = offset + size
         return self._buffer[offset:new_offset], new_offset
 
-    def _decode_double(self, size: int, offset: int) -> Tuple[float, int]:
+    def _decode_double(self, size: int, offset: int) -> tuple[float, int]:
         self._verify_size(size, 8)
         new_offset = offset + size
         packed_bytes = self._buffer[offset:new_offset]
         (value,) = struct.unpack(b"!d", packed_bytes)
         return value, new_offset
 
-    def _decode_float(self, size: int, offset: int) -> Tuple[float, int]:
+    def _decode_float(self, size: int, offset: int) -> tuple[float, int]:
         self._verify_size(size, 4)
         new_offset = offset + size
         packed_bytes = self._buffer[offset:new_offset]
         (value,) = struct.unpack(b"!f", packed_bytes)
         return value, new_offset
 
-    def _decode_int32(self, size: int, offset: int) -> Tuple[int, int]:
+    def _decode_int32(self, size: int, offset: int) -> tuple[int, int]:
         if size == 0:
             return 0, offset
         new_offset = offset + size
@@ -81,15 +76,15 @@ class Decoder:  # pylint: disable=too-few-public-methods
         (value,) = struct.unpack(b"!i", packed_bytes)
         return value, new_offset
 
-    def _decode_map(self, size: int, offset: int) -> Tuple[Dict[str, Record], int]:
-        container: Dict[str, Record] = {}
+    def _decode_map(self, size: int, offset: int) -> tuple[dict[str, Record], int]:
+        container: dict[str, Record] = {}
         for _ in range(size):
             (key, offset) = self.decode(offset)
             (value, offset) = self.decode(offset)
-            container[cast(str, key)] = value
+            container[cast("str", key)] = value
         return container, offset
 
-    def _decode_pointer(self, size: int, offset: int) -> Tuple[Record, int]:
+    def _decode_pointer(self, size: int, offset: int) -> tuple[Record, int]:
         pointer_size = (size >> 3) + 1
 
         buf = self._buffer[offset : offset + pointer_size]
@@ -112,12 +107,12 @@ class Decoder:  # pylint: disable=too-few-public-methods
         (value, _) = self.decode(pointer)
         return value, new_offset
 
-    def _decode_uint(self, size: int, offset: int) -> Tuple[int, int]:
+    def _decode_uint(self, size: int, offset: int) -> tuple[int, int]:
         new_offset = offset + size
         uint_bytes = self._buffer[offset:new_offset]
         return int.from_bytes(uint_bytes, "big"), new_offset
 
-    def _decode_utf8_string(self, size: int, offset: int) -> Tuple[str, int]:
+    def _decode_utf8_string(self, size: int, offset: int) -> tuple[str, int]:
         new_offset = offset + size
         return self._buffer[offset:new_offset].decode("utf-8"), new_offset
 
@@ -137,11 +132,12 @@ class Decoder:  # pylint: disable=too-few-public-methods
         15: _decode_float,
     }
 
-    def decode(self, offset: int) -> Tuple[Record, int]:
-        """Decode a section of the data section starting at offset
+    def decode(self, offset: int) -> tuple[Record, int]:
+        """Decode a section of the data section starting at offset.
 
         Arguments:
         offset -- the location of the data structure to decode
+
         """
         new_offset = offset + 1
         ctrl_byte = self._buffer[offset]
@@ -154,19 +150,19 @@ class Decoder:  # pylint: disable=too-few-public-methods
             decoder = self._type_decoder[type_num]
         except KeyError as ex:
             raise InvalidDatabaseError(
-                f"Unexpected type number ({type_num}) encountered"
+                f"Unexpected type number ({type_num}) encountered",
             ) from ex
 
         (size, new_offset) = self._size_from_ctrl_byte(ctrl_byte, new_offset, type_num)
         return decoder(self, size, new_offset)
 
-    def _read_extended(self, offset: int) -> Tuple[int, int]:
+    def _read_extended(self, offset: int) -> tuple[int, int]:
         next_byte = self._buffer[offset]
         type_num = next_byte + 7
         if type_num < 7:
             raise InvalidDatabaseError(
                 "Something went horribly wrong in the decoder. An "
-                f"extended type resolved to a type number < 8 ({type_num})"
+                f"extended type resolved to a type number < 8 ({type_num})",
             )
         return type_num, offset + 1
 
@@ -175,12 +171,15 @@ class Decoder:  # pylint: disable=too-few-public-methods
         if expected != actual:
             raise InvalidDatabaseError(
                 "The MaxMind DB file's data section contains bad data "
-                "(unknown data type or corrupt data)"
+                "(unknown data type or corrupt data)",
             )
 
     def _size_from_ctrl_byte(
-        self, ctrl_byte: int, offset: int, type_num: int
-    ) -> Tuple[int, int]:
+        self,
+        ctrl_byte: int,
+        offset: int,
+        type_num: int,
+    ) -> tuple[int, int]:
         size = ctrl_byte & 0x1F
         if type_num == 1 or size < 29:
             return size, offset

maxminddb-2.7.0/maxminddb/errors.py

@@ -0,0 +1,5 @@
+"""Typed errors thrown by this library."""
+
+
+class InvalidDatabaseError(RuntimeError):
+    """An error thrown when unexpected data is found in the database."""

{maxminddb-2.6.3 → maxminddb-2.7.0}/maxminddb/extension.pyi

@@ -1,27 +1,24 @@
-"""
-maxminddb.extension
-~~~~~~~~~~~~~~~~
-
-This module contains the C extension database reader and related classes.
-
-"""
+"""C extension database reader and related classes."""
 
+# pylint: disable=E0601,E0602
 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 typing import IO, Any, AnyStr, Optional, Union
+
+from maxminddb.const import MODE_AUTO
 from maxminddb.types import Record
 
 class Reader:
-    """
-    A C extension implementation of a reader for the MaxMind DB format. IP
+    """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
+        self,
+        database: Union[AnyStr, int, PathLike, IO],
+        mode: int = MODE_AUTO,
     ) -> None:
         """Reader for the MaxMind DB file format
 
@@ -30,6 +27,7 @@ class Reader:
                     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:
@@ -38,25 +36,26 @@ class Reader:
     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]:
+        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":
+    def metadata(self) -> Metadata:
         """Return the metadata associated with the MaxMind DB file"""
 
-    def __enter__(self) -> "Reader": ...
+    def __enter__(self) -> Reader: ...
     def __exit__(self, *args) -> None: ...
 
 # pylint: disable=too-few-public-methods
@@ -85,7 +84,7 @@ class Metadata:
     A string identifying the database type, e.g., "GeoIP2-City".
     """
 
-    description: Dict[str, str]
+    description: dict[str, str]
     """
     A map from locales to text descriptions of the database.
     """
@@ -97,7 +96,7 @@ class Metadata:
     both IPv4 and IPv6 lookups.
     """
 
-    languages: List[str]
+    languages: list[str]
     """
     A list of locale codes supported by the databse.
     """

{maxminddb-2.6.3 → maxminddb-2.7.0}/maxminddb/file.py

@@ -11,7 +11,7 @@ except ImportError:
 
 
 class FileBuffer:
-    """A slice-able file reader"""
+    """A slice-able file reader."""
 
     def __init__(self, database: str) -> None:
         # pylint: disable=consider-using-with
@@ -28,31 +28,31 @@ class FileBuffer:
         raise TypeError("Invalid argument type.")
 
     def rfind(self, needle: bytes, start: int) -> int:
-        """Reverse find needle from start"""
+        """Reverse find needle from start."""
         pos = self._read(self._size - start - 1, start).rfind(needle)
         if pos == -1:
             return pos
         return start + pos
 
     def size(self) -> int:
-        """Size of file"""
+        """Size of file."""
         return self._size
 
     def close(self) -> None:
-        """Close file"""
+        """Close file."""
         self._handle.close()
 
     if hasattr(os, "pread"):
 
         def _read(self, buffersize: int, offset: int) -> bytes:
-            """read that uses pread"""
+            """Read that uses pread."""
             # pylint: disable=no-member
             return os.pread(self._handle.fileno(), buffersize, offset)  # type: ignore
 
     else:
 
         def _read(self, buffersize: int, offset: int) -> bytes:
-            """read with a lock
+            """Read with a lock.
 
             This lock is necessary as after a fork, the different processes
             will share the same file table entry, even if we dup the fd, and