Merge pull request #1672 from ThomasWaldmann/black

Black integration, fixes #1662

Author: ThomasWaldmann

.github/workflows/black.yaml

@@ -0,0 +1,15 @@
+# https://black.readthedocs.io/en/stable/integrations/github_actions.html#usage
+# see also what we use locally, requirements.d/codestyle.txt - should be the same version here.
+
+name: Lint
+
+on: [push, pull_request]
+
+jobs:
+  lint:
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: psf/black@stable
+        with:
+            version: "~= 24.0"

.pre-commit-config.yaml

@@ -0,0 +1,10 @@
+repos:
+ -   repo: https://github.com/psf/black
+     rev: 24.3.0
+     hooks:
+     -   id: black
+ -   repo: https://github.com/pycqa/flake8
+     rev: 6.1.0
+     hooks:
+     -   id: flake8
+         files: '(src|_ui_tests|contrib|scripts|quickinstall.py)'

_ui_tests/conftest.py

@@ -27,6 +27,5 @@ def pytest_runtest_makereport(item, call):
     fails, ie whenever the method throws an exception
     """
     if call.excinfo is not None:
-        if driver_register.get_driver() is not None and hasattr(item, 'obj'):
-            driver_register.get_driver().get_screenshot_as_file(
-                str(item.obj).split(" ")[2] + '.png')
+        if driver_register.get_driver() is not None and hasattr(item, "obj"):
+            driver_register.get_driver().get_screenshot_as_file(str(item.obj).split(" ")[2] + ".png")

_ui_tests/test_subitems.py

@@ -24,10 +24,8 @@ def create_wiki_item(self, item_name):
         driver.get(self.base_url + "/" + item_name)
         driver.find_element_by_link_text("Default").click()
         driver.find_element_by_link_text("Wiki (MoinMoin)").click()
-        driver.find_element_by_link_text(
-            "create the item from scratch").click()
-        driver.find_element_by_id("f_content_form_data_text").send_keys(
-            "This is a test item\n")
+        driver.find_element_by_link_text("create the item from scratch").click()
+        driver.find_element_by_id("f_content_form_data_text").send_keys("This is a test item\n")
         driver.find_element_by_id("f_submit").click()
 
     def test_createsubitem(self):
@@ -38,26 +36,23 @@ def test_createsubitem(self):
 
         driver.get(self.base_url + "/" + self.base_item_name)
         driver.find_element_by_link_text("Modify").click()
-        driver.find_element_by_id("f_content_form_data_text").send_keys(
-            "\n[[/" + self.subitem_name + "]]\n")
+        driver.find_element_by_id("f_content_form_data_text").send_keys("\n[[/" + self.subitem_name + "]]\n")
         driver.find_element_by_id("f_submit").click()
         driver.find_element_by_link_text("/" + self.subitem_name).click()
         driver.find_element_by_link_text("Default").click()
         driver.find_element_by_link_text("Wiki (MoinMoin)").click()
         driver.find_element_by_link_text("create the item from scratch").click()
-        driver.find_element_by_id("f_content_form_data_text").send_keys(
-            "This is a test subitem")
+        driver.find_element_by_id("f_content_form_data_text").send_keys("This is a test subitem")
         driver.find_element_by_id("f_submit").click()
-        assert "This is a test subitem" in driver.find_element_by_id(
-            "moin-content-data").text
-        assert driver.title.split(" - ")[0] == self.base_item_name + \
-            "/" + self.subitem_name
+        assert "This is a test subitem" in driver.find_element_by_id("moin-content-data").text
+        assert driver.title.split(" - ")[0] == self.base_item_name + "/" + self.subitem_name
 
     def teardown_class(self):
         """shuts down browser"""
         self.driver.quit()
 
-if __name__ == '__main__':
+
+if __name__ == "__main__":
     # This lets us run the test directly, without using pytest
     # This is useful for example for being able to call help, eg
     # 'help(driver)', or 'help(driver.find_element_by_id("f_submit"))'

_ui_tests/utils.py

@@ -9,15 +9,15 @@
 
 import pytest
 
-pytest.importorskip('selenium')
+pytest.importorskip("selenium")
 webdriver = selenium.webdriver  # noqa
 
 import config
 
 try:
     f = urllib.request.urlopen(config.BASE_URL)
 except OSError:
-    pytestmark = pytest.mark.skip('The UI tests need a wiki server running on %s' % config.BASE_URL)
+    pytestmark = pytest.mark.skip("The UI tests need a wiki server running on %s" % config.BASE_URL)
 
 import driver_register
 
@@ -41,7 +41,7 @@ def generate_random_word(length):
     """
     generates a random string containing numbers, of length 'length'
     """
-    word = str(random.randint(10 ** (length - 1), 10 ** length))
+    word = str(random.randint(10 ** (length - 1), 10**length))
     return word