Merge pull request #5732 from jenshnielsen/deprecate_tests

Deprecate qcodes.tests module
microsoft · Feb 8, 2024 · 3861461 · 3861461
2 parents 00d6c06 + 70ba4f6
commit 3861461
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/docs/changes/newsfragments/5732.breaking b/docs/changes/newsfragments/5732.breaking
@@ -0,0 +1,3 @@
+The `qcodes.tests` module has been deprecated and will be removed in a future release. Please import mock instruments from
+`qcodes.instrument_drivers.mock_instruments` and `DriverTestCase` from `qcodes.extensions` instead. If you make use of
+any other part of the tests module please open an issue on GitHub.
diff --git a/src/qcodes/tests/__init__.py b/src/qcodes/tests/__init__.py
@@ -0,0 +1,7 @@
+from qcodes.utils import issue_deprecation_warning
+
+issue_deprecation_warning(
+    "`qcodes.tests` module",
+    "tests are no longer shipped with QCoDeS",
+    "`qcodes.instrument_drivers.mock_instruments` and `qcodes.extensions.DriverTestCase`",
+)