summary refs log tree commit diff
diff options
context:
space:
mode:
authorAndrew Morgan <1342360+anoadragon453@users.noreply.github.com>2020-06-30 10:11:36 +0100
committerGitHub <noreply@github.com>2020-06-30 10:11:36 +0100
commit2f6afdd8b45c27f30f91873ab3e42cf6ada7045a (patch)
tree382136aa53f8edae3e936787ef3247313b2ea27c
parentAdd another yield point to state res v2 (#7746) (diff)
downloadsynapse-2f6afdd8b45c27f30f91873ab3e42cf6ada7045a.tar.xz
Explain the purpose of the "tests" conditional dependency requirement (#7751)
Diffstat (limited to '')
-rw-r--r--changelog.d/7751.misc1
-rw-r--r--synapse/python_dependencies.py4
2 files changed, 5 insertions, 0 deletions
diff --git a/changelog.d/7751.misc b/changelog.d/7751.misc
new file mode 100644
index 0000000000..eb10ecd92e
--- /dev/null
+++ b/changelog.d/7751.misc
@@ -0,0 +1 @@
+Explain the "test" conditional requirement for dependencies is not all of the modules necessary to run the unit tests.
diff --git a/synapse/python_dependencies.py b/synapse/python_dependencies.py
index 92d3709ae3..b1cac901eb 100644
--- a/synapse/python_dependencies.py
+++ b/synapse/python_dependencies.py
@@ -93,6 +93,10 @@ CONDITIONAL_REQUIREMENTS = {
     "oidc": ["authlib>=0.14.0"],
     "systemd": ["systemd-python>=231"],
     "url_preview": ["lxml>=3.5.0"],
+    # Dependencies which are exclusively required by unit test code. This is
+    # NOT a list of all modules that are necessary to run the unit tests.
+    # Tests assume that all optional dependencies are installed.
+    #
     # parameterized_class decorator was introduced in parameterized 0.7.0
     "test": ["mock>=2.0", "parameterized>=0.7.0"],
     "sentry": ["sentry-sdk>=0.7.2"],