cirq-core 1.6.0.dev20250707230111__py3-none-any.whl → 1.6.0.dev20250708194540__py3-none-any.whl

cirq/_version.py

@@ -29,4 +29,4 @@ if sys.version_info < (3, 11 - 1, 0):  # pragma: no cover
         'of cirq (e.g. "python -m pip install cirq==1.5.0")'
     )
 
-__version__ = "1.6.0.dev20250707230111"
+__version__ = "1.6.0.dev20250708194540"

cirq/_version_test.py

@@ -3,4 +3,4 @@ import cirq
 
 
 def test_version() -> None:
-    assert cirq.__version__ == "1.6.0.dev20250707230111"
+    assert cirq.__version__ == "1.6.0.dev20250708194540"

cirq/circuits/moment.py

@@ -24,6 +24,7 @@ from typing import (
     Any,
     Callable,
     cast,
+    Hashable,
     Iterable,
     Iterator,
     Mapping,
@@ -77,7 +78,12 @@ class Moment:
             are no such operations, returns an empty Moment.
     """
 
-    def __init__(self, *contents: cirq.OP_TREE, _flatten_contents: bool = True) -> None:
+    def __init__(
+        self,
+        *contents: cirq.OP_TREE,
+        _flatten_contents: bool = True,
+        tags: tuple[Hashable, ...] = (),
+    ) -> None:
         """Constructs a moment with the given operations.
 
         Args:
@@ -88,6 +94,12 @@ class Moment:
                 we skip flattening and assume that contents already consists
                 of individual operations. This is used internally by helper
                 methods to avoid unnecessary validation.
+            tags:  Optional tags to denote specific Moment objects with meta-data.
+                These are a tuple of any Hashable object.  Typically, a class
+                will be passed.  Tags apply only to this specific set of operations
+                and will be lost on any transformation of the
+                Moment.  For instance, if operations are added to the Moment, tags
+                will be dropped unless explicitly added back in by the user.
 
         Raises:
             ValueError: A qubit appears more than once.
@@ -110,9 +122,10 @@ class Moment:
 
         self._measurement_key_objs: frozenset[cirq.MeasurementKey] | None = None
         self._control_keys: frozenset[cirq.MeasurementKey] | None = None
+        self._tags = tags
 
     @classmethod
-    def from_ops(cls, *ops: cirq.Operation) -> cirq.Moment:
+    def from_ops(cls, *ops: cirq.Operation, tags: tuple[Hashable, ...] = ()) -> cirq.Moment:
         """Construct a Moment from the given operations.
 
         This avoids calling `flatten_to_ops` in the moment constructor, which
@@ -122,8 +135,11 @@ class Moment:
 
         Args:
             *ops: Operations to include in the Moment.
+            tags:  Optional tags to denote specific Moment objects with meta-data.
+                These are a tuple of any Hashable object.  Tags will be dropped if
+                the operations in the Moment are modified or transformed.
         """
-        return cls(*ops, _flatten_contents=False)
+        return cls(*ops, _flatten_contents=False, tags=tags)
 
     @property
     def operations(self) -> tuple[cirq.Operation, ...]:
@@ -133,6 +149,34 @@ class Moment:
     def qubits(self) -> frozenset[cirq.Qid]:
         return frozenset(self._qubit_to_op)
 
+    @property
+    def tags(self) -> tuple[Hashable, ...]:
+        """Returns a tuple of the operation's tags."""
+        return self._tags
+
+    def with_tags(self, *new_tags: Hashable) -> cirq.Moment:
+        """Creates a new Moment with the current ops and the specified tags.
+
+        If the moment already has tags, this will add the new_tags to the
+        preexisting tags.
+
+        This method can be used to attach meta-data to moments
+        without affecting their functionality.  The intended usage is to
+        attach classes intended for this purpose or strings to mark operations
+        for specific usage that will be recognized by consumers.
+
+        Tags can be a list of any type of object that is useful to identify
+        this operation as long as the type is hashable.  If you wish the
+        resulting operation to be eventually serialized into JSON, you should
+        also restrict the operation to be JSON serializable.
+
+        Please note that tags should be instantiated if classes are
+        used.  Raw types are not allowed.
+        """
+        if not new_tags:
+            return self
+        return Moment(*self._operations, _flatten_contents=False, tags=(*self._tags, *new_tags))
+
     def operates_on_single_qubit(self, qubit: cirq.Qid) -> bool:
         """Determines if the moment has operations touching the given qubit.
         Args:
@@ -170,6 +214,8 @@ class Moment:
     def with_operation(self, operation: cirq.Operation) -> cirq.Moment:
         """Returns an equal moment, but with the given op added.
 
+        Any tags on the Moment will be dropped.
+
         Args:
             operation: The operation to append.
 
@@ -198,6 +244,9 @@ class Moment:
     def with_operations(self, *contents: cirq.OP_TREE) -> cirq.Moment:
         """Returns a new moment with the given contents added.
 
+        Any tags on the original Moment object are dropped if the Moment
+        is changed.
+
         Args:
             *contents: New operations to add to this moment.
 
@@ -235,6 +284,9 @@ class Moment:
     def without_operations_touching(self, qubits: Iterable[cirq.Qid]) -> cirq.Moment:
         """Returns an equal moment, but without ops on the given qubits.
 
+        Any tags on the original Moment object are dropped if the Moment
+        is changed.
+
         Args:
             qubits: Operations that touch these will be removed.
 
@@ -510,11 +562,13 @@ class Moment:
         return qis.kraus_to_superoperator(self._kraus_())
 
     def _json_dict_(self) -> dict[str, Any]:
-        return protocols.obj_to_dict_helper(self, ['operations'])
+        # For backwards compatibility, only output tags if they exist.
+        args = ['operations', 'tags'] if self._tags else ['operations']
+        return protocols.obj_to_dict_helper(self, args)
 
     @classmethod
-    def _from_json_dict_(cls, operations, **kwargs):
-        return cls.from_ops(*operations)
+    def _from_json_dict_(cls, operations, tags=(), **kwargs):
+        return cls(*operations, tags=tags)
 
     def __add__(self, other: cirq.OP_TREE) -> cirq.Moment:
         if isinstance(other, circuit.AbstractCircuit):

cirq/circuits/moment_test.py

@@ -939,3 +939,68 @@ def test_superoperator() -> None:
     assert m._has_superoperator_()
     s = m._superoperator_()
     assert np.allclose(s, np.array([[1, 0, 0, 1], [0, 0, 0, 0], [0, 0, 0, 0], [1, 0, 0, 1]]) / 2)
+
+
+def test_moment_with_tags() -> None:
+    q0 = cirq.LineQubit(0)
+    q1 = cirq.LineQubit(1)
+    op1 = cirq.X(q0)
+    op2 = cirq.Y(q1)
+
+    # Test initialization with no tags
+    moment_no_tags = cirq.Moment(op1)
+    assert moment_no_tags.tags == ()
+
+    # Test initialization with tags
+    moment_with_tags = cirq.Moment(op1, op2, tags=("initial_tag_1", "initial_tag_2"))
+    assert moment_with_tags.tags == ("initial_tag_1", "initial_tag_2")
+
+    # Test with_tags method to add new tags
+    new_moment = moment_with_tags.with_tags("new_tag_1", "new_tag_2")
+
+    # Ensure the original moment's tags are unchanged
+    assert moment_with_tags.tags == ("initial_tag_1", "initial_tag_2")
+
+    # Ensure the new moment has both old and new tags
+    assert new_moment.tags == ("initial_tag_1", "initial_tag_2", "new_tag_1", "new_tag_2")
+
+    # Test with_tags on a moment that initially had no tags
+    new_moment_from_no_tags = moment_no_tags.with_tags("single_new_tag")
+    assert new_moment_from_no_tags.tags == ("single_new_tag",)
+
+    # Test adding no new tags
+    same_moment_tags = moment_with_tags.with_tags()
+    assert same_moment_tags.tags == ("initial_tag_1", "initial_tag_2")
+
+    class CustomTag:
+        """Example Hashable Tag"""
+
+        def __init__(self, value):
+            self.value = value
+
+        def __hash__(self):
+            return hash(self.value)  # pragma: nocover
+
+        def __eq__(self, other):
+            return isinstance(other, CustomTag) and self.value == other.value  # pragma: nocover
+
+        def __repr__(self):
+            return f"CustomTag({self.value})"  # pragma: nocover
+
+    tag_obj = CustomTag("complex_tag")
+    moment_with_custom_tag = cirq.Moment(op1, tags=("string_tag", 123, tag_obj))
+    assert moment_with_custom_tag.tags == ("string_tag", 123, tag_obj)
+
+    new_moment_with_custom_tag = moment_with_custom_tag.with_tags(456)
+    assert new_moment_with_custom_tag.tags == ("string_tag", 123, tag_obj, 456)
+
+    # Test that tags are dropped if the Moment is changed.
+    moment = cirq.Moment.from_ops(op1, tags=(tag_obj,))
+    assert moment.tags == (tag_obj,)
+    assert moment.with_operation(op2).tags == ()
+    assert moment.with_operations(op2).tags == ()
+    assert moment.without_operations_touching([q0]).tags == ()
+
+    # Test that tags are retained if the Moment is unchanged.
+    assert moment.with_operations().tags == (tag_obj,)
+    assert moment.without_operations_touching([q1]).tags == (tag_obj,)

cirq/protocols/json_test_data/Moment.json

@@ -39,5 +39,28 @@
         }
       }
     ]
+  },
+  {
+	  "cirq_type": "Moment",
+	  "operations": [
+	      	  {
+		    	  "cirq_type": "SingleQubitPauliStringGateOperation",
+		    	  "pauli": {
+			  	  "cirq_type": "_PauliX",
+			  	  "exponent": 1.0,
+			  	  "global_shift": 0.0
+		    	  },
+		    	  "qubit": {
+			  	  "cirq_type": "LineQubit",
+			  	  "x": 0
+		    	  }
+	      	  }
+	  ],
+	  "tags": [
+	      {
+	      	  "cirq_type": "Duration",
+	      	  "picos": 25000
+	      }
+	  ]
   }
-]
+]

cirq/protocols/json_test_data/Moment.repr

@@ -2,4 +2,9 @@
     cirq.X(cirq.LineQubit(0)),
     cirq.Y(cirq.LineQubit(1)),
     cirq.Z(cirq.LineQubit(2)),
-)]
+),
+cirq.Moment(
+    cirq.X(cirq.LineQubit(0)),
+    tags=(cirq.Duration(nanos=25),)
+)
+]

{cirq_core-1.6.0.dev20250707230111.dist-info → cirq_core-1.6.0.dev20250708194540.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cirq-core
-Version: 1.6.0.dev20250707230111
+Version: 1.6.0.dev20250708194540
 Summary: A framework for creating, editing, and invoking Noisy Intermediate Scale Quantum (NISQ) circuits.
 Home-page: http://github.com/quantumlib/cirq
 Author: The Cirq Developers

{cirq_core-1.6.0.dev20250707230111.dist-info → cirq_core-1.6.0.dev20250708194540.dist-info}/RECORD

@@ -4,8 +4,8 @@ cirq/_compat_test.py,sha256=emXpdD5ZvwLRlFAoQB8YatmZyU3b4e9jg6FppMTUhkU,33900
 cirq/_doc.py,sha256=BrnoABo1hk5RgB3Cgww4zLHUfiyFny0F1V-tOMCbdaU,2909
 cirq/_import.py,sha256=ixBu4EyGl46Ram2cP3p5eZVEFDW5L2DS-VyTjz4N9iw,8429
 cirq/_import_test.py,sha256=oF4izzOVZLc7NZ0aZHFcGv-r01eiFFt_JORx_x7_D4s,1089
-cirq/_version.py,sha256=Tp7SXJVL5iN2CyCrx9PR2yLpzevsi0lafsxf75PcRz8,1278
-cirq/_version_test.py,sha256=cLFSN4t601BK8a9EBJ4LfGqkvHt4jLEzaI8W36H26dM,155
+cirq/_version.py,sha256=5oG9gU9cqqdiqs3o6hGtmfEJR4EziOoYF4cif-v8BhY,1278
+cirq/_version_test.py,sha256=zwK3BOP8XiYHsxdC8GpFR_cbti8p18KAdZJEX8uF1m8,155
 cirq/conftest.py,sha256=wSDKNdIQRDfLnXvOCWD3erheOw8JHRhdfQ53EyTUIXg,1239
 cirq/json_resolver_cache.py,sha256=hYyG53VJeV61X0oukK5ndZYega8lkL2FyaL1m0j6h5M,13556
 cirq/py.typed,sha256=VFSlmh_lNwnaXzwY-ZuW-C2Ws5PkuDoVgBdNCs0jXJE,63
@@ -24,8 +24,8 @@ cirq/circuits/frozen_circuit.py,sha256=CwlREZbCCrHJ6zTLLEbER_M7P4IsBEADhM5dbDBTv
 cirq/circuits/frozen_circuit_test.py,sha256=b-SQdV7KFLt3KCo50eBkGs8q29B2H5PmMevVGk8UCN4,4294
 cirq/circuits/insert_strategy.py,sha256=3995vK4U6O9RV4BXMoFl9Tf3ekxIiqxv71IuX80JtYo,3237
 cirq/circuits/insert_strategy_test.py,sha256=pBFgsylgRG1CS1h4JyzZQFP-xvh6fSbgpiZgxXfbpr4,1237
-cirq/circuits/moment.py,sha256=H6PRIo6HajNjeP-Wx5c2xiF31id56fr0FywelO3KZwY,25900
-cirq/circuits/moment_test.py,sha256=4zLOOyF-ckx_gKJMJI4ylugcqQDf7Sy2_FQgmdG-L5c,31770
+cirq/circuits/moment.py,sha256=MK8H9YUQ44ofLdM1E_zOrJ4Sh5Ayh4ezDtwZkx1O-1E,28363
+cirq/circuits/moment_test.py,sha256=-RXBe4ZkWTz1n4n5Hdna5HHslAfAn-gqdreMhuZP508,34233
 cirq/circuits/optimization_pass.py,sha256=W_YYo_9uy5h4ijU_In5n7gG3EvCVp1cJbE1pHD9ci74,6481
 cirq/circuits/optimization_pass_test.py,sha256=FvCCOZrqVQLYrf_BUAZ6M-sm6dMv00_xsvpN25Op1BA,5914
 cirq/circuits/qasm_output.py,sha256=qclnyiEnRzkcr0JqzzABuiHD3INkiALmhl1jCW0AYNk,13079
@@ -632,8 +632,8 @@ cirq/protocols/json_test_data/MeasurementType.json,sha256=OjFtbTIm-EweRuREf6jV_Y
 cirq/protocols/json_test_data/MeasurementType.repr,sha256=GKWPv9INNDbe8VHe-Ef3i1ykQ9aGIxaom-8Q3E4ptYc,64
 cirq/protocols/json_test_data/MixedUnitaryChannel.json,sha256=S44Yl3LDXyPuvCs_8oU0iA4hXvm4k11_FnQ-FwrE11A,2890
 cirq/protocols/json_test_data/MixedUnitaryChannel.repr,sha256=btyHCJZOc0KUvNHOCYqvsDkPi352tjy9O7Zf4XI5zL8,486
-cirq/protocols/json_test_data/Moment.json,sha256=iTcMbe_lKBpAKmcQT62y9CDwORvkoUgk_oob71CAKe0,897
-cirq/protocols/json_test_data/Moment.repr,sha256=6nuVloJ1MBxO-mWnLHymjO1Ylqsi39RrOpf_S95ccl0,109
+cirq/protocols/json_test_data/Moment.json,sha256=XkNGe04dogNVHWwAPUVFyGJZWHKmFggWoy2-gU6Hm9U,1336
+cirq/protocols/json_test_data/Moment.repr,sha256=zmD-5J0nOIrJzqDxxfKDnhc8RvVghIcJUk8pNTCyyOg,194
 cirq/protocols/json_test_data/MultiAsymmetricDepolarizingChannel.json,sha256=FQ68e4brRCsjN_5CL53DeF14QgCqO4V2mjV6HoGMX2c,115
 cirq/protocols/json_test_data/MultiAsymmetricDepolarizingChannel.repr,sha256=nqLmF-C4XmYAfQ6-uV70uPnHj4fWmiP1axVyWb6DrJA,68
 cirq/protocols/json_test_data/MultiDepolarizingChannel.json,sha256=Iyhfj1Te8kmiohUbYDliUgq8eSoYmAd2flDtq1UopBU,69
@@ -1220,8 +1220,8 @@ cirq/work/sampler.py,sha256=rxbMWvrhu3gfNSBjZKozw28lLKVvBAS_1EGyPdYe8Xg,19041
 cirq/work/sampler_test.py,sha256=SsMrRvLDYELyOAWLKISjkdEfrBwLYWRsT6D8WrsLM3Q,13533
 cirq/work/zeros_sampler.py,sha256=Fs2JWwq0n9zv7_G5Rm-9vPeHUag7uctcMOHg0JTkZpc,2371
 cirq/work/zeros_sampler_test.py,sha256=lQLgQDGBLtfImryys2HzQ2jOSGxHgc7-koVBUhv8qYk,3345
-cirq_core-1.6.0.dev20250707230111.dist-info/licenses/LICENSE,sha256=tAkwu8-AdEyGxGoSvJ2gVmQdcicWw3j1ZZueVV74M-E,11357
-cirq_core-1.6.0.dev20250707230111.dist-info/METADATA,sha256=xvHAc-XJ6ERKo6-ZrExeMpKFFYPFNiEg_stDcC2YkZc,4857
-cirq_core-1.6.0.dev20250707230111.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-cirq_core-1.6.0.dev20250707230111.dist-info/top_level.txt,sha256=Sz9iOxHU0IEMLSFGwiwOCaN2e9K-jFbBbtpPN1hB73g,5
-cirq_core-1.6.0.dev20250707230111.dist-info/RECORD,,
+cirq_core-1.6.0.dev20250708194540.dist-info/licenses/LICENSE,sha256=tAkwu8-AdEyGxGoSvJ2gVmQdcicWw3j1ZZueVV74M-E,11357
+cirq_core-1.6.0.dev20250708194540.dist-info/METADATA,sha256=nQaHL2Zt5HnbS80R-g9r6ZzzwW2OLtXlbaIdbhitiks,4857
+cirq_core-1.6.0.dev20250708194540.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+cirq_core-1.6.0.dev20250708194540.dist-info/top_level.txt,sha256=Sz9iOxHU0IEMLSFGwiwOCaN2e9K-jFbBbtpPN1hB73g,5
+cirq_core-1.6.0.dev20250708194540.dist-info/RECORD,,