Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix typos in two Tektronix channel classes #5932

Merged
merged 4 commits into from
Apr 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/changes/newsfragments/5932.breaking
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Fix spelling of the 2 incorrectly spelled classes
```qcodes.instrument_drivers.tektronix.TekronixDPOTrigger``` and
```qcodes.instrument_drivers.tektronix.TekronixDPOWaveform``` to
```qcodes.instrument_drivers.tektronix.TektronixDPOTrigger```
and ```qcodes.instrument_drivers.tektronix.TektronixDPOWaveform``` .
The old names have been deprecated and will be removed in a future release.
2 changes: 1 addition & 1 deletion docs/examples/Station.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -740,7 +740,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.11.0"
"version": "3.12.1"
},
"mimetype": "text/x-python",
"name": "python",
Expand Down
44 changes: 29 additions & 15 deletions src/qcodes/instrument_drivers/tektronix/DPO7200xx.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,15 @@
from typing import Any, Callable, ClassVar, Union, cast

import numpy as np
from typing_extensions import deprecated

from qcodes.instrument import ChannelList, Instrument, InstrumentChannel, VisaInstrument
from qcodes.parameters import (
Parameter,
ParameterWithSetpoints,
create_on_off_val_mapping,
)
from qcodes.utils import QCoDeSDeprecationWarning
from qcodes.validators import Arrays, Enum


Expand Down Expand Up @@ -115,14 +117,11 @@ def __init__(

self.add_submodule("channel", channel_list)

self.add_submodule(
"trigger",
TekronixDPOTrigger(self, "trigger")
)
self.add_submodule("trigger", TektronixDPOTrigger(self, "trigger"))

self.add_submodule(
"delayed_trigger",
TekronixDPOTrigger(self, "delayed_trigger", delayed_trigger=True)
TektronixDPOTrigger(self, "delayed_trigger", delayed_trigger=True),
)

self.connect_message()
Expand Down Expand Up @@ -173,7 +172,7 @@ def __init__(
"source",
get_cmd="DATa:SOU?",
set_cmd="DATa:SOU {}",
vals=Enum(*TekronixDPOWaveform.valid_identifiers)
vals=Enum(*TektronixDPOWaveform.valid_identifiers),
)

self.add_parameter(
Expand Down Expand Up @@ -201,7 +200,7 @@ def __init__(
)


class TekronixDPOWaveform(InstrumentChannel):
class TektronixDPOWaveform(InstrumentChannel):
"""
This submodule retrieves data from waveform sources, e.g.
channels.
Expand Down Expand Up @@ -356,6 +355,16 @@ def _get_trace_setpoints(self) -> np.ndarray:
return np.linspace(0, x_increment * sample_count, sample_count)


@deprecated(
"TekronixDPOWaveform is deprecated use TektronixDPOWaveform",
category=QCoDeSDeprecationWarning,
)
class TekronixDPOWaveform(TektronixDPOWaveform):
"""
Deprecated alias for backwards compatibility
"""


class TektronixDPOWaveformFormat(InstrumentChannel):
"""
With this sub module we can query waveform
Expand Down Expand Up @@ -431,10 +440,7 @@ def __init__(
self._identifier = f"CH{channel_number}"

self.add_submodule(
"waveform",
TekronixDPOWaveform(
self, "waveform", self._identifier
)
"waveform", TektronixDPOWaveform(self, "waveform", self._identifier)
)

self.add_parameter(
Expand Down Expand Up @@ -618,7 +624,7 @@ def _set_scale(self, value: float) -> None:
self.write(f"HORizontal:MODE:SCAle {value}")


class TekronixDPOTrigger(InstrumentChannel):
class TektronixDPOTrigger(InstrumentChannel):
"""
Submodule for trigger setup.

Expand Down Expand Up @@ -705,6 +711,16 @@ def _trigger_type(self, value: str) -> None:
self.write(f"TRIGger:{self._identifier}:TYPE {value}")


@deprecated(
"TekronixDPOTrigger is deprecated use TektronixDPOTrigger",
category=QCoDeSDeprecationWarning,
)
class TekronixDPOTrigger(TektronixDPOTrigger):
"""
Deprecated alias for backwards compatibility
"""


class TektronixDPOMeasurementParameter(Parameter):
"""
A measurement parameter does not only return the instantaneous value
Expand Down Expand Up @@ -861,9 +877,7 @@ def __init__(
get_cmd=f"MEASUrement:MEAS{self._measurement_number}:SOUrce"
f"{src}?",
set_cmd=partial(self._set_source, src),
vals=Enum(
*(TekronixDPOWaveform.valid_identifiers + ["HISTogram"])
)
vals=Enum(*(TektronixDPOWaveform.valid_identifiers + ["HISTogram"])),
)

@property
Expand Down
10 changes: 7 additions & 3 deletions src/qcodes/instrument_drivers/tektronix/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,17 @@
from .AWG70000A import Tektronix70000AWGChannel
from .AWG70002A import TektronixAWG70002A
from .DPO7200xx import (
TekronixDPOTrigger,
TekronixDPOWaveform,
TekronixDPOTrigger, # pyright: ignore[reportDeprecated]
TekronixDPOWaveform, # pyright: ignore[reportDeprecated]
TektronixDPOChannel,
TektronixDPOData,
TektronixDPOHorizontal,
TektronixDPOMeasurement,
TektronixDPOMeasurementParameter,
TektronixDPOMeasurementStatistics,
TektronixDPOModeError,
TektronixDPOTrigger,
TektronixDPOWaveform,
TektronixDPOWaveformFormat,
)
from .Tektronix_70001A import TektronixAWG70001A
Expand All @@ -26,8 +28,10 @@
from .TPS2012 import TektronixTPS2012, TektronixTPS2012Channel

__all__ = [
"TekronixDPOTrigger",
"TekronixDPOWaveform",
"TekronixDPOTrigger",
"TektronixDPOTrigger",
"TektronixDPOWaveform",
"Tektronix70000AWGChannel",
"TektronixAWG5014",
"TektronixAWG5208",
Expand Down
Loading