Deprecate Gateset.accept_global_phase_op

cirq-core/cirq/ops/gateset.py

@@ -16,7 +16,7 @@
 
 from typing import Any, Callable, cast, Dict, FrozenSet, List, Optional, Type, TYPE_CHECKING, Union
 from cirq.ops import global_phase_op, op_tree, raw_types
-from cirq import protocols, value
+from cirq import _compat, protocols, value
 
 if TYPE_CHECKING:
     import cirq
@@ -201,6 +201,12 @@ class Gateset:
     validation purposes.
     """
 
+    @_compat.deprecated_parameter(
+        deadline='v0.16',
+        fix='Add a global phase gate to the Gateset',
+        parameter_desc='ignore_global_phase',
+        match=lambda args, kwargs: 'accept_global_phase_op' in kwargs,
+    )
     def __init__(
         self,
         *gates: Union[Type[raw_types.Gate], raw_types.Gate, GateFamily],
@@ -225,7 +231,7 @@ def __init__(
             name: (Optional) Name for the Gateset. Useful for description.
             unroll_circuit_op: If True, `cirq.CircuitOperation` is recursively
                 validated by validating the underlying `cirq.Circuit`.
-            accept_global_phase_op: If True, `cirq.GlobalPhaseOperation` is accepted.
+            accept_global_phase_op: If True, `cirq.GlobalPhaseGate` is accepted.
         """
         self._name = name
         self._unroll_circuit_op = unroll_circuit_op
@@ -253,6 +259,12 @@ def name(self) -> Optional[str]:
     def gates(self) -> FrozenSet[GateFamily]:
         return self._gates
 
+    @_compat.deprecated_parameter(
+        deadline='v0.16',
+        fix='Add a global phase gate to the Gateset',
+        parameter_desc='ignore_global_phase',
+        match=lambda args, kwargs: 'accept_global_phase_op' in kwargs,
+    )
     def with_params(
         self,
         *,
@@ -287,11 +299,18 @@ def val_if_none(var: Any, val: Any) -> Any:
             and accept_global_phase_op == self._accept_global_phase_op
         ):
             return self
+        accept_global_phase = cast(bool, accept_global_phase_op)
+        if not accept_global_phase:
+            return Gateset(
+                *self.gates,
+                name=name,
+                unroll_circuit_op=cast(bool, unroll_circuit_op),
+                accept_global_phase_op=False,
+            )
         return Gateset(
             *self.gates,
             name=name,
             unroll_circuit_op=cast(bool, unroll_circuit_op),
-            accept_global_phase_op=cast(bool, accept_global_phase_op),
         )
 
     def __contains__(self, item: Union[raw_types.Gate, raw_types.Operation]) -> bool:

cirq-core/cirq/ops/gateset_test.py

@@ -204,7 +204,8 @@ def test_gateset_init():
 
 
 def test_gateset_repr_and_str():
-    cirq.testing.assert_equivalent_repr(gateset)
+    with cirq.testing.assert_deprecated('global phase', deadline='v0.16', count=3):
+        cirq.testing.assert_equivalent_repr(gateset)
     assert gateset.name in str(gateset)
     for gate_family in gateset.gates:
         assert str(gate_family) in str(gateset)
@@ -263,23 +264,27 @@ def assert_validate_and_contains_consistent(gateset, op_tree, result):
             assert gateset.validate(item) is result
 
     op_tree = [*get_ops(use_circuit_op, use_global_phase)]
-    assert_validate_and_contains_consistent(
-        gateset.with_params(
-            unroll_circuit_op=use_circuit_op,
-            accept_global_phase_op=use_global_phase,
-        ),
-        op_tree,
-        True,
-    )
-    if use_circuit_op or use_global_phase:
+    with cirq.testing.assert_deprecated(
+        'global phase', deadline='v0.16', count=1 if use_global_phase else 2
+    ):
         assert_validate_and_contains_consistent(
             gateset.with_params(
-                unroll_circuit_op=False,
-                accept_global_phase_op=False,
+                unroll_circuit_op=use_circuit_op,
+                accept_global_phase_op=use_global_phase,
             ),
             op_tree,
-            False,
+            True,
         )
+    if use_circuit_op or use_global_phase:
+        with cirq.testing.assert_deprecated('global phase', deadline='v0.16', count=2):
+            assert_validate_and_contains_consistent(
+                gateset.with_params(
+                    unroll_circuit_op=False,
+                    accept_global_phase_op=False,
+                ),
+                op_tree,
+                False,
+            )
 
 
 def test_gateset_validate_circuit_op_negative_reps():
@@ -291,17 +296,19 @@ def test_gateset_validate_circuit_op_negative_reps():
 
 def test_with_params():
     assert gateset.with_params() is gateset
-    assert (
-        gateset.with_params(
-            name=gateset.name,
-            unroll_circuit_op=gateset._unroll_circuit_op,
-            accept_global_phase_op=gateset._accept_global_phase_op,
+    with cirq.testing.assert_deprecated('global phase', deadline='v0.16', count=1):
+        assert (
+            gateset.with_params(
+                name=gateset.name,
+                unroll_circuit_op=gateset._unroll_circuit_op,
+                accept_global_phase_op=gateset._accept_global_phase_op,
+            )
+            is gateset
+        )
+    with cirq.testing.assert_deprecated('global phase', deadline='v0.16', count=2):
+        gateset_with_params = gateset.with_params(
+            name='new name', unroll_circuit_op=False, accept_global_phase_op=False
         )
-        is gateset
-    )
-    gateset_with_params = gateset.with_params(
-        name='new name', unroll_circuit_op=False, accept_global_phase_op=False
-    )
     assert gateset_with_params.name == 'new name'
     assert gateset_with_params._unroll_circuit_op is False
     assert gateset_with_params._accept_global_phase_op is False
@@ -313,9 +320,10 @@ def test_gateset_eq():
     eq.add_equality_group(cirq.Gateset(CustomX**3))
     eq.add_equality_group(cirq.Gateset(CustomX, name='Custom Gateset'))
     eq.add_equality_group(cirq.Gateset(CustomX, name='Custom Gateset', unroll_circuit_op=False))
-    eq.add_equality_group(
-        cirq.Gateset(CustomX, name='Custom Gateset', accept_global_phase_op=False)
-    )
+    with cirq.testing.assert_deprecated('global phase', deadline='v0.16', count=1):
+        eq.add_equality_group(
+            cirq.Gateset(CustomX, name='Custom Gateset', accept_global_phase_op=False)
+        )
     eq.add_equality_group(
         cirq.Gateset(
             cirq.GateFamily(CustomX, name='custom_name', description='custom_description'),