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:
$ pip install maxminddb
If you are not able to use pip, you may also use easy_install from the source directory:
$ easy_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. 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
- tryMODE_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¶
>>> 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.8+. Older versions are not supported. The C extension requires CPython.
Versioning¶
The MaxMind DB Python module uses Semantic Versioning.
Support¶
Please report all issues with this code using the GitHub issue tracker
If you are having an issue with a MaxMind service that is not specific to this API, please contact MaxMind support for assistance.
Modules¶
- exception maxminddb.InvalidDatabaseError¶
Bases:
RuntimeError
This error is thrown when unexpected data is found in the database.
- class maxminddb.Reader(database: AnyStr | int | PathLike | IO, mode: int = 0)¶
Bases:
object
A pure Python implementation of a reader for the MaxMind DB format. IP addresses can be looked up using the
get
method.- get(ip_address: str | IPv6Address | IPv4Address) AnyStr | bool | float | int | RecordList | RecordDict | None ¶
Return the record for the ip_address in the MaxMind DB
Arguments: ip_address – an IP address in the standard string notation
- get_with_prefix_len(ip_address: str | IPv6Address | IPv4Address) Tuple[AnyStr | bool | float | int | RecordList | RecordDict | None, int] ¶
Return a tuple with the record and the associated prefix length
Arguments: ip_address – an IP address in the standard string notation
- maxminddb.open_database(database: AnyStr | int | PathLike | IO, mode: int = 0) 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.
maxminddb.errors¶
This module contains custom errors for the MaxMind DB reader
- exception maxminddb.errors.InvalidDatabaseError¶
Bases:
RuntimeError
This error is thrown when unexpected data is found in the database.
maxminddb.reader¶
This module contains the pure Python database reader and related classes.
- class maxminddb.reader.Metadata(**kwargs)¶
Bases:
object
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.
- class maxminddb.reader.Reader(database: AnyStr | int | PathLike | IO, mode: int = 0)¶
Bases:
object
A pure Python implementation of a reader for the MaxMind DB format. IP addresses can be looked up using the
get
method.- get(ip_address: str | IPv6Address | IPv4Address) AnyStr | bool | float | int | RecordList | RecordDict | None ¶
Return the record for the ip_address in the MaxMind DB
Arguments: ip_address – an IP address in the standard string notation
- get_with_prefix_len(ip_address: str | IPv6Address | IPv4Address) Tuple[AnyStr | bool | float | int | RecordList | RecordDict | None, int] ¶
Return a tuple with the record and the associated prefix length
Arguments: ip_address – an IP address in the standard string notation
Indices and tables¶
- copyright:
2013-2024 by MaxMind, Inc.
- license:
Apache License, Version 2.0