From 787808430605829308b6e3b86260071367cf5d5c Mon Sep 17 00:00:00 2001 From: Valentin Deniaud Date: Tue, 30 Mar 2021 10:10:04 +0200 Subject: [PATCH 2/6] add black configuration (#52457) --- .git-blame-ignore-revs | 2 ++ .pre-commit-config.yaml | 8 ++++++++ Jenkinsfile | 2 +- README | 10 ++++++++++ tox.ini | 6 ++++-- 5 files changed, 25 insertions(+), 3 deletions(-) create mode 100644 .git-blame-ignore-revs create mode 100644 .pre-commit-config.yaml diff --git a/.git-blame-ignore-revs b/.git-blame-ignore-revs new file mode 100644 index 00000000..348e62df --- /dev/null +++ b/.git-blame-ignore-revs @@ -0,0 +1,2 @@ +# misc: apply black +4bb33d3d3c62516cfdb1ff5bba9216936a07d368 diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 00000000..a14705c7 --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,8 @@ +# See https://pre-commit.com for more information +# See https://pre-commit.com/hooks.html for more hooks +repos: +- repo: https://github.com/psf/black + rev: 20.8b1 + hooks: + - id: black + args: ['--target-version', 'py37', '--skip-string-normalization', '--line-length', '110'] diff --git a/Jenkinsfile b/Jenkinsfile index 56ed920f..19ba570b 100644 --- a/Jenkinsfile +++ b/Jenkinsfile @@ -14,7 +14,7 @@ pipeline { sh """ python3 -m venv ${env.TMPDIR}/venv/ ${env.TMPDIR}/venv/bin/pip install tox -PGPORT=`python -c 'import struct; import socket; s=socket.socket(); s.setsockopt(socket.SOL_SOCKET, socket.SO_LINGER, struct.pack("ii", 1, 0)); s.bind(("", 0)); print(s.getsockname()[1]); s.close()'` pg_virtualenv -o fsync=off ${env.TMPDIR}/venv/bin/tox -rv -e rbac-py3-dj111,authentic-py3-dj111-drf39,authentic-py3-dj22-drf39,pylint""" +PGPORT=`python -c 'import struct; import socket; s=socket.socket(); s.setsockopt(socket.SOL_SOCKET, socket.SO_LINGER, struct.pack("ii", 1, 0)); s.bind(("", 0)); print(s.getsockname()[1]); s.close()'` pg_virtualenv -o fsync=off ${env.TMPDIR}/venv/bin/tox -rv -e rbac-py3-dj111,authentic-py3-dj111-drf39-black,authentic-py3-dj22-drf39,pylint""" } post { always { diff --git a/README b/README index 9c53a472..1a8203b4 100644 --- a/README +++ b/README @@ -68,6 +68,16 @@ Upgrade using a previous one you must first upgrade to 2.1.12 before tempting upgrade to a release later than 2.2.0. +Code Style +========== + +black is used to format the code, using thoses parameters: + + black --target-version py37 --skip-string-normalization --line-length 110 + +There is .pre-commit-config.yaml to use pre-commit to automatically run black +before commits. (execute `pre-commit install` to install the git hook.) + Support ======= diff --git a/tox.ini b/tox.ini index 56ab9f9c..f5237aa5 100644 --- a/tox.ini +++ b/tox.ini @@ -6,7 +6,7 @@ [tox] toxworkdir = {env:TMPDIR:/tmp}/tox-{env:USER}/authentic/ envlist = - authentic-py3-dj111-drf39 + authentic-py3-dj111-drf39-black authentic-py3-dj22-drf39 [tox:jenkins] @@ -16,7 +16,7 @@ envlist = rbac-py3-dj111 rbac-py3-dj22 authentic-py3-dj111-drf34 - authentic-py3-dj111-drf39 + authentic-py3-dj111-drf39-black authentic-py3-dj22-drf39 [testenv] @@ -77,12 +77,14 @@ deps = py3: django-filter<2.3 drf34: djangorestframework>=3.4,<3.4.1 drf39: djangorestframework>=3.9.2,<3.10 + pre-commit usedevelop = True commands = py2: ./getlasso.sh py3: ./getlasso3.sh authentic: ./check-migrations.sh rbac,authentic: py.test {env:PYTESTOPTIONS:} {env:FAST:} {env:REUSEDB:} {env:COVERAGE:} {env:JUNIT:} {env:SW:} {posargs:{env:TESTS} --random-group} + black: pre-commit run black --all-files --show-diff-on-failure [testenv:pylint] basepython = python2.7 -- 2.20.1