iqm-pulse 10.3.0__tar.gz → 10.5.0__tar.gz

{iqm_pulse-10.3.0 → iqm_pulse-10.5.0}/CHANGELOG.rst

@@ -2,6 +2,23 @@
 Changelog
 =========
 
+Version 10.5.0 (2025-09-03)
+===========================
+
+Features
+--------
+
+- Enable ruff rule for missing annotations and mark exemptions.
+
+Version 10.4.0 (2025-08-12)
+===========================
+
+Features
+--------
+
+- Allow deprecating quantum operations and/or their implementations while still preserving them in the quantum operation
+  library (the names of deprecated canonical operations are still reserved).
+
 Version 10.3.0 (2025-08-11)
 ===========================
 

{iqm_pulse-10.3.0/src/iqm_pulse.egg-info → iqm_pulse-10.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: iqm-pulse
-Version: 10.3.0
+Version: 10.5.0
 Summary: A Python-based project for providing interface and implementations for control pulses.
 Author-email: IQM Finland Oy <info@meetiqm.com>
 License:                                  Apache License

{iqm_pulse-10.3.0 → iqm_pulse-10.5.0}/pyproject.toml

@@ -52,7 +52,7 @@ nb_diff_ignore = [ "/metadata/language_info", "/metadata/widgets", "/cells/*/exe
 
 [tool.ruff.lint]
 ignore = [ "D203", "D213",]
-select = [ "E4", "E7", "E9", "E5", "F", "Q", "PL", "I", "D", "UP007", "UP006", "UP035",]
+select = [ "E4", "E7", "E9", "E5", "F", "Q", "PL", "I", "D", "UP007", "UP006", "UP035", "ANN001", "ANN201", "ANN202",]
 unfixable = [ "F401",]
 
 [tool.ruff.lint.isort]
@@ -65,9 +65,9 @@ relative-imports-order = "closest-to-furthest"
 [tool.ruff.lint.per-file-ignores]
 "**/__init__.py" = [ "F401", "PLR0402",]
 "**/docs/*" = [ "E402", "D100",]
-"**/setup.py" = [ "D100", "D103", "I001",]
+"**/setup.py" = [ "D100", "D103", "I001", "ANN201",]
 "**/src/*" = [ "PLR2004", "D400", "D415", "D205", "D401", "D417", "D100", "D101", "D107", "D102", "D105", "D103", "D404", "D104",]
-"**/tests/*" = [ "F632", "PLR2004", "PLR0402", "PLC0414", "D",]
+"**/tests/*" = [ "F632", "PLR2004", "PLR0402", "PLC0414", "D", "ANN001", "ANN201", "ANN202",]
 
 [tool.ruff.lint.pylint]
 max-args = 8

{iqm_pulse-10.3.0 → iqm_pulse-10.5.0}/src/iqm/pulse/base_utils.py

@@ -24,7 +24,7 @@ from typing import Any
 import numpy as np
 
 
-def merge_dicts(A: dict, B: dict, path=(), merge_nones: bool = True) -> dict:
+def merge_dicts(A: dict, B: dict, path=(), merge_nones: bool = True) -> dict:  # noqa: ANN001
     """Merge two dictionaries recursively, leaving the originals unchanged.
 
     Args:

{iqm_pulse-10.3.0 → iqm_pulse-10.5.0}/src/iqm/pulse/builder.py

@@ -45,7 +45,7 @@ from iqm.pulse.gate_implementation import (
     OpCalibrationDataTree,
 )
 from iqm.pulse.gates import _validate_implementation, get_implementation_class
-from iqm.pulse.gates.default_gates import _quantum_ops_library
+from iqm.pulse.gates.default_gates import _deprecated_implementations, _deprecated_ops, _quantum_ops_library
 from iqm.pulse.playlist.channel import ChannelProperties, ProbeChannelProperties
 from iqm.pulse.playlist.instructions import (
     AcquisitionMethod,
@@ -184,8 +184,12 @@ def validate_quantum_circuit(
 def build_quantum_ops(ops: dict[str, dict[str, Any]]) -> QuantumOpTable:
     """Builds the table of known quantum operations.
 
-    Hardcoded default native ops table is extended by the ones in ``ops``.
-    In case of name collisions, the content of ``ops`` takes priority over the defaults.
+    Hardcoded canonical ops table is extended by the ones in ``ops``.
+    In case of name collisions, the content of ``ops`` takes priority over the defaults,
+    with the following caveats:
+
+    * canonical implementation names cannot be redefined, and
+    * for canonical operations you can only change :attr:`implementations` and :attr:`defaults_for_locus`.
 
     Args:
         ops: Contents of the ``gate_definitions`` section defining
@@ -204,7 +208,23 @@ def build_quantum_ops(ops: dict[str, dict[str, Any]]) -> QuantumOpTable:
         ValueError: Operation attributes don't match defaults or are invalid.
 
     """
-    op_table = copy.deepcopy(_quantum_ops_library)
+    # build the table of native ops
+    op_table = {}
+    for op_name, op in _quantum_ops_library.items():
+        # filter out deprecated ops, unless requested by the user in ``ops``
+        if op_name in _deprecated_ops and op_name not in ops:
+            continue
+
+        new_op = copy.deepcopy(op)  # to prevent modifications to the hardcoded table
+        if (deprecated_impls := _deprecated_implementations.get(op_name)) is not None:
+            # filter out deprecated implementations
+            non_deprecated = {
+                impl_name: impl for impl_name, impl in op.implementations.items() if impl_name not in deprecated_impls
+            }
+            new_op = replace(op, implementations=non_deprecated)
+        op_table[op_name] = new_op
+
+    # add ops defined by the user
     for op_name, op_definition in ops.items():
         # prepare the implementations
         implementations: dict[str, type[GateImplementation]] = {}
@@ -236,9 +256,9 @@ def build_quantum_ops(ops: dict[str, dict[str, Any]]) -> QuantumOpTable:
                     f"appear in the implementations dict."
                 )
 
-        # prepare a new op, or modify the existing one
-        if (old_op := op_table.get(op_name)) is not None:
-            # known op: only some fields can be redefined, and they have been popped out already
+        if (old_op := _quantum_ops_library.get(op_name)) is not None:
+            # modify a canonical operation
+            # only some fields can be modified, and they have been popped out already from op_definition
             if op_definition:
                 # TODO this should be an error, but there are so many old experiment.yml files in use
                 # that still have the old syntax that being strict about this would be disruptive.
@@ -247,15 +267,17 @@ def build_quantum_ops(ops: dict[str, dict[str, Any]]) -> QuantumOpTable:
                     f"'{op_name}' is a canonical operation, which means the fields {set(op_definition)} "
                     "provided by the user may not be changed."
                 )
-            op_table[op_name] = replace(old_op, implementations=implementations, defaults_for_locus=defaults_for_locus)
+
+            op = replace(old_op, implementations=implementations, defaults_for_locus=defaults_for_locus)
         else:
-            # new op
-            op_table[op_name] = QuantumOp(
+            # entirely new quantum operation defined by the user
+            op = QuantumOp(
                 name=op_name,
                 implementations=implementations,
                 defaults_for_locus=defaults_for_locus,
                 **op_definition,
             )
+        op_table[op_name] = op
 
     return op_table
 
@@ -1474,7 +1496,7 @@ class ScheduleBuilder:
         """
 
         def _shortcut_mthd(
-            self,
+            self,  # noqa: ANN001
             locus: Iterable[str],
             impl_name: str | None = None,
             *,

{iqm_pulse-10.3.0 → iqm_pulse-10.5.0}/src/iqm/pulse/circuit_operations.py

@@ -145,7 +145,7 @@ def get_unitary_from_circuit(
     return unitary
 
 
-def _get_qubit_order_from_circuit(circuit: list[CircuitOperation]):
+def _get_qubit_order_from_circuit(circuit: list[CircuitOperation]):  # noqa: ANN202
     """Get all qubits which are in the circuit in order."""
     # unique items, in the same order
     return list(dict.fromkeys(qb for op in circuit for qb in op.locus))
@@ -278,7 +278,7 @@ class CircuitOperationList(list):
             if self.table[op_name].arity:
                 self._set_specific_operation_shortcut(op_name)
 
-    def __getitem__(self, item) -> CircuitOperationList | CircuitOperation:  # type: ignore[override]  # type: ignore[override]  # type: ignore[override]
+    def __getitem__(self, item) -> CircuitOperationList | CircuitOperation:  # type: ignore[override]  # type: ignore[override]  # type: ignore[override]  # noqa: ANN001
         """For the builtin list, this method is used both for accessing a single element: ``mylist[0]`` and accessing
         a slice: ``mylist[1:3]``. The latter should generate a new CircuitOperationList, so we override the method to
         ensure that it does.
@@ -290,12 +290,12 @@ class CircuitOperationList(list):
 
         return result
 
-    def __add__(self, other) -> CircuitOperationList:
+    def __add__(self, other) -> CircuitOperationList:  # noqa: ANN001
         new = CircuitOperationList(list.__add__(self, other), qubits=self.qubits, table=self.table)
 
         return new
 
-    def __mul__(self, other) -> CircuitOperationList:
+    def __mul__(self, other) -> CircuitOperationList:  # noqa: ANN001
         new = CircuitOperationList(list.__mul__(self, other), qubits=self.qubits, table=self.table)
         return new
 
@@ -377,7 +377,7 @@ class CircuitOperationList(list):
 
     def compose(
         self,
-        other,
+        other,  # noqa: ANN001
         locus_indices: list[int] | None = None,
     ) -> Self:
         """A safer way to add circuits together, but will probably take time.
@@ -482,8 +482,8 @@ class CircuitOperationList(list):
         num_params = len(op.params)
         arity = op.arity
 
-        def _add_specific_op(
-            self,
+        def _add_specific_op(  # noqa: ANN202
+            self,  # noqa: ANN001
             *args_and_locus,
             impl_name: str | None = None,
         ):

{iqm_pulse-10.3.0 → iqm_pulse-10.5.0}/src/iqm/pulse/gates/__init__.py

@@ -46,7 +46,7 @@ from iqm.pulse.gates.cz import (
     FluxPulseGate_CRF_CRF,
     FluxPulseGate_TGSS_CRF,
 )
-from iqm.pulse.gates.default_gates import _default_implementations, _quantum_ops_library
+from iqm.pulse.gates.default_gates import _implementation_library, _quantum_ops_library
 from iqm.pulse.gates.delay import Delay
 from iqm.pulse.gates.flux_multiplexer import FluxMultiplexer_SampleLinear
 from iqm.pulse.gates.measure import Measure_Constant, Measure_Constant_Qnd, Shelved_Measure_Constant
@@ -157,7 +157,7 @@ def _validate_implementation(
         ValueError: A canonical implementation name is being redefined.
 
     """
-    default_implementations = _default_implementations.get(op_name, {})
+    default_implementations = _implementation_library.get(op_name, {})
 
     # check if the implementation name is canonical for this op
     if (impl_class := default_implementations.get(impl_name)) is not None:

{iqm_pulse-10.3.0 → iqm_pulse-10.5.0}/src/iqm/pulse/gates/default_gates.py

@@ -15,7 +15,7 @@
 
 from __future__ import annotations
 
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Final
 
 import numpy as np
 
@@ -63,7 +63,7 @@ if TYPE_CHECKING:
     from iqm.pulse.gate_implementation import GateImplementation
 
 
-_default_implementations: dict[str, dict[str, type[GateImplementation]]] = {
+_implementation_library: dict[str, dict[str, type[GateImplementation]]] = {
     "barrier": {"": Barrier},
     "delay": {"wait": Delay},
     "measure": {
@@ -105,9 +105,11 @@ _default_implementations: dict[str, dict[str, type[GateImplementation]]] = {
     "reset_wait": {"reset_wait": Reset_Wait},
     "flux_multiplexer": {"sample_linear": FluxMultiplexer_SampleLinear},
 }
-"""Canonical implementation names for the canonical quantum operations.
-A collection of mappings between default implementation names and their GateImplementation classes,
-for different gates."""
+"""For each canonical quantum operation name, maps its canonical implementation implementation names
+to their GateImplementation classes.
+
+Canonical names are reserved, and the users cannot redefine them.
+"""
 
 _quantum_ops_library = {
     op.name: op
@@ -115,101 +117,113 @@ _quantum_ops_library = {
         QuantumOp(
             "barrier",
             0,
-            implementations=_default_implementations["barrier"],  # type: ignore[arg-type]
+            implementations=_implementation_library["barrier"],
             symmetric=True,
         ),
         QuantumOp(
             "delay",
             0,
             ("duration",),
-            implementations=_default_implementations["delay"],  # type: ignore[arg-type]
+            implementations=_implementation_library["delay"],
             symmetric=True,
         ),
         QuantumOp(
             "measure",
             0,
             ("key",),
-            implementations=_default_implementations["measure"],  # type: ignore[arg-type]
+            implementations=_implementation_library["measure"],
             factorizable=True,
         ),
         QuantumOp(
             "prx",
             1,
             ("angle", "phase"),
-            implementations=_default_implementations["prx"],  # type: ignore[arg-type]
+            implementations=_implementation_library["prx"],
             unitary=get_unitary_prx,
         ),
         QuantumOp(
             "prx_12",
             1,
             ("angle", "phase"),
-            implementations=_default_implementations["prx_12"],  # type: ignore[arg-type]
+            implementations=_implementation_library["prx_12"],
         ),
         QuantumOp(
             "u",
             1,
             ("theta", "phi", "lam"),
-            implementations=_default_implementations["u"],  # type: ignore[arg-type]
+            implementations=_implementation_library["u"],
             unitary=get_unitary_u,
         ),
         QuantumOp(
             "sx",
             1,
-            implementations=_default_implementations["sx"],  # type: ignore[arg-type]
+            implementations=_implementation_library["sx"],
             unitary=lambda: get_unitary_prx(np.pi / 2, 0),
         ),
         QuantumOp(
             "rz",
             1,
             ("angle",),
-            implementations=_default_implementations["rz"],  # type: ignore[arg-type]
+            implementations=_implementation_library["rz"],
             unitary=get_unitary_rz,
         ),
         QuantumOp(
             "rz_physical",
             1,
-            implementations=_default_implementations["rz_physical"],  # type: ignore[arg-type]
+            implementations=_implementation_library["rz_physical"],
         ),
         QuantumOp(
             "cz",
             2,
             (),
-            implementations=_default_implementations["cz"],  # type: ignore[arg-type]
+            implementations=_implementation_library["cz"],
             symmetric=True,
             unitary=lambda: np.diag([1.0, 1.0, 1.0, -1.0]),
         ),
         QuantumOp(
             "move",
             2,
-            implementations=_default_implementations["move"],  # type: ignore[arg-type]
+            implementations=_implementation_library["move"],
         ),
         QuantumOp(
             "cc_prx",
             1,
             ("angle", "phase", "feedback_qubit", "feedback_key"),
-            implementations=_default_implementations["cc_prx"],  # type: ignore[arg-type]
+            implementations=_implementation_library["cc_prx"],
         ),
         QuantumOp(
             "reset",
             0,
-            implementations=_default_implementations["reset"],  # type: ignore[arg-type]
+            implementations=_implementation_library["reset"],
             symmetric=True,
             factorizable=True,
         ),
         QuantumOp(
             "reset_wait",
             0,
-            implementations=_default_implementations["reset_wait"],  # type: ignore[arg-type]
+            implementations=_implementation_library["reset_wait"],
             symmetric=True,
             factorizable=True,
         ),
         QuantumOp(
             "flux_multiplexer",
             0,
-            implementations=_default_implementations["flux_multiplexer"],  # type: ignore[arg-type]
+            implementations=_implementation_library["flux_multiplexer"],
         ),
     ]
 }
-"""Library of the current canonical quantum operations provided by iqm-pulse."""
-# NOTE If a canonical operation is removed in the future, consider adding a second dict for former
-# canonical operations so that we retain information about them.
+"""Canonical quantum operations provided by iqm-pulse.
+
+Their names are reserved, and the users cannot redefine them.
+"""
+
+_deprecated_ops: Final[set[str]] = set()
+"""Names of canonical quantum operations that are deprecated.
+
+They are not included by default in ScheduleBuilder unless the user specifically requests them."""
+_deprecated_implementations: Final[dict[str, set[str]]] = {}
+"""For each canonical quantum operation name, canonical implementation names that are deprecated.
+
+They are not included by default in ScheduleBuilder unless the user specifically requests them."""
+# TODO: deprecate gaussian_smoothed_square and everything with the tgss waveform as that is considered inferior to crf.
+# TODO: deprecate PRX_drag_gaussian

{iqm_pulse-10.3.0 → iqm_pulse-10.5.0}/src/iqm/pulse/gates/rz.py

@@ -253,7 +253,7 @@ class RZ_PRX_Composite(CompositeGate):
 
     registered_gates = ("prx",)
 
-    def __init__(self, parent, name, locus, calibration_data, builder):
+    def __init__(self, parent, name, locus, calibration_data, builder):  # noqa: ANN001
         super().__init__(parent, name, locus, calibration_data, builder)
 
     def __call__(self, angle: float) -> TimeBox:

{iqm_pulse-10.3.0 → iqm_pulse-10.5.0}/src/iqm/pulse/playlist/channel.py

@@ -272,7 +272,7 @@ class ChannelDescription:
             self.waveform_table.append(wave)
         return idx
 
-    def _lookup_or_insert_instruction(self, instruction) -> int:
+    def _lookup_or_insert_instruction(self, instruction) -> int:  # noqa: ANN001
         new_idx = len(self.instruction_table)
         idx = self._reverse_instruction_index.setdefault(instruction, new_idx)
         if idx == new_idx:

{iqm_pulse-10.3.0 → iqm_pulse-10.5.0}/src/iqm/pulse/playlist/instructions.py

@@ -103,7 +103,7 @@ class RealPulse(Instruction):
     scale: float
     """Scaling factor for the waveform."""
 
-    def validate(self):
+    def validate(self):  # noqa: ANN201
         super().validate()
         if abs(self.scale) > 1.0:
             raise ValueError(f"RealPulse.scale {self.scale} not in [-1, 1].")
@@ -149,7 +149,7 @@ class IQPulse(Instruction):
     all pulses that are played after it on the channel, in radians.
     """
 
-    def validate(self):
+    def validate(self):  # noqa: ANN201
         super().validate()
         if abs(self.scale_i) > 1.0:
             raise ValueError(f"IQPulse.scale_i {self.scale_i} not in [-1, 1].")
@@ -169,7 +169,7 @@ class ConditionalInstruction(Instruction):
     outcomes: tuple[Instruction, ...]
     """Maps possible outcomes of the condition to the corresponding instructions."""
 
-    def validate(self):
+    def validate(self):  # noqa: ANN201
         super().validate()
         if not self.outcomes:
             raise ValueError("There must be at least one outcome.")

{iqm_pulse-10.3.0 → iqm_pulse-10.5.0}/src/iqm/pulse/playlist/schedule.py

@@ -78,7 +78,7 @@ class Segment:
     def __len__(self) -> int:
         return len(self._instructions)
 
-    def __getitem__(self, key):
+    def __getitem__(self, key):  # noqa: ANN001
         return self._instructions[key]
 
     def __reversed__(self):
@@ -229,7 +229,7 @@ class Schedule:
             s += "|\n"
         return s
 
-    def items(self):
+    def items(self):  # noqa: ANN201
         """Iterator over the schedule channel names and segments."""
         return self._contents.items()
 
@@ -313,7 +313,7 @@ class Schedule:
             }
         return self
 
-    def front_pad_in_seconds(self, to_duration: float, channel_properties: dict[str, ChannelProperties]):
+    def front_pad_in_seconds(self, to_duration: float, channel_properties: dict[str, ChannelProperties]):  # noqa: ANN201
         """Modifies the schedule in place by front-padding it with :class:`.Wait` instructions.
 
         The new duration is given in seconds, and this method works also with variable sample rates.

{iqm_pulse-10.3.0 → iqm_pulse-10.5.0}/src/iqm/pulse/playlist/visualisation/base.py

@@ -31,7 +31,7 @@ import numpy as np
 from iqm.pulse.playlist.playlist import Playlist
 
 
-def _numpy_to_builtin_types(data: list[tuple[str, Any]]):
+def _numpy_to_builtin_types(data: list[tuple[str, Any]]):  # noqa: ANN202
     """Convert selected ``numpy`` types to Python's built-in types.
 
     This helper function is to be used for converting dataclasses into
@@ -57,7 +57,7 @@ def _numpy_to_builtin_types(data: list[tuple[str, Any]]):
 def _get_waveform(wave: Waveform, scale: float, wave_q: Waveform | None = None, scale_q: float | None = None) -> str:
     import matplotlib.pyplot as plt
 
-    def fig_to_base64(fig):
+    def fig_to_base64(fig):  # noqa: ANN001, ANN202
         img = io.BytesIO()
         fig.savefig(img, format="png", bbox_inches="tight")
         img.seek(0)

{iqm_pulse-10.3.0 → iqm_pulse-10.5.0}/src/iqm/pulse/playlist/waveforms.py

@@ -364,7 +364,7 @@ class Chirp(Waveform):
     alpha: float = 0.05
     phase: float = 0
 
-    def _sample(self, sample_coords):
+    def _sample(self, sample_coords):  # noqa: ANN001, ANN202
         chirpfreq = np.linspace(self.freq_start, self.freq_stop, len(sample_coords))
         chirpphase = 2 * np.pi * np.cumsum(chirpfreq) + self.phase
         wave = np.exp(1j * chirpphase) * ss.windows.tukey(len(sample_coords), self.alpha)

{iqm_pulse-10.3.0 → iqm_pulse-10.5.0}/src/iqm/pulse/validation.py

@@ -126,7 +126,7 @@ class AWGScheduleValidationError(Exception):
 class InvalidInstructionError(Exception):
     """Error raised when encountering an invalid instruction."""
 
-    def __init__(self, instruction, issue_string="unknown reason"):
+    def __init__(self, instruction, issue_string="unknown reason"):  # noqa: ANN001
         self.issue_string = issue_string
         self.instruction = instruction
         super().__init__(issue_string)
@@ -135,7 +135,7 @@ class InvalidInstructionError(Exception):
         return f"{self.issue_string} (in {self.instruction})"
 
 
-def validate_instruction_and_wf_length(instruction: Instruction):
+def validate_instruction_and_wf_length(instruction: Instruction):  # noqa: ANN201
     """Validate that instruction and waveform lengths match
 
     Args:
@@ -156,7 +156,7 @@ def validate_instruction_and_wf_length(instruction: Instruction):
             raise InvalidInstructionError(instruction, "scale not in -1..1")
 
 
-def validate_awg_and_schedule_compatibility(
+def validate_awg_and_schedule_compatibility(  # noqa: ANN201
     channel_description: ChannelDescription, device_constraints: AWGScheduleValidationData
 ):
     """Validates that the given playlist is compatible with the provided AWG data.

{iqm_pulse-10.3.0 → iqm_pulse-10.5.0/src/iqm_pulse.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: iqm-pulse
-Version: 10.3.0
+Version: 10.5.0
 Summary: A Python-based project for providing interface and implementations for control pulses.
 Author-email: IQM Finland Oy <info@meetiqm.com>
 License:                                  Apache License

iqm_pulse-10.5.0/version.txt

@@ -0,0 +1 @@
+10.5.0

iqm_pulse-10.3.0/version.txt

@@ -1 +0,0 @@
-10.3.0