Add Python 3.12 support (#154)

* minimal changes for python 3.12 support * keep old black python version for now * Update changelog * Added python 3.9 deprecation warning * Update Github Action to test python 3.12 and build docs on python 3.12 * Apply suggestions from code review Co-authored-by: Vladimir Kukushkin <[email protected]> * Update pipelines to use python 3.12 * Adjusted error message based on review feedback * fixed typo --------- Co-authored-by: Arianne Meijer <[email protected]> Co-authored-by: Vladimir Kukushkin <[email protected]>
iqm-finland · Dec 14, 2024 · 7d4a090 · 7d4a090
1 parent 80a1634
commit 7d4a090
Show file tree

Hide file tree

Showing 8 changed files with 37 additions and 22 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -12,7 +12,7 @@ jobs:
     strategy:
       matrix:
         platform: [ ubuntu-latest, macos-latest, windows-latest ]
-        python-version: [ '3.9', '3.10', '3.11' ]
+        python-version: [ '3.9', '3.10', '3.11', '3.12' ]
 
     steps:
       - uses: actions/checkout@v4
@@ -34,7 +34,7 @@ jobs:
       - name: Setup Python
         uses: actions/setup-python@v5
         with:
-          python-version: '3.9'
+          python-version: '3.12'
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip

diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -17,7 +17,7 @@ jobs:
       - name: Setup Python
         uses: actions/setup-python@v5
         with:
-          python-version: '3.9'
+          python-version: '3.12'
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
@@ -58,7 +58,7 @@ jobs:
       - name: Setup Python
         uses: actions/setup-python@v5
         with:
-          python-version: '3.9'
+          python-version: '3.12'
       - name: Checkout latest tagged commit
         run: |
           git checkout $(git describe --tags --abbrev=0)
@@ -90,7 +90,7 @@ jobs:
       - name: Setup Python
         uses: actions/setup-python@v5
         with:
-          python-version: '3.9'
+          python-version: '3.12'
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip

diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -2,6 +2,12 @@
 Changelog
 =========
 
+Version 20.9
+============
+
+* Added Python 3.12 support `#154 <https://github.com/iqm-finland/iqm-client/pull/154>`_
+* Python 3.9 support is deprecated and will be removed in the future
+
 Version 20.8
 ============
 

diff --git a/pyproject.toml b/pyproject.toml
@@ -16,7 +16,7 @@ classifiers = [
     "Intended Audience :: Science/Research",
     "License :: OSI Approved :: Apache Software License",
 ]
-requires-python = ">=3.9, <3.12"
+requires-python = ">=3.9, <3.13"
 dependencies = [
     "numpy",
     "packaging",

diff --git a/src/iqm/iqm_client/__init__.py b/src/iqm/iqm_client/__init__.py
@@ -14,6 +14,8 @@
 """Client-side library for connecting to and executing quantum circuits on IQM quantum computers.
 """
 from importlib.metadata import PackageNotFoundError, version
+import sys
+import warnings
 
 from iqm.iqm_client.api import *
 from iqm.iqm_client.authentication import *
@@ -29,3 +31,6 @@
     __version__ = "unknown"
 finally:
     del version, PackageNotFoundError
+
+if sys.version_info < (3, 10):
+    warnings.warn(DeprecationWarning("Python 3.9 will no longer be supported in a later release of IQM client."))
diff --git a/src/iqm/iqm_client/iqm_client.py b/src/iqm/iqm_client/iqm_client.py
@@ -115,9 +115,10 @@ def __init__(
             username,
             password,
         )
+        version_string = 'iqm-client'
         self._signature = f'{platform.platform(terse=True)}'
         self._signature += f', python {platform.python_version()}'
-        self._signature += f', iqm-client {version("iqm-client")}'
+        self._signature += f', iqm-client {version(version_string)}'
         if client_signature:
             self._signature += f', {client_signature}'
         self._architecture: QuantumArchitectureSpecification | None = None
@@ -648,15 +649,17 @@ def _get_run_v2(self, job_id: UUID, timeout_secs: float = REQUESTS_TIMEOUT) -> R
                 'metadata': {
                     '`': calibration_set_id,
                     'circuits_batch': circuits_batch,
-                    'parameters': None
-                    if result.status_code == 404
-                    else {
-                        'shots': request_parameters['shots'],
-                        'max_circuit_duration_over_t2': request_parameters['max_circuit_duration_over_t2'],
-                        'heralding_mode': request_parameters['heralding_mode'],
-                        'move_validation_mode': request_parameters['move_validation_mode'],
-                        'move_gate_frame_tracking_mode': request_parameters['move_gate_frame_tracking_mode'],
-                    },
+                    'parameters': (
+                        None
+                        if result.status_code == 404
+                        else {
+                            'shots': request_parameters['shots'],
+                            'max_circuit_duration_over_t2': request_parameters['max_circuit_duration_over_t2'],
+                            'heralding_mode': request_parameters['heralding_mode'],
+                            'move_validation_mode': request_parameters['move_validation_mode'],
+                            'move_gate_frame_tracking_mode': request_parameters['move_gate_frame_tracking_mode'],
+                        }
+                    ),
                     'timestamps': {datapoint['stage']: datapoint['timestamp'] for datapoint in timeline},
                 },
             }

diff --git a/src/iqm/iqm_client/models.py b/src/iqm/iqm_client/models.py
@@ -245,9 +245,8 @@ def name_validator(cls, value):
         """Check if the name of instruction is set to one of the supported quantum operations."""
         name = value
         if name not in _SUPPORTED_OPERATIONS:
-            raise ValueError(
-                f'Unknown operation "{name}". ' f'Supported operations are \"{", ".join(_SUPPORTED_OPERATIONS)}\"'
-            )
+            message = ', '.join(_SUPPORTED_OPERATIONS)
+            raise ValueError(f'Unknown operation "{name}". Supported operations are "{message}"')
         return name
 
     @field_validator('implementation')
@@ -294,9 +293,10 @@ def args_validator(cls, value, info: ValidationInfo):
                 f'but {tuple(submitted_arg_names)} were given'
             )
         if not submitted_arg_names <= allowed_arg_names:
+            message = tuple(allowed_arg_names) if allowed_arg_names else 'no'
             raise ValueError(
                 f'The operation "{name}" allows '
-                f'{tuple(allowed_arg_names) if allowed_arg_names else "no"} argument(s), '
+                f'{message} argument(s), '
                 f'but {tuple(submitted_arg_names)} were given'
             )
 

diff --git a/tox.ini b/tox.ini
@@ -1,20 +1,21 @@
 [tox]
 minversion = 4.11
-envlist = py39, py310, py311
+envlist = py39, py310, py311, py312
 
 [gh-actions]
 python =
     3.9: py39
     3.10: py310
     3.11: py311
+    3.12: py312
 
 [testenv]
 package = editable
 setenv =
     TOXINIDIR = {toxinidir}
     VIRTUALENV_PIP = 23.3.1
 
-[testenv:py{39,310,311}]
+[testenv:py{39,310,311,312}]
 description =
     Run automated tests.
 extras =