Merge pull request #44 from thisac/fix-unpin-requirements

Unpin and update requirements

Author: thisac

README.rst

@@ -7,7 +7,7 @@
 .. image:: https://circleci.com/gh/dwavesystems/dwave-gate.svg?style=svg
     :target: https://circleci.com/gh/dwavesystems/dwave-gate
 
-.. image:: https://codecov.io/gh/dwavesystems/dwave-gate/branch/master/graph/badge.svg
+.. image:: https://codecov.io/gh/dwavesystems/dwave-gate/branch/main/graph/badge.svg
     :target: https://codecov.io/gh/dwavesystems/dwave-gate
 
 dwave-gate
@@ -101,6 +101,15 @@ Tests and coverage can be run using Pytest.
 
     python -m pytest tests/ --cov=dwave.gate
 
+.. note::
+
+    For the QIR compiler and loader to work the PyQIR (v0.9.0) is required. It can be
+    installed manually with ``pip install pyqir==0.9.0`` or as an optional dependency:
+
+    .. code-block:: bash
+
+        pip install dwave-gate[qir]
+
 .. installation-end-marker
 
 License

docs/README.rst

@@ -7,7 +7,7 @@
 .. image:: https://circleci.com/gh/dwavesystems/dwave-gate.svg?style=svg
     :target: https://circleci.com/gh/dwavesystems/dwave-gate
 
-.. image:: https://codecov.io/gh/dwavesystems/dwave-gate/branch/master/graph/badge.svg
+.. image:: https://codecov.io/gh/dwavesystems/dwave-gate/branch/main/graph/badge.svg
     :target: https://codecov.io/gh/dwavesystems/dwave-gate
 
 dwave-gate
@@ -81,7 +81,7 @@ It can also be installed from source by cloning this GitHub repository and runni
     make install
 
 The makefile will also simplify running tests (``make test``), coverage (``make coverage``),
-documentation (``make docs```), as well as formatting (``make format``) the code using the `Black
+documentation (``make docs``), as well as formatting (``make format``) the code using the `Black
 <https://black.readthedocs.io/>`_ formatter (set to a line-length of 100) and `isort
 <https://pycqa.github.io/isort/>`_. It's available on both Unix as well as Windows systems, via the
 `make.bat` batch file.
@@ -99,7 +99,16 @@ Tests and coverage can be run using Pytest.
 
 .. code-block:: bash
 
-    pytest tests/ --cov=dwave.gate
+    python -m pytest tests/ --cov=dwave.gate
+
+.. note::
+
+    For the QIR compiler and loader to work the optional dependency PyQIR (v0.9.0) is required. It can be
+    installed manually with ``pip install pyqir==0.9.0`` or from PyPI as an extra:
+
+    .. code-block:: bash
+
+        pip install dwave-gate[qir]
 
 .. installation-end-marker
 

docs/reference/index.rst

@@ -13,3 +13,4 @@ Reference Documentation
     registers
     simulator
     tools
+    qir

docs/reference/qir.rst

@@ -0,0 +1,31 @@
+QIR
+===
+
+.. automodule:: dwave.gate.qir
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Compiler Module
+---------------
+
+.. automodule:: dwave.gate.qir.compiler
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Instructions Module
+-------------------
+
+.. automodule:: dwave.gate.qir.instructions
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Loader Module
+-------------
+
+.. automodule:: dwave.gate.qir.loader
+    :members:
+    :undoc-members:
+    :show-inheritance:

dwave/gate/qir/__init__.py

@@ -17,24 +17,11 @@
 Contains the QIR compiler, loader and related files and functions.
 """
 
-from typing import Tuple
-
 try:
     import pyqir  # noqa: F401
-except ImportError:  # pragma: no cover
-    pyqir_installed = False
-else:
-    # pyqir>=0.8 required
-    from importlib.metadata import version
-
-    def parse(version: str) -> Tuple[str, str, str]:
-        "Parse a MAJOR.MINOR.PATCH version string into a tuple."
-        return tuple(version.split("."))[:3]
-
-    pyqir_installed = parse(version("pyqir")) >= parse("0.8.0")
+except ImportError as e:  # pragma: no cover
+    raise ImportError("PyQIR required for using the QIR compiler") from e
 
-if not pyqir_installed:  # pragma: no cover
-    raise ImportError("PyQIR not installed.")
 
 from dwave.gate.qir.compiler import *
 from dwave.gate.qir.loader import *

dwave/gate/tools/counters.py

@@ -57,15 +57,15 @@ def refresh(cls) -> None:
             except StopIteration:
                 cls.length += 1
                 if cls.length > len(cls._alphanum):
+                    if not cls.id_set:
+                        raise ValueError(
+                            "ID length cannot be longer than number of unique characters available."
+                        )
                     warnings.warn(
                         f"Insufficient characters to generate unique ID of length {cls.length} or "
                         f"longer. Generated batch of {len(cls.id_set)} instead of requested "
                         f"batch size of {cls.batch} IDs"
                     )
-                    if not cls.id_set:
-                        raise ValueError(
-                            "ID length cannot be longer than number of unique characters available."
-                        )
                     break
 
                 cls._id_gen = itertools.combinations(cls._alphanum, r=cls.length)

pyproject.toml

@@ -34,6 +34,10 @@ requires-python = ">= 3.8"
 dependencies = [
     "numpy>=1.24.4",
 ]
+[project.optional-dependencies]
+qir = [
+    "pyqir>=0.8.0,<0.10",
+]
 
 [project.readme]
 file = "README.rst"
@@ -46,7 +50,7 @@ Download = "https://github.com/dwavesystems/dwave-gate/releases"
 [tool.cibuildwheel]
 build-verbosity = "1"
 skip = "pp* *musllinux*"
-before-test = "pip install pyqir==0.8.2 && pip install -r {project}/requirements_dev.txt"
+before-test = "pip install pyqir==0.9.0 && pip install -r {project}/requirements_dev.txt"
 test-command = "pytest {project}/tests"
 before-build = "pip install cgen==2020.1 && python {project}/dwave/gate/simulator/operation_generation.py"
 

releasenotes/notes/pyqir-support-a682839ae2ccc0c5.yaml

@@ -0,0 +1,5 @@
+---
+fixes:
+  - |
+    Remove PyQIR version check as it's been added as an optional dependency. A supported
+    version can now be installed directly with ``pip install dwave-gate[qir]``.

requirements.txt

@@ -1,4 +1,5 @@
+# working environment for Python>=3.8,<=3.11
 numpy==1.24.4
-cython==3.0.4
+cython==3.0.10
 cgen==2020.1
-pyqir==0.8.2
+pyqir==0.9.0

requirements_dev.txt

@@ -1,4 +1,4 @@
-pytest==7.2.0
-pytest-cov==4.0.0
-pytest-mock==3.10.0
-typing_extensions==4.4.0
+pytest>=7.2.0
+pytest-cov>=4.0.0
+pytest-mock>=3.10.0
+typing_extensions>=4.4.0