Merge pull request #1357 from VWS-Python/bump-mypy

adamtheturtle · web-flow · commit a66b07c6583f · 2021-01-23T01:09:56.000Z
Bump mypy and account for new features
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -17,7 +17,7 @@ jobs:
 
     strategy:
       matrix:
-        python-version: [3.8]
+        python-version: [3.9]
         platform: [ubuntu-latest]
 
     runs-on: ${{ matrix.platform }}
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
@@ -12,7 +12,7 @@ Installation
 
    pip install vws-python
 
-This is tested on Python 3.8+.
+This is tested on Python 3.9+.
 Get in touch with ``adamdangoor@gmail.com`` if you would like to use this with another language.
 
 Getting Started
diff --git a/dev-requirements.txt b/dev-requirements.txt
@@ -16,7 +16,7 @@ flake8-quotes==3.2.0  # Require single quotes
 flake8==3.8.4  # Lint
 freezegun==1.1.0
 isort==5.7.0  # Lint imports
-mypy==0.790  # Type checking
+mypy==0.800  # Type checking
 pip_check_reqs==2.1.1
 pydocstyle==5.1.1  # Lint docstrings
 pyenchant==3.2.0  # Bindings for a spellchecking sytem
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -61,7 +61,7 @@
 htmlhelp_basename = 'VWSPYTHONdoc'
 autoclass_content = 'init'
 intersphinx_mapping = {
-    'python': ('https://docs.python.org/3.8', None),
+    'python': ('https://docs.python.org/3.9', None),
 }
 nitpicky = True
 warning_is_error = True
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/lint.mk b/lint.mk
@@ -12,7 +12,7 @@ fix-black:
 
 .PHONY: mypy
 mypy:
-	mypy *.py src/ tests/ docs/source/ admin
+	mypy .
 
 .PHONY: check-manifest
 check-manifest:
diff --git a/pyproject.toml b/pyproject.toml
@@ -65,6 +65,8 @@
         'duplicate-code',
         # Let isort handle imports
         'wrong-import-order',
+        # pylint does not support new type hint styles e.g. list[str]
+        'unsubscriptable-object',
     ]
 
     [tool.pylint.'FORMAT']
diff --git a/setup.cfg b/setup.cfg
@@ -59,7 +59,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.readthedocs.io
diff --git a/setup.py b/setup.py
@@ -1,12 +1,13 @@
 """Setup script for VWS Python, a wrapper for 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/vws/query.py b/src/vws/query.py
@@ -2,9 +2,10 @@
 Tools for interacting with the Vuforia Cloud Recognition Web APIs.
 """
 
+from __future__ import annotations
+
 import datetime
 import io
-from typing import List, Optional
 from urllib.parse import urljoin
 
 import requests
@@ -54,7 +55,7 @@ def query(
         include_target_data: CloudRecoIncludeTargetData = (
             CloudRecoIncludeTargetData.TOP
         ),
-    ) -> List[QueryResult]:
+    ) -> list[QueryResult]:
         """
         Use the Vuforia Web Query API to make an Image Recognition Query.
 
@@ -156,7 +157,7 @@ def query(
         result = []
         result_list = list(response.json()['results'])
         for item in result_list:
-            target_data: Optional[TargetData] = None
+            target_data: TargetData | None = None
             if 'target_data' in item:
                 target_data_dict = item['target_data']
                 metadata = target_data_dict['application_metadata']
diff --git a/src/vws/vws.py b/src/vws/vws.py
@@ -2,12 +2,14 @@
 Tools for interacting with Vuforia APIs.
 """
 
+from __future__ import annotations
+
 import base64
 import io
 import json
 from datetime import date
 from time import sleep
-from typing import Dict, List, Optional, Union
+from typing import Dict
 from urllib.parse import urljoin
 
 import requests
@@ -197,10 +199,10 @@ def _make_request(
     def add_target(
         self,
         name: str,
-        width: Union[int, float],
+        width: int | float,
         image: io.BytesIO,
         active_flag: bool,
-        application_metadata: Optional[str],
+        application_metadata: str | None,
     ) -> str:
         """
         Add a target to a Vuforia Web Services database.
@@ -355,7 +357,7 @@ def wait_for_target_processed(
         self,
         target_id: str,
         seconds_between_requests: float = 0.2,
-        timeout_seconds: Optional[float] = 60 * 5,
+        timeout_seconds: float | None = 60 * 5,
     ) -> None:
         """
         Wait up to five minutes (arbitrary) for a target to get past the
@@ -399,7 +401,7 @@ def decorated() -> None:
         except FunctionTimedOut as exc:
             raise TargetProcessingTimeout from exc
 
-    def list_targets(self) -> List[str]:
+    def list_targets(self) -> list[str]:
         """
         List target IDs.
 
@@ -544,7 +546,7 @@ def delete_target(self, target_id: str) -> None:
             expected_result_code='Success',
         )
 
-    def get_duplicate_targets(self, target_id: str) -> List[str]:
+    def get_duplicate_targets(self, target_id: str) -> list[str]:
         """
         Get targets which may be considered duplicates of a given target.
 
@@ -582,11 +584,11 @@ def get_duplicate_targets(self, target_id: str) -> List[str]:
     def update_target(
         self,
         target_id: str,
-        name: Optional[str] = None,
-        width: Optional[Union[int, float]] = None,
-        image: Optional[io.BytesIO] = None,
-        active_flag: Optional[bool] = None,
-        application_metadata: Optional[str] = None,
+        name: str | None = None,
+        width: int | float | None = None,
+        image: io.BytesIO | None = None,
+        active_flag: bool | None = None,
+        application_metadata: str | None = None,
     ) -> None:
         """
         Add a target to a Vuforia Web Services database.
@@ -629,7 +631,7 @@ def update_target(
             ~vws.exceptions.vws_exceptions.RequestTimeTooSkewed: There is an
                 error with the time sent to Vuforia.
         """
-        data: Dict[str, Union[str, bool, float, int]] = {}
+        data: Dict[str, str | bool | float | int] = {}
 
         if name is not None:
             data['name'] = name
diff --git a/tests/test_vws.py b/tests/test_vws.py
@@ -2,12 +2,13 @@
 Tests for helper functions for managing a Vuforia database.
 """
 
+from __future__ import annotations
+
 import base64
 import datetime
 import io
 import random
 import uuid
-from typing import Optional
 
 import pytest
 from freezegun import freeze_time
@@ -36,7 +37,7 @@ def test_add_target(
         vws_client: VWS,
         high_quality_image: io.BytesIO,
         active_flag: bool,
-        application_metadata: Optional[bytes],
+        application_metadata: bytes | None,
         cloud_reco_client: CloudRecoService,
     ) -> None:
         """

Original file line number	Diff line number	Diff line change
`@@ -61,7 +61,7 @@`
`61`	`61`	`htmlhelp_basename = 'VWSPYTHONdoc'`
`62`	`62`	`autoclass_content = 'init'`
`63`	`63`	`intersphinx_mapping = {`
`64`		`- 'python': ('https://docs.python.org/3.8', None),`
	`64`	`+ 'python': ('https://docs.python.org/3.9', None),`
`65`	`65`	`}`
`66`	`66`	`nitpicky = True`
`67`	`67`	`warning_is_error = True`
Original file line number	Diff line number	Diff line change
`@@ -65,6 +65,8 @@`
`65`	`65`	`'duplicate-code',`
`66`	`66`	`# Let isort handle imports`
`67`	`67`	`'wrong-import-order',`
	`68`	`+ # pylint does not support new type hint styles e.g. list[str]`
	`69`	`+ 'unsubscriptable-object',`
`68`	`70`	`]`
`69`	`71`
`70`	`72`	`[tool.pylint.'FORMAT']`