Merge pull request #848 from VWS-Python/bump-python-and-mypy

adamtheturtle · web-flow · commit 01c3ad9f5586 · 2021-01-27T19:23:37.000Z
Bump Python to 3.9
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -20,7 +20,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: [3.8.5]
+        python-version: [3.9]
         ci_pattern:
           - test_query.py::TestContentType
           - test_query.py::TestSuccess
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -19,7 +19,7 @@ jobs:
 
     strategy:
       matrix:
-        python-version: [3.8]
+        python-version: [3.9]
 
     steps:
       - uses: actions/checkout@v2
diff --git a/.github/workflows/windows-ci.yml b/.github/workflows/windows-ci.yml
@@ -17,7 +17,7 @@ jobs:
 
     strategy:
       matrix:
-        python-version: [3.8]
+        python-version: [3.9]
         platform: [windows-latest]
 
     runs-on: ${{ matrix.platform }}
diff --git a/README.rst b/README.rst
@@ -13,7 +13,7 @@ Mocking calls made to Vuforia with Python ``requests``
 
 Using the mock redirects requests to Vuforia made with `requests`_ to an in-memory implementation.
 
-This requires Python 3.8.5+.
+This requires Python 3.9+.
 
 .. code:: sh
 
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -64,7 +64,7 @@
 htmlhelp_basename = 'VWSPYTHONMOCKdoc'
 autoclass_content = 'init'
 intersphinx_mapping = {
-    'python': ('https://docs.python.org/3.8', None),
+    'python': ('https://docs.python.org/3.9', None),
     'docker': ('https://docker-py.readthedocs.io/en/stable', None),
 }
 nitpicky = True
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -8,7 +8,7 @@ Mocking calls made to Vuforia with Python ``requests``
 
    pip3 install vws-python-mock
 
-This requires Python 3.8+.
+This requires Python 3.9+.
 
 .. include:: basic-example.rst
 
diff --git a/docs/source/installation.rst b/docs/source/installation.rst
@@ -5,4 +5,4 @@ Installation
 
    pip3 install vws-python-mock
 
-This requires Python 3.8+.
+This requires Python 3.9+.
diff --git a/docs/source/mock-api-reference.rst b/docs/source/mock-api-reference.rst
@@ -7,6 +7,8 @@ API Reference
    :members:
    :undoc-members:
 
+.. TODO why does this error only with :undoc-members:
+
 .. autoclass:: mock_vws.target.TargetDict
    :members:
    :undoc-members:
diff --git a/docs/source/release-process.rst b/docs/source/release-process.rst
@@ -10,7 +10,7 @@ Outcomes
 Prerequisites
 ~~~~~~~~~~~~~
 
-* ``python3`` on your ``PATH`` set to Python 3.8+.
+* ``python3`` on your ``PATH`` set to Python 3.9+.
 * ``virtualenv``.
 * Push access to this repository.
 * Trust that ``master`` is ready and high enough quality for release.
diff --git a/pyproject.toml b/pyproject.toml
@@ -68,6 +68,12 @@
         'duplicate-code',
         # Let isort handle imports
         'wrong-import-order',
+
+        # Wait until pylint supports Python 3.9 to disable these:
+        # - https://github.com/PyCQA/pylint/issues/3876
+        # - https://github.com/PyCQA/pylint/issues/3882
+        'unsubscriptable-object',
+        'inherit-non-class',
     ]
 
     [tool.pylint.'FORMAT']
diff --git a/setup.cfg b/setup.cfg
@@ -56,7 +56,7 @@ license_file = LICENSE
 classifiers =
     Operating System :: POSIX
     Environment :: Web Environment
-    Programming Language :: Python :: 3.8
+    Programming Language :: Python :: 3.9
     License :: OSI Approved :: MIT License
     Development Status :: 5 - Production/Stable
 url = https://vws-python-mock.readthedocs.io
diff --git a/setup.py b/setup.py
@@ -2,13 +2,14 @@
 Setup script for VWS Python Mock, a mock of Vuforia's Web Services APIs.
 """
 
+from __future__ import annotations
+
 from pathlib import Path
-from typing import List
 
 from setuptools import setup
 
 
-def _get_dependencies(requirements_file: Path) -> List[str]:
+def _get_dependencies(requirements_file: Path) -> list[str]:
     """
     Return requirements from a requirements file.
 
diff --git a/src/mock_vws/_database_matchers.py b/src/mock_vws/_database_matchers.py
@@ -2,7 +2,9 @@
 Helpers for getting databases which match keys given in requests.
 """
 
-from typing import Dict, Iterable, Optional
+from __future__ import annotations
+
+from typing import Dict, Iterable
 
 from vws_auth_tools import authorization_header
 
@@ -11,11 +13,11 @@
 
 def get_database_matching_client_keys(
     request_headers: Dict[str, str],
-    request_body: Optional[bytes],
+    request_body: bytes | None,
     request_method: str,
     request_path: str,
     databases: Iterable[VuforiaDatabase],
-) -> Optional[VuforiaDatabase]:
+) -> VuforiaDatabase | None:
     """
     Return which, if any, of the given databases is being accessed by the given
     client request.
@@ -53,11 +55,11 @@ def get_database_matching_client_keys(
 
 def get_database_matching_server_keys(
     request_headers: Dict[str, str],
-    request_body: Optional[bytes],
+    request_body: bytes | None,
     request_method: str,
     request_path: str,
     databases: Iterable[VuforiaDatabase],
-) -> Optional[VuforiaDatabase]:
+) -> VuforiaDatabase | None:
     """
     Return which, if any, of the given databases is being accessed by the given
     server request.
diff --git a/src/mock_vws/_flask_server/dockerfiles/base/Dockerfile b/src/mock_vws/_flask_server/dockerfiles/base/Dockerfile
@@ -1,4 +1,4 @@
-FROM python:3.8-slim-buster
+FROM python:3.9.1-slim-buster
 RUN apt update --yes
 # git is needed for setuptools-scm.
 # gcc is needed to create the wheel for backports.zoneinfo, at least on Apple
diff --git a/src/mock_vws/_flask_server/vws.py b/src/mock_vws/_flask_server/vws.py
@@ -11,7 +11,7 @@
 import os
 import uuid
 from http import HTTPStatus
-from typing import List, Set
+from typing import Set
 
 import requests
 from flask import Flask, Response, request
@@ -395,7 +395,7 @@ def get_duplicates(target_id: str) -> Response:
     ]
     other_targets = set(database.targets) - {target}
 
-    similar_targets: List[str] = [
+    similar_targets: list[str] = [
         other.target_id
         for other in other_targets
         if other.image_value == target.image_value
diff --git a/src/mock_vws/_query_tools.py b/src/mock_vws/_query_tools.py
@@ -2,12 +2,14 @@
 Tools for making Vuforia queries.
 """
 
+from __future__ import annotations
+
 import base64
 import cgi
 import datetime
 import io
 import uuid
-from typing import Any, Dict, List, Set, Union
+from typing import Any, Dict, Set
 
 from backports.zoneinfo import ZoneInfo
 
@@ -30,8 +32,8 @@ def get_query_match_response_text(
     request_method: str,
     request_path: str,
     databases: Set[VuforiaDatabase],
-    query_processes_deletion_seconds: Union[int, float],
-    query_recognizes_deletion_seconds: Union[int, float],
+    query_processes_deletion_seconds: int | float,
+    query_recognizes_deletion_seconds: int | float,
 ) -> str:
     """
     Args:
@@ -129,7 +131,7 @@ def get_query_match_response_text(
 
     matches = not_deleted_matches + deletion_not_recognized_matches
 
-    results: List[Dict[str, Any]] = []
+    results: list[Dict[str, Any]] = []
     for target in matches:
         target_timestamp = target.last_modified_date.timestamp()
         if target.application_metadata is None:
diff --git a/src/mock_vws/_requests_mock_server/decorators.py b/src/mock_vws/_requests_mock_server/decorators.py
@@ -2,9 +2,11 @@
 Decorators for using the mock.
 """
 
+from __future__ import annotations
+
 import re
 from contextlib import ContextDecorator
-from typing import Literal, Tuple, Union
+from typing import Literal, Tuple
 from urllib.parse import urljoin, urlparse
 
 import requests
@@ -27,9 +29,9 @@ def __init__(
         base_vws_url: str = 'https://vws.vuforia.com',
         base_vwq_url: str = 'https://cloudreco.vuforia.com',
         real_http: bool = False,
-        processing_time_seconds: Union[int, float] = 0.5,
-        query_recognizes_deletion_seconds: Union[int, float] = 0.2,
-        query_processes_deletion_seconds: Union[int, float] = 3,
+        processing_time_seconds: int | float = 0.5,
+        query_recognizes_deletion_seconds: int | float = 0.2,
+        query_processes_deletion_seconds: int | float = 3,
     ) -> None:
         """
         Route requests to Vuforia's Web Service APIs to fakes of those APIs.
diff --git a/src/mock_vws/_requests_mock_server/mock_web_query_api.py b/src/mock_vws/_requests_mock_server/mock_web_query_api.py
@@ -5,8 +5,10 @@
 https://library.vuforia.com/articles/Solution/How-To-Perform-an-Image-Recognition-Query
 """
 
+from __future__ import annotations
+
 import email.utils
-from typing import Callable, Set, Union
+from typing import Callable, Set
 
 from requests_mock import POST
 from requests_mock.request import _RequestObjectProxy
@@ -74,8 +76,8 @@ class MockVuforiaWebQueryAPI:
     def __init__(
         self,
         target_manager: TargetManager,
-        query_recognizes_deletion_seconds: Union[int, float],
-        query_processes_deletion_seconds: Union[int, float],
+        query_recognizes_deletion_seconds: int | float,
+        query_processes_deletion_seconds: int | float,
     ) -> None:
         """
         Args:
diff --git a/src/mock_vws/_requests_mock_server/mock_web_services_api.py b/src/mock_vws/_requests_mock_server/mock_web_services_api.py
@@ -5,14 +5,16 @@
 https://library.vuforia.com/articles/Solution/How-To-Use-the-Vuforia-Web-Services-API
 """
 
+from __future__ import annotations
+
 import base64
 import dataclasses
 import datetime
 import email.utils
 import random
 import uuid
 from http import HTTPStatus
-from typing import Callable, Dict, List, Set, Union
+from typing import Callable, Dict, Set
 
 from backports.zoneinfo import ZoneInfo
 from requests_mock import DELETE, GET, POST, PUT
@@ -86,7 +88,7 @@ class MockVuforiaWebServicesAPI:
     def __init__(
         self,
         target_manager: TargetManager,
-        processing_time_seconds: Union[int, float],
+        processing_time_seconds: int | float,
     ) -> None:
         """
         Args:
@@ -268,7 +270,7 @@ def database_summary(
             context.status_code = exc.status_code
             return exc.response_text
 
-        body: Dict[str, Union[str, int]] = {}
+        body: Dict[str, str | int] = {}
 
         database = get_database_matching_server_keys(
             request_headers=request.headers,
@@ -343,7 +345,7 @@ def target_list(
         date = email.utils.formatdate(None, localtime=False, usegmt=True)
 
         results = [target.target_id for target in database.not_deleted_targets]
-        body: Dict[str, Union[str, List[str]]] = {
+        body: Dict[str, str | list[str]] = {
             'transaction_id': uuid.uuid4().hex,
             'result_code': ResultCodes.SUCCESS.value,
             'results': results,
@@ -461,7 +463,7 @@ def get_duplicates(
 
         other_targets = set(database.targets) - {target}
 
-        similar_targets: List[str] = [
+        similar_targets: list[str] = [
             other.target_id
             for other in other_targets
             if other.image_value == target.image_value
diff --git a/src/mock_vws/target.py b/src/mock_vws/target.py
@@ -23,6 +23,8 @@ class TargetDict(TypedDict):
     A dictionary type which represents a target.
     """
 
+    # We cannot use the `X | Y` syntax for `Union`s and `Optional`s until
+    # https://github.com/sphinx-doc/sphinx/issues/8775 is resolved.
     name: str
     width: float
     image_base64: str
@@ -208,7 +210,7 @@ def to_dict(self) -> TargetDict:
         """
         Dump a target to a dictionary which can be loaded as JSON.
         """
-        delete_date: Optional[str] = None
+        delete_date: str | None = None
         if self.delete_date:
             delete_date = datetime.datetime.isoformat(self.delete_date)
 
diff --git a/tests/mock_vws/test_add_target.py b/tests/mock_vws/test_add_target.py
@@ -2,12 +2,14 @@
 Tests for the mock of the add target endpoint.
 """
 
+from __future__ import annotations
+
 import base64
 import io
 import json
 from http import HTTPStatus
 from string import hexdigits
-from typing import Any, Dict, Union
+from typing import Any, Dict
 from urllib.parse import urljoin
 
 import pytest
@@ -758,7 +760,7 @@ class TestActiveFlag:
     @pytest.mark.parametrize('active_flag', [True, False, None])
     def test_valid(
         self,
-        active_flag: Union[bool, None],
+        active_flag: bool | None,
         image_file_failed_state: io.BytesIO,
         vuforia_database: VuforiaDatabase,
     ) -> None:
diff --git a/tests/mock_vws/test_query.py b/tests/mock_vws/test_query.py
@@ -4,6 +4,8 @@
 https://library.vuforia.com/articles/Solution/How-To-Perform-an-Image-Recognition-Query.
 """
 
+from __future__ import annotations
+
 import base64
 import calendar
 import datetime
@@ -13,7 +15,7 @@
 import uuid
 from http import HTTPStatus
 from pathlib import Path
-from typing import Any, Dict, Optional, Union
+from typing import Any, Dict
 from urllib.parse import urljoin
 
 import pytest
@@ -180,8 +182,8 @@ def test_incorrect_no_boundary(
         vuforia_database: VuforiaDatabase,
         content_type: str,
         resp_status_code: int,
-        resp_content_type: Optional[str],
-        resp_cache_control: Optional[str],
+        resp_content_type: str | None,
+        resp_cache_control: str | None,
         resp_text: str,
     ) -> None:
         """
@@ -689,7 +691,7 @@ def test_valid_accepted(
         self,
         high_quality_image: io.BytesIO,
         vuforia_database: VuforiaDatabase,
-        num_results: Union[int, bytes],
+        num_results: int | bytes,
     ) -> None:
         """
         Numbers between 1 and 50 are valid inputs.
diff --git a/tests/mock_vws/test_update_target.py b/tests/mock_vws/test_update_target.py
diff --git a/tests/mock_vws/utils/assertions.py b/tests/mock_vws/utils/assertions.py

Original file line number	Diff line number	Diff line change
`@@ -64,7 +64,7 @@`
`64`	`64`	`htmlhelp_basename = 'VWSPYTHONMOCKdoc'`
`65`	`65`	`autoclass_content = 'init'`
`66`	`66`	`intersphinx_mapping = {`
`67`		`- 'python': ('https://docs.python.org/3.8', None),`
	`67`	`+ 'python': ('https://docs.python.org/3.9', None),`
`68`	`68`	`'docker': ('https://docker-py.readthedocs.io/en/stable', None),`
`69`	`69`	`}`
`70`	`70`	`nitpicky = True`
Original file line number	Diff line number	Diff line change
`@@ -5,4 +5,4 @@ Installation`
`5`	`5`
`6`	`6`	`pip3 install vws-python-mock`
`7`	`7`
`8`		`-This requires Python 3.8+.`
	`8`	`+This requires Python 3.9+.`