Add PEP 484 type hints to transpiler analysis and utility passes

qiskit/transpiler/passes/analysis/count_ops.py

@@ -12,6 +12,9 @@
 
 """Count the operations in a DAG circuit."""
 
+from __future__ import annotations
+
+from qiskit.dagcircuit import DAGCircuit
 from qiskit.transpiler.basepasses import AnalysisPass
 
 
@@ -21,10 +24,16 @@ class CountOps(AnalysisPass):
     The result is saved in ``property_set['count_ops']`` as an integer.
     """
 
-    def __init__(self, *, recurse=True):
+    def __init__(self, *, recurse: bool = True) -> None:
+        """Initialize a ``CountOps`` pass.
+
+        Args:
+            recurse: If ``True`` (default), recursively count operations
+                inside control-flow blocks.
+        """
         super().__init__()
         self.recurse = recurse
 
-    def run(self, dag):
-        """Run the CountOps pass on `dag`."""
+    def run(self, dag: DAGCircuit) -> None:
+        """Run the CountOps pass on *dag*."""
         self.property_set["count_ops"] = dag.count_ops(recurse=self.recurse)

qiskit/transpiler/passes/analysis/count_ops_longest_path.py

@@ -12,6 +12,9 @@
 
 """Count the operations on the longest path in a DAGCircuit."""
 
+from __future__ import annotations
+
+from qiskit.dagcircuit import DAGCircuit
 from qiskit.transpiler.basepasses import AnalysisPass
 
 
@@ -21,6 +24,6 @@ class CountOpsLongestPath(AnalysisPass):
     The result is saved in ``property_set['count_ops_longest_path']`` as an integer.
     """
 
-    def run(self, dag):
-        """Run the CountOpsLongestPath pass on `dag`."""
+    def run(self, dag: DAGCircuit) -> None:
+        """Run the CountOpsLongestPath pass on *dag*."""
         self.property_set["count_ops_longest_path"] = dag.count_ops_longest_path()

qiskit/transpiler/passes/analysis/dag_longest_path.py

@@ -12,13 +12,16 @@
 
 """Return the longest path in a :class:`.DAGCircuit` as a list of DAGNodes."""
 
+from __future__ import annotations
+
+from qiskit.dagcircuit import DAGCircuit
 from qiskit.transpiler.basepasses import AnalysisPass
 
 
 class DAGLongestPath(AnalysisPass):
     """Return the longest path in a :class:`.DAGCircuit` as a list of
     :class:`.DAGOpNode`\\ s, :class:`.DAGInNode`\\ s, and :class:`.DAGOutNode`\\ s."""
 
-    def run(self, dag):
-        """Run the DAGLongestPath pass on `dag`."""
+    def run(self, dag: DAGCircuit) -> None:
+        """Run the DAGLongestPath pass on *dag*."""
         self.property_set["dag_longest_path"] = dag.longest_path()

qiskit/transpiler/passes/analysis/depth.py

@@ -12,13 +12,16 @@
 
 """Calculate the depth of a DAG circuit."""
 
+from __future__ import annotations
+
+from qiskit.dagcircuit import DAGCircuit
 from qiskit.transpiler.basepasses import AnalysisPass
 
 
 class Depth(AnalysisPass):
     """Calculate the depth of a DAG circuit."""
 
-    def __init__(self, *, recurse=False):
+    def __init__(self, *, recurse: bool = False) -> None:
         """
         Args:
             recurse: whether to allow recursion into control flow.  If this is ``False`` (default),
@@ -28,6 +31,6 @@ def __init__(self, *, recurse=False):
         super().__init__()
         self.recurse = recurse
 
-    def run(self, dag):
-        """Run the Depth pass on `dag`."""
+    def run(self, dag: DAGCircuit) -> None:
+        """Run the Depth pass on *dag*."""
         self.property_set["depth"] = dag.depth(recurse=self.recurse)

qiskit/transpiler/passes/analysis/num_qubits.py

@@ -12,6 +12,9 @@
 
 """Calculate the number of qubits of a DAG circuit."""
 
+from __future__ import annotations
+
+from qiskit.dagcircuit import DAGCircuit
 from qiskit.transpiler.basepasses import AnalysisPass
 
 
@@ -21,6 +24,6 @@ class NumQubits(AnalysisPass):
     The result is saved in ``property_set['num_qubits']`` as an integer.
     """
 
-    def run(self, dag):
-        """Run the NumQubits pass on `dag`."""
+    def run(self, dag: DAGCircuit) -> None:
+        """Run the NumQubits pass on *dag*."""
         self.property_set["num_qubits"] = dag.num_qubits()

qiskit/transpiler/passes/analysis/num_tensor_factors.py

@@ -12,6 +12,9 @@
 
 """Calculate the number of tensor factors of a DAG circuit."""
 
+from __future__ import annotations
+
+from qiskit.dagcircuit import DAGCircuit
 from qiskit.transpiler.basepasses import AnalysisPass
 
 
@@ -21,6 +24,6 @@ class NumTensorFactors(AnalysisPass):
     The result is saved in ``property_set['num_tensor_factors']`` as an integer.
     """
 
-    def run(self, dag):
-        """Run the NumTensorFactors pass on `dag`."""
+    def run(self, dag: DAGCircuit) -> None:
+        """Run the NumTensorFactors pass on *dag*."""
         self.property_set["num_tensor_factors"] = dag.num_tensor_factors()

qiskit/transpiler/passes/analysis/resource_estimation.py

@@ -12,6 +12,9 @@
 
 """Automatically require analysis passes for resource estimation."""
 
+from __future__ import annotations
+
+from qiskit.dagcircuit import DAGCircuit
 from qiskit.transpiler.basepasses import AnalysisPass
 from qiskit.transpiler.passes.analysis.depth import Depth
 from qiskit.transpiler.passes.analysis.width import Width
@@ -30,11 +33,16 @@ class ResourceEstimation(AnalysisPass):
     * Size()
     * CountOps()
     * NumTensorFactors()
+    * NumQubits()
     """
 
-    def __init__(self):
+    def __init__(self) -> None:
         super().__init__()
         self.requires += [Depth(), Width(), Size(), CountOps(), NumTensorFactors(), NumQubits()]
 
-    def run(self, _):
-        """Run the ResourceEstimation pass on `dag`."""
+    def run(self, dag: DAGCircuit) -> None:
+        """Run the ResourceEstimation pass on *dag*.
+
+        This is a no-op: the actual analysis is performed by the required
+        sub-passes listed in :attr:`requires`.
+        """

qiskit/transpiler/passes/analysis/size.py

@@ -12,6 +12,9 @@
 
 """Calculate the size of a DAG circuit."""
 
+from __future__ import annotations
+
+from qiskit.dagcircuit import DAGCircuit
 from qiskit.transpiler.basepasses import AnalysisPass
 
 
@@ -21,7 +24,7 @@ class Size(AnalysisPass):
     The result is saved in ``property_set['size']`` as an integer.
     """
 
-    def __init__(self, *, recurse=False):
+    def __init__(self, *, recurse: bool = False) -> None:
         """
         Args:
             recurse: whether to allow recursion into control flow.  If this is ``False`` (default),
@@ -31,6 +34,6 @@ def __init__(self, *, recurse=False):
         super().__init__()
         self.recurse = recurse
 
-    def run(self, dag):
-        """Run the Size pass on `dag`."""
+    def run(self, dag: DAGCircuit) -> None:
+        """Run the Size pass on *dag*."""
         self.property_set["size"] = dag.size(recurse=self.recurse)

qiskit/transpiler/passes/analysis/width.py

@@ -12,6 +12,9 @@
 
 """Calculate the width of a DAG circuit."""
 
+from __future__ import annotations
+
+from qiskit.dagcircuit import DAGCircuit
 from qiskit.transpiler.basepasses import AnalysisPass
 
 
@@ -22,6 +25,6 @@ class Width(AnalysisPass):
     contains the number of qubits + the number of clbits.
     """
 
-    def run(self, dag):
-        """Run the Width pass on `dag`."""
+    def run(self, dag: DAGCircuit) -> None:
+        """Run the Width pass on *dag*."""
         self.property_set["width"] = dag.width()

qiskit/transpiler/passes/utils/contains_instruction.py

@@ -10,8 +10,11 @@
 # copyright notice, and modified files need to carry a notice indicating
 # that they have been altered from the originals.
 
-"""Check if a property reached a fixed point."""
+"""Check if the DAG contains a specific instruction."""
 
+from __future__ import annotations
+
+from qiskit.dagcircuit import DAGCircuit
 from qiskit.transpiler.basepasses import AnalysisPass
 
 
@@ -23,23 +26,23 @@ class ContainsInstruction(AnalysisPass):
     that instruction and ``False`` if it does not.
     """
 
-    def __init__(self, instruction_name, recurse: bool = True):
-        """ContainsInstruction initializer.
+    def __init__(self, instruction_name: str | set[str], recurse: bool = True) -> None:
+        """Initialize a ``ContainsInstruction`` pass.
 
         Args:
-            instruction_name (str | Iterable[str]): The instruction or instructions to check are in
+            instruction_name: The instruction or instructions to check are in
                 the DAG. The output in the property set is set to ``contains_`` prefixed on each
                 value for this parameter.
-            recurse (bool): if ``True`` (default), then recurse into control-flow operations.
+            recurse: if ``True`` (default), then recurse into control-flow operations.
         """
         super().__init__()
         self._instruction_names = (
             {instruction_name} if isinstance(instruction_name, str) else set(instruction_name)
         )
         self._recurse = recurse
 
-    def run(self, dag):
-        """Run the ContainsInstruction pass on dag."""
+    def run(self, dag: DAGCircuit) -> None:
+        """Run the ContainsInstruction pass on *dag*."""
         names = dag.count_ops(recurse=self._recurse)
         for name in self._instruction_names:
             self.property_set[f"contains_{name}"] = name in names

qiskit/transpiler/passes/utils/dag_fixed_point.py

@@ -12,8 +12,11 @@
 
 """Check if the DAG has reached a fixed point."""
 
+from __future__ import annotations
+
 from copy import deepcopy
 
+from qiskit.dagcircuit import DAGCircuit
 from qiskit.transpiler.basepasses import AnalysisPass
 
 
@@ -25,8 +28,8 @@ class DAGFixedPoint(AnalysisPass):
     ``property_set['dag_fixed_point']`` as a boolean.
     """
 
-    def run(self, dag):
-        """Run the DAGFixedPoint pass on `dag`."""
+    def run(self, dag: DAGCircuit) -> None:
+        """Run the DAGFixedPoint pass on *dag*."""
         if self.property_set["_dag_fixed_point_previous_dag"] is None:
             self.property_set["dag_fixed_point"] = False
         else:

qiskit/transpiler/passes/utils/fixed_point.py

@@ -12,8 +12,11 @@
 
 """Check if a property reached a fixed point."""
 
+from __future__ import annotations
+
 from copy import deepcopy
 
+from qiskit.dagcircuit import DAGCircuit
 from qiskit.transpiler.basepasses import AnalysisPass
 
 
@@ -25,17 +28,17 @@ class FixedPoint(AnalysisPass):
     as a boolean.
     """
 
-    def __init__(self, property_to_check):
-        """FixedPoint initializer.
+    def __init__(self, property_to_check: str) -> None:
+        """Initialize a ``FixedPoint`` pass.
 
         Args:
-            property_to_check (str): The property to check if a fixed point was reached.
+            property_to_check: The property to check if a fixed point was reached.
         """
         super().__init__()
         self._property = property_to_check
 
-    def run(self, dag):
-        """Run the FixedPoint pass on `dag`."""
+    def run(self, dag: DAGCircuit) -> None:
+        """Run the FixedPoint pass on *dag*."""
         current_value = self.property_set[self._property]
         fixed_point_previous_property = f"_fixed_point_previous_{self._property}"