Debian Codegraph @

tests/conftest.py

raw
1 #
2 # This file is part of the PyMeasure package.
3 #
4 # Copyright (c) 2013-2024 PyMeasure Developers
5 #
6 # Permission is hereby granted, free of charge, to any person obtaining a copy
7 # of this software and associated documentation files (the "Software"), to deal
8 # in the Software without restriction, including without limitation the rights
9 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 # copies of the Software, and to permit persons to whom the Software is
11 # furnished to do so, subject to the following conditions:
12 #
13 # The above copyright notice and this permission notice shall be included in
14 # all copies or substantial portions of the Software.
15 #
16 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 # THE SOFTWARE.
23 #
24
25 import pytest
26
27
28 def pytest_addoption(parser):
29 parser.addoption(
30 "--device-address",
31 action="store",
32 default=None,
33 dest="adapter",
34 help=(
35 "Pass an adapter string for connection to an instrument needed for a test, e.g. "
36 "--device-address ASRL1::INSTR or --device-address TCPIP::192.168.0.123::INSTR"
37 ),
38 )
39
40
41 @pytest.fixture(scope="session")
42 def connected_device_address(pytestconfig):
43 """
44 Fixture to pass the address to a device for tests that require a connection to an instrument.
45
46 Using this fixture in a test function will skip it when running pytest by default. The test will
47 only run if a device address is provided with the --device-address option when invoking pytest.
48 To run only relevant tests, use the -k option to select the desired tests.
49 """
50 address = pytestconfig.getoption("--device-address", skip=True)
51 return address