Merge pull request #67 from maxmind/greg/py3

Drop Python 2 support

Author: horgh

.pylintrc

@@ -1,5 +1,5 @@
 [MESSAGES CONTROL]
-disable=C0330,R0201,R0205,W0105
+disable=C0330
 
 [BASIC]
 

.travis.yml

@@ -1,22 +1,11 @@
 language: python
 matrix:
   include:
-    - python: 2.7
-      dist: trusty
-      env: RUN_SNYK=1
-    - python: 3.5
-      dist: trusty
     - python: 3.6
-      dist: trusty
     - python: 3.7
-      dist: xenial
     - python: 3.8
-      dist: xenial
       env: RUN_LINTER=1
     - python: nightly
-      dist: xenial
-    - python: pypy
-      dist: trusty
   allow_failures:
     - python: nightly
 
@@ -31,17 +20,17 @@ before_install:
   - sudo ldconfig
   - cd ..
   - pip install coverage coveralls
-  - if [[ $RUN_LINTER ]]; then pip install pylint black; fi
+  - if [[ $RUN_LINTER ]]; then pip install pylint black mypy; fi
   - |
     if [[ $RUN_SNYK && $SNYK_TOKEN ]]; then
       sudo apt-get install -y nodejs;
       npm install -g snyk;
     fi
 
 script:
-  - if [[ $TRAVIS_PYTHON_VERSION != 'pypy' ]]; then export MM_FORCE_EXT_TESTS=1; fi
-  - CFLAGS="-Werror -Wall -Wextra" coverage run --source maxminddb setup.py test
+  - MM_FORCE_EXT_TESTS=1 CFLAGS="-Werror -Wall -Wextra" coverage run --source maxminddb setup.py test
   - if [[ $RUN_SNYK && $SNYK_TOKEN ]]; then snyk test --org=maxmind --file=requirements.txt; fi
+  - if [[ $RUN_LINTER ]]; then mypy maxminddb tests; fi
   - if [[ $RUN_LINTER ]]; then pylint --rcfile .pylintrc maxminddb/*.py; fi
   - if [[ $RUN_LINTER ]]; then ./.travis-black.sh; fi
 

HISTORY.rst

@@ -3,6 +3,13 @@
 History
 -------
 
+2.0.0
+++++++++++++++++++
+
+* IMPORTANT: Python 3.6 or greater is required. If you are using an older
+  version, please use a 1.x.x release.
+* Type hints have been added to the pure Python implementation.
+
 1.5.4 (2020-05-05)
 ++++++++++++++++++
 

README.rst

@@ -93,12 +93,8 @@ invalid IP address or an IPv6 address in an IPv4 database.
 Requirements
 ------------
 
-This code requires Python 2.7+ or 3.5+. Older versions are not supported. The C
-extension requires CPython. The pure Python implementation has been tested with
-PyPy.
-
-On Python 2, the `ipaddress module <https://pypi.python.org/pypi/ipaddress>`_ is
-required.
+This code requires Python 3.6+. Older versions are not supported. The C
+extension requires CPython.
 
 Versioning
 ----------

docs/conf.py

@@ -53,7 +53,7 @@
 
 # General information about the project.
 project = "maxminddb"
-copyright = "2013-2019, MaxMind, Inc."
+copyright = "2013-2020, 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

docs/index.rst

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

examples/benchmark.py

@@ -1,8 +1,6 @@
 #!/usr/bin/python
 # -*- coding: utf-8 -*-
 
-from __future__ import print_function
-
 import argparse
 import maxminddb
 import random

extension/maxminddb.c

@@ -41,17 +41,6 @@ static PyObject *from_array(MMDB_entry_data_list_s **entry_data_list);
 static PyObject *from_uint128(const MMDB_entry_data_list_s *entry_data_list);
 static int ip_converter(PyObject *obj, struct sockaddr_storage *ip_address);
 
-#if PY_MAJOR_VERSION >= 3
-#define MOD_INIT(name) PyMODINIT_FUNC PyInit_##name(void)
-#define RETURN_MOD_INIT(m) return (m)
-#define FILE_NOT_FOUND_ERROR PyExc_FileNotFoundError
-#else
-#define MOD_INIT(name) PyMODINIT_FUNC init##name(void)
-#define RETURN_MOD_INIT(m) return
-#define PyInt_FromLong PyLong_FromLong
-#define FILE_NOT_FOUND_ERROR PyExc_IOError
-#endif
-
 #ifdef __GNUC__
 #define UNUSED(x) UNUSED_##x __attribute__((__unused__))
 #else
@@ -78,8 +67,9 @@ static int Reader_init(PyObject *self, PyObject *args, PyObject *kwds) {
     }
 
     if (0 != access(filename, R_OK)) {
-        PyErr_Format(
-            FILE_NOT_FOUND_ERROR, "No such file or directory: '%s'", filename);
+        PyErr_Format(PyExc_FileNotFoundError,
+                     "No such file or directory: '%s'",
+                     filename);
         return -1;
     }
 
@@ -213,17 +203,10 @@ static int get_record(PyObject *self, PyObject *args, PyObject **record) {
 }
 
 static int ip_converter(PyObject *obj, struct sockaddr_storage *ip_address) {
-#if PY_MAJOR_VERSION >= 3
     if (PyUnicode_Check(obj)) {
         Py_ssize_t len;
         const char *ipstr = PyUnicode_AsUTF8AndSize(obj, &len);
-#else
-    if (PyUnicode_Check(obj) || PyString_Check(obj)) {
-        // Although this should work on Python 3, we will hopefully delete
-        // this soon and the Python 3 version is cleaner.
-        const char *ipstr = PyString_AsString(obj);
-        Py_ssize_t len = PyString_Size(obj);
-#endif
+
         if (!ipstr) {
             PyErr_SetString(PyExc_TypeError,
                             "argument 1 contains an invalid string");
@@ -713,57 +696,51 @@ static PyTypeObject Metadata_Type = {
 
 static PyMethodDef MaxMindDB_methods[] = {{NULL, NULL, 0, NULL}};
 
-#if PY_MAJOR_VERSION >= 3
 static struct PyModuleDef MaxMindDB_module = {
     PyModuleDef_HEAD_INIT,
     .m_name = "extension",
     .m_doc = "This is a C extension to read MaxMind DB file format",
     .m_methods = MaxMindDB_methods,
 };
-#endif
 
-MOD_INIT(extension) {
+PyMODINIT_FUNC PyInit_extension(void) {
     PyObject *m;
 
-#if PY_MAJOR_VERSION >= 3
     m = PyModule_Create(&MaxMindDB_module);
-#else
-    m = Py_InitModule("extension", MaxMindDB_methods);
-#endif
 
     if (!m) {
-        RETURN_MOD_INIT(NULL);
+        return NULL;
     }
 
     Reader_Type.tp_new = PyType_GenericNew;
     if (PyType_Ready(&Reader_Type)) {
-        RETURN_MOD_INIT(NULL);
+        return NULL;
     }
     Py_INCREF(&Reader_Type);
     PyModule_AddObject(m, "Reader", (PyObject *)&Reader_Type);
 
     Metadata_Type.tp_new = PyType_GenericNew;
     if (PyType_Ready(&Metadata_Type)) {
-        RETURN_MOD_INIT(NULL);
+        return NULL;
     }
     PyModule_AddObject(m, "extension", (PyObject *)&Metadata_Type);
 
     PyObject *error_mod = PyImport_ImportModule("maxminddb.errors");
     if (error_mod == NULL) {
-        RETURN_MOD_INIT(NULL);
+        return NULL;
     }
 
     MaxMindDB_error = PyObject_GetAttrString(error_mod, "InvalidDatabaseError");
     Py_DECREF(error_mod);
 
     if (MaxMindDB_error == NULL) {
-        RETURN_MOD_INIT(NULL);
+        return NULL;
     }
 
     Py_INCREF(MaxMindDB_error);
 
     /* We primarily add it to the module for backwards compatibility */
     PyModule_AddObject(m, "InvalidDatabaseError", MaxMindDB_error);
 
-    RETURN_MOD_INIT(m);
+    return m;
 }

maxminddb/__init__.py

@@ -1,12 +1,13 @@
 # pylint:disable=C0111
 import os
+from typing import AnyStr, IO, Union
 
 import maxminddb.reader
 
 try:
     import maxminddb.extension
 except ImportError:
-    maxminddb.extension = None
+    maxminddb.extension = None  # type: ignore
 
 from maxminddb.const import (
     MODE_AUTO,
@@ -17,10 +18,13 @@
     MODE_FD,
 )
 from maxminddb.decoder import InvalidDatabaseError
+from maxminddb.reader import Reader as PyReader
 
 
-def open_database(database, mode=MODE_AUTO):
-    """Open a Maxmind DB database
+def open_database(
+    database: Union[AnyStr, int, os.PathLike, IO], mode: int = MODE_AUTO
+) -> Union[PyReader, "maxminddb.extension.Reader"]:
+    """Open a MaxMind DB database
 
     Arguments:
         database -- A path to a valid MaxMind DB file such as a GeoIP2 database
@@ -43,7 +47,7 @@ def open_database(database, mode=MODE_AUTO):
             )
         return maxminddb.extension.Reader(database)
     if mode in (MODE_AUTO, MODE_MMAP, MODE_FILE, MODE_MEMORY, MODE_FD):
-        return maxminddb.reader.Reader(database, mode)
+        return PyReader(database, mode)
     raise ValueError("Unsupported open mode: {0}".format(mode))
 
 
@@ -56,4 +60,4 @@ def Reader(database):  # pylint: disable=invalid-name
 __version__ = "1.5.4"
 __author__ = "Gregory Oschwald"
 __license__ = "Apache License, Version 2.0"
-__copyright__ = "Copyright 2013-2019 Maxmind, Inc."
+__copyright__ = "Copyright 2013-2020 MaxMind, Inc."