Use typehints for **kwargs

[purva-thakre]

As noted in #2589 (comment), typehint for kwargs are manually provided.

To close this issue:

• Find all the docstrings where we manually add the type hints for **kwargs.
• Replace the manual additions with what's discussed here: https://peps.python.org/pep-0692/#specification

[EmilyIsCoding]

Hello, I have some questions about the expected changes.

According to the updated documentation, would it look something like:

from typing import TypedDict, Unpack

class Method_Select(TypedDict):
    method: str

def execute_with_cdr(
    circuit: QPROGRAM,
    executor: Union[Executor, Callable[[QPROGRAM], QuantumResult]],
    observable: Optional[Observable] = None,
    *,
    simulator: Union[Executor, Callable[[QPROGRAM], QuantumResult]],
    num_training_circuits: int = 10,
    fraction_non_clifford: float = 0.1,
    fit_function: Callable[..., float] = linear_fit_function,
    num_fit_parameters: Optional[int] = None,
    scale_factors: Sequence[float] = (1,),
    scale_noise: Callable[[QPROGRAM, float], QPROGRAM] = fold_gates_at_random,
    **kwargs: Method_Select,
) -> float:

In which case I'm not sure what the advantage switching over to Unpack is. Thanks for your patience in explaining!

[purva-thakre]

HI @EmilyIsCoding, thank you for your interest in this issue!

In which case I'm not sure what the advantage switching over to Unpack is.

Right now, type hinting for kwargs is accomplished through manually providing the type. See below.

mitiq/mitiq/cdr/cdr.py

Lines 82 to 99 in c4d6a44

	kwargs: Available keyword arguments are:
	- method_select (string): Specifies the method used to select the
	non-Clifford gates to replace when constructing the near-Clifford
	training circuits. Can be 'uniform' or 'gaussian'.
	- method_replace (string): Specifies the method used to replace the
	selected non-Clifford gates with a Clifford when constructing the
	near-Clifford training circuits. Can be 'uniform', 'gaussian', or
	'closest'.
	- sigma_select (float): Width of the Gaussian distribution used for
	``method_select='gaussian'``.
	- sigma_replace (float): Width of the Gaussian distribution used
	for ``method_replace='gaussian'``.
	- random_state (int): Seed for sampling.

If we switch to using Unpack, I believe we would no longer have to provide the manually added descriptions. Maybe there is a better way to do this. I am open to other options as well!