1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
|
#
# This file is part of the PyMeasure package.
#
# Copyright (c) 2013-2024 PyMeasure Developers
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
#
from pytest import raises
from pymeasure.test import expected_protocol
from pymeasure.instruments import Instrument
from pymeasure.instruments.validators import strict_range
class BasicTestInstrument(Instrument):
def __init__(self, adapter, name="Basic Test Instrument", **kwargs):
super().__init__(adapter, name)
self.kwargs = kwargs
simple = Instrument.control(
"VOLT?", "VOLT %s V",
"""Simple property replying with plain floats""",
)
limited_control = Instrument.control(
"AMP?", "AMP %g A",
"""Property limited to 0, 10.""",
values=(0, 10),
validator=strict_range
)
with_error_checks = Instrument.control(
"VOLT?", "VOLT %s V",
"""Property with error checks after both setting and getting""",
check_set_errors=True,
check_get_errors=True,
)
def test_simple_protocol():
"""Test a property without parsing or channel prefixes."""
with expected_protocol(
BasicTestInstrument,
[('VOLT?', 3.14),
('VOLT 4.5 V', None)]
) as instr:
assert instr.simple == 3.14
instr.simple = 4.5
def test_kwargs():
"""Test whether the kwargs are handed over correctly."""
with expected_protocol(
BasicTestInstrument,
[],
test=5,
xyz="abc"
) as instr:
assert instr.kwargs == {'test': 5, 'xyz': "abc"}
def test_error_checks():
"""Test protocol for getting and setting with error checks."""
with expected_protocol(
BasicTestInstrument,
[('VOLT?', 3.14),
('SYST:ERR?', '0, 0'),
('VOLT 4.5 V', None),
('SYST:ERR?', '0, 0'),
]
) as instr:
assert instr.with_error_checks == 3.14
instr.with_error_checks = 4.5
def test_not_all_communication_used():
"""Test whether unused communication raises an error."""
with raises(AssertionError, match="Unprocessed protocol definitions remain"):
with expected_protocol(
BasicTestInstrument,
[('VOLT?', 3.14),
('VOLT 4.5 V', None),
]
) as instr:
assert instr.simple == 3.14
def test_non_empty_write_buffer():
with raises(AssertionError, match="Non-empty write buffer remains"):
with expected_protocol(
BasicTestInstrument,
[('VOLT?', 3.14)]
) as instr:
instr.adapter.write_bytes(b"VOLT")
instr.adapter._index = 1
def test_non_empty_read_buffer():
with raises(AssertionError, match="Non-empty read buffer remains"):
with expected_protocol(
BasicTestInstrument,
[('VOLT?', 3.14)]
) as instr:
instr.write("VOLT?")
def test_preprocess_reply_on_values():
class InstrumentWithPreprocessValues(BasicTestInstrument):
"""Workaround to get preprocess_reply working with protocol tests."""
simple2 = Instrument.control(
"VOLT?", "VOLT %s V",
"""Simple property replying with plain floats""",
preprocess_reply=lambda v: v + "2345"
)
with expected_protocol(
InstrumentWithPreprocessValues,
[("VOLT?", "3.1")]
) as instr:
assert instr.simple2 == 3.12345
class TestConnectionCalls:
def test_connection_method_call(self):
with expected_protocol(
BasicTestInstrument,
[],
connection_methods={'stb': 17}
) as inst:
assert inst.adapter.connection.stb() == 17
def test_connection_attribute(self):
with expected_protocol(
BasicTestInstrument,
[],
connection_attributes={'timeout': 100}
) as inst:
assert inst.adapter.connection.timeout == 100
def test_limited_control_raises_validator_exception():
"""Verify, that the validator's exception is caught."""
with expected_protocol(
BasicTestInstrument,
[],
) as inst:
with raises(ValueError, match="not in range"):
inst.limited_control = 20
|
