1849 randomized compiling

.github/PULL_REQUEST_TEMPLATE.md

@@ -10,6 +10,7 @@ Insert your PR description here. Thanks for [contributing][contributing] to pyQu
 - [ ] All changes to code are covered via unit tests.
 - [ ] Parameters and return values have type hints with [PEP 484 syntax][pep-484].
 - [ ] Functions and classes have useful [Sphinx-style][sphinx] docstrings.
+- [ ] Live QPU tests have run via `pytest test --live-qpu-access` by myself or a reviewer.
 - [ ] (New Feature) The [docs][docs] have been updated accordingly.
 - [ ] (Bugfix) The associated issue is referenced above using [auto-close keywords][auto-close].
 

.github/workflows/test.yml

@@ -98,7 +98,7 @@ jobs:
         go install github.com/google/osv-scanner/cmd/osv-scanner@latest
     - name: Run OSV scanner
       run: |
-        osv-scanner --lockfile=./poetry.lock
+        osv-scanner scan --config=.osv-scanner.toml --lockfile=./poetry.lock
 
   test-doctest:
     name: Run Doctests
@@ -153,7 +153,7 @@ jobs:
           poetry run make test
       - name: Report Coverage
         if: matrix.python-version == '3.11' && github.event_name == 'pull_request'
-        continue-on-error: true 
+        continue-on-error: true
         uses: orgoro/coverage@v3.1
         with:
           coverageFile: coverage.xml

.gitignore

@@ -184,10 +184,13 @@ fabric.properties
 ### MyPi ###
 .mypy_cache
 
+.ruff_cache
+
 ### VSCode ###
 **/.vscode/
 
 pyrightconfig.json
+pyrefly.toml
 
 # unversioned developer notes
 .scratch/

.osv-scanner.toml

@@ -0,0 +1,72 @@
+# See https://github.com/rigetti/pyquil/issues/1852
+# pillow 11.3.0 - locked for python <3.11 via matplotlib (docs extra)
+# Fixed in pillow 12.x which requires python >=3.10
+[[IgnoredVulns]]
+id = "GHSA-5xmw-vc9v-4wf2"
+reason = "pillow 11.3.0 only resolved for python <3.11 (docs extra); fix requires dropping python 3.9 support"
+
+[[IgnoredVulns]]
+id = "GHSA-cfh3-3jmp-rvhc"
+reason = "pillow 11.3.0 only resolved for python <3.11 (docs extra); fix requires dropping python 3.9 support"
+
+[[IgnoredVulns]]
+id = "GHSA-pwv6-vv43-88gr"
+reason = "pillow 11.3.0 only resolved for python <3.11 (docs extra); fix requires dropping python 3.9 support"
+
+[[IgnoredVulns]]
+id = "GHSA-r73j-pqj5-w3x7"
+reason = "pillow 11.3.0 only resolved for python <3.11 (docs extra); fix requires dropping python 3.9 support"
+
+[[IgnoredVulns]]
+id = "GHSA-whj4-6x5x-4v2j"
+reason = "pillow 11.3.0 only resolved for python <3.11 (docs extra); fix requires dropping python 3.9 support"
+
+[[IgnoredVulns]]
+id = "PYSEC-2026-165"
+reason = "pillow 11.3.0 only resolved for python <3.11 (docs extra); fix requires dropping python 3.9 support"
+
+[[IgnoredVulns]]
+id = "GHSA-wjx4-4jcj-g98j"
+reason = "pillow 11.3.0 only resolved for python <3.11 (docs extra); fix requires dropping python 3.9 support"
+
+# pytest 8.4.2 - dev dependency only, not shipped to users
+# Fixed in pytest 9.x but requires bumping pytest-benchmark and other plugins
+[[IgnoredVulns]]
+id = "GHSA-6w46-j5rx-g56g"
+reason = "pytest is a dev dependency only; fix requires bumping to pytest ^9 and updating plugins"
+
+# requests 2.32.5 - locked for python <3.11 via sphinx (docs extra)
+# Fixed in requests 2.34.x which requires python >=3.10
+[[IgnoredVulns]]
+id = "GHSA-gc5v-m9x4-r6x2"
+reason = "requests 2.32.5 only resolved for python <3.11 (docs extra); fix requires dropping python 3.9 support"
+
+# urllib3 2.6.3 - locked for python <3.11 via sphinx/requests (docs extra)
+# Fixed in urllib3 2.7.x which requires python >=3.10
+[[IgnoredVulns]]
+id = "PYSEC-2026-142"
+reason = "urllib3 2.6.3 only resolved for python <3.11 (docs extra); fix requires dropping python 3.9 support"
+
+[[IgnoredVulns]]
+id = "GHSA-mf9v-mfxr-j63j"
+reason = "urllib3 2.6.3 only resolved for python <3.11 (docs extra); fix requires dropping python 3.9 support"
+
+[[IgnoredVulns]]
+id = "PYSEC-2026-141"
+reason = "urllib3 2.6.3 only resolved for python <3.11 (docs extra); fix requires dropping python 3.9 support"
+
+[[IgnoredVulns]]
+id = "GHSA-qccp-gfcp-xxvc"
+reason = "urllib3 2.6.3 only resolved for python <3.11 (docs extra); fix requires dropping python 3.9 support"
+
+[[IgnoredVulns]]
+id = "GHSA-8rfp-98v4-mmr6"
+reason = "bleach update requires python >= 3.10"
+
+[[IgnoredVulns]]
+id = "GHSA-gj48-438w-jh9v"
+reason = "bleach update requires python >= 3.10"
+
+[[IgnoredVulns]]
+id = "GHSA-6v7p-g79w-8964"
+reason = "requires dropping rpcq dependency"

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pyquil"
-version = "4.17.1-rc.0"
+version = "4.18.0-rc.4"
 description = "A Python library for creating Quantum Instruction Language (Quil) programs."
 authors = ["Rigetti Computing <softapps@rigetti.com>"]
 readme = "README.md"
@@ -28,7 +28,7 @@ scipy = "^1.11"
 rpcq = "^3.11.0"
 networkx = ">=2.5"
 qcs-sdk-python = ">=0.20.1,<0.22"
-quil = ">=0.15.3,<0.18"
+quil = "0.18.0rc2"
 packaging = ">=23.1"
 deprecated = "^1.2.14"
 types-deprecated = "^1.2.9.3"

pyquil/_qpu/extern_signatures.py

@@ -0,0 +1,199 @@
+from quil import instructions as inst
+
+from pyquil.quilbase import Pragma
+
+_NUMBER_PAULI_PAIRS = 16
+
+
+def build_extern_function_signatures() -> dict[str, Pragma]:
+    """Build and return a map from extern function name to the corresponding EXTERN pragma.
+
+    These signtures reflect extern function signatures publicly supported by various pyQuil features, such as
+    but not limited to randomized compiling.
+    """
+    destination = inst.ExternParameter(
+        "destination",
+        True,
+        inst.ExternParameterType.from_variable_length_vector(inst.ScalarType.Real),
+    )
+    unitary_angles = inst.ExternParameter(
+        "unitary_angles",
+        False,
+        inst.ExternParameterType.from_variable_length_vector(inst.ScalarType.Real),
+    )
+    angle_offset = inst.ExternParameter(
+        "angle_offset",
+        False,
+        inst.ExternParameterType.from_scalar(inst.ScalarType.Integer),
+    )
+    pauli_set = inst.ExternParameterType.from_scalar(inst.ScalarType.Integer)
+    pauli_index = inst.ExternParameterType.from_scalar(inst.ScalarType.Integer)
+    is_pauli_left = inst.ExternParameter(
+        "is_pauli_left", False, inst.ExternParameterType.from_scalar(inst.ScalarType.Bit)
+    )
+    pauli_conjugates_map = inst.ExternParameter(
+        "pauli_conjugates_map",
+        False,
+        inst.ExternParameterType.from_fixed_length_vector(inst.Vector(inst.ScalarType.Integer, _NUMBER_PAULI_PAIRS)),
+    )
+    pauli_literal = inst.ExternParameterType.from_scalar(inst.ScalarType.Integer)
+    signatures = [
+        (
+            "merge_zxzxz_unitary_with_paulis_reference_conjugate",
+            inst.ExternSignature(
+                parameters=[
+                    destination,
+                    unitary_angles,
+                    angle_offset,
+                    inst.ExternParameter("next_paulis", False, pauli_set),
+                    inst.ExternParameter("next_pauli_index", False, pauli_index),
+                    inst.ExternParameter("previous_paulis_left", False, pauli_set),
+                    inst.ExternParameter("previous_pauli_left_index", False, pauli_index),
+                    inst.ExternParameter("previous_paulis_right", False, pauli_set),
+                    inst.ExternParameter("previous_pauli_right_index", False, pauli_index),
+                    is_pauli_left,
+                    pauli_conjugates_map,
+                ],
+                return_type=None,
+            ).to_quil(),
+        ),
+        (
+            "merge_zxzxz_unitary_with_paulis_literal_literal",
+            inst.ExternSignature(
+                parameters=[
+                    destination,
+                    unitary_angles,
+                    angle_offset,
+                    inst.ExternParameter("next_pauli", False, pauli_literal),
+                    inst.ExternParameter("conjugate_pauli", False, pauli_literal),
+                ],
+                return_type=None,
+            ).to_quil(),
+        ),
+        (
+            "merge_zxzxz_unitary_with_paulis_literal_conjugate",
+            inst.ExternSignature(
+                parameters=[
+                    destination,
+                    unitary_angles,
+                    angle_offset,
+                    inst.ExternParameter("next_pauli", False, pauli_literal),
+                    inst.ExternParameter("previous_paulis_left", False, pauli_set),
+                    inst.ExternParameter("previous_pauli_left_index", False, pauli_index),
+                    inst.ExternParameter("previous_paulis_right", False, pauli_set),
+                    inst.ExternParameter("previous_pauli_right_index", False, pauli_index),
+                    is_pauli_left,
+                    pauli_conjugates_map,
+                ],
+                return_type=None,
+            ).to_quil(),
+        ),
+        (
+            "merge_zxzxz_unitary_with_paulis_reference_literal",
+            inst.ExternSignature(
+                parameters=[
+                    destination,
+                    unitary_angles,
+                    angle_offset,
+                    inst.ExternParameter("next_paulis", False, pauli_set),
+                    inst.ExternParameter("next_pauli_index", False, pauli_index),
+                    inst.ExternParameter("conjugate_pauli", False, pauli_literal),
+                ],
+                return_type=None,
+            ).to_quil(),
+        ),
+        (
+            "merge_zxzxz_unitary_with_paulis_literal_reference",
+            inst.ExternSignature(
+                parameters=[
+                    destination,
+                    unitary_angles,
+                    angle_offset,
+                    inst.ExternParameter("next_pauli", False, pauli_literal),
+                    inst.ExternParameter("previous_paulis", False, pauli_set),
+                    inst.ExternParameter("previous_pauli_index", False, pauli_index),
+                ],
+                return_type=None,
+            ).to_quil(),
+        ),
+        (
+            "merge_zxzxz_unitary_with_paulis_reference_reference",
+            inst.ExternSignature(
+                parameters=[
+                    destination,
+                    unitary_angles,
+                    angle_offset,
+                    inst.ExternParameter("next_paulis", False, pauli_set),
+                    inst.ExternParameter("next_pauli_index", False, pauli_index),
+                    inst.ExternParameter("previous_paulis", False, pauli_set),
+                    inst.ExternParameter("previous_pauli_index", False, pauli_index),
+                ],
+                return_type=None,
+            ).to_quil(),
+        ),
+        (
+            "prng_set_seed_and_step",
+            inst.ExternSignature(
+                parameters=[
+                    inst.ExternParameter("seed", False, inst.ExternParameterType.from_scalar(inst.ScalarType.Integer))
+                ],
+                return_type=inst.ScalarType.Integer,
+            ).to_quil(),
+        ),
+        (
+            "prng_step",
+            inst.ExternSignature(
+                parameters=[],
+                return_type=inst.ScalarType.Integer,
+            ).to_quil(),
+        ),
+        (
+            "if_then_else_integer",
+            inst.ExternSignature(
+                parameters=[
+                    inst.ExternParameter("condition", False, inst.ExternParameterType.from_scalar(inst.ScalarType.Bit)),
+                    inst.ExternParameter(
+                        "true_value", False, inst.ExternParameterType.from_scalar(inst.ScalarType.Integer)
+                    ),
+                    inst.ExternParameter(
+                        "false_value", False, inst.ExternParameterType.from_scalar(inst.ScalarType.Integer)
+                    ),
+                ],
+                return_type=inst.ScalarType.Integer,
+            ).to_quil(),
+        ),
+        (
+            "if_then_else_real",
+            inst.ExternSignature(
+                parameters=[
+                    inst.ExternParameter("condition", False, inst.ExternParameterType.from_scalar(inst.ScalarType.Bit)),
+                    inst.ExternParameter(
+                        "true_value", False, inst.ExternParameterType.from_scalar(inst.ScalarType.Real)
+                    ),
+                    inst.ExternParameter(
+                        "false_value", False, inst.ExternParameterType.from_scalar(inst.ScalarType.Real)
+                    ),
+                ],
+                return_type=inst.ScalarType.Real,
+            ).to_quil(),
+        ),
+        (
+            "choose_random_real_sub_regions",
+            inst.ExternSignature(
+                parameters=[
+                    inst.ExternParameter(
+                        "destination", True, inst.ExternParameterType.from_variable_length_vector(inst.ScalarType.Real)
+                    ),
+                    inst.ExternParameter(
+                        "source", False, inst.ExternParameterType.from_variable_length_vector(inst.ScalarType.Real)
+                    ),
+                    inst.ExternParameter(
+                        "sub_region_size", False, inst.ExternParameterType.from_scalar(inst.ScalarType.Integer)
+                    ),
+                    inst.ExternParameter("seed", True, inst.ExternParameterType.from_scalar(inst.ScalarType.Integer)),
+                ],
+                return_type=None,
+            ).to_quil(),
+        ),
+    ]
+    return {name: Pragma("EXTERN", [name], signature) for name, signature in signatures}