Run isort, autopep8 and flake8 in pre-commit. (#1224)

* Run isort, autopep8 and flake8 in pre-commit.
* Apply pre-commit code formatting
* Run meta/config.

---------

Co-authored-by: pre-commit-ci-lite[bot] <117423508+pre-commit-ci-lite[bot]@users.noreply.github.com>

.github/workflows/pre-commit.yml

@@ -0,0 +1,33 @@
+# Generated from:
+# https://github.com/zopefoundation/meta/tree/master/config/zope-product
+name: pre-commit
+
+on:
+  pull_request:
+  push:
+    branches:
+    - master
+  # Allow to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+env:
+  FORCE_COLOR: 1
+
+jobs:
+  pre-commit:
+    name: linting
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v5
+      with:
+        python-version: 3.x
+    - uses: pre-commit/[email protected]
+      with:
+        extra_args: --all-files --show-diff-on-failure
+      env:
+        PRE_COMMIT_COLOR: always
+    - uses: pre-commit-ci/[email protected]
+      if: always()
+      with:
+        msg: Apply pre-commit code formatting

.github/workflows/tests.yml

@@ -23,7 +23,6 @@ jobs:
         config:
         # [Python version, tox env]
         - ["3.11",  "release-check"]
-        - ["3.11",  "lint"]
         - ["3.8",   "py38"]
         - ["3.9",   "py39"]
         - ["3.10",  "py310"]
@@ -34,11 +33,9 @@ jobs:
         - ["3.11",   "coverage"]
         exclude:
           - { os: ["windows", "windows-latest"], config: ["3.11",  "release-check"] }
-          - { os: ["windows", "windows-latest"], config: ["3.11",  "lint"] }
           - { os: ["windows", "windows-latest"], config: ["3.11",  "docs"] }
           - { os: ["windows", "windows-latest"], config: ["3.11",  "coverage"] }
           - { os: ["macos", "macos-latest"], config: ["3.11",  "release-check"] }
-          - { os: ["macos", "macos-latest"], config: ["3.11",  "lint"] }
           - { os: ["macos", "macos-latest"], config: ["3.11",  "docs"] }
           - { os: ["macos", "macos-latest"], config: ["3.11",  "coverage"] }
 

.meta.toml

@@ -2,7 +2,7 @@
 # https://github.com/zopefoundation/meta/tree/master/config/zope-product
 [meta]
 template = "zope-product"
-commit-id = "994c74d7"
+commit-id = "da0ad14b"
 
 [python]
 with-pypy = false
@@ -47,9 +47,6 @@ testenv-deps = [
     "universal2: MarkupSafe",
     "universal2: zope.testrunner",
     ]
-additional-envlist = [
-    "pre-commit",
-    ]
 testenv-commands-pre = [
     "{envbindir}/buildout -c {toxinidir}/buildout.cfg buildout:directory={envdir} buildout:develop={toxinidir} buildout:root-directory={toxinidir}",
     ]
@@ -64,27 +61,6 @@ testenv-commands = [
 coverage-command = "coverage run {envdir}/bin/alltests {posargs:-vc}"
 testenv-additional = [
     "allowlist_externals = *",
-    "",
-    "[testenv:pre-commit]",
-    "basepython = python3",
-    "description = This env runs all linters configured in .pre-commit-config.yaml",
-    "skip_install = true",
-    "deps =",
-    "    pre-commit",
-    "commands_pre =",
-    "commands =",
-    "    pre-commit run --all-files --show-diff-on-failure",
-    "",
-    "[testenv:autopep8]",
-    "basepython = python3.8",
-    "skip_install = true",
-    "deps =",
-    "    -cconstraints.txt",
-    "    autopep8",
-    "    docformatter",
-    "commands =",
-    "    autopep8 --verbose --in-place --recursive --aggressive --aggressive {toxinidir}/src setup.py",
-    "    docformatter --in-place --recursive {toxinidir}/src setup.py",
     ]
 use-flake8 = true
 

.pre-commit-config.yaml

@@ -1,6 +1,24 @@
+# Generated from:
+# https://github.com/zopefoundation/meta/tree/master/config/zope-product
+minimum_pre_commit_version: '3.6'
 repos:
+  - repo: https://github.com/pycqa/isort
+    rev: "5.13.2"
+    hooks:
+    - id: isort
+  - repo: https://github.com/hhatto/autopep8
+    rev: "v2.3.1"
+    hooks:
+    - id: autopep8
+      args: [--in-place, --aggressive, --aggressive]
   - repo: https://github.com/asottile/pyupgrade
-    rev: v2.6.2
+    rev: v3.17.0
     hooks:
     - id: pyupgrade
-      args: [--py36-plus]
+      args: [--py38-plus]
+  - repo: https://github.com/PyCQA/flake8
+    rev: "7.1.1"
+    hooks:
+    - id: flake8
+      additional_dependencies:
+        - flake8-debugger == 4.1.2

MANIFEST.in

@@ -5,6 +5,7 @@ include *.rst
 include *.txt
 include buildout.cfg
 include tox.ini
+include .pre-commit-config.yaml
 
 recursive-include docs *.py
 recursive-include docs *.rst

docs/conf.py

@@ -100,7 +100,7 @@
     "light_logo": "Zope.svg",
     "dark_logo": "Zope.svg",
     "light_css_variables": {
-#        "color-brand-content": "#00AAD4",  # Too light for white background
+        # "color-brand-content": "#00AAD4",  # Too light for white background
     },
     "dark_css_variables": {
         "color-brand-content": "#00AAD4",

src/App/Dialogs.py

@@ -37,10 +37,12 @@
 class MessageDialogHTML(HTML):
     """A special version of HTML which is always published as text/html
     """
+
     def __call__(self, *args, **kw):
         class _HTMLString(str):
             """A special string that will be published as text/html
             """
+
             def asHTML(self):
                 return self
         return _HTMLString(super().__call__(*args, **kw))

src/App/config.py

@@ -55,6 +55,7 @@ class DefaultConfiguration:
     """
     This configuration should be used effectively only during unit tests
     """
+
     def __init__(self):
         from App import FindHomes
         self.clienthome = FindHomes.CLIENT_HOME

src/App/tests/test_ProductContext.py

@@ -134,6 +134,7 @@ def _verify_reg(self, name, obj):
 
 class _Product:
     """Product mockup."""
+
     def __init__(self):
         self.id = "pid"
 

src/OFS/DTMLDocument.py

@@ -48,8 +48,8 @@ class DTMLDocument(PropertyManager, DTMLMethod):
 
     # Replace change_dtml_methods by change_dtml_documents
     __ac_permissions__ = tuple([
-        (perms[0] == change_dtml_methods) and  # NOQA: W504
-        (change_dtml_documents, perms[1]) or perms
+        (perms[0] == change_dtml_methods)  # NOQA: W504
+        and (change_dtml_documents, perms[1]) or perms
         for perms in DTMLMethod.__ac_permissions__])
 
     def __call__(self, client=None, REQUEST={}, RESPONSE=None, **kw):

src/OFS/absoluteurl.py

@@ -124,6 +124,7 @@ def _isVirtualHostRoot(self):
 class RootAbsoluteURL(OFSTraversableAbsoluteURL):
     """An absolute_url adapter for the root object (OFS.Application)
     """
+
     def breadcrumbs(self):
         context = self.context
 

src/OFS/tests/testHistory.py

@@ -166,6 +166,7 @@ def test_manage_historicalComparison(self):
 class HistoryItemWithSetState(HistoryItem):
     """A class with a data migration on __setstate__
     """
+
     def __setstate__(self, state):
         super().__setstate__(state)
         self.changed_something = True

src/OFS/tests/testObjectManager.py

@@ -615,6 +615,7 @@ def test_export_import(self):
 
 class _CallResult:
     """Auxiliary class to provide defined call results."""
+
     def __init__(self, result):
         self.result = result
 

src/OFS/tests/testTraverse.py

@@ -21,6 +21,7 @@ class UnitTestSecurityPolicy:
         Stub out the existing security policy for unit testing purposes.
     """
     #   Standard SecurityPolicy interface
+
     def validate(self, accessed=None, container=None, name=None, value=None,
                  context=None, roles=None, *args, **kw):
         return 1
@@ -33,6 +34,7 @@ class CruelSecurityPolicy:
     """Denies everything
     """
     #   Standard SecurityPolicy interface
+
     def validate(self, accessed, container, name, value, *args):
         from AccessControl import Unauthorized
         raise Unauthorized(name)
@@ -44,6 +46,7 @@ def checkPermission(self, permission, object, context):
 class ProtectedMethodSecurityPolicy:
     """Check security strictly on bound methods.
     """
+
     def validate(self, accessed, container, name, value, *args):
         from AccessControl import Unauthorized
         from Acquisition import aq_base
@@ -135,6 +138,7 @@ class UnitTestUser(Implicit):
             """
                 Stubbed out manager for unit testing purposes.
             """
+
             def getId(self):
                 return 'unit_tester'
             getUserName = getId
@@ -192,10 +196,12 @@ class Restricted(SimpleItem):
             """Instance we'll check with ProtectedMethodSecurityPolicy."""
 
             getId__roles__ = None  # ACCESS_PUBLIC
+
             def getId(self):  # NOQA: E306  # pseudo decorator
                 return self.id
 
             private__roles__ = ()  # ACCESS_PRIVATE
+
             def private(self):  # NOQA: E306  # pseudo decorator
                 return 'private!'
 

src/Products/Five/browser/pagetemplatefile.py

@@ -35,6 +35,7 @@ def getEngine():
 class ViewPageTemplateFile(TrustedAppPT, PageTemplateFile):
     """Page Template used as class variable of views defined as Python classes.
     """
+
     def __init__(self, filename, _prefix=None, content_type=None):
         _prefix = self.get_path_from_prefix(_prefix)
         super().__init__(filename, _prefix)

src/Products/Five/browser/resource.py

@@ -43,6 +43,7 @@ class Resource:
     thus making this mixin (and probably the other classes in this
     module) obsolete.
     """
+
     def __call__(self):
         name = self.__name__
         container = self.__parent__

src/Products/Five/tests/testing/folder.py

@@ -23,6 +23,7 @@ class NoVerifyPasteFolder(Folder):
     """Folder that does not perform paste verification.
     Used by test_events
     """
+
     def _verifyObjectPaste(self, object, validate_src=1):
         pass
 

src/Products/Five/viewlet/tests.py

@@ -33,6 +33,7 @@ class UnitTestSecurityPolicy:
         Stub out the existing security policy for unit testing purposes.
     """
     # Standard SecurityPolicy interface
+
     def validate(self,
                  accessed=None,
                  container=None,

src/Products/PageTemplates/Expressions.py

@@ -163,6 +163,7 @@ class _CombinedMapping:
 
     Earlier mappings take precedence.
     """
+
     def __init__(self, *ms):
         self.mappings = ms
 

src/Products/PageTemplates/engine.py

@@ -86,6 +86,7 @@ def __call__(self, key, iterable):
 
 class RepeatItem(PathIterator):
     """Iterator compatible with ``chameleon`` and ``zope.tales``."""
+
     def __iter__(self):
         return self
 
@@ -241,6 +242,7 @@ def _C2ZContextWrapper(c_context, attrs):
 
 class MappedExpr:
     """map expression: ``zope.tales`` --> ``chameleon.tales``."""
+
     def __init__(self, type, expression, zt_engine):
         self.type = type
         # At this place, *expression* is a `chameleon.tokenize.Token`
@@ -315,6 +317,7 @@ def __call__(self, target, c_engine):
 
 class MappedExprType:
     """map expression type: ``zope.tales`` --> ``chameleon.tales``."""
+
     def __init__(self, engine, type):
         self.engine = engine
         self.type = type

src/Products/PageTemplates/expression.py

@@ -216,6 +216,7 @@ class ChameleonEngine(ExpressionEngine):
 
     Only partially implemented: its ``compile`` is currently unusable
     """
+
     def compile(self, expression):
         raise NotImplementedError()
 

src/Products/PageTemplates/tests/testDTMLTests.py

@@ -40,6 +40,7 @@ class UnitTestSecurityPolicy:
     #
     #   Standard SecurityPolicy interface
     #
+
     def validate(self,
                  accessed=None,
                  container=None,

src/Products/PageTemplates/tests/testHTMLTests.py

@@ -52,6 +52,7 @@ class UnitTestSecurityPolicy:
         Stub out the existing security policy for unit testing purposes.
     """
     # Standard SecurityPolicy interface
+
     def validate(self,
                  accessed=None,
                  container=None,

src/Products/PageTemplates/tests/testZopeTalesExpressions.py

@@ -9,6 +9,7 @@ class ZopeTalesExpressionTests(testHTMLTests.HTMLTests):
     The tests in this class ensure that the ``_zt_expr_registry``
     is cleared at the start and end of each test.
     """
+
     def setUp(self):
         super().setUp()
         _zt_expr_registry.clear()

src/Shared/DC/Scripts/Signature.py

@@ -32,14 +32,14 @@ def __init__(self, varnames=(), argcount=-1):
     def __eq__(self, other):
         if not isinstance(other, FuncCode):
             return False
-        return ((self.co_argcount, self.co_varnames) ==  # NOQA: W504
-                (other.co_argcount, other.co_varnames))
+        return ((self.co_argcount, self.co_varnames)  # NOQA: W504
+                == (other.co_argcount, other.co_varnames))
 
     def __lt__(self, other):
         if not isinstance(other, FuncCode):
             return False
-        return ((self.co_argcount, self.co_varnames) <  # NOQA: W504
-                (other.co_argcount, other.co_varnames))
+        return ((self.co_argcount, self.co_varnames)  # NOQA: W504
+                < (other.co_argcount, other.co_varnames))
 
 
 def _setFuncSignature(self, defaults=None, varnames=(), argcount=-1):

src/ZPublisher/BaseRequest.py

@@ -710,11 +710,10 @@ def ensure_publishable(self, obj, for_call=False):
             # a tuple of allowed request methods
             request_method = (getattr(self, "environ", None)
                               and self.environ.get("REQUEST_METHOD"))
-            if  (request_method is None  # noqa: E271
-                 or request_method.upper() not in publishable):
-                raise Forbidden(
-                    f"The object at {url} does not support "
-                    f"{request_method} requests")
+            if (request_method is None  # noqa: E271
+                    or request_method.upper() not in publishable):
+                raise Forbidden(f"The object at {url} does not support "
+                                f"{request_method} requests")
             return
         # ``publishable`` is ``None``
 
@@ -850,11 +849,11 @@ def lineno(o, m=False):
             f = i.unwrap(obj.__func__)
             c = obj.__self__.__class__
             desc = f"'{c.__module__}.{c.__qualname__}' " \
-                   f"method '{obj.__qualname__}'{lineno(f, 1)}"
+                f"method '{obj.__qualname__}'{lineno(f, 1)}"
         elif i.isfunction(obj):
             f = i.unwrap(obj)
             desc = f"function '{f.__module__}.{f.__qualname__}'" \
-                   f"{lineno(f)}"
+                f"{lineno(f)}"
         else:
             try:
                 cls_doc = "__doc__" not in obj.__dict__