test: Add pre-commit configuration

Author: chrisburr

.github/workflows/basic-python3.yml

@@ -3,6 +3,19 @@ name: Python 3 tests
 on: [push, pull_request]
 
 jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    if: github.event_name != 'push' || github.repository == 'DIRACGrid/DIRAC'
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/setup-python@v2
+      with:
+        python-version: '3.9'
+    - name: Install pre-commit
+      run: pip install pre-commit
+    - name: Run pre-commit
+      run: pre-commit run --all-files --show-diff-on-failure
+
   check:
     runs-on: ubuntu-latest
     if: github.event_name != 'push' || github.repository == 'DIRACGrid/DIRAC'

.pre-commit-config.yaml

@@ -0,0 +1,25 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+
+default_language_version:
+  python: python3.9
+
+exclude: |
+    (?x)^(
+        src/DIRAC/Interfaces/API/test/test.*\.jdl
+    )$
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.0.1
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-added-large-files
+
+  - repo: https://github.com/psf/black
+    rev: 21.9b0
+    hooks:
+      - id: black
+        additional_dependencies: [".[python2]"]

pyproject.toml

@@ -7,3 +7,7 @@ build-backend = "setuptools.build_meta"
 [tool.setuptools_scm]
 # Avoid letting setuptools_scm use old style tags (i.e. vXrYpZ)
 git_describe_command = "git describe --dirty --tags --long --match *[0-9].[0-9]* --exclude v[0-9]r* --exclude v[0-9][0-9]r*"
+
+[tool.black]
+line-length = 120
+target-version = ['py27']

setup.cfg

@@ -287,29 +287,13 @@ console_scripts =
 # Linting
 ###############################################################################
 
-# pep8 binary will still look into this section
-[pep8]
-# Pep8 codes:
-# E111 - indentation is not a multiple of four
-# E114  indentation is not a multiple of four (comment)
-ignore=E111,E114
-
-# Make it format also comments, and method signatures
-aggressive=2
-
-# Understood by pep8 and autopep8
-max_line_length=120
-# indent_size is unknown to pep8, but not to autopep8
-indent_size=2
-
 [pycodestyle]
 # Pep8 codes:
-# E111 - indentation is not a multiple of four
-# E114 - indentation is not a multiple of four (comment)
+# E203 - Whitespace before ':' (spaces should be present for list slices)
+# E211 - Whitespace before '(' (black incorrectly formats exec when in Python 2 mode)
+# E266 - Too many leading '#' for block comment
 # E402 - module level import not at top of file (for scripts)
 # W503 - line break before binary operator (stupid, complains after or before...)
-# W504 - line break after binary operator (stupid, complains after or before...)
-ignore=E111,E114,E402,W503,W504
-max_line_length=120
-exclude=
-    integration_tests.py
+ignore = E203, E211, E266, E402, W503
+# TODO: This should be reduced back to 120 at some point
+max_line_length=130