maxminddb 2.8.2__cp313-cp313-android_21_arm64_v8a.whl

maxminddb/__init__.py

@@ -0,0 +1,94 @@
+"""Module for reading MaxMind DB files."""
+
+from __future__ import annotations
+
+from typing import IO, TYPE_CHECKING, AnyStr, cast
+
+from .const import (
+    MODE_AUTO,
+    MODE_FD,
+    MODE_FILE,
+    MODE_MEMORY,
+    MODE_MMAP,
+    MODE_MMAP_EXT,
+)
+from .decoder import InvalidDatabaseError
+from .reader import Reader
+
+if TYPE_CHECKING:
+    import os
+
+try:
+    from . import extension as _extension
+except ImportError:
+    _extension = None  # type: ignore[assignment]
+
+
+__all__ = [
+    "MODE_AUTO",
+    "MODE_FD",
+    "MODE_FILE",
+    "MODE_MEMORY",
+    "MODE_MMAP",
+    "MODE_MMAP_EXT",
+    "InvalidDatabaseError",
+    "Reader",
+    "open_database",
+]
+
+
+def open_database(
+    database: AnyStr | int | os.PathLike | IO,
+    mode: int = MODE_AUTO,
+) -> Reader:
+    """Open a MaxMind DB database.
+
+    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. Valid mode are:
+              * MODE_MMAP_EXT - use the C extension with memory map.
+              * MODE_MMAP - read from memory map. Pure Python.
+              * MODE_FILE - read database as standard file. Pure Python.
+              * MODE_MEMORY - load database into memory. Pure Python.
+              * MODE_FD - the param passed via database is a file descriptor, not
+                          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,
+        MODE_FD,
+        MODE_FILE,
+        MODE_MEMORY,
+        MODE_MMAP,
+        MODE_MMAP_EXT,
+    ):
+        msg = f"Unsupported open mode: {mode}"
+        raise ValueError(msg)
+
+    has_extension = _extension and hasattr(_extension, "Reader")
+    use_extension = has_extension if mode == MODE_AUTO else mode == MODE_MMAP_EXT
+
+    if not use_extension:
+        return Reader(database, mode)
+
+    if not has_extension:
+        msg = "MODE_MMAP_EXT requires the maxminddb.extension module to be available"
+        raise ValueError(
+            msg,
+        )
+
+    # The C type exposes the same API as the Python Reader, so for type
+    # checking purposes, pretend it is one. (Ideally this would be a subclass
+    # of, or share a common parent class with, the Python Reader
+    # implementation.)
+    return cast("Reader", _extension.Reader(database, mode))
+
+
+__title__ = "maxminddb"
+__version__ = "2.8.2"
+__author__ = "Gregory Oschwald"
+__license__ = "Apache License, Version 2.0"
+__copyright__ = "Copyright 2013-2025 MaxMind, Inc."

maxminddb/const.py

@@ -0,0 +1,8 @@
+"""Constants used in the API."""
+
+MODE_AUTO = 0
+MODE_MMAP_EXT = 1
+MODE_MMAP = 2
+MODE_FILE = 4
+MODE_MEMORY = 8
+MODE_FD = 16

maxminddb/decoder.py

@@ -0,0 +1,207 @@
+"""Decoder for the MaxMind DB data section."""
+
+import struct
+from typing import ClassVar, Union, cast
+
+try:
+    import mmap
+except ImportError:
+    mmap = None  # type: ignore[assignment]
+
+
+from maxminddb.errors import InvalidDatabaseError
+from maxminddb.file import FileBuffer
+from maxminddb.types import Record
+
+
+class Decoder:
+    """Decoder for the data section of the MaxMind DB."""
+
+    def __init__(
+        self,
+        database_buffer: Union[FileBuffer, "mmap.mmap", bytes],
+        pointer_base: int = 0,
+        pointer_test: bool = False,  # noqa: FBT001, FBT002
+    ) -> None:
+        """Create 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]:
+        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]:
+        return size != 0, offset
+
+    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]:
+        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]:
+        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]:
+        if size == 0:
+            return 0, offset
+        new_offset = offset + size
+        packed_bytes = self._buffer[offset:new_offset]
+
+        if size != 4:
+            packed_bytes = packed_bytes.rjust(4, b"\x00")
+        (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] = {}
+        for _ in range(size):
+            (key, offset) = self.decode(offset)
+            (value, offset) = self.decode(offset)
+            container[cast("str", key)] = value
+        return container, offset
+
+    def _decode_pointer(self, size: int, offset: int) -> tuple[Record, int]:
+        pointer_size = (size >> 3) + 1
+
+        buf = self._buffer[offset : offset + pointer_size]
+        new_offset = offset + pointer_size
+
+        if pointer_size == 1:
+            buf = bytes([size & 0x7]) + buf
+            pointer = struct.unpack(b"!H", buf)[0] + self._pointer_base
+        elif pointer_size == 2:
+            buf = b"\x00" + bytes([size & 0x7]) + buf
+            pointer = struct.unpack(b"!I", buf)[0] + 2048 + self._pointer_base
+        elif pointer_size == 3:
+            buf = bytes([size & 0x7]) + buf
+            pointer = struct.unpack(b"!I", buf)[0] + 526336 + self._pointer_base
+        else:
+            pointer = struct.unpack(b"!I", buf)[0] + self._pointer_base
+
+        if self._pointer_test:
+            return pointer, new_offset
+        (value, _) = self.decode(pointer)
+        return value, new_offset
+
+    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]:
+        new_offset = offset + size
+        return self._buffer[offset:new_offset].decode("utf-8"), new_offset
+
+    _type_decoder: ClassVar = {
+        1: _decode_pointer,
+        2: _decode_utf8_string,
+        3: _decode_double,
+        4: _decode_bytes,
+        5: _decode_uint,  # uint16
+        6: _decode_uint,  # uint32
+        7: _decode_map,
+        8: _decode_int32,
+        9: _decode_uint,  # uint64
+        10: _decode_uint,  # uint128
+        11: _decode_array,
+        14: _decode_boolean,
+        15: _decode_float,
+    }
+
+    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]
+        type_num = ctrl_byte >> 5
+        # Extended type
+        if not type_num:
+            (type_num, new_offset) = self._read_extended(new_offset)
+
+        try:
+            decoder = self._type_decoder[type_num]
+        except KeyError as ex:
+            msg = f"Unexpected type number ({type_num}) encountered"
+            raise InvalidDatabaseError(
+                msg,
+            ) 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]:
+        next_byte = self._buffer[offset]
+        type_num = next_byte + 7
+        if type_num < 7:
+            msg = (
+                "Something went horribly wrong in the decoder. An "
+                f"extended type resolved to a type number < 8 ({type_num})"
+            )
+            raise InvalidDatabaseError(
+                msg,
+            )
+        return type_num, offset + 1
+
+    @staticmethod
+    def _verify_size(expected: int, actual: int) -> None:
+        if expected != actual:
+            msg = (
+                "The MaxMind DB file's data section contains bad data "
+                "(unknown data type or corrupt data)"
+            )
+            raise InvalidDatabaseError(
+                msg,
+            )
+
+    def _size_from_ctrl_byte(
+        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
+
+        if size == 29:
+            size = 29 + self._buffer[offset]
+            return size, offset + 1
+
+        # Using unpack rather than int_from_bytes as it is faster
+        # here and below.
+        if size == 30:
+            new_offset = offset + 2
+            size_bytes = self._buffer[offset:new_offset]
+            size = 285 + struct.unpack(b"!H", size_bytes)[0]
+            return size, new_offset
+
+        new_offset = offset + 3
+        size_bytes = self._buffer[offset:new_offset]
+        size = struct.unpack(b"!I", b"\x00" + size_bytes)[0] + 65821
+        return size, new_offset

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/extension.pyi

@@ -0,0 +1,115 @@
+"""C extension database reader and related classes."""
+
+from ipaddress import IPv4Address, IPv6Address
+from os import PathLike
+from typing import IO, Any, AnyStr
+
+from typing_extensions import Self
+
+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: AnyStr | int | PathLike | IO,
+        mode: int = ...,
+    ) -> 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:
+        """Close the MaxMind DB file and returns the resources to the system."""
+
+    def get(self, ip_address: str | IPv6Address | IPv4Address) -> Record | None:
+        """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: str | IPv6Address | IPv4Address,
+    ) -> tuple[Record | None, 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) -> Self: ...
+    def __exit__(self, *args) -> None: ...  # noqa: ANN002
+
+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 database.
+    """
+
+    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:  # noqa: ANN401
+        """Create new Metadata object. kwargs are key/value pairs from spec."""

maxminddb/file.py

@@ -0,0 +1,74 @@
+"""For internal use only. It provides a slice-like file reader."""
+
+from __future__ import annotations
+
+import os
+from typing import overload
+
+try:
+    from multiprocessing import Lock
+except ImportError:
+    from threading import Lock  # type: ignore[assignment]
+
+
+class FileBuffer:
+    """A slice-able file reader."""
+
+    def __init__(self, database: str) -> None:
+        """Create FileBuffer."""
+        self._handle = open(database, "rb")  # noqa: SIM115
+        self._size = os.fstat(self._handle.fileno()).st_size
+        if not hasattr(os, "pread"):
+            self._lock = Lock()
+
+    @overload
+    def __getitem__(self, index: int) -> int: ...
+
+    @overload
+    def __getitem__(self, index: slice) -> bytes: ...
+
+    def __getitem__(self, index: slice | int) -> bytes | int:
+        """Get item by index."""
+        if isinstance(index, slice):
+            return self._read(index.stop - index.start, index.start)
+        if isinstance(index, int):
+            return self._read(1, index)[0]
+        msg = "Invalid argument type."
+        raise TypeError(msg)
+
+    def rfind(self, needle: bytes, start: int) -> int:
+        """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."""
+        return self._size
+
+    def close(self) -> None:
+        """Close file."""
+        self._handle.close()
+
+    if hasattr(os, "pread"):  # type: ignore[attr-defined]
+
+        def _read(self, buffersize: int, offset: int) -> bytes:
+            """Read that uses pread."""
+            return os.pread(self._handle.fileno(), buffersize, offset)  # type: ignore[attr-defined]
+
+    else:
+
+        def _read(self, buffersize: int, offset: int) -> bytes:
+            """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
+            as such the same offsets. There does not appear to be a way to
+            duplicate the file table entry and we cannot re-open based on the
+            original path as that file may have replaced with another or
+            unlinked.
+            """
+            with self._lock:
+                self._handle.seek(offset)
+                return self._handle.read(buffersize)

maxminddb/reader.py

@@ -0,0 +1,380 @@
+"""Pure-Python reader for the MaxMind DB file format."""
+
+from __future__ import annotations
+
+try:
+    import mmap
+except ImportError:
+    mmap = None  # type: ignore[assignment]
+
+import contextlib
+import ipaddress
+import struct
+from ipaddress import IPv4Address, IPv6Address
+from typing import IO, TYPE_CHECKING, Any, AnyStr
+
+from maxminddb.const import MODE_AUTO, MODE_FD, MODE_FILE, MODE_MEMORY, MODE_MMAP
+from maxminddb.decoder import Decoder
+from maxminddb.errors import InvalidDatabaseError
+from maxminddb.file import FileBuffer
+
+if TYPE_CHECKING:
+    from collections.abc import Iterator
+    from os import PathLike
+
+    from typing_extensions import Self
+
+    from maxminddb.types import Record
+
+_IPV4_MAX_NUM = 2**32
+
+
+class Reader:
+    """A pure Python implementation of a reader for the MaxMind DB format.
+
+    IP addresses can be looked up using the ``get`` method.
+    """
+
+    _DATA_SECTION_SEPARATOR_SIZE = 16
+    _METADATA_START_MARKER = b"\xab\xcd\xefMaxMind.com"
+
+    _buffer: bytes | FileBuffer | "mmap.mmap"  # noqa: UP037
+    _buffer_size: int
+    closed: bool
+    _decoder: Decoder
+    _metadata: Metadata
+    _ipv4_start: int
+
+    def __init__(
+        self,
+        database: 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. Valid mode are:
+                  * MODE_MMAP - read from memory map.
+                  * MODE_FILE - read database as standard file.
+                  * MODE_MEMORY - load database into memory.
+                  * MODE_AUTO - tries MODE_MMAP and then MODE_FILE. Default.
+                  * MODE_FD - the param passed via database is a file descriptor, not
+                              a path. This mode implies MODE_MEMORY.
+
+        """
+        filename: Any
+        if (mode == MODE_AUTO and mmap) or mode == MODE_MMAP:
+            with open(database, "rb") as db_file:  # type: ignore[arg-type]
+                self._buffer = mmap.mmap(db_file.fileno(), 0, access=mmap.ACCESS_READ)
+                self._buffer_size = self._buffer.size()
+            filename = database
+        elif mode in (MODE_AUTO, MODE_FILE):
+            self._buffer = FileBuffer(database)  # type: ignore[arg-type]
+            self._buffer_size = self._buffer.size()
+            filename = database
+        elif mode == MODE_MEMORY:
+            with open(database, "rb") as db_file:  # type: ignore[arg-type]
+                buf = db_file.read()
+                self._buffer = buf
+                self._buffer_size = len(buf)
+            filename = database
+        elif mode == MODE_FD:
+            self._buffer = database.read()  # type: ignore[union-attr]
+            self._buffer_size = len(self._buffer)  # type: ignore[arg-type]
+            filename = database.name  # type: ignore[union-attr]
+        else:
+            msg = (
+                f"Unsupported open mode ({mode}). Only MODE_AUTO, MODE_FILE, "
+                "MODE_MEMORY and MODE_FD are supported by the pure Python "
+                "Reader"
+            )
+            raise ValueError(
+                msg,
+            )
+
+        metadata_start = self._buffer.rfind(
+            self._METADATA_START_MARKER,
+            max(0, self._buffer_size - 128 * 1024),
+        )
+
+        if metadata_start == -1:
+            self.close()
+            msg = (
+                f"Error opening database file ({filename}). "
+                "Is this a valid MaxMind DB file?"
+            )
+            raise InvalidDatabaseError(
+                msg,
+            )
+
+        metadata_start += len(self._METADATA_START_MARKER)
+        metadata_decoder = Decoder(self._buffer, metadata_start)
+        (metadata, _) = metadata_decoder.decode(metadata_start)
+
+        if not isinstance(metadata, dict):
+            msg = f"Error reading metadata in database file ({filename})."
+            raise InvalidDatabaseError(
+                msg,
+            )
+
+        self._metadata = Metadata(**metadata)
+
+        self._decoder = Decoder(
+            self._buffer,
+            self._metadata.search_tree_size + self._DATA_SECTION_SEPARATOR_SIZE,
+        )
+        self.closed = False
+
+        ipv4_start = 0
+        if self._metadata.ip_version == 6:
+            # We store the IPv4 starting node as an optimization for IPv4 lookups
+            # in IPv6 trees. This allows us to skip over the first 96 nodes in
+            # this case.
+            node = 0
+            for _ in range(96):
+                if node >= self._metadata.node_count:
+                    break
+                node = self._read_node(node, 0)
+            ipv4_start = node
+        self._ipv4_start = ipv4_start
+
+    def metadata(self) -> Metadata:
+        """Return the metadata associated with the MaxMind DB file."""
+        return self._metadata
+
+    def get(self, ip_address: str | IPv6Address | IPv4Address) -> Record | None:
+        """Return the record for the ip_address in the MaxMind DB.
+
+        Arguments:
+            ip_address: an IP address in the standard string notation
+
+        """
+        (record, _) = self.get_with_prefix_len(ip_address)
+        return record
+
+    def get_with_prefix_len(
+        self,
+        ip_address: str | IPv6Address | IPv4Address,
+    ) -> tuple[Record | None, int]:
+        """Return a tuple with the record and the associated prefix length.
+
+        Arguments:
+            ip_address: an IP address in the standard string notation
+
+        """
+        if isinstance(ip_address, str):
+            address = ipaddress.ip_address(ip_address)
+        else:
+            address = ip_address
+
+        try:
+            packed_address = bytearray(address.packed)
+        except AttributeError as ex:
+            msg = "argument 1 must be a string or ipaddress object"
+            raise TypeError(msg) from ex
+
+        if address.version == 6 and self._metadata.ip_version == 4:
+            msg = (
+                f"Error looking up {ip_address}. You attempted to look up "
+                "an IPv6 address in an IPv4-only database."
+            )
+            raise ValueError(
+                msg,
+            )
+
+        (pointer, prefix_len) = self._find_address_in_tree(packed_address)
+
+        if pointer:
+            return self._resolve_data_pointer(pointer), prefix_len
+        return None, prefix_len
+
+    def __iter__(self) -> Iterator:
+        return self._generate_children(0, 0, 0)
+
+    def _generate_children(self, node: int, depth: int, ip_acc: int) -> Iterator:
+        if ip_acc != 0 and node == self._ipv4_start:
+            # Skip nodes aliased to IPv4
+            return
+
+        node_count = self._metadata.node_count
+        if node > node_count:
+            bits = 128 if self._metadata.ip_version == 6 else 32
+            ip_acc <<= bits - depth
+            if ip_acc <= _IPV4_MAX_NUM and bits == 128:
+                depth -= 96
+            yield (
+                ipaddress.ip_network((ip_acc, depth)),
+                self._resolve_data_pointer(
+                    node,
+                ),
+            )
+        elif node < node_count:
+            left = self._read_node(node, 0)
+            ip_acc <<= 1
+            depth += 1
+            yield from self._generate_children(left, depth, ip_acc)
+            right = self._read_node(node, 1)
+            yield from self._generate_children(right, depth, ip_acc | 1)
+
+    def _find_address_in_tree(self, packed: bytearray) -> tuple[int, int]:
+        bit_count = len(packed) * 8
+        node = self._start_node(bit_count)
+        node_count = self._metadata.node_count
+
+        i = 0
+        while i < bit_count and node < node_count:
+            bit = 1 & (packed[i >> 3] >> 7 - (i % 8))
+            node = self._read_node(node, bit)
+            i = i + 1
+
+        if node == node_count:
+            # Record is empty
+            return 0, i
+        if node > node_count:
+            return node, i
+
+        msg = "Invalid node in search tree"
+        raise InvalidDatabaseError(msg)
+
+    def _start_node(self, length: int) -> int:
+        if self._metadata.ip_version == 6 and length == 32:
+            return self._ipv4_start
+        return 0
+
+    def _read_node(self, node_number: int, index: int) -> int:
+        base_offset = node_number * self._metadata.node_byte_size
+
+        record_size = self._metadata.record_size
+        if record_size == 24:
+            offset = base_offset + index * 3
+            node_bytes = b"\x00" + self._buffer[offset : offset + 3]
+        elif record_size == 28:
+            offset = base_offset + 3 * index
+            node_bytes = bytearray(self._buffer[offset : offset + 4])
+            if index:
+                node_bytes[0] = 0x0F & node_bytes[0]
+            else:
+                middle = (0xF0 & node_bytes.pop()) >> 4
+                node_bytes.insert(0, middle)
+        elif record_size == 32:
+            offset = base_offset + index * 4
+            node_bytes = self._buffer[offset : offset + 4]
+        else:
+            msg = f"Unknown record size: {record_size}"
+            raise InvalidDatabaseError(msg)
+        return struct.unpack(b"!I", node_bytes)[0]
+
+    def _resolve_data_pointer(self, pointer: int) -> Record:
+        resolved = pointer - self._metadata.node_count + self._metadata.search_tree_size
+
+        if resolved >= self._buffer_size:
+            msg = "The MaxMind DB file's search tree is corrupt"
+            raise InvalidDatabaseError(msg)
+
+        (data, _) = self._decoder.decode(resolved)
+        return data
+
+    def close(self) -> None:
+        """Close the MaxMind DB file and returns the resources to the system."""
+        with contextlib.suppress(AttributeError):
+            self._buffer.close()  # type: ignore[union-attr]
+
+        self.closed = True
+
+    def __exit__(self, *_) -> None:  # noqa: ANN002
+        self.close()
+
+    def __enter__(self) -> Self:
+        if self.closed:
+            msg = "Attempt to reopen a closed MaxMind DB"
+            raise ValueError(msg)
+        return self
+
+
+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 database.
+    """
+
+    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) -> None:
+        """Create new Metadata object. kwargs are key/value pairs from spec."""
+        # Although I could just update __dict__, that is less obvious and it
+        # doesn't work well with static analysis tools and some IDEs
+        self.node_count = kwargs["node_count"]
+        self.record_size = kwargs["record_size"]
+        self.ip_version = kwargs["ip_version"]
+        self.database_type = kwargs["database_type"]
+        self.languages = kwargs["languages"]
+        self.binary_format_major_version = kwargs["binary_format_major_version"]
+        self.binary_format_minor_version = kwargs["binary_format_minor_version"]
+        self.build_epoch = kwargs["build_epoch"]
+        self.description = kwargs["description"]
+
+    @property
+    def node_byte_size(self) -> int:
+        """The size of a node in bytes.
+
+        :type: int
+        """
+        return self.record_size // 4
+
+    @property
+    def search_tree_size(self) -> int:
+        """The size of the search tree.
+
+        :type: int
+        """
+        return self.node_count * self.node_byte_size
+
+    def __repr__(self) -> str:
+        args = ", ".join(f"{k}={v!r}" for k, v in self.__dict__.items())
+        return f"{self.__module__}.{self.__class__.__name__}({args})"

maxminddb/types.py

@@ -0,0 +1,14 @@
+"""Types representing database records."""
+
+from typing import AnyStr, Union
+
+Primitive = Union[AnyStr, bool, float, int]
+Record = Union[Primitive, "RecordList", "RecordDict"]
+
+
+class RecordList(list[Record]):
+    """RecordList is a type for lists in a database record."""
+
+
+class RecordDict(dict[str, Record]):
+    """RecordDict is a type for dicts in a database record."""

maxminddb-2.8.2.dist-info/METADATA

@@ -0,0 +1,145 @@
+Metadata-Version: 2.4
+Name: maxminddb
+Version: 2.8.2
+Summary: Reader for the MaxMind DB format
+Author-email: Gregory Oschwald <goschwald@maxmind.com>
+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
+Project-URL: Issue Tracker, https://github.com/maxmind/MaxMind-DB-Reader-python/issues
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Web Environment
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Internet
+Classifier: Topic :: Internet :: Proxy Servers
+Requires-Python: >=3.9
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+Dynamic: license-file
+
+========================
+MaxMind DB Python Module
+========================
+
+Description
+-----------
+
+This is a Python module for reading MaxMind DB files. The module includes both
+a pure Python reader and an optional C extension.
+
+MaxMind DB is a binary file format that stores data indexed by IP address
+subnets (IPv4 or IPv6).
+
+Installation
+------------
+
+To install ``maxminddb``, type:
+
+.. code-block:: bash
+
+    $ pip install maxminddb
+
+If you are not able to install from PyPI, you may also use ``pip`` from the
+source directory:
+
+.. code-block:: bash
+
+    $ 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.
+
+Usage
+-----
+
+To use this module, you must first download or create a MaxMind DB file. We
+provide `free GeoLite2 databases
+<https://dev.maxmind.com/geoip/geolocate-an-ip/databases?lang=en>`_. These
+files must be decompressed with ``gunzip``.
+
+After you have obtained a database and imported the module, call
+``open_database`` with a path, or file descriptor (in the case of ``MODE_FD``),
+to the database as the first argument. Optionally, you may pass a mode as the
+second argument. The modes are exported from ``maxminddb``. Valid modes are:
+
+* ``MODE_MMAP_EXT`` - use the C extension with memory map.
+* ``MODE_MMAP`` - read from memory map. Pure Python.
+* ``MODE_FILE`` - read database as standard file. Pure Python.
+* ``MODE_MEMORY`` - load database into memory. Pure Python.
+* ``MODE_FD`` - load database into memory from a file descriptor. Pure Python.
+* ``MODE_AUTO`` - try ``MODE_MMAP_EXT``, ``MODE_MMAP``, ``MODE_FILE`` in that
+  order. Default.
+
+**NOTE**: When using ``MODE_FD``, it is the *caller's* responsibility to be
+sure that the file descriptor gets closed properly. The caller may close the
+file descriptor immediately after the ``Reader`` object is created.
+
+The ``open_database`` function returns a ``Reader`` object. To look up an IP
+address, use the ``get`` method on this object. The method will return the
+corresponding values for the IP address from the database (e.g., a dictionary
+for GeoIP2/GeoLite2 databases). If the database does not contain a record for
+that IP address, the method will return ``None``.
+
+If you wish to also retrieve the prefix length for the record, use the
+``get_with_prefix_len`` method. This returns a tuple containing the record
+followed by the network prefix length associated with the record.
+
+You may also iterate over the whole database. The ``Reader`` class implements
+the ``__iter__`` method that returns an iterator. This iterator yields a
+tuple containing the network and the record.
+
+Example
+-------
+
+.. code-block:: pycon
+
+    >>> import maxminddb
+    >>>
+    >>> with maxminddb.open_database('GeoLite2-City.mmdb') as reader:
+    >>>
+    >>>     reader.get('152.216.7.110')
+    {'country': ... }
+    >>>
+    >>>     reader.get_with_prefix_len('152.216.7.110')
+    ({'country': ... }, 24)
+    >>>
+    >>>     for network, record in reader:
+    >>>         ...
+
+Exceptions
+----------
+
+The module will return an ``InvalidDatabaseError`` if the database is corrupt
+or otherwise invalid. A ``ValueError`` will be thrown if you look up an
+invalid IP address or an IPv6 address in an IPv4 database.
+
+Requirements
+------------
+
+This code requires Python 3.9+. Older versions are not supported. The C
+extension requires CPython.
+
+Versioning
+----------
+
+The MaxMind DB Python module uses `Semantic Versioning <https://semver.org/>`_.
+
+Support
+-------
+
+Please report all issues with this code using the `GitHub issue tracker
+<https://github.com/maxmind/MaxMind-DB-Reader-python/issues>`_
+
+If you are having an issue with a MaxMind service that is not specific to this
+API, please contact `MaxMind support <https://www.maxmind.com/en/support>`_ for
+assistance.

maxminddb-2.8.2.dist-info/RECORD

@@ -0,0 +1,15 @@
+maxminddb/__init__.py,sha256=ESNJkA5VoLZsDCHGkU7Rhe7-ulJLxvtFbSV59XjYU8o,2656
+maxminddb/const.py,sha256=X8W_Zic36qfZRRxmZO2GmBUdWGMHLDqXh0d2MfpaYiM,123
+maxminddb/decoder.py,sha256=ljoIBp8V1gFcSweb9c_5H1_eYh04vwUghFVDpa303bw,7034
+maxminddb/errors.py,sha256=RCKtM1525SQgSY4ncztf8tXveQJX4nJ0VzA4uaIARes,160
+maxminddb/extension.cpython-313-aarch64-linux-android.so,sha256=LzR-Oa3jANl2j0Mi1o5sxkNqATsH8gwIucEm_wIVT8c,47288
+maxminddb/extension.pyi,sha256=0QOwgEK48_6XX1sdFzeUWUGJF9ct7m30PRSWTbFG5Zs,3056
+maxminddb/file.py,sha256=8jP0yM5q6FSpRkUw8U1nNJUcpJYnYpgUCNUgvP6xqCk,2401
+maxminddb/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+maxminddb/reader.py,sha256=-d7JeTgCnn6BW4JT99MVJXZ89s80QJf_YFmjEb5h-g4,12566
+maxminddb/types.py,sha256=EsiHjODJHMBdfZ3UwWE9BuN2wxM7tKCnh1RdTmkkV_s,375
+maxminddb-2.8.2.dist-info/licenses/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+maxminddb-2.8.2.dist-info/METADATA,sha256=1xCaVJaDkqcDvVUvJgu9dDEQHXIgfwTAiGEc2uiNuHw,5063
+maxminddb-2.8.2.dist-info/WHEEL,sha256=5I58AbR9O_ArnZQueeIBJrrQjT_lZqa3wHwMOp-EJ_E,112
+maxminddb-2.8.2.dist-info/top_level.txt,sha256=AKInnuDXa1wn83qmLWp8u5KzNupVHFWR8eSuSgsjTpc,10
+maxminddb-2.8.2.dist-info/RECORD,,

maxminddb-2.8.2.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: false
+Tag: cp313-cp313-android_21_arm64_v8a
+

maxminddb-2.8.2.dist-info/licenses/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

maxminddb-2.8.2.dist-info/top_level.txt

@@ -0,0 +1 @@
+maxminddb