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

cirq/vis/histogram.py

@@ -11,25 +11,28 @@
 # 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 typing import Any, Mapping, Optional, Sequence, SupportsFloat, Union
+
+from __future__ import annotations
+
+from typing import Any, Mapping, Sequence, SupportsFloat
 
 import numpy as np
 from matplotlib import pyplot as plt
 
 
 def integrated_histogram(
-    data: Union[Sequence[SupportsFloat], Mapping[Any, SupportsFloat]],
-    ax: Optional[plt.Axes] = None,
+    data: Sequence[SupportsFloat] | Mapping[Any, SupportsFloat],
+    ax: plt.Axes | None = None,
     *,
     cdf_on_x: bool = False,
     axis_label: str = '',
     semilog: bool = True,
     median_line: bool = True,
-    median_label: Optional[str] = 'median',
+    median_label: str | None = 'median',
     mean_line: bool = False,
-    mean_label: Optional[str] = 'mean',
+    mean_label: str | None = 'mean',
     show_zero: bool = False,
-    title: Optional[str] = None,
+    title: str | None = None,
     **kwargs,
 ) -> plt.Axes:
     """Plot the integrated histogram for an array of data.

cirq/vis/histogram_test.py

@@ -11,8 +11,11 @@
 # 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.
+
 """Tests for Histogram."""
 
+from __future__ import annotations
+
 import matplotlib.pyplot as plt
 import numpy as np
 import pytest
@@ -22,7 +25,7 @@ from cirq.vis import integrated_histogram
 
 @pytest.mark.usefixtures('closefigures')
 @pytest.mark.parametrize('data', [range(10), {f'key_{i}': i for i in range(10)}])
-def test_integrated_histogram(data):
+def test_integrated_histogram(data) -> None:
     ax = integrated_histogram(
         data,
         title='Test Plot',
@@ -40,7 +43,7 @@ def test_integrated_histogram(data):
 
 
 @pytest.mark.usefixtures('closefigures')
-def test_multiple_plots():
+def test_multiple_plots() -> None:
     _, ax = plt.subplots(1, 1)
     n = 53
     data = np.random.random_sample((2, n))

cirq/vis/state_histogram.py

@@ -14,8 +14,10 @@
 
 """Tool to visualize the results of a study."""
 
+from __future__ import annotations
+
 import collections
-from typing import Optional, Sequence, SupportsFloat, Union
+from typing import Sequence, SupportsFloat
 
 import matplotlib.pyplot as plt
 import numpy as np
@@ -23,7 +25,7 @@ import numpy as np
 import cirq.study.result as result
 
 
-def get_state_histogram(result: 'result.Result') -> np.ndarray:
+def get_state_histogram(result: result.Result) -> np.ndarray:
     """Computes a state histogram from a single result with repetitions.
 
     Args:
@@ -52,13 +54,13 @@ def get_state_histogram(result: 'result.Result') -> np.ndarray:
 
 
 def plot_state_histogram(
-    data: Union['result.Result', collections.Counter, Sequence[SupportsFloat]],
-    ax: Optional[plt.Axes] = None,
+    data: result.Result | collections.Counter | Sequence[SupportsFloat],
+    ax: plt.Axes | None = None,
     *,
-    tick_label: Optional[Sequence[str]] = None,
-    xlabel: Optional[str] = 'qubit state',
-    ylabel: Optional[str] = 'result count',
-    title: Optional[str] = 'Result State Histogram',
+    tick_label: Sequence[str] | None = None,
+    xlabel: str | None = 'qubit state',
+    ylabel: str | None = 'result count',
+    title: str | None = 'Result State Histogram',
 ) -> plt.Axes:
     """Plot the state histogram from either a single result with repetitions or
        a histogram computed using `result.histogram()` or a flattened histogram

cirq/vis/state_histogram_test.py

@@ -14,6 +14,8 @@
 
 """Tests for state_histogram."""
 
+from __future__ import annotations
+
 import matplotlib as mpl
 import numpy as np
 import pytest
@@ -24,7 +26,7 @@ from cirq.devices import GridQubit
 from cirq.vis import state_histogram
 
 
-def test_get_state_histogram():
+def test_get_state_histogram() -> None:
     simulator = cirq.Simulator()
 
     q0 = GridQubit(0, 0)
@@ -40,7 +42,7 @@ def test_get_state_histogram():
     np.testing.assert_equal(values_to_plot, expected_values)
 
 
-def test_get_state_histogram_multi_1():
+def test_get_state_histogram_multi_1() -> None:
     qubits = cirq.LineQubit.range(4)
     c = cirq.Circuit(
         cirq.X.on_each(*qubits[1:]), cirq.measure(*qubits)  # One multi-qubit measurement
@@ -51,7 +53,7 @@ def test_get_state_histogram_multi_1():
     np.testing.assert_equal(values_to_plot, expected_values)
 
 
-def test_get_state_histogram_multi_2():
+def test_get_state_histogram_multi_2() -> None:
     qubits = cirq.LineQubit.range(4)
     c = cirq.Circuit(
         cirq.X.on_each(*qubits[1:]),
@@ -65,7 +67,7 @@ def test_get_state_histogram_multi_2():
 
 
 @pytest.mark.usefixtures('closefigures')
-def test_plot_state_histogram_result():
+def test_plot_state_histogram_result() -> None:
     qubits = cirq.LineQubit.range(4)
     c = cirq.Circuit(
         cirq.X.on_each(*qubits[1:]), cirq.measure(*qubits)  # One multi-qubit measurement
@@ -83,7 +85,7 @@ def test_plot_state_histogram_result():
 
 
 @pytest.mark.usefixtures('closefigures')
-def test_plot_state_histogram_collection():
+def test_plot_state_histogram_collection() -> None:
     qubits = cirq.LineQubit.range(4)
     c = cirq.Circuit(
         cirq.X.on_each(*qubits[1:]), cirq.measure(*qubits)  # One multi-qubit measurement

cirq/vis/vis_utils.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
+
 from typing import TYPE_CHECKING
 
 import numpy as np
@@ -19,7 +22,7 @@ if TYPE_CHECKING:
     from numpy.typing import ArrayLike
 
 
-def relative_luminance(color: 'ArrayLike') -> float:
+def relative_luminance(color: ArrayLike) -> float:
     """Returns the relative luminance according to W3C specification.
 
     Spec: https://www.w3.org/TR/WCAG21/#dfn-relative-luminance.

cirq/vis/vis_utils_test.py

@@ -11,12 +11,15 @@
 # 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 numpy as np
 
 import cirq
 
 
-def test_relative_luminance():
+def test_relative_luminance() -> None:
     rl = cirq.vis.relative_luminance([100, 100, 100])
     assert np.isclose(rl, 55560.6360)
     rl = cirq.vis.relative_luminance([0, 1, 2])

cirq/work/collector.py

@@ -12,8 +12,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+from __future__ import annotations
+
 import abc
-from typing import Any, Iterator, List, Optional, Tuple, TYPE_CHECKING, Union
+from typing import Any, Iterator, TYPE_CHECKING
 
 import duet
 import numpy as np
@@ -29,7 +31,7 @@ if TYPE_CHECKING:
 class CircuitSampleJob:
     """Describes a sampling task."""
 
-    def __init__(self, circuit: 'cirq.AbstractCircuit', *, repetitions: int, tag: Any = None):
+    def __init__(self, circuit: cirq.AbstractCircuit, *, repetitions: int, tag: Any = None):
         """Inits CircuitSampleJob.
 
         Args:
@@ -57,11 +59,11 @@ class CircuitSampleJob:
 
 
 class CircuitSampleJobTree(Protocol):
-    def __iter__(self) -> Iterator[Union[CircuitSampleJob, 'CircuitSampleJobTree']]:
+    def __iter__(self) -> Iterator[CircuitSampleJob | CircuitSampleJobTree]:
         pass
 
 
-CIRCUIT_SAMPLE_JOB_TREE = Union[CircuitSampleJob, CircuitSampleJobTree]
+CIRCUIT_SAMPLE_JOB_TREE = CircuitSampleJob | CircuitSampleJobTree
 
 
 class Collector(metaclass=abc.ABCMeta):
@@ -75,7 +77,7 @@ class Collector(metaclass=abc.ABCMeta):
     """
 
     @abc.abstractmethod
-    def next_job(self) -> Optional[CIRCUIT_SAMPLE_JOB_TREE]:
+    def next_job(self) -> CIRCUIT_SAMPLE_JOB_TREE | None:
         """Determines what to sample next.
 
         This method is called by driving code when more samples can be
@@ -105,11 +107,7 @@ class Collector(metaclass=abc.ABCMeta):
         """
 
     def collect(
-        self,
-        sampler: 'cirq.Sampler',
-        *,
-        concurrency: int = 2,
-        max_total_samples: Optional[int] = None,
+        self, sampler: cirq.Sampler, *, concurrency: int = 2, max_total_samples: int | None = None
     ) -> None:
         """Collects needed samples from a sampler.
 
@@ -140,11 +138,7 @@ class Collector(metaclass=abc.ABCMeta):
         )
 
     async def collect_async(
-        self,
-        sampler: 'cirq.Sampler',
-        *,
-        concurrency: int = 2,
-        max_total_samples: Optional[int] = None,
+        self, sampler: cirq.Sampler, *, concurrency: int = 2, max_total_samples: int | None = None
     ) -> None:
         """Asynchronously collects needed samples from a sampler.
 
@@ -167,10 +161,10 @@ class Collector(metaclass=abc.ABCMeta):
             The collector's result after all desired samples have been
             collected.
         """
-        results: duet.AsyncCollector[Tuple[CircuitSampleJob, 'cirq.Result']] = duet.AsyncCollector()
+        results: duet.AsyncCollector[tuple[CircuitSampleJob, cirq.Result]] = duet.AsyncCollector()
         job_error = None
         running_jobs = 0
-        queued_jobs: List[CircuitSampleJob] = []
+        queued_jobs: list[CircuitSampleJob] = []
         remaining_samples = np.inf if max_total_samples is None else max_total_samples
 
         async def run_job(job):
@@ -213,7 +207,7 @@ class Collector(metaclass=abc.ABCMeta):
                 self.on_job_result(job, result)
 
 
-def _flatten_jobs(tree: Optional[CIRCUIT_SAMPLE_JOB_TREE]) -> Iterator[CircuitSampleJob]:
+def _flatten_jobs(tree: CIRCUIT_SAMPLE_JOB_TREE | None) -> Iterator[CircuitSampleJob]:
     if isinstance(tree, CircuitSampleJob):
         yield tree
     elif tree is not None:

cirq/work/collector_test.py

@@ -12,13 +12,15 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+from __future__ import annotations
+
 import duet
 import pytest
 
 import cirq
 
 
-def test_circuit_sample_job_equality():
+def test_circuit_sample_job_equality() -> None:
     eq = cirq.testing.EqualsTester()
     c1 = cirq.Circuit()
     c2 = cirq.Circuit(cirq.measure(cirq.LineQubit(0)))
@@ -32,14 +34,14 @@ def test_circuit_sample_job_equality():
     eq.add_equality_group(cirq.CircuitSampleJob(c1, repetitions=10, tag='test'))
 
 
-def test_circuit_sample_job_repr():
+def test_circuit_sample_job_repr() -> None:
     cirq.testing.assert_equivalent_repr(
         cirq.CircuitSampleJob(cirq.Circuit(cirq.H(cirq.LineQubit(0))), repetitions=10, tag='guess')
     )
 
 
 @duet.sync
-async def test_async_collect():
+async def test_async_collect() -> None:
     received = []
 
     class TestCollector(cirq.Collector):
@@ -51,14 +53,13 @@ async def test_async_collect():
         def on_job_result(self, job, result):
             received.append(job.tag)
 
-    result = await TestCollector().collect_async(
+    await TestCollector().collect_async(
         sampler=cirq.Simulator(), max_total_samples=100, concurrency=5
     )
-    assert result is None
     assert received == ['test'] * 10
 
 
-def test_collect():
+def test_collect() -> None:
     received = []
 
     class TestCollector(cirq.Collector):
@@ -74,7 +75,7 @@ def test_collect():
     assert received == ['test'] * 10
 
 
-def test_failed_job():
+def test_failed_job() -> None:
     class FailingSampler:
         async def run_async(self, circuit, repetitions):
             await duet.completed_future(None)
@@ -90,10 +91,14 @@ def test_failed_job():
             pass
 
     with pytest.raises(Exception, match='job failed!'):
-        TestCollector().collect(sampler=FailingSampler(), max_total_samples=100, concurrency=5)
+        TestCollector().collect(
+            sampler=FailingSampler(),  # type:ignore
+            max_total_samples=100,
+            concurrency=5,
+        )
 
 
-def test_collect_with_reaction():
+def test_collect_with_reaction() -> None:
     events = [0]
     sent = 0
     received = 0
@@ -123,7 +128,7 @@ def test_collect_with_reaction():
     assert all(events.index(-k) > events.index(k) for k in range(1, 11))
 
 
-def test_flatten_jobs_terminate_from_collector():
+def test_flatten_jobs_terminate_from_collector() -> None:
     sent = False
     received = []
 

cirq/work/observable_grouping.py

@@ -12,20 +12,19 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from typing import Callable, cast, Dict, Iterable, List, TYPE_CHECKING
+from __future__ import annotations
+
+from typing import Callable, cast, Iterable
 
 from cirq import ops, value
 from cirq.work.observable_settings import _max_weight_observable, _max_weight_state, InitObsSetting
 
-if TYPE_CHECKING:
-    pass
-
-GROUPER_T = Callable[[Iterable[InitObsSetting]], Dict[InitObsSetting, List[InitObsSetting]]]
+GROUPER_T = Callable[[Iterable[InitObsSetting]], dict[InitObsSetting, list[InitObsSetting]]]
 
 
 def group_settings_greedy(
     settings: Iterable[InitObsSetting],
-) -> Dict[InitObsSetting, List[InitObsSetting]]:
+) -> dict[InitObsSetting, list[InitObsSetting]]:
     """Greedily group settings which can be simultaneously measured.
 
     We construct a dictionary keyed by `max_setting` (see docstrings
@@ -46,7 +45,7 @@ def group_settings_greedy(
         input list of settings. Each dictionary value is a list of
         settings compatible with `max_setting`.
     """
-    grouped_settings: Dict[InitObsSetting, List[InitObsSetting]] = {}
+    grouped_settings: dict[InitObsSetting, list[InitObsSetting]] = {}
     for setting in settings:
         for max_setting, simul_settings in grouped_settings.items():
             trial_grouped_settings = simul_settings + [setting]

cirq/work/observable_grouping_test.py

@@ -12,10 +12,12 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+from __future__ import annotations
+
 import cirq
 
 
-def test_group_settings_greedy_one_group():
+def test_group_settings_greedy_one_group() -> None:
     qubits = cirq.LineQubit.range(2)
     q0, q1 = qubits
     terms = [cirq.X(q0), cirq.Y(q1)]
@@ -33,7 +35,7 @@ def test_group_settings_greedy_one_group():
     assert set(the_group) == set(settings)
 
 
-def test_group_settings_greedy_two_groups():
+def test_group_settings_greedy_two_groups() -> None:
     qubits = cirq.LineQubit.range(2)
     q0, q1 = qubits
     terms = [cirq.X(q0) * cirq.X(q1), cirq.Y(q0) * cirq.Y(q1)]
@@ -48,7 +50,7 @@ def test_group_settings_greedy_two_groups():
     assert set(grouped_settings.keys()) == set(group_max_settings_should_be)
 
 
-def test_group_settings_greedy_single_item():
+def test_group_settings_greedy_single_item() -> None:
     qubits = cirq.LineQubit.range(2)
     q0, q1 = qubits
     term = cirq.X(q0) * cirq.X(q1)
@@ -60,11 +62,11 @@ def test_group_settings_greedy_single_item():
     assert list(grouped_settings.values())[0][0] == settings[0]
 
 
-def test_group_settings_greedy_empty():
+def test_group_settings_greedy_empty() -> None:
     assert cirq.work.group_settings_greedy([]) == dict()
 
 
-def test_group_settings_greedy_init_state_compat():
+def test_group_settings_greedy_init_state_compat() -> None:
     q0, q1 = cirq.LineQubit.range(2)
     settings = [
         cirq.work.InitObsSetting(
@@ -78,14 +80,13 @@ def test_group_settings_greedy_init_state_compat():
     assert len(grouped_settings) == 1
 
 
-def test_group_settings_greedy_init_state_compat_sparse():
+def test_group_settings_greedy_init_state_compat_sparse() -> None:
     q0, q1 = cirq.LineQubit.range(2)
     settings = [
         cirq.work.InitObsSetting(init_state=cirq.KET_PLUS(q0), observable=cirq.X(q0)),
         cirq.work.InitObsSetting(init_state=cirq.KET_ZERO(q1), observable=cirq.Z(q1)),
     ]
     grouped_settings = cirq.work.group_settings_greedy(settings)
-    # pylint: disable=line-too-long
     grouped_settings_should_be = {
         cirq.work.InitObsSetting(
             init_state=cirq.KET_PLUS(q0) * cirq.KET_ZERO(q1), observable=cirq.X(q0) * cirq.Z(q1)
@@ -94,7 +95,7 @@ def test_group_settings_greedy_init_state_compat_sparse():
     assert grouped_settings == grouped_settings_should_be
 
 
-def test_group_settings_greedy_init_state_incompat():
+def test_group_settings_greedy_init_state_incompat() -> None:
     q0, q1 = cirq.LineQubit.range(2)
     settings = [
         cirq.work.InitObsSetting(
@@ -106,7 +107,7 @@ def test_group_settings_greedy_init_state_incompat():
     assert len(grouped_settings) == 2
 
 
-def test_group_settings_greedy_hydrogen():
+def test_group_settings_greedy_hydrogen() -> None:
     qubits = cirq.LineQubit.range(4)
     q0, q1, q2, q3 = qubits
     terms = [