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

cirq/protocols/json_serialization.py

@@ -11,6 +11,9 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
+
+from __future__ import annotations
+
 import dataclasses
 import datetime
 import gzip
@@ -18,21 +21,7 @@ import json
 import numbers
 import pathlib
 from types import NotImplementedType
-from typing import (
-    Any,
-    Callable,
-    cast,
-    Dict,
-    IO,
-    Iterable,
-    List,
-    Optional,
-    overload,
-    Sequence,
-    Tuple,
-    Type,
-    Union,
-)
+from typing import Any, Callable, cast, IO, Iterable, overload, Sequence
 
 import attrs
 import numpy as np
@@ -42,16 +31,16 @@ from typing_extensions import Protocol
 
 from cirq._doc import doc_private
 
-ObjectFactory = Union[Type, Callable[..., Any]]
+ObjectFactory = type | Callable[..., Any]
 
 
 class JsonResolver(Protocol):
     """Protocol for json resolver functions passed to read_json."""
 
-    def __call__(self, cirq_type: str) -> Optional[ObjectFactory]: ...
+    def __call__(self, cirq_type: str) -> ObjectFactory | None: ...
 
 
-def _lazy_resolver(dict_factory: Callable[[], Dict[str, ObjectFactory]]) -> JsonResolver:
+def _lazy_resolver(dict_factory: Callable[[], dict[str, ObjectFactory]]) -> JsonResolver:
     """A lazy JsonResolver based on a dict_factory.
 
     It only calls dict_factory when the first key is accessed.
@@ -61,13 +50,13 @@ def _lazy_resolver(dict_factory: Callable[[], Dict[str, ObjectFactory]]) -> Json
           class resolution map - it is assumed to be cached
     """
 
-    def json_resolver(cirq_type: str) -> Optional[ObjectFactory]:
+    def json_resolver(cirq_type: str) -> ObjectFactory | None:
         return dict_factory().get(cirq_type, None)
 
     return json_resolver
 
 
-DEFAULT_RESOLVERS: List[JsonResolver] = []
+DEFAULT_RESOLVERS: list[JsonResolver] = []
 """A default list of 'JsonResolver' functions for use in read_json.
 
 For more information about cirq_type resolution during deserialization
@@ -87,7 +76,7 @@ prepended to this list:
 """
 
 
-def _register_resolver(dict_factory: Callable[[], Dict[str, ObjectFactory]]) -> None:
+def _register_resolver(dict_factory: Callable[[], dict[str, ObjectFactory]]) -> None:
     """Register a resolver based on a dict factory for lazy initialization.
 
     Cirq modules are the ones referred in cirq/__init__.py. If a Cirq module
@@ -124,7 +113,7 @@ class SupportsJSON(Protocol):
     """
 
     @doc_private
-    def _json_dict_(self) -> Union[None, NotImplementedType, Dict[Any, Any]]:
+    def _json_dict_(self) -> None | NotImplementedType | dict[Any, Any]:
         pass
 
 
@@ -145,7 +134,7 @@ class HasJSONNamespace(Protocol):
         pass
 
 
-def obj_to_dict_helper(obj: Any, attribute_names: Iterable[str]) -> Dict[str, Any]:
+def obj_to_dict_helper(obj: Any, attribute_names: Iterable[str]) -> dict[str, Any]:
     """Construct a dictionary containing attributes from obj
 
     This is useful as a helper function in objects implementing the
@@ -166,8 +155,7 @@ def obj_to_dict_helper(obj: Any, attribute_names: Iterable[str]) -> Dict[str, An
     return d
 
 
-# pylint: enable=redefined-builtin
-def dataclass_json_dict(obj: Any) -> Dict[str, Any]:
+def dataclass_json_dict(obj: Any) -> dict[str, Any]:
     """Return a dictionary suitable for `_json_dict_` from a dataclass.
 
     Dataclasses keep track of their relevant fields, so we can automatically generate these.
@@ -183,7 +171,7 @@ def dataclass_json_dict(obj: Any) -> Dict[str, Any]:
     return obj_to_dict_helper(obj, attribute_names)
 
 
-def attrs_json_dict(obj: Any) -> Dict[str, Any]:
+def attrs_json_dict(obj: Any) -> dict[str, Any]:
     """Return a dictionary suitable for `_json_dict_` from an attrs dataclass."""
     attribute_names = [f.name for f in attrs.fields(type(obj))]
     return obj_to_dict_helper(obj, attribute_names)
@@ -336,8 +324,8 @@ class ObjectHook:
 
     def __init__(self, resolvers: Sequence[JsonResolver]) -> None:
         self.resolvers = resolvers
-        self.memo: Dict[int, SerializableByKey] = {}
-        self.context_map: Dict[int, SerializableByKey] = {}
+        self.memo: dict[int, SerializableByKey] = {}
+        self.context_map: dict[int, SerializableByKey] = {}
 
     def __call__(self, d):
         cirq_type = d.get('cirq_type')
@@ -380,7 +368,7 @@ class SerializableByKey(SupportsJSON):
     """
 
 
-def json_namespace(type_obj: Type) -> str:
+def json_namespace(type_obj: type) -> str:
     """Returns a namespace for JSON serialization of `type_obj`.
 
     Types can provide custom namespaces with `_json_namespace_`; otherwise, a
@@ -404,7 +392,7 @@ def json_namespace(type_obj: Type) -> str:
     raise ValueError(f'{type_obj} is not a Cirq type, and does not define _json_namespace_.')
 
 
-def json_cirq_type(type_obj: Type) -> str:
+def json_cirq_type(type_obj: type) -> str:
     """Returns a string type for JSON serialization of `type_obj`.
 
     This method is not part of the base serialization path. Together with
@@ -418,7 +406,7 @@ def json_cirq_type(type_obj: Type) -> str:
 
 
 def factory_from_json(
-    type_str: str, resolvers: Optional[Sequence[JsonResolver]] = None
+    type_str: str, resolvers: Sequence[JsonResolver] | None = None
 ) -> ObjectFactory:
     """Returns a factory for constructing objects of type `type_str`.
 
@@ -444,7 +432,7 @@ def factory_from_json(
     raise ValueError(f"Could not resolve type '{type_str}' during deserialization")
 
 
-def cirq_type_from_json(type_str: str, resolvers: Optional[Sequence[JsonResolver]] = None) -> Type:
+def cirq_type_from_json(type_str: str, resolvers: Sequence[JsonResolver] | None = None) -> type:
     """Returns a type object for JSON deserialization of `type_str`.
 
     This method is not part of the base deserialization path. Together with
@@ -471,15 +459,9 @@ def cirq_type_from_json(type_str: str, resolvers: Optional[Sequence[JsonResolver
     raise ValueError(f"Type {type_str} maps to a factory method instead of a type.")
 
 
-# pylint: disable=function-redefined
 @overload
 def to_json(
-    obj: Any,
-    file_or_fn: Union[IO, pathlib.Path, str],
-    *,
-    indent=2,
-    separators=None,
-    cls=CirqEncoder,
+    obj: Any, file_or_fn: IO | pathlib.Path | str, *, indent=2, separators=None, cls=CirqEncoder
 ) -> None:
     pass
 
@@ -493,12 +475,12 @@ def to_json(
 
 def to_json(
     obj: Any,
-    file_or_fn: Union[None, IO, pathlib.Path, str] = None,
+    file_or_fn: None | IO | pathlib.Path | str = None,
     *,
-    indent: Optional[int] = 2,
-    separators: Optional[Tuple[str, str]] = None,
-    cls: Type[json.JSONEncoder] = CirqEncoder,
-) -> Optional[str]:
+    indent: int | None = 2,
+    separators: tuple[str, str] | None = None,
+    cls: type[json.JSONEncoder] = CirqEncoder,
+) -> str | None:
     """Write a JSON file containing a representation of obj.
 
     The object may be a cirq object or have data members that are cirq
@@ -533,12 +515,11 @@ def to_json(
     return None
 
 
-# pylint: enable=function-redefined
 def read_json(
-    file_or_fn: Union[None, IO, pathlib.Path, str] = None,
+    file_or_fn: None | IO | pathlib.Path | str = None,
     *,
-    json_text: Optional[str] = None,
-    resolvers: Optional[Sequence[JsonResolver]] = None,
+    json_text: str | None = None,
+    resolvers: Sequence[JsonResolver] | None = None,
 ):
     """Read a JSON file that optionally contains cirq objects.
 
@@ -582,11 +563,11 @@ def read_json(
 
 def to_json_gzip(
     obj: Any,
-    file_or_fn: Union[None, IO, pathlib.Path, str] = None,
+    file_or_fn: None | IO | pathlib.Path | str = None,
     *,
     indent: int = 2,
-    cls: Type[json.JSONEncoder] = CirqEncoder,
-) -> Optional[bytes]:
+    cls: type[json.JSONEncoder] = CirqEncoder,
+) -> bytes | None:
     """Write a gzipped JSON file containing a representation of obj.
 
     The object may be a cirq object or have data members that are cirq
@@ -621,10 +602,10 @@ def to_json_gzip(
 
 
 def read_json_gzip(
-    file_or_fn: Union[None, IO, pathlib.Path, str] = None,
+    file_or_fn: None | IO | pathlib.Path | str = None,
     *,
-    gzip_raw: Optional[bytes] = None,
-    resolvers: Optional[Sequence[JsonResolver]] = None,
+    gzip_raw: bytes | None = None,
+    resolvers: Sequence[JsonResolver] | None = None,
 ):
     """Read a gzipped JSON file that optionally contains cirq objects.
 

cirq/protocols/json_serialization_test.py

@@ -12,6 +12,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+from __future__ import annotations
+
 import contextlib
 import dataclasses
 import datetime
@@ -21,7 +23,6 @@ import json
 import os
 import pathlib
 import warnings
-from typing import Dict, List, Optional, Tuple, Type
 from unittest import mock
 
 import attrs
@@ -46,25 +47,18 @@ class _ModuleDeprecation:
 
 
 # tested modules and their deprecation settings
-TESTED_MODULES: Dict[str, Optional[_ModuleDeprecation]] = {
+TESTED_MODULES: dict[str, _ModuleDeprecation | None] = {
     'cirq_aqt': None,
     'cirq_ionq': None,
     'cirq_google': None,
     'cirq_pasqal': None,
-    'cirq_rigetti': None,
+    f'cirq{"."}contrib': None,
     'cirq.protocols': None,
     'non_existent_should_be_fine': None,
 }
 
-# TODO(#6706) remove after cirq_rigetti supports NumPy 2.0
-if np.__version__.startswith("2."):  # pragma: no cover
-    warnings.warn(
-        "json_serialization_test - ignoring cirq_rigetti due to incompatibility with NumPy 2.0"
-    )
-    del TESTED_MODULES["cirq_rigetti"]
-
 
-def _get_testspecs_for_modules() -> List[ModuleJsonTestSpec]:
+def _get_testspecs_for_modules() -> list[ModuleJsonTestSpec]:
     modules = []
     for m in TESTED_MODULES.keys():
         try:
@@ -357,9 +351,9 @@ class SBKImpl(cirq.SerializableByKey):
     def __init__(
         self,
         name: str,
-        data_list: Optional[List] = None,
-        data_tuple: Optional[Tuple] = None,
-        data_dict: Optional[Dict] = None,
+        data_list: list | None = None,
+        data_tuple: tuple | None = None,
+        data_dict: dict | None = None,
     ):
         self.name = name
         self.data_list = data_list or []
@@ -524,7 +518,7 @@ def test_json_test_data_coverage(mod_spec: ModuleJsonTestSpec, cirq_obj_name: st
 
 @dataclasses.dataclass
 class SerializableTypeObject:
-    test_type: Type
+    test_type: type
 
     def _json_dict_(self):
         return {'test_type': json_serialization.json_cirq_type(self.test_type)}
@@ -556,9 +550,7 @@ def test_type_serialization(mod_spec: ModuleJsonTestSpec, cirq_obj_name: str, cl
 
     sto = SerializableTypeObject(cls)
     test_resolvers = [custom_resolver] + cirq.DEFAULT_RESOLVERS
-    expected_json = (
-        f'{{\n  "cirq_type": "SerializableTypeObject",\n' f'  "test_type": "{typename}"\n}}'
-    )
+    expected_json = f'{{\n  "cirq_type": "SerializableTypeObject",\n  "test_type": "{typename}"\n}}'
     assert cirq.to_json(sto) == expected_json
     assert cirq.read_json(json_text=expected_json, resolvers=test_resolvers) == sto
     assert_json_roundtrip_works(sto, resolvers=test_resolvers)
@@ -605,9 +597,9 @@ def test_to_from_json_gzip():
         _ = cirq.read_json_gzip()
 
 
-def _eval_repr_data_file(path: pathlib.Path, deprecation_deadline: Optional[str]):
+def _eval_repr_data_file(path: pathlib.Path, deprecation_deadline: str | None):
     content = path.read_text()
-    ctx_managers: List[contextlib.AbstractContextManager] = [contextlib.suppress()]
+    ctx_managers: list[contextlib.AbstractContextManager] = [contextlib.suppress()]
     if deprecation_deadline:  # pragma: no cover
         # we ignore coverage here, because sometimes there are no deprecations at all in any of the
         # modules
@@ -617,6 +609,7 @@ def _eval_repr_data_file(path: pathlib.Path, deprecation_deadline: Optional[str]
         if deprecation is not None and deprecation.old_name in content:
             ctx_managers.append(deprecation.deprecation_assertion)  # pragma: no cover
 
+    # TODO: consider to add the support for 'tunits'.
     imports = {'cirq': cirq, 'pd': pd, 'sympy': sympy, 'np': np, 'datetime': datetime, 'nx': nx}
 
     for m in TESTED_MODULES.keys():
@@ -637,7 +630,7 @@ def assert_repr_and_json_test_data_agree(
     repr_path: pathlib.Path,
     json_path: pathlib.Path,
     inward_only: bool,
-    deprecation_deadline: Optional[str],
+    deprecation_deadline: str | None,
 ):
     if not repr_path.exists() and not json_path.exists():
         return

cirq/protocols/json_test_data/CXSWAP.json

@@ -0,0 +1,46 @@
+{
+  "cirq_type": "CliffordGate",
+  "n": 2,
+  "rs": [
+    false,
+    false,
+    false,
+    false
+  ],
+  "xs": [
+    [
+      true,
+      true
+    ],
+    [
+      true,
+      false
+    ],
+    [
+      false,
+      false
+    ],
+    [
+      false,
+      false
+    ]
+  ],
+  "zs": [
+    [
+      false,
+      false
+    ],
+    [
+      false,
+      false
+    ],
+    [
+      false,
+      true
+    ],
+    [
+      true,
+      true
+    ]
+  ]
+}

cirq/protocols/json_test_data/CXSWAP.repr

@@ -0,0 +1,13 @@
+cirq.CliffordGate(_clifford_tableau=
+    cirq.CliffordTableau(
+        2,
+        rs=np.array([False, False, False, False], dtype=np.dtype('bool')),
+        xs=np.array(
+            [[True, True], [True, False], [False, False], [False, False]], dtype=np.dtype('bool')
+        ),
+        zs=np.array(
+            [[False, False], [False, False], [False, True], [True, True]], dtype=np.dtype('bool')
+        ),
+        initial_state=0,
+    )
+)

cirq/protocols/json_test_data/CZSWAP.json

@@ -0,0 +1,46 @@
+{
+  "cirq_type": "CliffordGate",
+  "n": 2,
+  "rs": [
+    false,
+    false,
+    false,
+    false
+  ],
+  "xs": [
+    [
+      false,
+      true
+    ],
+    [
+      true,
+      false
+    ],
+    [
+      false,
+      false
+    ],
+    [
+      false,
+      false
+    ]
+  ],
+  "zs": [
+    [
+      true,
+      false
+    ],
+    [
+      false,
+      true
+    ],
+    [
+      false,
+      true
+    ],
+    [
+      true,
+      false
+    ]
+  ]
+}

cirq/protocols/json_test_data/CZSWAP.repr

@@ -0,0 +1,13 @@
+cirq.CliffordGate(_clifford_tableau=
+    cirq.CliffordTableau(
+        2,
+        rs=np.array([False, False, False, False], dtype=np.dtype('bool')),
+        xs=np.array(
+            [[False, True], [True, False], [False, False], [False, False]], dtype=np.dtype('bool')
+        ),
+        zs=np.array(
+            [[True, False], [False, True], [False, True], [True, False]], dtype=np.dtype('bool')
+        ),
+        initial_state=0,
+    )
+)

cirq/protocols/json_test_data/CircuitOperation.json

@@ -133,7 +133,8 @@
     "parent_path": [],
     "repetition_ids": [
       "0"
-    ]
+    ],
+    "use_repetition_ids": true
   },
   {
     "cirq_type": "CircuitOperation",
@@ -187,7 +188,8 @@
     "repetition_ids": [
       "a",
       "b"
-    ]
+    ],
+    "use_repetition_ids": true
   },
   {
     "cirq_type": "CircuitOperation",
@@ -217,7 +219,8 @@
     "repetition_ids": [
       "a",
       "b"
-    ]
+    ],
+    "use_repetition_ids": true
   },
   {
     "cirq_type": "CircuitOperation",

cirq/protocols/json_test_data/CircuitOperation.repr_inward

@@ -25,10 +25,12 @@ cirq.CircuitOperation(circuit=cirq.FrozenCircuit([
         (cirq.X**sympy.Symbol('theta')).on(cirq.LineQubit(0)),
     ),
 ]),
-param_resolver={sympy.Symbol('theta'): 1.5}),
+param_resolver={sympy.Symbol('theta'): 1.5},
+use_repetition_ids=True),
 cirq.CircuitOperation(circuit=cirq.FrozenCircuit([
     cirq.Moment(
         (cirq.X**sympy.Symbol('theta')).on(cirq.LineQubit(0)),
     ),
 ]),
-param_resolver={sympy.Symbol('theta'): 1.5})]
+param_resolver={sympy.Symbol('theta'): 1.5},
+use_repetition_ids=True)]

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/protocols/json_test_data/ThermalNoiseModel.json

@@ -0,0 +1,32 @@
+{
+  "cirq_type": "ThermalNoiseModel",
+  "qubits": [
+    {
+      "cirq_type": "LineQubit",
+      "x": 0
+    },
+    {
+      "cirq_type": "LineQubit",
+      "x": 1
+    }
+  ],
+  "gate_durations_ns": {
+    "ZPowGate": 5.0,
+    "CZPowGate": 12.0
+  },
+  "heat_rate_GHz": [
+    1e-05,
+    1e-05
+  ],
+  "cool_rate_GHz": [
+    0.0001,
+    0.00015
+  ],
+  "dephase_rate_GHz": [
+    0.0002,
+    0.0002
+  ],
+  "require_physical_tag": false,
+  "skip_measurements": false,
+  "prepend": false
+}

cirq/protocols/json_test_data/ThermalNoiseModel.repr

@@ -0,0 +1 @@
+cirq.devices.ThermalNoiseModel(qubits={cirq.LineQubit(0), cirq.LineQubit(1)}, gate_durations_ns={cirq.ops.common_gates.ZPowGate: 5.0,cirq.ops.common_gates.CZPowGate: 12.0}, heat_rate_GHz=1e-05, cool_rate_GHz={cirq.LineQubit(0): 0.0001,cirq.LineQubit(1): 0.00015}, dephase_rate_GHz=0.0002, require_physical_tag=False, skip_measurements=False, prepend=False)

cirq/protocols/json_test_data/spec.py

@@ -12,6 +12,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+from __future__ import annotations
+
 import pathlib
 
 import cirq
@@ -164,15 +166,17 @@ TestSpec = ModuleJsonTestSpec(
         'ParamMappingType',
         # utility:
         'CliffordSimulator',
-        'NoiseModelFromNoiseProperties',
         'Simulator',
         'StabilizerSampler',
         'DEFAULT_RESOLVERS',
     ],
     deprecated={},
     tested_elsewhere=[
+        # Tested in cirq.devices.noise_properties_test module, because
+        # serde test uses a non-public SampleNoiseProperties class.
+        'NoiseModelFromNoiseProperties',
         # SerializableByKey does not follow common serialization rules.
         # It is tested separately in test_context_serialization.
-        'SerializableByKey'
+        'SerializableByKey',
     ],
 )