Pre commit tisto (#161)

* Run pre-commit.ci, fix three typos

* Use same black version as pre-commit.ci

* Set black version to pre-commit.ci one

* black

* Add isort/black config to pyproject.toml

CHANGES.rst

@@ -245,7 +245,7 @@ Bugfixes:
   [buchi]
 
 - Fallback to regular views during traversal to ensure compatibility with
-  views beeing called with a specific Accept header.
+  views being called with a specific Accept header.
   [buchi]
 
 
@@ -295,7 +295,7 @@ Bugfixes:
 
 - Refactor traversal of REST requests by using a traversal adapter on the site
   root instead of a traversal adapter for each REST service. This prevents
-  REST services from being overriden by other traversal adapters.
+  REST services from being overridden by other traversal adapters.
   [buchi]
 
 

Makefile

@@ -87,6 +87,7 @@ build-plone-6.0:  ## Build Plone 6.0
 	python$(version) -m venv .
 	bin/pip install --upgrade pip
 	bin/pip install -r requirements-6.0.x.txt
+	bin/pip install pip install black==$$(awk '/^black =/{print $$NF}' versions.cfg)
 	bin/buildout -c plone-6.0.x.cfg
 
 .PHONY: Test

README.rst

@@ -271,7 +271,7 @@ allow_origin
 allow_methods
   A comma separated list of HTTP method names that are allowed by this CORS
   policy, e.g. "DELETE,GET,OPTIONS,PATCH,POST,PUT". If not specified, all
-  methods for which there's a service registerd are allowed.
+  methods for which there's a service registered are allowed.
 
 allow_credentials
   Indicates whether the resource supports user credentials in the request.

plone-5.2.x.cfg

@@ -7,7 +7,7 @@ versions=versions
 
 [versions]
 plone.rest =
-black = 21.12b0
+black = 23.3.0
 
 # Error: The requirement ('virtualenv>=20.0.35') is not allowed by your [versions] constraint (20.0.26)
 virtualenv = 20.0.35

plone-6.0.x.cfg

@@ -9,5 +9,5 @@ zodb-temporary-storage = off
 
 [versions]
 plone.rest =
-black = 21.7b0
+black = 23.3.0
 pygments = 2.14.0

pyproject.toml

@@ -22,4 +22,10 @@ showcontent = true
 [[tool.towncrier.type]]
 directory = "internal"
 name = "Internal:"
-showcontent = true
+showcontent = true
+
+[tool.isort]
+profile = "plone"
+
+[tool.black]
+target-version = ["py38"]

setup.py

@@ -1,6 +1,7 @@
-import os
+from setuptools import find_packages
+from setuptools import setup
 
-from setuptools import find_packages, setup
+import os
 
 
 def read(*rnames):

src/plone/rest/__init__.py

@@ -1,2 +1 @@
-# -*- coding: utf-8 -*-
 from plone.rest.service import Service  # noqa

src/plone/rest/cors.py

@@ -1,7 +1,7 @@
-# -*- coding: utf-8 -*-
 from plone.rest.interfaces import ICORSPolicy
 from zope.interface import implementer
 
+
 # CORS preflight service registry
 # A mapping of method -> service_id
 _services = {}
@@ -19,7 +19,7 @@ def lookup_preflight_service_id(method):
 
 
 @implementer(ICORSPolicy)
-class CORSPolicy(object):
+class CORSPolicy:
     def __init__(self, context, request):
         self.context = context
         self.request = request

src/plone/rest/demo.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 from plone.rest import Service
 
 import json

src/plone/rest/errors.py

@@ -1,5 +1,6 @@
 from AccessControl import getSecurityManager
 
+
 try:
     from plone.app.redirector.interfaces import IRedirectionStorage
 except ImportError:
@@ -10,10 +11,11 @@
 from Products.CMFCore.permissions import ManagePortal
 from Products.Five.browser import BrowserView
 from six.moves import urllib
-from six.moves.urllib.parse import quote
-from six.moves.urllib.parse import unquote
+from urllib.parse import quote
+from urllib.parse import unquote
 from zExceptions import NotFound
 
+
 try:
     from ZPublisher.HTTPRequest import WSGIRequest
 
@@ -61,7 +63,7 @@ def render_exception(self, exception):
         if six.PY2:
             name = name.decode("utf-8")
             message = message.decode("utf-8")
-        result = {u"type": name, u"message": message}
+        result = {"type": name, "message": message}
 
         policy = queryMultiAdapter((self.context, self.request), ICORSPolicy)
         if policy is not None:
@@ -77,10 +79,10 @@ def render_exception(self, exception):
             # NotFound exceptions need special handling because their
             # exception message gets turned into HTML by ZPublisher
             url = self.request.getURL()
-            result[u"message"] = u"Resource not found: %s" % url
+            result["message"] = "Resource not found: %s" % url
 
         if getSecurityManager().checkPermission(ManagePortal, getSite()):
-            result[u"traceback"] = self.render_traceback(exception)
+            result["traceback"] = self.render_traceback(exception)
 
         return result
 
@@ -101,8 +103,8 @@ def render_traceback(self, exception):
                 pass
             else:
                 return (
-                    u"ERROR: Another exception happened before we could "
-                    u"render the traceback."
+                    "ERROR: Another exception happened before we could "
+                    "render the traceback."
                 )
 
         raw = "\n".join(traceback.format_tb(exc_traceback))
@@ -192,7 +194,7 @@ def attempt_redirect(self):
 
         query_string = self.request.QUERY_STRING
         if query_string:
-            new_path = storage.get("%s?%s" % (old_path, query_string))
+            new_path = storage.get(f"{old_path}?{query_string}")
             # if we matched on the query_string we don't want to include it
             # in redirect
             if new_path:

src/plone/rest/events.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 from plone.rest.cors import lookup_preflight_service_id
 from plone.rest.interfaces import IAPIRequest
 from plone.rest.negotiation import lookup_service_id

src/plone/rest/interfaces.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 from zope.interface import Interface
 
 

src/plone/rest/negotiation.py

@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-
 # Service registry
 # A mapping of method -> type name -> subtype name -> service id
 _services = {}
@@ -42,7 +40,7 @@ def register_service(method, media_type):
     """Register a service for the given request method and media type and
     return it's service id.
     """
-    service_id = u"{}_{}_{}_".format(method, media_type[0], media_type[1])
+    service_id = f"{method}_{media_type[0]}_{media_type[1]}_"
     types = _services.setdefault(method, {})
     subtypes = types.setdefault(media_type[0], {})
     subtypes[media_type[1]] = service_id

src/plone/rest/patches.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 from plone.rest.interfaces import IAPIRequest
 
 

src/plone/rest/service.py

@@ -1,12 +1,11 @@
-# -*- coding: utf-8 -*-
 from plone.rest.interfaces import ICORSPolicy
 from plone.rest.interfaces import IService
 from zope.component import queryMultiAdapter
 from zope.interface import implementer
 
 
 @implementer(IService)
-class Service(object):
+class Service:
     def __call__(self):
         policy = queryMultiAdapter((self.context, self.request), ICORSPolicy)
         if policy is not None:
@@ -29,4 +28,4 @@ def __getattribute__(self, name):
         # include credentials
         if name == "__roles__" and self.request._rest_cors_preflight:
             return ["Anonymous"]
-        return super(Service, self).__getattribute__(name)
+        return super().__getattribute__(name)

src/plone/rest/testing.py

@@ -1,16 +1,13 @@
-# -*- coding: utf-8 -*-
 from plone.app.contenttypes.testing import PLONE_APP_CONTENTTYPES_FIXTURE
 from plone.app.testing import FunctionalTesting
 from plone.app.testing import IntegrationTesting
 from plone.app.testing import PloneSandboxLayer
 from plone.rest.service import Service
 from plone.testing import z2
-
 from zope.configuration import xmlconfig
 
 
 class PloneRestLayer(PloneSandboxLayer):
-
     defaultBases = (PLONE_APP_CONTENTTYPES_FIXTURE,)
 
     def setUpZope(self, app, configurationContext):
@@ -31,7 +28,7 @@ def setUpZope(self, app, configurationContext):
 
 class InternalServerErrorService(Service):
     def __call__(self):
-        from six.moves.urllib.error import HTTPError
+        from urllib.error import HTTPError
 
         raise HTTPError(
             "http://nohost/plone/500-internal-server-error",

src/plone/rest/tests/__init__.py

@@ -1 +0,0 @@
-# -*- coding: utf-8 -*-

src/plone/rest/tests/test_cors.py

@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-from ZPublisher.pubevents import PubStart
 from plone.app.testing import popGlobalRegistry
 from plone.app.testing import pushGlobalRegistry
 from plone.rest.cors import CORSPolicy
@@ -10,12 +8,12 @@
 from zope.event import notify
 from zope.interface import Interface
 from zope.publisher.interfaces.browser import IDefaultBrowserLayer
+from ZPublisher.pubevents import PubStart
 
 import unittest
 
 
 class TestCORSPolicy(unittest.TestCase):
-
     layer = PLONE_REST_INTEGRATION_TESTING
 
     def setUp(self):
@@ -195,7 +193,6 @@ def test_preflight_cors_sets_status_code_200(self):
 
 
 class TestCORS(unittest.TestCase):
-
     layer = PLONE_REST_INTEGRATION_TESTING
 
     def setUp(self):
@@ -231,7 +228,7 @@ def test_simple_cors_gets_processed(self):
 
     def test_preflight_request_without_cors_policy_doesnt_render_service(self):
         # "Unregister" the current CORS policy
-        class NoCORSPolicy(object):
+        class NoCORSPolicy:
             def __new__(cls, context, request):
                 return None