1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
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."""
|
