Keysight refactor

docs/changes/newsfragments/6115.improved_driver

@@ -1,4 +1,4 @@
-The Keithley  drivers shipping with QCoDeS
+The Keithley drivers shipping with QCoDeS
 have been updated to ensure all Parameters are set as static
 attributes that are documented and can be type checked. The docs for the same drivers have been
 updated to not document inherited members. This makes the documentation significantly more readable

docs/changes/newsfragments/6125.improved_driver

@@ -0,0 +1,6 @@
+The Keysight drivers shipping with QCoDeS
+have been updated to ensure all Parameters are set as static
+attributes that are documented and can be type checked. The docs for the same drivers have been
+updated to not document inherited members. This makes the documentation significantly more readable
+as it focuses on specific members for a given instrument. The documentation now also links superclasses.
+Please consult these for inherited members.

docs/drivers_api/Keysight.rst

@@ -5,3 +5,4 @@ Keysight Drivers
 
 .. automodule:: qcodes.instrument_drivers.Keysight
     :autosummary:
+    :no-inherited-members:

src/qcodes/instrument_drivers/Keysight/Infiniium.py

@@ -125,7 +125,7 @@
         """
         instrument = self.instrument
         if isinstance(instrument, KeysightInfiniiumChannel):
-            root_instrument: "KeysightInfiniium"
+            root_instrument: KeysightInfiniium
             root_instrument = self.root_instrument  # type: ignore[assignment]
             cache_setpoints = root_instrument.cache_setpoints()
             if not cache_setpoints:
@@ -206,7 +206,7 @@
         """
         if self.instrument is None:
             raise RuntimeError("Cannot get data without instrument")
-        root_instr: "KeysightInfiniium" = self.root_instrument  # type: ignore[assignment]
+        root_instr: KeysightInfiniium = self.root_instrument  # type: ignore[assignment]
         # Check if we can use cached trace parameters
         if not root_instr.cache_setpoints():
             self.update_setpoints()

src/qcodes/instrument_drivers/Keysight/Keysight_33210a.py

@@ -1,7 +1,7 @@
-from .KeysightAgilent_33XXX import WaveformGenerator_33XXX
+from .KeysightAgilent_33XXX import Keysight33xxx
 
 
-class Keysight33210A(WaveformGenerator_33XXX):
+class Keysight33210A(Keysight33xxx):
     """
     QCoDeS driver for the Keysight 33210A waveform generator.
     """

src/qcodes/instrument_drivers/Keysight/Keysight_33250a.py

@@ -1,7 +1,7 @@
-from .KeysightAgilent_33XXX import WaveformGenerator_33XXX
+from .KeysightAgilent_33XXX import Keysight33xxx
 
 
-class Keysight33250A(WaveformGenerator_33XXX):
+class Keysight33250A(Keysight33xxx):
     """
     QCoDeS driver for the Keysight 33250A waveform generator.
     """

src/qcodes/instrument_drivers/Keysight/Keysight_33510b.py

@@ -1,7 +1,7 @@
-from .KeysightAgilent_33XXX import WaveformGenerator_33XXX
+from .KeysightAgilent_33XXX import Keysight33xxx
 
 
-class Keysight33510B(WaveformGenerator_33XXX):
+class Keysight33510B(Keysight33xxx):
     """
     QCoDeS driver for the Keysight 33510B waveform generator.
     """

src/qcodes/instrument_drivers/Keysight/Keysight_33511b.py

@@ -1,7 +1,7 @@
-from .KeysightAgilent_33XXX import WaveformGenerator_33XXX
+from .KeysightAgilent_33XXX import Keysight33xxx
 
 
-class Keysight33511B(WaveformGenerator_33XXX):
+class Keysight33511B(Keysight33xxx):
     """
     QCoDeS driver for the Keysight 33511B waveform generator.
     """

src/qcodes/instrument_drivers/Keysight/Keysight_33512b.py

@@ -1,7 +1,7 @@
-from .KeysightAgilent_33XXX import WaveformGenerator_33XXX
+from .KeysightAgilent_33XXX import Keysight33xxx
 
 
-class Keysight33512B(WaveformGenerator_33XXX):
+class Keysight33512B(Keysight33xxx):
     """
     QCoDeS driver for the Keysight 33512B waveform generator.
     """

src/qcodes/instrument_drivers/Keysight/Keysight_33522b.py

@@ -1,7 +1,7 @@
-from .KeysightAgilent_33XXX import WaveformGenerator_33XXX
+from .KeysightAgilent_33XXX import Keysight33xxx
 
 
-class Keysight33522B(WaveformGenerator_33XXX):
+class Keysight33522B(Keysight33xxx):
     """
     QCoDeS driver for the Keysight 33522B waveform generator.
     """

src/qcodes/instrument_drivers/Keysight/Keysight_33622a.py

@@ -1,7 +1,7 @@
-from .KeysightAgilent_33XXX import WaveformGenerator_33XXX
+from .KeysightAgilent_33XXX import Keysight33xxx
 
 
-class Keysight33622A(WaveformGenerator_33XXX):
+class Keysight33622A(Keysight33xxx):
     """
     QCoDeS driver for the Keysight 33622A waveform generator.
     """

src/qcodes/instrument_drivers/Keysight/Keysight_34410A_submodules.py

@@ -1,14 +1,18 @@
 from typing import TYPE_CHECKING
 
-from .private.Keysight_344xxA_submodules import _Keysight_344xxA
+from typing_extensions import deprecated
+
+from qcodes.utils import QCoDeSDeprecationWarning
+
+from .private.Keysight_344xxA_submodules import Keysight344xxA
 
 if TYPE_CHECKING:
     from typing_extensions import Unpack
 
     from qcodes.instrument import VisaInstrumentKWArgs
 
 
-class Keysight34410A(_Keysight_344xxA):
+class Keysight34410A(Keysight344xxA):
     """
     This is the qcodes driver for the Keysight 34410A Multimeter
     """
@@ -23,6 +27,7 @@ def __init__(
         super().__init__(name, address, silent, **kwargs)
 
 
+@deprecated("Use Keysight34410A", category=QCoDeSDeprecationWarning)
 class Keysight_34410A(Keysight34410A):
     """
     Alias for backwards compatibility.

src/qcodes/instrument_drivers/Keysight/Keysight_34411A_submodules.py

@@ -1,14 +1,18 @@
 from typing import TYPE_CHECKING
 
-from .private.Keysight_344xxA_submodules import _Keysight_344xxA
+from typing_extensions import deprecated
+
+from qcodes.utils import QCoDeSDeprecationWarning
+
+from .private.Keysight_344xxA_submodules import Keysight344xxA
 
 if TYPE_CHECKING:
     from typing_extensions import Unpack
 
     from qcodes.instrument import VisaInstrumentKWArgs
 
 
-class Keysight34411A(_Keysight_344xxA):
+class Keysight34411A(Keysight344xxA):
     """
     This is the qcodes driver for the Keysight 34411A Multimeter
     """
@@ -23,6 +27,7 @@ def __init__(
         super().__init__(name, address, silent, **kwargs)
 
 
+@deprecated("Use Keysight34411A", category=QCoDeSDeprecationWarning)
 class Keysight_34411A(Keysight34411A):
     """
     Alias for backwards compatibility.

src/qcodes/instrument_drivers/Keysight/Keysight_34460A_submodules.py

@@ -1,14 +1,18 @@
 from typing import TYPE_CHECKING
 
-from .private.Keysight_344xxA_submodules import _Keysight_344xxA
+from typing_extensions import deprecated
+
+from qcodes.utils import QCoDeSDeprecationWarning
+
+from .private.Keysight_344xxA_submodules import Keysight344xxA
 
 if TYPE_CHECKING:
     from typing_extensions import Unpack
 
     from qcodes.instrument import VisaInstrumentKWArgs
 
 
-class Keysight34460A(_Keysight_344xxA):
+class Keysight34460A(Keysight344xxA):
     """
     This is the qcodes driver for the Keysight 34460A Multimeter
     """
@@ -23,6 +27,7 @@ def __init__(
         super().__init__(name, address, silent, **kwargs)
 
 
+@deprecated("Use Keysight34460A", category=QCoDeSDeprecationWarning)
 class Keysight_34460A(Keysight34460A):
     """
     Alias for backwards compatibility.

src/qcodes/instrument_drivers/Keysight/Keysight_34461A_submodules.py

@@ -1,14 +1,18 @@
 from typing import TYPE_CHECKING
 
-from .private.Keysight_344xxA_submodules import _Keysight_344xxA
+from typing_extensions import deprecated
+
+from qcodes.utils import QCoDeSDeprecationWarning
+
+from .private.Keysight_344xxA_submodules import Keysight344xxA
 
 if TYPE_CHECKING:
     from typing_extensions import Unpack
 
     from qcodes.instrument import VisaInstrumentKWArgs
 
 
-class Keysight34461A(_Keysight_344xxA):
+class Keysight34461A(Keysight344xxA):
     """
     This is the qcodes driver for the Keysight 34461A Multimeter
     """
@@ -23,7 +27,8 @@ def __init__(
         super().__init__(name, address, silent, **kwargs)
 
 
-class Keysight_34461A(_Keysight_344xxA):
+@deprecated("Use Keysight34461A", category=QCoDeSDeprecationWarning)
+class Keysight_34461A(Keysight344xxA):
     """
     Alias for backwards compatibility.
     """

src/qcodes/instrument_drivers/Keysight/Keysight_34465A_submodules.py

@@ -1,14 +1,18 @@
 from typing import TYPE_CHECKING
 
-from .private.Keysight_344xxA_submodules import _Keysight_344xxA
+from typing_extensions import deprecated
+
+from qcodes.utils import QCoDeSDeprecationWarning
+
+from .private.Keysight_344xxA_submodules import Keysight344xxA
 
 if TYPE_CHECKING:
     from typing_extensions import Unpack
 
     from qcodes.instrument import VisaInstrumentKWArgs
 
 
-class Keysight34465A(_Keysight_344xxA):
+class Keysight34465A(Keysight344xxA):
     """
     This is the qcodes driver for the Keysight 34465A Multimeter
     """
@@ -23,6 +27,7 @@ def __init__(
         super().__init__(name, address, silent, **kwargs)
 
 
+@deprecated("Use Keysight34461A", category=QCoDeSDeprecationWarning)
 class Keysight_34465A(Keysight34465A):
     """
     Alias for backwards compatibility.

src/qcodes/instrument_drivers/Keysight/Keysight_34470A_submodules.py

@@ -1,14 +1,18 @@
 from typing import TYPE_CHECKING
 
-from .private.Keysight_344xxA_submodules import _Keysight_344xxA
+from typing_extensions import deprecated
+
+from qcodes.utils.deprecate import QCoDeSDeprecationWarning
+
+from .private.Keysight_344xxA_submodules import Keysight344xxA
 
 if TYPE_CHECKING:
     from typing_extensions import Unpack
 
     from qcodes.instrument import VisaInstrumentKWArgs
 
 
-class Keysight34470A(_Keysight_344xxA):
+class Keysight34470A(Keysight344xxA):
     """
     This is the qcodes driver for the Keysight 34470A Multimeter
     """
@@ -23,6 +27,7 @@ def __init__(
         super().__init__(name, address, silent, **kwargs)
 
 
+@deprecated("Use Keysight34460A", category=QCoDeSDeprecationWarning)
 class Keysight_34470A(Keysight34470A):
     """
     Alias for backwards compatibility.