From efb6b6629c78409251f61857f2bfe6c2f8f8fb8d Mon Sep 17 00:00:00 2001
From: Jonathan de Jong <jonathandejong02@gmail.com>
Date: Thu, 17 Sep 2020 22:45:22 +0200
Subject: [PATCH] Move lint dependencies to extras_require (#8330)
Lint dependencies can now be installed with pip install -e ".[lint]"
This should help keep the version in sync between tox and documentation.
---
CONTRIBUTING.md | 6 +++---
changelog.d/8330.misc | 1 +
synapse/python_dependencies.py | 5 ++++-
tox.ini | 10 ++--------
4 files changed, 10 insertions(+), 12 deletions(-)
create mode 100644 changelog.d/8330.misc
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 062413e925..524f82433d 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -17,9 +17,9 @@ https://help.github.com/articles/using-pull-requests/) to ask us to pull your
changes into our repo.
Some other points to follow:
-
+
* Please base your changes on the `develop` branch.
-
+
* Please follow the [code style requirements](#code-style).
* Please include a [changelog entry](#changelog) with each PR.
@@ -46,7 +46,7 @@ locally. You'll need python 3.6 or later, and to install a number of tools:
```
# Install the dependencies
-pip install -U black flake8 flake8-comprehensions isort
+pip install -e ".[lint]"
# Run the linter script
./scripts-dev/lint.sh
diff --git a/changelog.d/8330.misc b/changelog.d/8330.misc
new file mode 100644
index 0000000000..c51370f215
--- /dev/null
+++ b/changelog.d/8330.misc
@@ -0,0 +1 @@
+Move lint-related dependencies to package-extra field, update CONTRIBUTING.md to utilise this.
\ No newline at end of file
diff --git a/synapse/python_dependencies.py b/synapse/python_dependencies.py
index ff0c67228b..67f019fd22 100644
--- a/synapse/python_dependencies.py
+++ b/synapse/python_dependencies.py
@@ -104,13 +104,16 @@ CONDITIONAL_REQUIREMENTS = {
# hiredis is not a *strict* dependency, but it makes things much faster.
# (if it is not installed, we fall back to slow code.)
"redis": ["txredisapi>=1.4.7", "hiredis"],
+ # We pin black so that our tests don't start failing on new releases.
+ "lint": ["isort==5.0.3", "black==19.10b0", "flake8-comprehensions", "flake8"],
}
ALL_OPTIONAL_REQUIREMENTS = set() # type: Set[str]
for name, optional_deps in CONDITIONAL_REQUIREMENTS.items():
# Exclude systemd as it's a system-based requirement.
- if name not in ["systemd"]:
+ # Exclude lint as it's a dev-based requirement.
+ if name not in ["systemd", "lint"]:
ALL_OPTIONAL_REQUIREMENTS = set(optional_deps) | ALL_OPTIONAL_REQUIREMENTS
diff --git a/tox.ini b/tox.ini
index df473bd234..ddcab0198f 100644
--- a/tox.ini
+++ b/tox.ini
@@ -118,20 +118,14 @@ commands =
check-manifest
[testenv:check_codestyle]
-skip_install = True
-deps =
- flake8
- flake8-comprehensions
- # We pin so that our tests don't start failing on new releases of black.
- black==19.10b0
+extras = lint
commands =
python -m black --check --diff .
/bin/sh -c "flake8 synapse tests scripts scripts-dev contrib synctl {env:PEP8SUFFIX:}"
{toxinidir}/scripts-dev/config-lint.sh
[testenv:check_isort]
-skip_install = True
-deps = isort==5.0.3
+extras = lint
commands = /bin/sh -c "isort -c --df --sp setup.cfg synapse tests scripts-dev scripts"
[testenv:check-newsfragment]
--
GitLab