style: Apply PEP 585/604 for type annotations (#239)

Co-authored-by: ABC <[email protected]>

Author: tachikoma-li

qctrlopencontrols/driven_controls/driven_control.py

@@ -15,10 +15,12 @@
 """
 Driven control module.
 """
+from __future__ import annotations
+
 import csv
 import json
 from typing import (
-    Dict,
+    Any,
     Optional,
 )
 
@@ -374,7 +376,7 @@ def resample(self, time_step: float, name: Optional[str] = None) -> "DrivenContr
             name,
         )
 
-    def _qctrl_expanded_export_content(self, coordinates: str) -> Dict:
+    def _qctrl_expanded_export_content(self, coordinates: str) -> dict[str, Any]:
         """
         Prepare the content to be saved in Q-CTRL expanded format.
 
@@ -386,7 +388,7 @@ def _qctrl_expanded_export_content(self, coordinates: str) -> Dict:
 
         Returns
         -------
-        Dict
+        dict
             A dictionary containing the information of the control.
         """
 
@@ -551,7 +553,7 @@ def export_to_file(
 
     def export(
         self, coordinates=Coordinate.CYLINDRICAL.value, dimensionless_rabi_rate=True
-    ):
+    ) -> dict[str, Any]:
 
         """
         Returns a dictionary formatted for plotting using the ``qctrl-visualizer`` package.

qctrlopencontrols/driven_controls/predefined.py

@@ -16,10 +16,9 @@
 Module for defining commonly used driven controls.
 """
 
-from typing import (
-    List,
-    Optional,
-)
+from __future__ import annotations
+
+from typing import Optional
 
 import numpy as np
 
@@ -81,14 +80,14 @@ def _get_transformed_rabi_rotation_wimperis(rabi_rotation: float) -> float:
 
 def _derive_segments(
     angles: np.ndarray, amplitude: float = 2.0 * np.pi
-) -> List[List[float]]:
+) -> list[list[float]]:
     """
     Derive the driven control segments from a set of rabi_rotations defined in terms of the
     spherical polar angles.
 
     Parameters
     ----------
-    angles : numpy.array
+    angles : np.ndarray
         angles is made of a list polar angle 2-lists formatted
         as [polar_angle, azimuthal_angle].
         All angles should be greater or equal to 0, and the polar_angles

qctrlopencontrols/dynamic_decoupling_sequences/dynamic_decoupling_sequence.py

@@ -16,8 +16,10 @@
 Dynamical decoupling module.
 """
 
+from __future__ import annotations
+
 from typing import (
-    Dict,
+    Any,
     Optional,
 )
 
@@ -129,7 +131,7 @@ def __init__(
         self.detuning_rotations = np.asarray(detuning_rotations, dtype=float)
         self.name = name
 
-    def export(self) -> Dict:
+    def export(self) -> dict[str, Any]:
         """
         Returns a dictionary for plotting using the qctrl-visualizer package.
 

qctrlopencontrols/dynamic_decoupling_sequences/predefined.py

@@ -16,7 +16,7 @@
 Module for defining commonly used dynamical decoupling sequences.
 """
 
-from typing import Tuple
+from __future__ import annotations
 
 import numpy as np
 
@@ -30,7 +30,7 @@ def _add_pre_post_rotations(
     rabi_rotations: np.ndarray,
     azimuthal_angles: np.ndarray,
     detuning_rotations: np.ndarray,
-) -> Tuple[np.ndarray, np.ndarray, np.ndarray, np.ndarray]:
+) -> tuple[np.ndarray, np.ndarray, np.ndarray, np.ndarray]:
     """
     Adds a pre and post X rotation at the start and end of the sequence.
 
@@ -44,15 +44,15 @@ def _add_pre_post_rotations(
 
     Parameters
     ----------
-    duration: float
+    duration : float
         The duration of the sequence
-    offsets : numpy.ndarray
+    offsets : np.ndarray
         Offsets of the sequence.
-    rabi_rotations: numpy.ndarray
+    rabi_rotations : np.ndarray
         Rabi rotations at each of the offsets.
-    azimuthal_angles : numpy.ndarray
+    azimuthal_angles : np.ndarray
         Azimuthal angles at each of the offsets.
-    detuning_rotations: numpy.ndarray
+    detuning_rotations : np.ndarray
         Detuning rotations at each of the offsets
 
     Returns
@@ -140,7 +140,9 @@ def _add_pre_post_rotations(
     return offsets, rabi_rotations, azimuthal_angles, detuning_rotations
 
 
-def new_ramsey_sequence(duration, pre_post_rotation=False, name=None):
+def new_ramsey_sequence(
+    duration, pre_post_rotation=False, name=None
+) -> DynamicDecouplingSequence:
     r"""
     Creates the Ramsey sequence.
 
@@ -198,7 +200,9 @@ def new_ramsey_sequence(duration, pre_post_rotation=False, name=None):
     )
 
 
-def new_spin_echo_sequence(duration, pre_post_rotation=False, name=None):
+def new_spin_echo_sequence(
+    duration, pre_post_rotation=False, name=None
+) -> DynamicDecouplingSequence:
     r"""
     Creates the spin echo sequence.
 
@@ -261,7 +265,7 @@ def new_spin_echo_sequence(duration, pre_post_rotation=False, name=None):
 
 def new_carr_purcell_sequence(
     duration, offset_count, pre_post_rotation=False, name=None
-):
+) -> DynamicDecouplingSequence:
     r"""
     Creates the Carr-Purcell sequence.
 
@@ -344,7 +348,9 @@ def new_carr_purcell_sequence(
     )
 
 
-def new_cpmg_sequence(duration, offset_count, pre_post_rotation=False, name=None):
+def new_cpmg_sequence(
+    duration, offset_count, pre_post_rotation=False, name=None
+) -> DynamicDecouplingSequence:
     r"""
     Creates the Carr-Purcell-Meiboom-Gill sequence.
 
@@ -428,7 +434,9 @@ def new_cpmg_sequence(duration, offset_count, pre_post_rotation=False, name=None
     )
 
 
-def new_uhrig_sequence(duration, offset_count, pre_post_rotation=False, name=None):
+def new_uhrig_sequence(
+    duration, offset_count, pre_post_rotation=False, name=None
+) -> DynamicDecouplingSequence:
     r"""
     Creates the Uhrig sequence.
 
@@ -507,7 +515,9 @@ def new_uhrig_sequence(duration, offset_count, pre_post_rotation=False, name=Non
     )
 
 
-def new_periodic_sequence(duration, offset_count, pre_post_rotation=False, name=None):
+def new_periodic_sequence(
+    duration, offset_count, pre_post_rotation=False, name=None
+) -> DynamicDecouplingSequence:
     r"""
     Creates the periodic sequence.
 
@@ -586,7 +596,9 @@ def new_periodic_sequence(duration, offset_count, pre_post_rotation=False, name=
     )
 
 
-def new_walsh_sequence(duration, paley_order, pre_post_rotation=False, name=None):
+def new_walsh_sequence(
+    duration, paley_order, pre_post_rotation=False, name=None
+) -> DynamicDecouplingSequence:
     r"""
     Creates the Walsh sequence.
 
@@ -709,7 +721,7 @@ def new_walsh_sequence(duration, paley_order, pre_post_rotation=False, name=None
 
 def new_quadratic_sequence(
     duration, inner_offset_count, outer_offset_count, pre_post_rotation=False, name=None
-):
+) -> DynamicDecouplingSequence:
     r"""
     Creates the quadratic sequence.
 
@@ -842,7 +854,7 @@ def new_quadratic_sequence(
 
 def new_x_concatenated_sequence(
     duration, concatenation_order, pre_post_rotation=False, name=None
-):
+) -> DynamicDecouplingSequence:
     r"""
     Creates the :math:`X`-concatenated sequence.
 
@@ -945,7 +957,7 @@ def new_x_concatenated_sequence(
 
 def new_xy_concatenated_sequence(
     duration, concatenation_order, pre_post_rotation=False, name=None
-):
+) -> DynamicDecouplingSequence:
     r"""
     Creates the :math:`XY`-concatenated sequence.
 
@@ -1138,7 +1150,7 @@ def _carr_purcell_meiboom_gill_offsets(
 
     Returns
     -------
-    numpy.ndarray
+    np.ndarray
         The offset values.
     """
 
@@ -1166,7 +1178,7 @@ def _uhrig_single_axis_offsets(duration: float, offset_count: int) -> np.ndarray
 
     Returns
     -------
-    numpy.ndarray
+    np.ndarray
         The offset values.
     """
 
@@ -1192,7 +1204,7 @@ def _concatenation_x(concatenation_sequence: int) -> np.ndarray:
 
     Returns
     -------
-    numpy.ndarray
+    np.ndarray
         The offset values.
     """
 
@@ -1222,7 +1234,7 @@ def _concatenation_xy(concatenation_sequence) -> np.ndarray:
 
     Returns
     -------
-    numpy.ndarray
+    np.ndarray
         The offset values.
     """
 

qctrlopencontrols/utils.py

@@ -15,12 +15,18 @@
 """
 Miscellaneous functions and dataclasses.
 """
+from __future__ import annotations
+
 from enum import Enum
+from typing import (
+    Any,
+    Optional,
+)
 
 from .exceptions import ArgumentsValueError
 
 
-def create_repr_from_attributes(class_instance=None, attributes=None):
+def create_repr_from_attributes(class_instance=None, attributes=None) -> str:
 
     """
     Returns a string representation of an object.
@@ -81,30 +87,36 @@ def create_repr_from_attributes(class_instance=None, attributes=None):
     return repr_string
 
 
-def check_arguments(condition, description, arguments, extras=None):
+def check_arguments(
+    condition: Any,
+    description: str,
+    arguments: dict[str, Any],
+    extras: Optional[dict[str, Any]] = None,
+):
     """
     Raises an ArgumentsValueError with the specified parameters if the given condition is false,
     otherwise does nothing.
 
     For example, a use case may look like::
 
         def log(x):
-            check_arguments(x > 0,
-                            "x must be positive.",
-                            {"x": x})
-            return numpy.log(x)
+            check_arguments(
+                x > 0, "x must be positive.", {"x": x}
+            )
+            return np.log(x)
 
     Parameters
     ----------
-    condition: Any
+    condition : Any
         The condition to be checked. Evaluated result of the condition must be bool.
-    description: str
+    description : str
         Error information to explain why condition fails.
-    arguments: dict
+    arguments : dict
         arguments that fail the condition. Keys should be the names of the arguments and arguments
         are the values.
-    extras: dict, optional
+    extras : dict, optional
         Any extra information to explain why condition fails. Defaults to None.
+
     Raises
     ------
     ArgumentsValueError