pre-commit docformatter integration

This uses a custom docformatter, since upstream repository is currently broken, see:
PyCQA/docformatter#293

.pre-commit-config.yaml

@@ -38,3 +38,7 @@ repos:
     hooks:
       - id: bandit
         exclude: "^(doc/.*|se/test_.*)$"
+  - repo: https://github.com/biolds/docformatter
+    rev: v1.7.6-alpha
+    hooks:
+      - id: docformatter

se/test_views.py

@@ -134,9 +134,7 @@ def test_views(self):
                 self._view_request(url, view_cls, params, self.anon_user, anon_expected)
 
     def test_views_no_auth(self):
-        """
-        Test views that require no authentication
-        """
+        """Test views that require no authentication."""
         for url, view_cls, params in (("/opensearch.xml", OpensearchView, {}),):
             for anon_search in (True, False):
                 with self.settings(SOSSE_ANONYMOUS_SEARCH=anon_search):
@@ -145,9 +143,8 @@ def test_views_no_auth(self):
                     self._view_request(url, view_cls, params, self.anon_user, 200)
 
     def test_views_no_auth_redirect(self):
-        """
-        Test views that do not redirect to the login page when auth is required
-        """
+        """Test views that do not redirect to the login page when auth is
+        required."""
         for url, view_cls, params in (
             ("/atom/?q=page", AtomView, {}),
             ("/atom/?q=page&cached=1", AtomView, {}),

se/views.py

@@ -28,10 +28,8 @@
 
 
 def format_url(request, params):
-    """
-    This function takes the current url and replaces query parameters
-    by new values provided
-    """
+    """This function takes the current url and replaces query parameters by new
+    values provided."""
     parsed_url = urlparse(request.get_full_path())
     query_string = parse_qs(parsed_url.query)
     for k, v in query_string.items():

sosse/settings.py

@@ -12,9 +12,7 @@
 #
 # You should have received a copy of the GNU Affero General Public License along with SOSSE.
 # If not, see <https://www.gnu.org/licenses/>.
-
-"""
-Django settings for SOSSE project.
+"""Django settings for SOSSE project.
 
 Generated by 'django-admin startproject' using Django 2.2.25.
 

sosse/sosse_admin.py

@@ -13,7 +13,6 @@
 #
 # You should have received a copy of the GNU Affero General Public License along with SOSSE.
 # If not, see <https://www.gnu.org/licenses/>.
-
 """Django's command-line utility for administrative tasks."""
 
 import os

sosse/urls.py

@@ -12,8 +12,7 @@
 #
 # You should have received a copy of the GNU Affero General Public License along with SOSSE.
 # If not, see <https://www.gnu.org/licenses/>.
-
-"""sosse URL Configuration
+"""Sosse URL Configuration.
 
 The `urlpatterns` list routes URLs to views. For more information please see:
     https://docs.djangoproject.com/en/2.2/topics/http/urls/

sosse/wsgi.py

@@ -12,9 +12,7 @@
 #
 # You should have received a copy of the GNU Affero General Public License along with SOSSE.
 # If not, see <https://www.gnu.org/licenses/>.
-
-"""
-WSGI config for sosse project.
+"""WSGI config for sosse project.
 
 It exposes the WSGI callable as a module-level variable named ``application``.