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
|
#
# 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
import pickle
from pymeasure.experiment.procedure import Procedure, ProcedureWrapper
from pymeasure.experiment.parameters import Parameter
from pymeasure.units import ureg
from data.procedure_for_testing import RandomProcedure
def test_parameters():
class TestProcedure(Procedure):
x = Parameter('X', default=5)
p = TestProcedure()
assert p.x == 5
p.x = 10
assert p.x == 10
assert p.parameters_are_set()
objs = p.parameter_objects()
assert 'x' in objs
assert objs['x'].value == p.x
# TODO: Add tests for measureables
def test_procedure_wrapper():
assert RandomProcedure.iterations.value == 100
procedure = RandomProcedure()
procedure.iterations = 101
wrapper = ProcedureWrapper(procedure)
new_wrapper = pickle.loads(pickle.dumps(wrapper))
assert hasattr(new_wrapper, 'procedure')
assert new_wrapper.procedure.iterations == 101
assert RandomProcedure.iterations.value == 100
# This test checks that user can define properties using the parameters inside the procedure
# The test ensure that property is evaluated only when the Parameter has been processed during
# class initialization.
def test_procedure_properties():
class TestProcedure(Procedure):
@property
def a(self):
assert isinstance(self.x, int)
return self.x
@property
def z(self):
assert isinstance(self.x, int)
return self.x
x = Parameter('X', default=5)
p = TestProcedure()
assert p.x == 5
# Make sure that a procedure can be initialized even though some properties are raising
# errors at initialization time
def test_procedure_init_with_invalid_property():
class TestProcedure(Procedure):
@property
def prop(self):
return self.x
p = TestProcedure()
with pytest.raises(AttributeError):
_ = p.prop # AttributeError
p.x = 5
assert p.prop == 5
@pytest.mark.parametrize("header, units", (
("x (m)", ureg.m),
("x (m/s)", ureg.m / ureg.s),
("x (V/(m*s))", ureg.V / ureg.m / ureg.s),
("x (1)", ureg.dimensionless)
))
def test_procedure_parse_columns(header, units):
assert Procedure.parse_columns([header])[header] == ureg.Quantity(1, units)
@pytest.mark.parametrize("valid_header_no_unit", (
["x"], ["x ( x + y )"], ["x ( notes )"], ["x [V]"]
))
def test_procedure_no_parsed_units(valid_header_no_unit):
assert Procedure.parse_columns(valid_header_no_unit) == {}
@pytest.mark.parametrize("invalid_header_unit", (
["x (sqrt)"], ["x (x)"], ["x (y)"],
))
def test_procedure_invalid_parsed_unit(invalid_header_unit):
with pytest.raises(ValueError):
Procedure.parse_columns(invalid_header_unit)
|
