Deprecate legacy alias modules in qcodes.instrument_drivers

docs/changes/newsfragments/7292.breaking

@@ -0,0 +1,139 @@
+Legacy backwards-compatibility aliases across the ``instrument_drivers`` module have been
+deprecated. Users should migrate to the canonical class names listed below. All deprecated
+names will be removed in a future release.
+
+**AlazarTech**
+
+- Class ``AlazarTech_ATS9360`` is deprecated. Use ``AlazarTechATS9360`` instead.
+- Class ``AlazarTech_ATS9373`` is deprecated. Use ``AlazarTechATS9373`` instead.
+- Class ``AlazarTech_ATS9440`` is deprecated. Use ``AlazarTechATS9440`` instead.
+- Class ``AlazarTech_ATS9870`` is deprecated. Use ``AlazarTechATS9870`` instead.
+- Class ``Demodulation_AcquisitionController`` is deprecated. Use ``DemodulationAcquisitionController`` instead.
+
+**Basel**
+
+- Module ``qcodes.instrument_drivers.basel.sp983c`` is deprecated. Import from ``qcodes.instrument_drivers.basel`` instead.
+- Module ``qcodes.instrument_drivers.basel.sp983c_remote`` is deprecated. Import from ``qcodes.instrument_drivers.basel`` instead.
+
+**Galil**
+
+- Class ``VectorMode`` is deprecated. Use ``GalilDMC4133VectorMode`` instead.
+- Class ``Motor`` is deprecated. Use ``GalilDMC4133Motor`` instead.
+- Class ``DMC4133Controller`` is deprecated. Use ``GalilDMC4133Controller`` instead.
+- Class ``Arm`` is deprecated. Use ``GalilDMC4133Arm`` instead.
+
+**HP**
+
+- Module ``qcodes.instrument_drivers.HP.HP8133A`` is deprecated. Import from ``qcodes.instrument_drivers.HP`` instead.
+- Module ``qcodes.instrument_drivers.HP.HP8753D`` is deprecated. Import from ``qcodes.instrument_drivers.HP`` instead.
+- Class ``HP_83650A`` is deprecated. Use ``HP83650A`` instead.
+
+**Ithaco**
+
+- Class ``Ithaco_1211`` is deprecated. Use ``Ithaco1211`` instead.
+
+**Keithley / Tektronix**
+
+- Module ``qcodes.instrument_drivers.tektronix.Keithley_2450`` is deprecated. Import from ``qcodes.instrument_drivers.Keithley`` instead.
+- Module ``qcodes.instrument_drivers.tektronix.keithley_7510`` is deprecated. Import from ``qcodes.instrument_drivers.Keithley`` instead.
+- Module ``qcodes.instrument_drivers.tektronix.Keithley_s46`` is deprecated. Import from ``qcodes.instrument_drivers.Keithley`` instead.
+- Class ``Keithley_2000`` is deprecated. Use ``Keithley2000`` instead.
+- Class ``Keithley_2400`` is deprecated. Use ``Keithley2400`` instead.
+- Class ``Keithley_2600`` is deprecated. Use ``Keithley2600`` instead.
+- Class ``Keithley_3706A`` is deprecated. Use ``Keithley3706A`` instead.
+- Class ``Keithley_6500`` is deprecated. Use ``Keithley6500`` instead.
+- Class ``S46`` is deprecated. Use ``KeithleyS46`` instead.
+
+**Keysight**
+
+- Class ``B2962A`` is deprecated. Use ``KeysightB2962A`` instead.
+- Class ``MeasurementPair`` is deprecated. Use ``KeysightE4980AMeasurementPair`` instead.
+- Class ``E4980AMeasurements`` is deprecated. Use ``KeysightE4980AMeasurements`` instead.
+- Class ``Correction4980A`` is deprecated. Use ``KeysightE4980ACorrection`` instead.
+- Class ``BoundMeasurement`` is deprecated. Use ``KeysightInfiniiumBoundMeasurement`` instead.
+- Class ``UnboundMeasurement`` is deprecated. Use ``KeysightInfiniiumUnboundMeasurement`` instead.
+- Class ``InfiniiumFunction`` is deprecated. Use ``KeysightInfiniiumFunction`` instead.
+- Class ``InfiniiumChannel`` is deprecated. Use ``KeysightInfiniiumChannel`` instead.
+- Class ``Infiniium`` is deprecated. Use ``KeysightInfiniium`` instead.
+- Class ``N5173B`` is deprecated. Use ``KeysightN5173B`` instead.
+- Class ``N5183B`` is deprecated. Use ``KeysightN5183B`` instead.
+- Class ``N5222B`` is deprecated. Use ``KeysightN5222B`` instead.
+- Class ``N5230C`` is deprecated. Use ``KeysightN5230C`` instead.
+- Class ``N5245A`` is deprecated. Use ``KeysightN5245A`` instead.
+- Class ``N6705BChannel`` is deprecated. Use ``KeysightN6705BChannel`` instead.
+- Class ``N6705B`` is deprecated. Use ``KeysightN6705B`` instead.
+- Class ``N9030B`` is deprecated. Use ``KeysightN9030B`` instead.
+- Class ``P9374A`` is deprecated. Use ``KeysightP9374A`` instead.
+- Class ``KtM960x`` is deprecated. Use ``KeysightM960x`` instead.
+- Class ``KtMAWGChannel`` is deprecated. Use ``KeysightM9336AAWGChannel`` instead.
+- Class ``KtMAwg`` is deprecated. Use ``KeysightM9336A`` instead.
+
+**Keysight B1500**
+
+- Class ``B1511B`` is deprecated. Use ``KeysightB1511B`` instead.
+- Class ``IVSweeper`` is deprecated. Use ``KeysightB1500IVSweeper`` instead.
+- Class ``B1517A`` is deprecated. Use ``KeysightB1517A`` instead.
+- Class ``CVSweeper`` is deprecated. Use ``KeysightB1500CVSweeper`` instead.
+- Class ``B1520A`` is deprecated. Use ``KeysightB1520A`` instead.
+- Class ``CVSweepMeasurement`` is deprecated. Use ``KeysightB1500CVSweepMeasurement`` instead.
+- Class ``Correction`` is deprecated. Use ``KeysightB1500Correction`` instead.
+- Class ``FrequencyList`` is deprecated. Use ``KeysightB1500FrequencyList`` instead.
+- Class ``B1530A`` is deprecated. Use ``KeysightB1530A`` instead.
+
+**Mini-Circuits**
+
+- Class ``MC_channel`` (RC_SP4T) is deprecated. Use ``MiniCircuitsRCSP4TChannel`` instead.
+- Class ``RC_SP4T`` is deprecated. Use ``MiniCircuitsRCSP4T`` instead.
+- Class ``MC_channel`` (RC_SPDT) is deprecated. Use ``MiniCircuitsRCSPDTChannel`` instead.
+- Class ``RC_SPDT`` is deprecated. Use ``MiniCircuitsRCSPDT`` instead.
+- Class ``SwitchChannelUSB`` is deprecated. Use ``MiniCircuitsUsbSPDTSwitchChannel`` instead.
+- Class ``USB_SPDT`` is deprecated. Use ``MiniCircuitsUsbSPDT`` instead.
+- Class ``RUDAT_13G_90`` is deprecated. Use ``MiniCircuitsRudat13G90Base`` instead.
+- Class ``RUDAT_13G_90_USB`` is deprecated. Use ``MiniCircuitsRudat13G90Usb`` instead.
+
+**Oxford Instruments**
+
+- Class ``Triton`` is deprecated. Use ``OxfordTriton`` instead.
+- Class ``MercuryWorkerPS`` is deprecated. Use ``OxfordMercuryWorkerPS`` instead.
+- Class ``MercuryiPS`` is deprecated. Use ``OxfordMercuryiPS`` instead.
+
+**Rigol**
+
+- Module ``qcodes.instrument_drivers.rigol.DG1062`` is deprecated. Import from ``qcodes.instrument_drivers.rigol`` instead.
+- Module ``qcodes.instrument_drivers.rigol.DG4000`` is deprecated. Import from ``qcodes.instrument_drivers.rigol`` instead.
+- Module ``qcodes.instrument_drivers.rigol.DP821`` is deprecated. Import from ``qcodes.instrument_drivers.rigol`` instead.
+- Module ``qcodes.instrument_drivers.rigol.DP831`` is deprecated. Import from ``qcodes.instrument_drivers.rigol`` instead.
+- Module ``qcodes.instrument_drivers.rigol.DP832`` is deprecated. Import from ``qcodes.instrument_drivers.rigol`` instead.
+- Module ``qcodes.instrument_drivers.rigol.DS1074Z`` is deprecated. Import from ``qcodes.instrument_drivers.rigol`` instead.
+- Module ``qcodes.instrument_drivers.rigol.DS4000`` is deprecated. Import from ``qcodes.instrument_drivers.rigol`` instead.
+
+**Rohde & Schwarz**
+
+- Class ``RohdeSchwarz_SGS100A`` is deprecated. Use ``RohdeSchwarzSGS100A`` instead.
+
+**Signal Hound**
+
+- Class ``SignalHound_USB_SA124B`` is deprecated. Use ``SignalHoundUSBSA124B`` instead.
+
+**Stanford Research Systems**
+
+- Class ``SRS_SG384`` is deprecated. Use ``SG384`` instead.
+
+**Tektronix**
+
+- Class ``AWG5208`` is deprecated. Use ``TektronixAWG5208`` instead.
+- Class ``AWG70002A`` is deprecated. Use ``TektronixAWG70002A`` instead.
+- Class ``AWGChannel`` is deprecated. Use ``Tektronix70000AWGChannel`` instead.
+- Class ``Tektronix_AWG5014`` is deprecated. Use ``TektronixAWG5014`` instead.
+- Class ``ModeError`` is deprecated. Use ``TektronixDPOModeError`` instead.
+
+**Weinschel**
+
+- Class ``Weinschel_8320`` is deprecated. Use ``Weinschel8320`` instead.
+
+**Yokogawa**
+
+- Class ``GS200Exception`` is deprecated. Use ``YokogawaGS200Exception`` instead.
+- Class ``GS200_Monitor`` is deprecated. Use ``YokogawaGS200Monitor`` instead.
+- Class ``GS200Program`` is deprecated. Use ``YokogawaGS200Program`` instead.
+- Class ``GS200`` is deprecated. Use ``YokogawaGS200`` instead.

src/qcodes/instrument_drivers/AlazarTech/ATS9360.py

@@ -2,8 +2,10 @@
 
 import numpy as np
 from packaging import version
+from typing_extensions import deprecated
 
 from qcodes import validators
+from qcodes.utils.deprecate import QCoDeSDeprecationWarning
 
 from .ATS import AlazarTechATS
 from .utils import TraceParameter
@@ -482,6 +484,11 @@ def _set_trigger_holdoff(self, value: bool) -> None:
         self._write_register(58, int(new_value))
 
 
+@deprecated(
+    "AlazarTech_ATS9360 is deprecated. Please use qcodes.instrument_drivers.AlazarTech.AlazarTechATS9360 instead.",
+    category=QCoDeSDeprecationWarning,
+    stacklevel=1,
+)
 class AlazarTech_ATS9360(AlazarTechATS9360):
     """
     Alias for backwards compatibility. Will eventually be deprecated and removed

src/qcodes/instrument_drivers/AlazarTech/ATS9373.py

@@ -2,10 +2,12 @@
 
 import numpy as np
 from packaging import version
+from typing_extensions import deprecated
 
 from qcodes import validators
 from qcodes.instrument_drivers.AlazarTech.ATS import AlazarTechATS
 from qcodes.instrument_drivers.AlazarTech.utils import TraceParameter
+from qcodes.utils.deprecate import QCoDeSDeprecationWarning
 
 if TYPE_CHECKING:
     from qcodes.parameters import Parameter
@@ -497,6 +499,11 @@ def _set_trigger_holdoff(self, value: bool) -> None:
         self._write_register(58, int(new_value))
 
 
+@deprecated(
+    "AlazarTech_ATS9373 is deprecated. Please use qcodes.instrument_drivers.AlazarTech.AlazarTechATS9373 instead.",
+    category=QCoDeSDeprecationWarning,
+    stacklevel=1,
+)
 class AlazarTech_ATS9373(AlazarTechATS9373):
     """
     Alias for backwards compatibility. Will eventually be deprecated and removed

src/qcodes/instrument_drivers/AlazarTech/ATS9440.py

@@ -1,6 +1,9 @@
 from typing import TYPE_CHECKING, Any
 
+from typing_extensions import deprecated
+
 from qcodes import validators
+from qcodes.utils.deprecate import QCoDeSDeprecationWarning
 
 from .ATS import AlazarTechATS
 from .utils import TraceParameter
@@ -397,6 +400,11 @@ def __init__(
         """Parameter buffer_timeout"""
 
 
+@deprecated(
+    "AlazarTech_ATS9440 is deprecated. Please use qcodes.instrument_drivers.AlazarTech.AlazarTechATS9440 instead.",
+    category=QCoDeSDeprecationWarning,
+    stacklevel=1,
+)
 class AlazarTech_ATS9440(AlazarTechATS9440):
     """
     Alias for backwards compatibility. Will eventually be deprecated and removed

src/qcodes/instrument_drivers/AlazarTech/ATS9870.py

@@ -1,6 +1,9 @@
 from typing import TYPE_CHECKING, Any
 
+from typing_extensions import deprecated
+
 from qcodes import validators
+from qcodes.utils.deprecate import QCoDeSDeprecationWarning
 
 from .ATS import AlazarTechATS
 from .utils import TraceParameter
@@ -405,6 +408,11 @@ def __init__(
             )
 
 
+@deprecated(
+    "AlazarTech_ATS9870 is deprecated. Please use qcodes.instrument_drivers.AlazarTech.AlazarTechATS9870 instead.",
+    category=QCoDeSDeprecationWarning,
+    stacklevel=1,
+)
 class AlazarTech_ATS9870(AlazarTechATS9870):
     """
     Alias for backwards compatibility. Will eventually be deprecated and removed

src/qcodes/instrument_drivers/AlazarTech/ATS_acquisition_controllers.py

@@ -3,6 +3,9 @@
 
 import numpy as np
 import numpy.typing as npt
+from typing_extensions import deprecated
+
+from qcodes.utils.deprecate import QCoDeSDeprecationWarning
 
 from .ATS import AcquisitionController
 
@@ -166,6 +169,11 @@ def fit(self, buf: npt.NDArray) -> tuple[float, float]:
         return ampl, math.atan2(ImPart, RePart) * 360 / (2 * math.pi)
 
 
+@deprecated(
+    "Demodulation_AcquisitionController is deprecated. Please use qcodes.instrument_drivers.AlazarTech.DemodulationAcquisitionController instead.",
+    category=QCoDeSDeprecationWarning,
+    stacklevel=1,
+)
 class Demodulation_AcquisitionController(DemodulationAcquisitionController):
     """
     Alias for backwards compatibility. Will eventually be deprecated and removed

src/qcodes/instrument_drivers/Galil/dmc_41x3.py

@@ -8,8 +8,10 @@
 
 import numpy as np
 import numpy.typing as npt
+from typing_extensions import deprecated
 
 from qcodes.instrument import Instrument, InstrumentBaseKWArgs, InstrumentChannel
+from qcodes.utils.deprecate import QCoDeSDeprecationWarning
 from qcodes.validators import Enum, Ints, Multiples
 
 if TYPE_CHECKING:
@@ -248,10 +250,17 @@ def clear_sequence(self, coord_sys: str) -> None:
         self.write(f"CS {coord_sys}")
 
 
-VectorMode = GalilDMC4133VectorMode
-"""
-Alias for backwards compatibility
-"""
+@deprecated(
+    "VectorMode is deprecated. Please use qcodes.instrument_drivers.Galil.GalilDMC4133VectorMode instead.",
+    category=QCoDeSDeprecationWarning,
+    stacklevel=1,
+)
+class VectorMode(GalilDMC4133VectorMode):
+    """
+    Alias for backwards compatibility
+    """
+
+    pass
 
 
 class GalilDMC4133Motor(InstrumentChannel["GalilDMC4133Controller"]):
@@ -470,10 +479,17 @@ def error_magnitude(self) -> float:
         return float(self.ask(f"QS{self._axis}=?"))
 
 
-Motor = GalilDMC4133Motor
-"""
-Alias for backwards compatibility
-"""
+@deprecated(
+    "Motor is deprecated. Please use qcodes.instrument_drivers.Galil.GalilDMC4133Motor instead.",
+    category=QCoDeSDeprecationWarning,
+    stacklevel=1,
+)
+class Motor(GalilDMC4133Motor):
+    """
+    Alias for backwards compatibility
+    """
+
+    pass
 
 
 class GalilDMC4133Controller(GalilMotionController):
@@ -629,10 +645,17 @@ def wait_till_motion_complete(self) -> None:
             self.motors_off()
 
 
-DMC4133Controller = GalilDMC4133Controller
-"""
-Alias for backwards compatibility
-"""
+@deprecated(
+    "DMC4133Controller is deprecated. Please use qcodes.instrument_drivers.Galil.GalilDMC4133Controller instead.",
+    category=QCoDeSDeprecationWarning,
+    stacklevel=1,
+)
+class DMC4133Controller(GalilDMC4133Controller):
+    """
+    Alias for backwards compatibility
+    """
+
+    pass
 
 
 class GalilDMC4133Arm:
@@ -1145,7 +1168,14 @@ def _calculate_vector_component(vec: float, val: int) -> int:
     return return_val
 
 
-Arm = GalilDMC4133Arm
-"""
-Alias for backwards compatibility
-"""
+@deprecated(
+    "Arm is deprecated. Please use qcodes.instrument_drivers.Galil.GalilDMC4133Arm instead.",
+    category=QCoDeSDeprecationWarning,
+    stacklevel=1,
+)
+class Arm(GalilDMC4133Arm):
+    """
+    Alias for backwards compatibility
+    """
+
+    pass

src/qcodes/instrument_drivers/HP/HP8133A.py

@@ -2,4 +2,15 @@
 Module left for backwards compatibility. Will be deprecated and removed eventually.
 """
 
+import warnings
+
+from qcodes.utils import QCoDeSDeprecationWarning
+
 from .HP_8133A import HP8133A
+
+warnings.warn(
+    "The `qcodes._drivers.HP.HP8133A` module is deprecated. "
+    "Please import drivers from from `qcodes.instrument_drivers.HP` instead.",
+    category=QCoDeSDeprecationWarning,
+    stacklevel=2,
+)

src/qcodes/instrument_drivers/HP/HP8753D.py

@@ -2,4 +2,15 @@
 Module left for backwards compatibility. Will be deprecated and removed eventually.
 """
 
+import warnings
+
+from qcodes.utils import QCoDeSDeprecationWarning
+
 from .HP_8753D import HP8753D
+
+warnings.warn(
+    "The `qcodes._drivers.HP.HP8753D` module is deprecated. "
+    "Please import drivers from from `qcodes.instrument_drivers.HP` instead.",
+    category=QCoDeSDeprecationWarning,
+    stacklevel=2,
+)