Rename typevar as suggested in review

Author: jenshnielsen

src/qcodes/parameters/array_parameter.py

@@ -14,7 +14,7 @@
     has_loop = False
 from typing import Generic
 
-from .parameter_base import InstrumentType_co, ParameterBase, ParameterDataTypeVar
+from .parameter_base import InstrumentTypeVar_co, ParameterBase, ParameterDataTypeVar
 from .sequence_helpers import is_sequence_of
 
 if TYPE_CHECKING:
@@ -41,8 +41,8 @@
 
 
 class ArrayParameter(
-    ParameterBase[ParameterDataTypeVar, InstrumentType_co],
-    Generic[ParameterDataTypeVar, InstrumentType_co],
+    ParameterBase[ParameterDataTypeVar, InstrumentTypeVar_co],
+    Generic[ParameterDataTypeVar, InstrumentTypeVar_co],
 ):
     """
     A gettable parameter that returns an array of values.
@@ -133,9 +133,9 @@ def __init__(
         self,
         name: str,
         shape: Sequence[int],
-        # mypy seems to be confused here. The bound and default for InstrumentType_co
+        # mypy seems to be confused here. The bound and default for InstrumentTypeVar_co
         # contains None but mypy will not allow it as a default as of v 1.19.0
-        instrument: InstrumentType_co = None,  # type: ignore[assignment]
+        instrument: InstrumentTypeVar_co = None,  # type: ignore[assignment]
         label: str | None = None,
         unit: str | None = None,
         setpoints: Sequence[Any] | None = None,

src/qcodes/parameters/delegate_parameter.py

@@ -5,7 +5,7 @@
 from typing_extensions import TypeVar
 
 from .parameter import Parameter
-from .parameter_base import InstrumentType_co, ParameterDataTypeVar
+from .parameter_base import InstrumentTypeVar_co, ParameterDataTypeVar
 
 if TYPE_CHECKING:
     from collections.abc import Sequence
@@ -22,17 +22,17 @@
 # Generic type variables for inner cache class
 # these need to be different variables such that both classes can be generic
 _local_ParameterDataTypeVar = TypeVar("_local_ParameterDataTypeVar", default=Any)
-_local_InstrumentType_co = TypeVar(
-    "_local_InstrumentType_co",
+_local_InstrumentTypeVar_co = TypeVar(
+    "_local_InstrumentTypeVar_co",
     bound="InstrumentBase | None",
     default="InstrumentBase | None",
     covariant=True,
 )
 
 
 class DelegateParameter(
-    Parameter[ParameterDataTypeVar, InstrumentType_co],
-    Generic[ParameterDataTypeVar, InstrumentType_co],
+    Parameter[ParameterDataTypeVar, InstrumentTypeVar_co],
+    Generic[ParameterDataTypeVar, InstrumentTypeVar_co],
 ):
     """
     The :class:`.DelegateParameter` wraps a given `source` :class:`Parameter`.
@@ -72,12 +72,12 @@ class DelegateParameter(
     """
 
     class _DelegateCache(
-        Generic[_local_ParameterDataTypeVar, _local_InstrumentType_co]
+        Generic[_local_ParameterDataTypeVar, _local_InstrumentTypeVar_co]
     ):
         def __init__(
             self,
             parameter: DelegateParameter[
-                _local_ParameterDataTypeVar, _local_InstrumentType_co
+                _local_ParameterDataTypeVar, _local_InstrumentTypeVar_co
             ],
         ):
             self._parameter = parameter
@@ -210,7 +210,9 @@ def __init__(
         # i.e. _SetParamContext overrides it
         self._settable = True
 
-        self.cache = self._DelegateCache[ParameterDataTypeVar, InstrumentType_co](self)
+        self.cache = self._DelegateCache[ParameterDataTypeVar, InstrumentTypeVar_co](
+            self
+        )
         if initial_cache_value is not None:
             self.cache.set(initial_cache_value)
 

src/qcodes/parameters/multi_parameter.py

@@ -6,7 +6,7 @@
 
 import numpy as np
 
-from .parameter_base import InstrumentType_co, ParameterBase, ParameterDataTypeVar
+from .parameter_base import InstrumentTypeVar_co, ParameterBase, ParameterDataTypeVar
 from .sequence_helpers import is_sequence_of
 
 try:
@@ -48,8 +48,8 @@ def _is_nested_sequence_or_none(
 
 
 class MultiParameter(
-    ParameterBase[ParameterDataTypeVar, InstrumentType_co],
-    Generic[ParameterDataTypeVar, InstrumentType_co],
+    ParameterBase[ParameterDataTypeVar, InstrumentTypeVar_co],
+    Generic[ParameterDataTypeVar, InstrumentTypeVar_co],
 ):
     """
     A gettable parameter that returns multiple values with separate names,
@@ -141,9 +141,9 @@ def __init__(
         name: str,
         names: Sequence[str],
         shapes: Sequence[Sequence[int]],
-        # mypy seems to be confused here. The bound and default for InstrumentType_co
+        # mypy seems to be confused here. The bound and default for InstrumentTypeVar_co
         # contains None but mypy will not allow it as a default as of v 1.19.0
-        instrument: InstrumentType_co = None,  # type: ignore[assignment]
+        instrument: InstrumentTypeVar_co = None,  # type: ignore[assignment]
         labels: Sequence[str] | None = None,
         units: Sequence[str] | None = None,
         setpoints: Sequence[Sequence[Any]] | None = None,

src/qcodes/parameters/parameter.py

@@ -10,7 +10,7 @@
 
 from .command import Command
 from .parameter_base import (
-    InstrumentType_co,
+    InstrumentTypeVar_co,
     ParameterBase,
     ParameterDataTypeVar,
     ParamRawDataType,
@@ -30,8 +30,8 @@
 
 
 class Parameter(
-    ParameterBase[ParameterDataTypeVar, InstrumentType_co],
-    Generic[ParameterDataTypeVar, InstrumentType_co],
+    ParameterBase[ParameterDataTypeVar, InstrumentTypeVar_co],
+    Generic[ParameterDataTypeVar, InstrumentTypeVar_co],
 ):
     """
     A parameter represents a single degree of freedom. Most often,
@@ -180,9 +180,9 @@ class Parameter(
     def __init__(
         self,
         name: str,
-        # mypy seems to be confused here. The bound and default for InstrumentType_co
+        # mypy seems to be confused here. The bound and default for InstrumentTypeVar_co
         # contains None but mypy will not allow None as a default as of v 1.19.0
-        instrument: InstrumentType_co = None,  # type: ignore[assignment]
+        instrument: InstrumentTypeVar_co = None,  # type: ignore[assignment]
         label: str | None = None,
         unit: str | None = None,
         get_cmd: str | Callable[..., Any] | Literal[False] | None = None,

src/qcodes/parameters/parameter_base.py

@@ -45,13 +45,13 @@
     from qcodes.instrument import InstrumentBase
     from qcodes.logger.instrument_logger import InstrumentLoggerAdapter
 ParameterDataTypeVar = TypeVar("ParameterDataTypeVar", default=Any)
-# InstrumentType_co is a covariant type variable representing the instrument
+# InstrumentTypeVar_co is a covariant type variable representing the instrument
 # type associated with the parameter. It needs to be covariant to allow passing
 # a Parameter bound to None or a specific instrument where the default is used in the type hint.
 # Otherwise we see errors such as
 # Type parameter "InstrumentType@ParameterBase" is invariant, but "None" is not the same as "InstrumentBase | None"
-InstrumentType_co = TypeVar(
-    "InstrumentType_co",
+InstrumentTypeVar_co = TypeVar(
+    "InstrumentTypeVar_co",
     bound="InstrumentBase | None",
     default="InstrumentBase | None",
     covariant=True,
@@ -125,7 +125,7 @@ def invert_val_mapping(val_mapping: Mapping[Any, Any]) -> dict[Any, Any]:
 
 
 class ParameterBase(
-    MetadatableWithName, Generic[ParameterDataTypeVar, InstrumentType_co]
+    MetadatableWithName, Generic[ParameterDataTypeVar, InstrumentTypeVar_co]
 ):
     """
     Shared behavior for all parameters. Not intended to be used
@@ -229,7 +229,7 @@ class ParameterBase(
     def __init__(
         self,
         name: str,
-        instrument: InstrumentType_co,
+        instrument: InstrumentTypeVar_co,
         snapshot_get: bool = True,
         metadata: Mapping[Any, Any] | None = None,
         step: float | None = None,
@@ -1063,7 +1063,7 @@ def register_name(self) -> str:
         return self._register_name or self.full_name
 
     @property
-    def instrument(self) -> InstrumentType_co:
+    def instrument(self) -> InstrumentTypeVar_co:
         """
         Return the first instrument that this parameter is bound to.
         E.g if this is bound to a channel it will return the channel

src/qcodes/parameters/parameter_with_setpoints.py

@@ -9,7 +9,7 @@
     Parameter,
 )
 from qcodes.parameters.parameter_base import (
-    InstrumentType_co,
+    InstrumentTypeVar_co,
     ParameterBase,
     ParameterDataTypeVar,
     ParameterSet,
@@ -26,8 +26,8 @@
 
 
 class ParameterWithSetpoints(
-    Parameter[ParameterDataTypeVar, InstrumentType_co],
-    Generic[ParameterDataTypeVar, InstrumentType_co],
+    Parameter[ParameterDataTypeVar, InstrumentTypeVar_co],
+    Generic[ParameterDataTypeVar, InstrumentTypeVar_co],
 ):
     """
     A parameter that has associated setpoints. The setpoints is nothing