cirq-core 1.5.0.dev20250409225226__py3-none-any.whl → 1.6.0__py3-none-any.whl

cirq/transformers/target_gatesets/sqrt_iswap_gateset_test.py

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from typing import Optional
+from __future__ import annotations
 
 import numpy as np
 import pytest
@@ -38,7 +38,7 @@ def assert_optimizes(before: cirq.Circuit, expected: cirq.Circuit, **kwargs):
 
 
 def assert_optimization_not_broken(
-    circuit: cirq.Circuit, required_sqrt_iswap_count: Optional[int] = None
+    circuit: cirq.Circuit, required_sqrt_iswap_count: int | None = None
 ):
     c_new = cirq.optimize_for_target_gateset(
         circuit,
@@ -60,7 +60,7 @@ def assert_optimization_not_broken(
     )
 
 
-def test_convert_to_sqrt_iswap_preserving_moment_structure():
+def test_convert_to_sqrt_iswap_preserving_moment_structure() -> None:
     q = cirq.LineQubit.range(5)
     op = lambda q0, q1: cirq.H(q1).controlled_by(q0)
     c_orig = cirq.Circuit(
@@ -112,7 +112,7 @@ def test_convert_to_sqrt_iswap_preserving_moment_structure():
     ],
 )
 @pytest.mark.parametrize('use_sqrt_iswap_inv', [True, False])
-def test_two_qubit_gates_with_symbols(gate: cirq.Gate, use_sqrt_iswap_inv: bool):
+def test_two_qubit_gates_with_symbols(gate: cirq.Gate, use_sqrt_iswap_inv: bool) -> None:
     # Note that even though these gates are not natively supported by
     # `cirq.parameterized_2q_op_to_sqrt_iswap_operations`, the transformation succeeds because
     # `cirq.optimize_for_target_gateset` also relies on `cirq.decompose` as a fallback.
@@ -142,12 +142,12 @@ def test_two_qubit_gates_with_symbols(gate: cirq.Gate, use_sqrt_iswap_inv: bool)
         )
 
 
-def test_sqrt_iswap_gateset_raises():
+def test_sqrt_iswap_gateset_raises() -> None:
     with pytest.raises(ValueError, match="`required_sqrt_iswap_count` must be 0, 1, 2, or 3"):
         _ = cirq.SqrtIswapTargetGateset(required_sqrt_iswap_count=4)
 
 
-def test_sqrt_iswap_gateset_eq():
+def test_sqrt_iswap_gateset_eq() -> None:
     eq = cirq.testing.EqualsTester()
     eq.add_equality_group(
         cirq.SqrtIswapTargetGateset(), cirq.SqrtIswapTargetGateset(use_sqrt_iswap_inv=False)
@@ -179,11 +179,11 @@ def test_sqrt_iswap_gateset_eq():
         cirq.SqrtIswapTargetGateset(additional_gates=()),
     ],
 )
-def test_sqrt_iswap_gateset_repr(gateset):
+def test_sqrt_iswap_gateset_repr(gateset) -> None:
     cirq.testing.assert_equivalent_repr(gateset)
 
 
-def test_simplifies_sqrt_iswap():
+def test_simplifies_sqrt_iswap() -> None:
     a, b = cirq.LineQubit.range(2)
     assert_optimizes(
         before=cirq.Circuit(
@@ -204,7 +204,7 @@ def test_simplifies_sqrt_iswap():
     )
 
 
-def test_simplifies_sqrt_iswap_inv():
+def test_simplifies_sqrt_iswap_inv() -> None:
     a, b = cirq.LineQubit.range(2)
     assert_optimizes(
         use_sqrt_iswap_inv=True,
@@ -226,7 +226,7 @@ def test_simplifies_sqrt_iswap_inv():
     )
 
 
-def test_works_with_tags():
+def test_works_with_tags() -> None:
     a, b = cirq.LineQubit.range(2)
     assert_optimizes(
         before=cirq.Circuit(
@@ -240,7 +240,7 @@ def test_works_with_tags():
     )
 
 
-def test_no_touch_single_sqrt_iswap():
+def test_no_touch_single_sqrt_iswap() -> None:
     a, b = cirq.LineQubit.range(2)
     circuit = cirq.Circuit(
         [
@@ -252,7 +252,7 @@ def test_no_touch_single_sqrt_iswap():
     assert_optimizes(before=circuit, expected=circuit)
 
 
-def test_no_touch_single_sqrt_iswap_inv():
+def test_no_touch_single_sqrt_iswap_inv() -> None:
     a, b = cirq.LineQubit.range(2)
     circuit = cirq.Circuit(
         [
@@ -264,19 +264,19 @@ def test_no_touch_single_sqrt_iswap_inv():
     assert_optimizes(before=circuit, expected=circuit, use_sqrt_iswap_inv=True)
 
 
-def test_cnots_separated_by_single_gates_correct():
+def test_cnots_separated_by_single_gates_correct() -> None:
     a, b = cirq.LineQubit.range(2)
     assert_optimization_not_broken(cirq.Circuit(cirq.CNOT(a, b), cirq.H(b), cirq.CNOT(a, b)))
 
 
-def test_czs_separated_by_single_gates_correct():
+def test_czs_separated_by_single_gates_correct() -> None:
     a, b = cirq.LineQubit.range(2)
     assert_optimization_not_broken(
         cirq.Circuit(cirq.CZ(a, b), cirq.X(b), cirq.X(b), cirq.X(b), cirq.CZ(a, b))
     )
 
 
-def test_inefficient_circuit_correct():
+def test_inefficient_circuit_correct() -> None:
     t = 0.1
     v = 0.11
     a, b = cirq.LineQubit.range(2)
@@ -301,7 +301,7 @@ def test_inefficient_circuit_correct():
     )
 
 
-def test_optimizes_single_iswap():
+def test_optimizes_single_iswap() -> None:
     a, b = cirq.LineQubit.range(2)
     c = cirq.Circuit(cirq.ISWAP(a, b))
     assert_optimization_not_broken(c)
@@ -311,7 +311,7 @@ def test_optimizes_single_iswap():
     assert len([1 for op in c.all_operations() if len(op.qubits) == 2]) == 2
 
 
-def test_optimizes_single_inv_sqrt_iswap():
+def test_optimizes_single_inv_sqrt_iswap() -> None:
     a, b = cirq.LineQubit.range(2)
     c = cirq.Circuit(cirq.SQRT_ISWAP_INV(a, b))
     assert_optimization_not_broken(c)
@@ -321,7 +321,7 @@ def test_optimizes_single_inv_sqrt_iswap():
     assert len([1 for op in c.all_operations() if len(op.qubits) == 2]) == 1
 
 
-def test_optimizes_single_iswap_require0():
+def test_optimizes_single_iswap_require0() -> None:
     a, b = cirq.LineQubit.range(2)
     c = cirq.Circuit(cirq.CNOT(a, b), cirq.CNOT(a, b))  # Minimum 0 sqrt-iSWAP
     assert_optimization_not_broken(c, required_sqrt_iswap_count=0)
@@ -331,7 +331,7 @@ def test_optimizes_single_iswap_require0():
     assert len([1 for op in c.all_operations() if len(op.qubits) == 2]) == 0
 
 
-def test_optimizes_single_iswap_require0_raises():
+def test_optimizes_single_iswap_require0_raises() -> None:
     a, b = cirq.LineQubit.range(2)
     c = cirq.Circuit(cirq.CNOT(a, b))  # Minimum 2 sqrt-iSWAP
     with pytest.raises(ValueError, match='cannot be decomposed into exactly 0 sqrt-iSWAP gates'):
@@ -342,7 +342,7 @@ def test_optimizes_single_iswap_require0_raises():
         )
 
 
-def test_optimizes_single_iswap_require1():
+def test_optimizes_single_iswap_require1() -> None:
     a, b = cirq.LineQubit.range(2)
     c = cirq.Circuit(cirq.SQRT_ISWAP_INV(a, b))  # Minimum 1 sqrt-iSWAP
     assert_optimization_not_broken(c, required_sqrt_iswap_count=1)
@@ -352,7 +352,7 @@ def test_optimizes_single_iswap_require1():
     assert len([1 for op in c.all_operations() if len(op.qubits) == 2]) == 1
 
 
-def test_optimizes_single_iswap_require1_raises():
+def test_optimizes_single_iswap_require1_raises() -> None:
     a, b = cirq.LineQubit.range(2)
     c = cirq.Circuit(cirq.CNOT(a, b))  # Minimum 2 sqrt-iSWAP
     with pytest.raises(ValueError, match='cannot be decomposed into exactly 1 sqrt-iSWAP gates'):
@@ -363,7 +363,7 @@ def test_optimizes_single_iswap_require1_raises():
         )
 
 
-def test_optimizes_single_iswap_require2():
+def test_optimizes_single_iswap_require2() -> None:
     a, b = cirq.LineQubit.range(2)
     c = cirq.Circuit(cirq.SQRT_ISWAP_INV(a, b))  # Minimum 1 sqrt-iSWAP but 2 possible
     assert_optimization_not_broken(c, required_sqrt_iswap_count=2)
@@ -373,7 +373,7 @@ def test_optimizes_single_iswap_require2():
     assert len([1 for op in c.all_operations() if len(op.qubits) == 2]) == 2
 
 
-def test_optimizes_single_iswap_require2_raises():
+def test_optimizes_single_iswap_require2_raises() -> None:
     a, b = cirq.LineQubit.range(2)
     c = cirq.Circuit(cirq.SWAP(a, b))  # Minimum 3 sqrt-iSWAP
     with pytest.raises(ValueError, match='cannot be decomposed into exactly 2 sqrt-iSWAP gates'):
@@ -384,7 +384,7 @@ def test_optimizes_single_iswap_require2_raises():
         )
 
 
-def test_optimizes_single_iswap_require3():
+def test_optimizes_single_iswap_require3() -> None:
     a, b = cirq.LineQubit.range(2)
     c = cirq.Circuit(cirq.ISWAP(a, b))  # Minimum 2 sqrt-iSWAP but 3 possible
     assert_optimization_not_broken(c, required_sqrt_iswap_count=3)
@@ -394,7 +394,7 @@ def test_optimizes_single_iswap_require3():
     assert len([1 for op in c.all_operations() if len(op.qubits) == 2]) == 3
 
 
-def test_optimizes_single_inv_sqrt_iswap_require3():
+def test_optimizes_single_inv_sqrt_iswap_require3() -> None:
     a, b = cirq.LineQubit.range(2)
     c = cirq.Circuit(cirq.SQRT_ISWAP_INV(a, b))
     assert_optimization_not_broken(c, required_sqrt_iswap_count=3)

cirq/transformers/transformer_api.py

@@ -14,25 +14,14 @@
 
 """Defines the API for circuit transformers in Cirq."""
 
+from __future__ import annotations
+
 import dataclasses
 import enum
 import functools
 import inspect
 import textwrap
-from typing import (
-    Any,
-    Callable,
-    cast,
-    Hashable,
-    List,
-    Optional,
-    overload,
-    Tuple,
-    Type,
-    TYPE_CHECKING,
-    TypeVar,
-    Union,
-)
+from typing import Any, Callable, cast, Hashable, overload, TYPE_CHECKING, TypeVar
 
 from typing_extensions import Protocol
 
@@ -83,10 +72,10 @@ class _LoggerNode:
 
     transformer_id: int
     transformer_name: str
-    initial_circuit: 'cirq.AbstractCircuit'
-    final_circuit: 'cirq.AbstractCircuit'
-    logs: List[Tuple[LogLevel, Tuple[str, ...]]] = dataclasses.field(default_factory=list)
-    nested_loggers: List[int] = dataclasses.field(default_factory=list)
+    initial_circuit: cirq.AbstractCircuit
+    final_circuit: cirq.AbstractCircuit
+    logs: list[tuple[LogLevel, tuple[str, ...]]] = dataclasses.field(default_factory=list)
+    nested_loggers: list[int] = dataclasses.field(default_factory=list)
 
 
 class TransformerLogger:
@@ -99,8 +88,8 @@ class TransformerLogger:
 
     The logger assumes that
         - Transformers are run sequentially.
-        - Nested transformers are allowed, in which case the behavior would be similar to a
-          doing a depth first search on the graph of transformers -- i.e. the top level transformer
+        - Nested transformers are allowed, in which case the behavior would be similar to
+          doing a depth-first search on the graph of transformers -- i.e. the top level transformer
           would end (i.e. receive a `register_final` call) once all nested transformers (i.e. all
           `register_initial` calls received while the top level transformer was active) have
           finished (i.e. corresponding `register_final` calls have also been received).
@@ -113,10 +102,10 @@ class TransformerLogger:
     def __init__(self) -> None:
         """Initializes TransformerLogger."""
         self._curr_id: int = 0
-        self._logs: List[_LoggerNode] = []
-        self._stack: List[int] = []
+        self._logs: list[_LoggerNode] = []
+        self._stack: list[int] = []
 
-    def register_initial(self, circuit: 'cirq.AbstractCircuit', transformer_name: str) -> None:
+    def register_initial(self, circuit: cirq.AbstractCircuit, transformer_name: str) -> None:
         """Register the beginning of a new transformer stage.
 
         Args:
@@ -143,7 +132,7 @@ class TransformerLogger:
             raise ValueError('No active transformer found.')
         self._logs[self._stack[-1]].logs.append((level, args))
 
-    def register_final(self, circuit: 'cirq.AbstractCircuit', transformer_name: str) -> None:
+    def register_final(self, circuit: cirq.AbstractCircuit, transformer_name: str) -> None:
         """Register the end of the currently active transformer stage.
 
         Args:
@@ -195,13 +184,13 @@ class TransformerLogger:
 class NoOpTransformerLogger(TransformerLogger):
     """All calls to this logger are a no-op"""
 
-    def register_initial(self, circuit: 'cirq.AbstractCircuit', transformer_name: str) -> None:
+    def register_initial(self, circuit: cirq.AbstractCircuit, transformer_name: str) -> None:
         pass
 
     def log(self, *args: str, level: LogLevel = LogLevel.INFO) -> None:
         pass
 
-    def register_final(self, circuit: 'cirq.AbstractCircuit', transformer_name: str) -> None:
+    def register_final(self, circuit: cirq.AbstractCircuit, transformer_name: str) -> None:
         pass
 
     def show(self, level: LogLevel = LogLevel.INFO) -> None:
@@ -225,7 +214,7 @@ class TransformerContext:
     """
 
     logger: TransformerLogger = NoOpTransformerLogger()
-    tags_to_ignore: Tuple[Hashable, ...] = ()
+    tags_to_ignore: tuple[Hashable, ...] = ()
     deep: bool = False
 
 
@@ -242,7 +231,7 @@ class TRANSFORMER(Protocol):
     >>> def convert_to_cz(
     ...     circuit: cirq.AbstractCircuit,
     ...     *,
-    ...     context: 'Optional[cirq.TransformerContext]' = None,
+    ...     context: cirq.TransformerContext | None = None,
     ...     atol: float = 1e-8,
     ... ) -> cirq.Circuit:
     ...     ...
@@ -256,21 +245,19 @@ class TRANSFORMER(Protocol):
     ...         self,
     ...         circuit: cirq.AbstractCircuit,
     ...         *,
-    ...         context: 'Optional[cirq.TransformerContext]' = None,
+    ...         context: cirq.TransformerContext | None = None,
     ...      ) -> cirq.AbstractCircuit:
     ...         ...
     """
 
     def __call__(
-        self, circuit: 'cirq.AbstractCircuit', *, context: Optional[TransformerContext] = None
-    ) -> 'cirq.AbstractCircuit': ...
+        self, circuit: cirq.AbstractCircuit, *, context: TransformerContext | None = None
+    ) -> cirq.AbstractCircuit: ...
 
 
 _TRANSFORMER_T = TypeVar('_TRANSFORMER_T', bound=TRANSFORMER)
-_TRANSFORMER_CLS_T = TypeVar('_TRANSFORMER_CLS_T', bound=Type[TRANSFORMER])
-_TRANSFORMER_OR_CLS_T = TypeVar(
-    '_TRANSFORMER_OR_CLS_T', bound=Union[TRANSFORMER, Type[TRANSFORMER]]
-)
+_TRANSFORMER_CLS_T = TypeVar('_TRANSFORMER_CLS_T', bound=type[TRANSFORMER])
+_TRANSFORMER_OR_CLS_T = TypeVar('_TRANSFORMER_OR_CLS_T', bound=TRANSFORMER | type[TRANSFORMER])
 
 
 @overload
@@ -301,7 +288,7 @@ def transformer(cls_or_func: Any = None, *, add_deep_support: bool = False) -> A
 
     >>> @cirq.transformer
     ... def convert_to_cz(
-    ...    circuit: cirq.AbstractCircuit, *, context: 'Optional[cirq.TransformerContext]' = None
+    ...    circuit: cirq.AbstractCircuit, *, context: cirq.TransformerContext | None = None
     ... ) -> cirq.Circuit:
     ...    ...
 
@@ -315,7 +302,7 @@ def transformer(cls_or_func: Any = None, *, add_deep_support: bool = False) -> A
     ...        self,
     ...        circuit: cirq.AbstractCircuit,
     ...        *,
-    ...        context: 'Optional[cirq.TransformerContext]' = None,
+    ...        context: cirq.TransformerContext | None = None,
     ...    ) -> cirq.Circuit:
     ...        ...
 
@@ -326,7 +313,7 @@ def transformer(cls_or_func: Any = None, *, add_deep_support: bool = False) -> A
     ... def convert_to_sqrt_iswap(
     ...     circuit: cirq.AbstractCircuit,
     ...     *,
-    ...     context: 'Optional[cirq.TransformerContext]' = None,
+    ...     context: cirq.TransformerContext | None = None,
     ...     atol: float = 1e-8,
     ...     sqrt_iswap_gate: cirq.ISwapPowGate = cirq.SQRT_ISWAP_INV,
     ...     cleanup_operations: bool = True,
@@ -357,8 +344,8 @@ def transformer(cls_or_func: Any = None, *, add_deep_support: bool = False) -> A
 
         @functools.wraps(method)
         def method_with_logging(
-            self, circuit: 'cirq.AbstractCircuit', **kwargs
-        ) -> 'cirq.AbstractCircuit':
+            self, circuit: cirq.AbstractCircuit, **kwargs
+        ) -> cirq.AbstractCircuit:
             return _transform_and_log(
                 add_deep_support,
                 lambda circuit, **kwargs: method(self, circuit, **kwargs),
@@ -376,7 +363,7 @@ def transformer(cls_or_func: Any = None, *, add_deep_support: bool = False) -> A
         default_context = _get_default_context(func)
 
         @functools.wraps(func)
-        def func_with_logging(circuit: 'cirq.AbstractCircuit', **kwargs) -> 'cirq.AbstractCircuit':
+        def func_with_logging(circuit: cirq.AbstractCircuit, **kwargs) -> cirq.AbstractCircuit:
             return _transform_and_log(
                 add_deep_support,
                 func,
@@ -401,10 +388,10 @@ def _get_default_context(func: TRANSFORMER) -> TransformerContext:
 def _run_transformer_on_circuit(
     add_deep_support: bool,
     func: TRANSFORMER,
-    circuit: 'cirq.AbstractCircuit',
-    extracted_context: Optional[TransformerContext],
+    circuit: cirq.AbstractCircuit,
+    extracted_context: TransformerContext | None,
     **kwargs,
-) -> 'cirq.AbstractCircuit':
+) -> cirq.AbstractCircuit:
     mutable_circuit = None
     if extracted_context and extracted_context.deep and add_deep_support:
         batch_replace = []
@@ -429,10 +416,10 @@ def _transform_and_log(
     add_deep_support: bool,
     func: TRANSFORMER,
     transformer_name: str,
-    circuit: 'cirq.AbstractCircuit',
-    extracted_context: Optional[TransformerContext],
+    circuit: cirq.AbstractCircuit,
+    extracted_context: TransformerContext | None,
     **kwargs,
-) -> 'cirq.AbstractCircuit':
+) -> cirq.AbstractCircuit:
     """Helper to log initial and final circuits before and after calling the transformer."""
     if extracted_context:
         extracted_context.logger.register_initial(circuit, transformer_name)

cirq/transformers/transformer_api_test.py

@@ -12,7 +12,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from typing import Optional
+from __future__ import annotations
+
 from unittest import mock
 
 import pytest
@@ -27,7 +28,7 @@ class MockTransformerClass:
         self.mock = mock.Mock()
 
     def __call__(
-        self, circuit: cirq.AbstractCircuit, *, context: Optional[cirq.TransformerContext] = None
+        self, circuit: cirq.AbstractCircuit, *, context: cirq.TransformerContext | None = None
     ) -> cirq.Circuit:
         self.mock(circuit, context)
         return circuit.unfreeze()
@@ -51,7 +52,7 @@ class MockTransformerClassWithDefaults:
         self,
         circuit: cirq.AbstractCircuit,
         *,
-        context: Optional[cirq.TransformerContext] = cirq.TransformerContext(),
+        context: cirq.TransformerContext | None = cirq.TransformerContext(),
         atol: float = 1e-4,
         custom_arg: CustomArg = CustomArg(),
     ) -> cirq.AbstractCircuit:
@@ -71,7 +72,7 @@ def make_transformer_func_with_defaults() -> cirq.TRANSFORMER:
     def func(
         circuit: cirq.AbstractCircuit,
         *,
-        context: Optional[cirq.TransformerContext] = cirq.TransformerContext(),
+        context: cirq.TransformerContext | None = cirq.TransformerContext(),
         atol: float = 1e-4,
         custom_arg: CustomArg = CustomArg(),
     ) -> cirq.FrozenCircuit:
@@ -87,7 +88,7 @@ def make_transformer_func(add_deep_support: bool = False) -> cirq.TRANSFORMER:
 
     @cirq.transformer(add_deep_support=add_deep_support)
     def mock_tranformer_func(
-        circuit: cirq.AbstractCircuit, *, context: Optional[cirq.TransformerContext] = None
+        circuit: cirq.AbstractCircuit, *, context: cirq.TransformerContext | None = None
     ) -> cirq.Circuit:
         my_mock(circuit, context)
         return circuit.unfreeze()
@@ -177,7 +178,7 @@ def test_transformer_decorator_adds_support_for_deep(transformer, supports_deep)
 @cirq.transformer
 class T1:
     def __call__(
-        self, circuit: cirq.AbstractCircuit, context: Optional[cirq.TransformerContext] = None
+        self, circuit: cirq.AbstractCircuit, context: cirq.TransformerContext | None = None
     ) -> cirq.AbstractCircuit:
         assert context is not None
         context.logger.log("First Verbose Log", "of T1", level=LogLevel.DEBUG)
@@ -191,7 +192,7 @@ t1 = T1()
 
 @cirq.transformer
 def t2(
-    circuit: cirq.AbstractCircuit, context: Optional[cirq.TransformerContext] = None
+    circuit: cirq.AbstractCircuit, context: cirq.TransformerContext | None = None
 ) -> cirq.FrozenCircuit:
     assert context is not None
     context.logger.log("First INFO Log", "of T2 Start")
@@ -202,7 +203,7 @@ def t2(
 
 @cirq.transformer
 def t3(
-    circuit: cirq.AbstractCircuit, context: Optional[cirq.TransformerContext] = None
+    circuit: cirq.AbstractCircuit, context: cirq.TransformerContext | None = None
 ) -> cirq.Circuit:
     assert context is not None
     context.logger.log("First INFO Log", "of T3 Start")