Fix mypy type errors and remove typos

Author: tanujkhattar

Diff for: cirq-core/cirq/transformers/align.py

@@ -14,6 +14,7 @@
 
 """Transformer passes which align operations to the left or right of the circuit."""
 
+import dataclasses
 from typing import Optional, TYPE_CHECKING
 from cirq import circuits, ops
 from cirq.transformers import transformer_api
@@ -22,7 +23,7 @@
     import cirq
 
 
-@transformer_api.transformer
+@transformer_api.transformer(add_support_for_deep=True)
 def align_left(
     circuit: 'cirq.AbstractCircuit', *, context: Optional['cirq.TransformerContext'] = None
 ) -> 'cirq.Circuit':
@@ -54,7 +55,7 @@ def align_left(
     return ret
 
 
-@transformer_api.transformer
+@transformer_api.transformer(add_support_for_deep=True)
 def align_right(
     circuit: 'cirq.AbstractCircuit', *, context: Optional['cirq.TransformerContext'] = None
 ) -> 'cirq.Circuit':
@@ -70,4 +71,6 @@ def align_right(
     Returns:
           Copy of the transformed input circuit.
     """
+    if context is not None and context.deep is True:
+        context = dataclasses.replace(context, deep=False)
     return align_left(circuit[::-1], context=context)[::-1]

Diff for: cirq-core/cirq/transformers/align_test.py

@@ -71,6 +71,41 @@ def test_align_left_no_compile_context():
     )
 
 
+def test_align_left_deep():
+    q1, q2 = cirq.LineQubit.range(2)
+    c_nested = cirq.FrozenCircuit(
+        [
+            cirq.Moment([cirq.X(q1)]),
+            cirq.Moment([cirq.Y(q2)]),
+            cirq.Moment([cirq.Z(q1), cirq.Y(q2).with_tags("nocompile")]),
+            cirq.Moment([cirq.Y(q1)]),
+            cirq.measure(q2, key='a'),
+            cirq.Z(q1).with_classical_controls('a'),
+        ]
+    )
+    c_nested_aligned = cirq.FrozenCircuit(
+        cirq.Moment(cirq.X(q1), cirq.Y(q2)),
+        cirq.Moment(cirq.Z(q1)),
+        cirq.Moment([cirq.Y(q1), cirq.Y(q2).with_tags("nocompile")]),
+        cirq.measure(q2, key='a'),
+        cirq.Z(q1).with_classical_controls('a'),
+    )
+    c_orig = cirq.Circuit(
+        c_nested,
+        cirq.CircuitOperation(c_nested).repeat(6).with_tags("nocompile"),
+        c_nested,
+        cirq.CircuitOperation(c_nested).repeat(5).with_tags("preserve_tag"),
+    )
+    c_expected = cirq.Circuit(
+        c_nested_aligned,
+        cirq.CircuitOperation(c_nested).repeat(6).with_tags("nocompile"),
+        c_nested_aligned,
+        cirq.CircuitOperation(c_nested_aligned).repeat(5).with_tags("preserve_tag"),
+    )
+    context = cirq.TransformerContext(tags_to_ignore=["nocompile"], deep=True)
+    cirq.testing.assert_same_circuits(cirq.align_left(c_orig, context=context), c_expected)
+
+
 def test_align_left_subset_of_operations():
     q1 = cirq.NamedQubit('q1')
     q2 = cirq.NamedQubit('q2')
@@ -133,6 +168,39 @@ def test_align_right_no_compile_context():
     )
 
 
+def test_align_right_deep():
+    q1, q2 = cirq.LineQubit.range(2)
+    c_nested = cirq.FrozenCircuit(
+        cirq.Moment([cirq.X(q1)]),
+        cirq.Moment([cirq.Y(q1), cirq.X(q2).with_tags("nocompile")]),
+        cirq.Moment([cirq.X(q2)]),
+        cirq.Moment([cirq.Y(q1)]),
+        cirq.measure(q1, key='a'),
+        cirq.Z(q2).with_classical_controls('a'),
+    )
+    c_nested_aligned = cirq.FrozenCircuit(
+        cirq.Moment([cirq.X(q1), cirq.X(q2).with_tags("nocompile")]),
+        [cirq.Y(q1), cirq.Y(q1)],
+        cirq.Moment(cirq.measure(q1, key='a'), cirq.X(q2)),
+        cirq.Z(q2).with_classical_controls('a'),
+    )
+    c_orig = cirq.Circuit(
+        c_nested,
+        cirq.CircuitOperation(c_nested).repeat(6).with_tags("nocompile"),
+        c_nested,
+        cirq.CircuitOperation(c_nested).repeat(5).with_tags("preserve_tag"),
+    )
+    c_expected = cirq.Circuit(
+        c_nested_aligned,
+        cirq.CircuitOperation(c_nested).repeat(6).with_tags("nocompile"),
+        cirq.Moment(),
+        c_nested_aligned,
+        cirq.CircuitOperation(c_nested_aligned).repeat(5).with_tags("preserve_tag"),
+    )
+    context = cirq.TransformerContext(tags_to_ignore=["nocompile"], deep=True)
+    cirq.testing.assert_same_circuits(cirq.align_right(c_orig, context=context), c_expected)
+
+
 def test_classical_control():
     q0, q1 = cirq.LineQubit.range(2)
     circuit = cirq.Circuit(

Diff for: cirq-core/cirq/transformers/transformer_api.py

@@ -22,6 +22,7 @@
 from typing import (
     cast,
     Any,
+    Callable,
     Tuple,
     Hashable,
     List,
@@ -30,6 +31,7 @@
     Type,
     TYPE_CHECKING,
     TypeVar,
+    Union,
 )
 from typing_extensions import Protocol
 
@@ -235,6 +237,16 @@ def __call__(
 
 _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]]
+)
+
+
+@overload
+def transformer(
+    *, add_support_for_deep: bool = False
+) -> Callable[[_TRANSFORMER_OR_CLS_T], _TRANSFORMER_OR_CLS_T]:
+    pass
 
 
 @overload

Diff for: cirq-core/cirq/transformers/transformer_api_test.py

@@ -89,11 +89,9 @@ def make_transformer_func(add_support_for_deep: bool = False) -> cirq.TRANSFORME
     def mock_tranformer_func(
         circuit: cirq.AbstractCircuit, *, context: Optional[cirq.TransformerContext] = None
     ) -> cirq.Circuit:
-        print("CALLED:", circuit, context, sep="\n\n----------\n\n")
         my_mock(circuit, context)
         return circuit.unfreeze()
 
-    # mock_transformer = mock_tranformer_func(add_support_for_deep)
     mock_tranformer_func.mock = my_mock  # type: ignore
     return mock_tranformer_func
 
@@ -141,9 +139,6 @@ def test_transformer_decorator_with_defaults(transformer):
     transformer.mock.assert_called_with(circuit, context, 1e-2, CustomArg(12))
 
 
-# from unittest.mock import patch, call
-
-
 @pytest.mark.parametrize(
     'transformer, supports_deep',
     [
@@ -154,9 +149,9 @@ def test_transformer_decorator_with_defaults(transformer):
     ],
 )
 def test_transformer_decorator_adds_support_for_deep(transformer, supports_deep):
-    q1, q2 = cirq.LineQubit.range(2)
-    c_nested_x = cirq.FrozenCircuit(cirq.X(q1))
-    c_nested_y = cirq.FrozenCircuit(cirq.Y(q1))
+    q = cirq.NamedQubit("q")
+    c_nested_x = cirq.FrozenCircuit(cirq.X(q))
+    c_nested_y = cirq.FrozenCircuit(cirq.Y(q))
     c_nested_xy = cirq.FrozenCircuit(
         cirq.CircuitOperation(c_nested_x).repeat(5).with_tags("ignore"),
         cirq.CircuitOperation(c_nested_y).repeat(7).with_tags("preserve_tag"),