doc: Use idiomatic Python types in docstrings (#1151)

Author: speller26

src/braket/ahs/atom_arrangement.py

@@ -70,7 +70,7 @@ def add(
         """Add a coordinate to the atom arrangement.
 
         Args:
-            coordinate (Union[tuple[Number, Number], ndarray]): The coordinate of the
+            coordinate (tuple[Number, Number] | np.ndarray): The coordinate of the
                 atom (in meters). The coordinates can be a numpy array of shape (2,)
                 or a tuple of int, float, Decimal
             site_type (SiteType): The type of site. Optional. Default is FILLED.
@@ -354,7 +354,7 @@ def from_bravais_lattice(
             a1 (tuple[Number, Number]): First lattice vector (x, y) in meters.
             a2 (tuple[Number, Number]): Second lattice vector (x, y) in meters.
             canvas (Canvas): Canvas defining the boundary where atoms can be placed.
-            basis (list[tuple[Number, Number]], optional): Basis vectors for decorated lattice.
+            basis (list[tuple[Number, Number]] | None): Basis vectors for decorated lattice.
                 If None, uses a single atom at (0, 0). Default is None.
             site_type (SiteType): The type of sites to create. Default is FILLED.
 

src/braket/ahs/driving_field.py

@@ -50,11 +50,11 @@ def __init__(
         with the sum :math:`\sum_k` taken over all target atoms.
 
         Args:
-            amplitude (Union[Field, TimeSeries]): global amplitude (:math:`\Omega(t)`).
+            amplitude (Field | TimeSeries): global amplitude (:math:`\Omega(t)`).
                 Time is in s, and value is in rad/s.
-            phase (Union[Field, TimeSeries]): global phase (:math:`\phi(t)`).
+            phase (Field | TimeSeries): global phase (:math:`\phi(t)`).
                 Time is in s, and value is in rad/s.
-            detuning (Union[Field, TimeSeries]): global detuning (:math:`\Delta(t)`).
+            detuning (Field | TimeSeries): global detuning (:math:`\Delta(t)`).
                 Time is in s, and value is in rad/s.
         """
         super().__init__()

src/braket/ahs/field.py

@@ -25,7 +25,7 @@ def __init__(self, time_series: TimeSeries, pattern: Pattern | None = None) -> N
 
         Args:
             time_series (TimeSeries): The time series representing this field.
-            pattern (Optional[Pattern]): The local pattern of real numbers.
+            pattern (Pattern | None): The local pattern of real numbers.
         """
         self._time_series = time_series
         self._pattern = pattern
@@ -37,7 +37,7 @@ def time_series(self) -> TimeSeries:
 
     @property
     def pattern(self) -> Pattern | None:
-        """Optional[Pattern]: The local pattern of real numbers."""
+        """Pattern | None: The local pattern of real numbers."""
         return self._pattern
 
     def discretize(
@@ -51,9 +51,9 @@ def discretize(
         closest multiple of their corresponding resolutions.
 
         Args:
-            time_resolution (Optional[Decimal]): Time resolution
-            value_resolution (Optional[Decimal]): Value resolution
-            pattern_resolution (Optional[Decimal]): Pattern resolution
+            time_resolution (Decimal | None): Time resolution
+            value_resolution (Decimal | None): Value resolution
+            pattern_resolution (Decimal | None): Pattern resolution
 
         Returns:
             Field: A new discretized field.

src/braket/ahs/pattern.py

@@ -40,7 +40,7 @@ def discretize(self, resolution: Decimal | None) -> Pattern:
         of the resolution.
 
         Args:
-            resolution (Optional[Decimal]): Resolution of the discretization
+            resolution (Decimal | None): Resolution of the discretization
 
         Returns:
             Pattern: The new discretized pattern

src/braket/aws/aws_device.py

@@ -92,8 +92,8 @@ def __init__(
 
         Args:
             arn (str): The ARN of the device
-            aws_session (Optional[AwsSession]): An AWS session object. Default is `None`.
-            noise_model (Optional[NoiseModel]): The Braket noise model to apply to the circuit
+            aws_session (AwsSession | None): An AWS session object. Default is `None`.
+            noise_model (NoiseModel | None): The Braket noise model to apply to the circuit
                 before execution. Noise model can only be added to the devices that support
                 noise simulation.
 
@@ -142,20 +142,20 @@ def run(
             task_specification (TaskSpecification):
                 Specification of quantum task (circuit, OpenQASM program, program set,
                 pulse sequence or AHS program) to run on the device.
-            s3_destination_folder (Optional[S3DestinationFolder]): The S3 location to
+            s3_destination_folder (S3DestinationFolder | None): The S3 location to
                 save the quantum task's results to. Default is `<default_bucket>/tasks` if evoked outside a
                 Braket Hybrid Job, `<Job Bucket>/jobs/<job name>/tasks` if evoked inside a Braket Hybrid Job.
-            shots (Optional[int]): The number of times to run the circuit or annealing problem.
+            shots (int | None): The number of times to run the circuit or annealing problem.
                 Default is 1000 for QPUs and 0 for simulators.
             poll_timeout_seconds (float): The polling timeout for `AwsQuantumTask.result()`,
                 in seconds. Default: 5 days.
-            poll_interval_seconds (Optional[float]): The polling interval for `AwsQuantumTask.result()`,
+            poll_interval_seconds (float | None): The polling interval for `AwsQuantumTask.result()`,
                 in seconds. Defaults to the ``getTaskPollIntervalMillis`` value specified in
                 ``self.properties.service`` (divided by 1000) if provided, otherwise 1 second.
-            inputs (Optional[dict[str, float]]): Inputs to be passed along with the
+            inputs (dict[str, float] | None): Inputs to be passed along with the
                 IR. If the IR supports inputs, the inputs will be updated with this value.
                 Default: {}.
-            gate_definitions (Optional[dict[tuple[Gate, QubitSet], PulseSequence]]): A
+            gate_definitions (dict[tuple[Gate, QubitSet], PulseSequence] | None): A
                 `dict[tuple[Gate, QubitSet], PulseSequence]]` for a user defined gate calibration.
                 The calibration is defined for a particular `Gate` on a particular `QubitSet`
                 and is represented by a `PulseSequence`.
@@ -244,12 +244,12 @@ def run_batch(
             task_specifications (TaskSpecification | list[TaskSpecification]):
                 Single instance or list of task specifications (circuits, OpenQASM programs,
                 pulse sequences or AHS programs) to run on the device.
-            s3_destination_folder (Optional[S3DestinationFolder]): The S3 location to
+            s3_destination_folder (S3DestinationFolder | None): The S3 location to
                 save the quantum tasks' results to. Default is `<default_bucket>/tasks` if evoked outside a
                 Braket Job, `<Job Bucket>/jobs/<job name>/tasks` if evoked inside a Braket Job.
-            shots (Optional[int]): The number of times to run the circuit or annealing problem.
+            shots (int | None): The number of times to run the circuit or annealing problem.
                 Default is 1000 for QPUs and 0 for simulators.
-            max_parallel (Optional[int]): The maximum number of quantum tasks to run on AWS in parallel.
+            max_parallel (int | None): The maximum number of quantum tasks to run on AWS in parallel.
                 Batch creation will fail if this value is greater than the maximum allowed
                 concurrent quantum tasks on the device. Default: 10
             max_connections (int): The maximum number of connections in the Boto3 connection pool.
@@ -259,14 +259,14 @@ def run_batch(
             poll_interval_seconds (float): The polling interval for `AwsQuantumTask.result()`,
                 in seconds. Defaults to the ``getTaskPollIntervalMillis`` value specified in
                 ``self.properties.service`` (divided by 1000) if provided, otherwise 1 second.
-            inputs (Optional[dict[str, float] | list[dict[str, float]]]): Inputs to be
+            inputs (dict[str, float] | list[dict[str, float]] | None): Inputs to be
                 passed along with the IR. If the IR supports inputs, the inputs will be updated
                 with this value. Default: {}.
-            gate_definitions (Optional[dict[tuple[Gate, QubitSet], PulseSequence]]): A
+            gate_definitions (dict[tuple[Gate, QubitSet], PulseSequence] | None): A
                 `dict[tuple[Gate, QubitSet], PulseSequence]]` for a user defined gate calibration.
                 The calibration is defined for a particular `Gate` on a particular `QubitSet`
                 and is represented by a `PulseSequence`. Default: None.
-            reservation_arn (Optional[str]): The reservation ARN provided by Braket Direct
+            reservation_arn (str | None): The reservation ARN provided by Braket Direct
                 to reserve exclusive usage for the device to run the quantum task on.
                 Note: If you are creating tasks in a job that itself was created reservation ARN,
                 those tasks do not need to be created with the reservation ARN.
@@ -409,7 +409,7 @@ def gate_calibrations(self) -> GateCalibrations | None:
         If a QPU does not expose these calibrations, None is returned.
 
         Returns:
-            Optional[GateCalibrations]: The calibration object. Returns `None` if the data
+            GateCalibrations | None: The calibration object. Returns `None` if the data
             is not present.
         """
         if not self._gate_calibrations:
@@ -610,18 +610,18 @@ def get_devices(
             >>> AwsDevice.get_devices(types=["SIMULATOR"])
 
         Args:
-            arns (Optional[list[str]]): device ARN filter, default is `None`
-            names (Optional[list[str]]): device name filter, default is `None`
-            types (Optional[list[AwsDeviceType]]): device type filter, default is `None`
+            arns (list[str] | None): device ARN filter, default is `None`
+            names (list[str] | None): device name filter, default is `None`
+            types (list[AwsDeviceType] | None): device type filter, default is `None`
                 QPUs will be searched for all regions and simulators will only be
                 searched for the region of the current session.
-            statuses (Optional[list[str]]): device status filter, default is `None`. When `None`
+            statuses (list[str] | None): device status filter, default is `None`. When `None`
                 is used, RETIRED devices will not be returned. To include RETIRED devices in
                 the results, use a filter that includes "RETIRED" for this parameter.
-            provider_names (Optional[list[str]]): provider name filter, default is `None`
+            provider_names (list[str] | None): provider name filter, default is `None`
             order_by (str): field to order result by, default is `name`.
                 Accepted values are ['arn', 'name', 'type', 'provider_name', 'status']
-            aws_session (Optional[AwsSession]): An AWS session object.
+            aws_session (AwsSession | None): An AWS session object.
                 Default is `None`.
 
         Raises:
@@ -782,7 +782,7 @@ def refresh_gate_calibrations(self) -> GateCalibrations | None:
             URLError: If the URL provided returns a non 2xx response.
 
         Returns:
-            Optional[GateCalibrations]: the calibration data for the device. None
+            GateCalibrations | None: the calibration data for the device. None
             is returned if the device does not have a gate calibrations URL associated.
         """
         if (

src/braket/aws/aws_quantum_task.py

@@ -245,7 +245,7 @@ def __init__(
                 `getLogger(__name__)`
             quiet (bool): Sets the verbosity of the logger to low and does not report queue
                 position. Default is `False`.
-            task_specification (Optional[TaskSpecification]): The specification the task
+            task_specification (TaskSpecification | None): The specification the task
                 was run with
 
         Examples:

src/braket/aws/aws_session.py

@@ -648,13 +648,13 @@ def search_devices(
         all the filters `arns`, `names`, `types`, `statuses`, `provider_names`.
 
         Args:
-            arns (Optional[list[str]]): device ARN filter, default is `None`.
-            names (Optional[list[str]]): device name filter, default is `None`.
-            types (Optional[list[str]]): device type filter, default is `None`.
-            statuses (Optional[list[str]]): device status filter, default is `None`. When `None`
+            arns (list[str] | None): device ARN filter, default is `None`.
+            names (list[str] | None): device name filter, default is `None`.
+            types (list[str] | None): device type filter, default is `None`.
+            statuses (list[str] | None): device status filter, default is `None`. When `None`
                 is used, RETIRED devices will not be returned. To include RETIRED devices in
                 the results, use a filter that includes "RETIRED" for this parameter.
-            provider_names (Optional[list[str]]): provider name list, default is `None`.
+            provider_names (list[str] | None): provider name list, default is `None`.
 
         Returns:
             list[dict[str, Any]]: The response from the Amazon Braket `SearchDevices` operation.
@@ -755,9 +755,9 @@ def describe_log_streams(
         Args:
             log_group (str): Name of the log group.
             log_stream_prefix (str): Prefix for log streams to include.
-            limit (Optional[int]): Limit for number of log streams returned.
+            limit (int | None): Limit for number of log streams returned.
                 default is 50.
-            next_token (Optional[str]): The token for the next set of items to return.
+            next_token (str | None): The token for the next set of items to return.
                 Would have been received in a previous call.
 
         Returns:
@@ -793,7 +793,7 @@ def get_log_events(
             start_time (int): Timestamp that indicates a start time to include log events.
             start_from_head (bool): Bool indicating to return oldest events first. default
                 is True.
-            next_token (Optional[str]): The token for the next set of items to return.
+            next_token (str | None): The token for the next set of items to return.
                 Would have been received in a previous call.
 
         Returns:
@@ -819,8 +819,8 @@ def copy_session(
         """Creates a new AwsSession based on the region.
 
         Args:
-            region (Optional[str]): Name of the region. Default = `None`.
-            max_connections (Optional[int]): The maximum number of connections in the
+            region (str | None): Name of the region. Default = `None`.
+            max_connections (int | None): The maximum number of connections in the
                 Boto3 connection pool. Default = `None`.
 
         Returns:

src/braket/aws/queue_information.py

@@ -51,9 +51,9 @@ class QuantumTaskQueueInfo:
     Attributes:
         queue_type (QueueType): type of the quantum_task queue either 'Normal'
             or 'Priority'.
-        queue_position (Optional[str]): current position of your quantum task within a respective
+        queue_position (str | None): current position of your quantum task within a respective
             device queue. This value can be None based on the state of the task. Default: None.
-        message (Optional[str]): Additional message information. This key is present only
+        message (str | None): Additional message information. This key is present only
             if 'queue_position' is None. Default: None.
     """
 
@@ -67,12 +67,12 @@ class HybridJobQueueInfo:
     """Represents hybrid job queue information.
 
     Attributes:
-        queue_position (Optional[str]): current position of your hybrid job within a respective
+        queue_position (str | None): current position of your hybrid job within a respective
             device queue. If the queue position of the hybrid job is greater than 15, we
             return '>15' as the queue_position return value. The queue_position is only
             returned when hybrid job is not in RUNNING/CANCELLING/TERMINAL states, else
             queue_position is returned as None.
-        message (Optional[str]): Additional message information. This key is present only
+        message (str | None): Additional message information. This key is present only
             if 'queue_position' is None. Default: None.
     """