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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
|
#
# 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.
#
import pytest
from pymeasure.experiment.parameters import Parameter
from pymeasure.experiment.parameters import IntegerParameter
from pymeasure.experiment.parameters import BooleanParameter
from pymeasure.experiment.parameters import FloatParameter
from pymeasure.experiment.parameters import ListParameter
from pymeasure.experiment.parameters import VectorParameter
def test_parameter_default():
p = Parameter('Test', default=5)
assert p.value == 5
assert p.cli_args[0] == 5
assert p.cli_args[1] == [('units are', 'units'), 'default']
def test_integer_units():
p = IntegerParameter('Test', units='V')
assert p.units == 'V'
assert p.cli_args[0] is None
assert p.cli_args[1] == [('units are', 'units'), 'default', 'minimum', 'maximum']
def test_integer_value():
p = IntegerParameter('Test', units='tests')
with pytest.raises(ValueError):
_ = p.value # not set
with pytest.raises(ValueError):
p.value = 'a' # not an integer
p.value = 0.5 # a float
assert p.value == 0
p.value = False # a boolean
assert p.value == 0
p.value = 10
assert p.value == 10
p.value = '5'
assert p.value == 5
p.value = '11 tests'
assert p.value == 11
assert p.units == 'tests'
with pytest.raises(ValueError):
p.value = '31 incorrect units' # not the correct units
def test_integer_bounds():
p = IntegerParameter('Test', minimum=0, maximum=10)
p.value = 10
assert p.value == 10
with pytest.raises(ValueError):
p.value = 100 # above maximum
with pytest.raises(ValueError):
p.value = -100 # below minimum
def test_boolean_value():
p = BooleanParameter('Test')
with pytest.raises(ValueError):
_ = p.value # not set
with pytest.raises(ValueError):
p.value = 'a' # a string
with pytest.raises(ValueError):
p.value = 10 # a number other than 0 or 1
p.value = "True"
assert p.value is True
p.value = "False"
assert p.value is False
p.value = "true"
assert p.value is True
p.value = "false"
assert p.value is False
p.value = 1 # a number
assert p.value is True
p.value = 0 # zero
assert p.value is False
p.value = True
assert p.value is True
assert p.cli_args[0] is None
assert p.cli_args[1] == [('units are', 'units'), 'default']
def test_float_value():
p = FloatParameter('Test', units='tests')
with pytest.raises(ValueError):
_ = p.value # not set
with pytest.raises(ValueError):
p.value = 'a' # not a float
p.value = False # boolean
assert p.value == 0.0
p.value = 100
assert p.value == 100.0
p.value = '1.06'
assert p.value == 1.06
p.value = '11.3 tests'
assert p.value == 11.3
assert p.units == 'tests'
with pytest.raises(ValueError):
p.value = '31.3 incorrect units' # not the correct units
assert p.cli_args[0] is None
assert p.cli_args[1] == [('units are', 'units'), 'default', 'decimals']
def test_float_bounds():
p = FloatParameter('Test', minimum=0.1, maximum=0.5)
p.value = 0.3
assert p.value == 0.3
with pytest.raises(ValueError):
p.value = 10 # above maximum
with pytest.raises(ValueError):
p.value = -10 # below minimum
def test_list_string():
# make sure string representation of choices is unique
with pytest.raises(ValueError):
_ = ListParameter('Test', choices=[1, '1'])
def test_list_value():
p = ListParameter('Test', choices=[1, 2.2, 'three', 'and four'])
p.value = 1
assert p.value == 1
p.value = 2.2
assert p.value == 2.2
p.value = '1' # reading from file
assert p.value == 1
p.value = '2.2' # reading from file
assert p.value == 2.2
p.value = 'three'
assert p.value == 'three'
p.value = 'and four'
assert p.value == 'and four'
with pytest.raises(ValueError):
p.value = 5
assert p.cli_args[0] is None
assert p.cli_args[1] == [('units are', 'units'), 'default', ('choices are', 'choices')]
def test_list_value_with_units():
p = ListParameter(
'Test', choices=[1, 2.2, 'three', 'and four'],
units='tests')
p.value = '1 tests'
assert p.value == 1
p.value = '2.2 tests'
assert p.value == 2.2
p.value = 'three tests'
assert p.value == 'three'
p.value = 'and four tests'
assert p.value == 'and four'
assert p.cli_args[0] is None
assert p.cli_args[1] == [('units are', 'units'), 'default', ('choices are', 'choices')]
def test_list_order():
p = ListParameter('Test', choices=[1, 2.2, 'three', 'and four'])
# check if order is preserved, choices are internally stored as dict
assert p.choices == (1, 2.2, 'three', 'and four')
assert p.cli_args[0] is None
assert p.cli_args[1] == [('units are', 'units'), 'default', ('choices are', 'choices')]
def test_vector():
p = VectorParameter('test', length=3, units='tests')
p.value = [1, 2, 3]
assert p.value == [1, 2, 3]
p.value = '[4, 5, 6]'
assert p.value == [4, 5, 6]
p.value = '[7, 8, 9] tests'
assert p.value == [7, 8, 9]
with pytest.raises(ValueError):
p.value = '[0, 1, 2] wrong unit'
with pytest.raises(ValueError):
p.value = [1, 2]
with pytest.raises(ValueError):
p.value = ['a', 'b']
with pytest.raises(ValueError):
p.value = '0, 1, 2'
assert p.cli_args[0] is None
assert p.cli_args[1] == [('units are', 'units'), 'default', '_length']
# TODO: Add tests for Measurable
|
