Refactor types to check with pyright

.gitmodules

@@ -2,3 +2,6 @@
 	path = qcodes/tests/dataset/fixtures/db_files
 	url = https://github.com/QCoDeS/qcodes_db_fixtures.git
 	branch = main
+[submodule "typings"]
+	path = typings
+	url = https://github.com/QCoDeS/qcodes-python-type-stubs.git

docs/changes/newsfragments/4894.breaking

@@ -0,0 +1,5 @@
+``InstrumentBase.ancestors`` now returns a tuple of ancestors
+to the current Instrument, Instrumentchannel or Instrumentmodule and not a list.
+
+``dond ``, ``do1d`` etc. now returns tuples of Matplotlib axes and colorbars
+when plotting and not lists.

pyproject.toml

@@ -42,7 +42,7 @@ dependencies = [
     "pyvisa>=1.11.0, <1.14.0",
     "ruamel.yaml>=0.16.0,!=0.16.6",
     "tabulate>=0.8.0",
-    "typing_extensions>=3.10.0",
+    "typing_extensions>=4.0.0",
     "tqdm>=4.32.2",
     "uncertainties>=3.1.4",
     "versioningit>=2.0.1",
@@ -228,6 +228,25 @@ module = [
 ]
 ignore_missing_imports = true
 
+[tool.pyright]
+include = ["qcodes"]
+ignore = [
+    "qcodes/tests",
+    "qcodes/instrument_drivers/test.py",
+    "qcodes/instrument_drivers/zurich_instruments",
+    "qcodes/instrument_drivers/Harvard/Decadac.py",
+    "qcodes/instrument_drivers/oxford/mercuryiPS.py",
+    "qcodes/actions.py",
+    "qcodes/data",
+    "qcodes/loops.py",
+    "qcodes/measure.py",
+    "qcodes/plots/pyqtgraph.py",
+    "qcodes/plots/qcmatplotlib.py",
+    "qcodes/plots/base.py",
+    "qcodes/extensions/slack.py"
+    ]
+reportMissingTypeStubs = true
+
 [tool.pytest.ini_options]
 minversion = "6.0"
 junit_family = "legacy"

qcodes/dataset/data_set.py

@@ -1229,8 +1229,9 @@ def _enqueue_results(
 
         toplevel_params = (set(interdeps.dependencies)
                            .intersection(set(result_dict)))
-        if self._in_memory_cache:
-            new_results: dict[str, dict[str, numpy.ndarray]] = {}
+
+        new_results: dict[str, dict[str, numpy.ndarray]] = {}
+
         for toplevel_param in toplevel_params:
             inff_params = set(interdeps.inferences.get(toplevel_param, ()))
             deps_params = set(interdeps.dependencies.get(toplevel_param, ()))
@@ -1353,7 +1354,7 @@ def _finalize_res_dict_numeric_text_or_complex(
                     flat_results[dep.name] = result_dict[dep].ravel()
             for inff in inff_params:
                 if numpy.shape(result_dict[inff]) == ():
-                    flat_results[inff.name] = numpy.repeat(result_dict[dep], N)
+                    flat_results[inff.name] = numpy.repeat(result_dict[inff], N)
                 else:
                     flat_results[inff.name] = result_dict[inff].ravel()
 
@@ -1375,21 +1376,28 @@ def _finalize_res_dict_standalones(
         for param, value in result_dict.items():
             if param.type == 'text':
                 if value.shape:
-                    res_list += [{param.name: str(val)} for val in value]
+                    new_res: list[dict[str, VALUE]] = [
+                        {param.name: str(val)} for val in value
+                    ]
+                    res_list += new_res
                 else:
-                    res_list += [{param.name: str(value)}]
+                    new_res = [{param.name: str(value)}]
+                    res_list += new_res
             elif param.type == 'numeric':
                 if value.shape:
                     res_list += [{param.name: number} for number in value]
                 else:
-                    res_list += [{param.name: float(value)}]
+                    new_res = [{param.name: float(value)}]
+                    res_list += new_res
             elif param.type == 'complex':
                 if value.shape:
                     res_list += [{param.name: number} for number in value]
                 else:
-                    res_list += [{param.name: complex(value)}]
+                    new_res = [{param.name: complex(value)}]
+                    res_list += new_res
             else:
-                res_list += [{param.name: value}]
+                new_res = [{param.name: value}]
+                res_list += new_res
 
         return res_list
 

qcodes/dataset/data_set_protocol.py

@@ -85,7 +85,7 @@ class CompletedError(RuntimeError):
 
 
 @runtime_checkable
-class DataSetProtocol(Protocol, Sized):
+class DataSetProtocol(Protocol):
 
     # the "persistent traits" are the attributes/properties of the DataSet
     # that are NOT tied to the representation of the DataSet in any particular
@@ -116,114 +116,114 @@ def prepare(
         parent_datasets: Sequence[Mapping[Any, Any]] = (),
         write_in_background: bool = False,
     ) -> None:
-        pass
+        ...
 
     @property
     def pristine(self) -> bool:
-        pass
+        ...
 
     @property
     def running(self) -> bool:
-        pass
+        ...
 
     @property
     def completed(self) -> bool:
-        pass
+        ...
 
     def mark_completed(self) -> None:
-        pass
+        ...
 
     # dataset attributes
 
     @property
     def run_id(self) -> int:
-        pass
+        ...
 
     @property
     def captured_run_id(self) -> int:
-        pass
+        ...
 
     @property
     def counter(self) -> int:
-        pass
+        ...
 
     @property
     def captured_counter(self) -> int:
-        pass
+        ...
 
     @property
     def guid(self) -> str:
-        pass
+        ...
 
     @property
     def number_of_results(self) -> int:
-        pass
+        ...
 
     @property
     def name(self) -> str:
-        pass
+        ...
 
     @property
     def exp_name(self) -> str:
-        pass
+        ...
 
     @property
     def exp_id(self) -> int:
-        pass
+        ...
 
     @property
     def sample_name(self) -> str:
-        pass
+        ...
 
     def run_timestamp(self, fmt: str = "%Y-%m-%d %H:%M:%S") -> str | None:
-        pass
+        ...
 
     @property
     def run_timestamp_raw(self) -> float | None:
-        pass
+        ...
 
     def completed_timestamp(self, fmt: str = "%Y-%m-%d %H:%M:%S") -> str | None:
-        pass
+        ...
 
     @property
     def completed_timestamp_raw(self) -> float | None:
-        pass
+        ...
 
     # snapshot and metadata
     @property
     def snapshot(self) -> dict[str, Any] | None:
-        pass
+        ...
 
     def add_snapshot(self, snapshot: str, overwrite: bool = False) -> None:
-        pass
+        ...
 
     @property
     def _snapshot_raw(self) -> str | None:
-        pass
+        ...
 
     def add_metadata(self, tag: str, metadata: Any) -> None:
-        pass
+        ...
 
     @property
     def metadata(self) -> dict[str, Any]:
-        pass
+        ...
 
     @property
     def path_to_db(self) -> str | None:
-        pass
+        ...
 
     # dataset description and links
     @property
     def paramspecs(self) -> dict[str, ParamSpec]:
-        pass
+        ...
 
     @property
     def description(self) -> RunDescriber:
-        pass
+        ...
 
     @property
     def parent_dataset_links(self) -> list[Link]:
-        pass
+        ...
 
     # data related members
 
@@ -233,15 +233,15 @@ def export(
         path: str | None = None,
         prefix: str | None = None,
     ) -> None:
-        pass
+        ...
 
     @property
     def export_info(self) -> ExportInfo:
-        pass
+        ...
 
     @property
     def cache(self) -> DataSetCache[DataSetProtocol]:
-        pass
+        ...
 
     def get_parameter_data(
         self,
@@ -250,15 +250,15 @@ def get_parameter_data(
         end: int | None = None,
         callback: Callable[[float], None] | None = None,
     ) -> ParameterData:
-        pass
+        ...
 
     def get_parameters(self) -> SPECS:
         # used by plottr
-        pass
+        ...
 
     @property
     def dependent_parameters(self) -> tuple[ParamSpecBase, ...]:
-        pass
+        ...
 
     # exporters to other in memory formats
 
@@ -268,49 +268,52 @@ def to_xarray_dataarray_dict(
         start: int | None = None,
         end: int | None = None,
     ) -> dict[str, xr.DataArray]:
-        pass
+        ...
 
     def to_xarray_dataset(
         self,
         *params: str | ParamSpec | ParameterBase,
         start: int | None = None,
         end: int | None = None,
     ) -> xr.Dataset:
-        pass
+        ...
 
     def to_pandas_dataframe_dict(
         self,
         *params: str | ParamSpec | ParameterBase,
         start: int | None = None,
         end: int | None = None,
     ) -> dict[str, pd.DataFrame]:
-        pass
+        ...
 
     def to_pandas_dataframe(
         self,
         *params: str | ParamSpec | ParameterBase,
         start: int | None = None,
         end: int | None = None,
     ) -> pd.DataFrame:
-        pass
+        ...
 
     # private members called by various other parts or the api
 
     def _enqueue_results(self, result_dict: Mapping[ParamSpecBase, np.ndarray]) -> None:
-        pass
+        ...
 
     def _flush_data_to_database(self, block: bool = False) -> None:
-        pass
+        ...
 
     @property
     def _parameters(self) -> str | None:
-        pass
+        ...
 
     def _set_export_info(self, export_info: ExportInfo) -> None:
-        pass
+        ...
 
+    def __len__(self) -> int:
+        ...
 
-class BaseDataSet(DataSetProtocol):
+
+class BaseDataSet(DataSetProtocol, Protocol):
 
     # shared methods between all implementations of the dataset
 

qcodes/dataset/dond/do_0d.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 import logging
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, cast
 
 from qcodes import config
 from qcodes.parameters import ParameterBase
@@ -54,7 +54,7 @@ def do0d(
         The QCoDeS dataset.
     """
     if do_plot is None:
-        do_plot = config.dataset.dond_plot
+        do_plot = cast(bool, config.dataset.dond_plot)
     meas = Measurement(name=measurement_name, exp=exp)
     if log_info is not None:
         meas._extra_log_info = log_info

qcodes/dataset/dond/do_1d.py

@@ -3,7 +3,7 @@
 import logging
 import sys
 import time
-from typing import TYPE_CHECKING, Sequence
+from typing import TYPE_CHECKING, Sequence, cast
 
 import numpy as np
 from tqdm.auto import tqdm
@@ -101,7 +101,7 @@ def do1d(
         The QCoDeS dataset.
     """
     if do_plot is None:
-        do_plot = config.dataset.dond_plot
+        do_plot = cast(bool, config.dataset.dond_plot)
     if show_progress is None:
         show_progress = config.dataset.dond_show_progress