Black code formatting (#32)

* Black code formatting of all Python code

Author: DevilXD

.vscode/settings.json

@@ -0,0 +1,10 @@
+{
+    "restructuredtext.confPath": "${workspaceFolder}\\docs\\source",
+    "python.formatting.blackArgs": [
+        "--line-length",
+        "79",
+        "--skip-string-normalization"
+    ],
+    "python.formatting.provider": "black",
+    "editor.rulers": [79, 87]
+}

docs/source/conf.py

@@ -18,9 +18,7 @@
 import os
 import sys
 
-sys.path.insert(
-    0, os.path.split(os.path.split(os.path.dirname(os.path.abspath(
-        __file__)))[0])[0])
+sys.path.insert(0, os.path.abspath("../.."))
 
 from pytest_order import __version__  # noqa: E402
 
@@ -53,7 +51,7 @@
 master_doc = "index"
 
 # General information about the project.
-project = u"pytest-order"
+project = "pytest-order"
 
 # The version info for the project you"re documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -205,8 +203,13 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    ("index", "pytest-order.tex", u"pytest-order Documentation",
-     u"Frank Tobia", "manual"),
+    (
+        "index",
+        "pytest-order.tex",
+        "pytest-order Documentation",
+        "Frank Tobia",
+        "manual",
+    ),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
@@ -235,8 +238,13 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    ("index", "pytest-order", u"pytest-order Documentation",
-     [u"Frank Tobia"], 1)
+    (
+        "index",
+        "pytest-order",
+        "pytest-order Documentation",
+        ["Frank Tobia"],
+        1,
+    )
 ]
 
 # If true, show URL addresses after external links.
@@ -249,9 +257,15 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    ("index", "pytest-order", u"pytest-order Documentation",
-     u"Frank Tobia", "pytest-order", "One line description of project.",
-     "Miscellaneous"),
+    (
+        "index",
+        "pytest-order",
+        "pytest-order Documentation",
+        "Frank Tobia",
+        "pytest-order",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]
 
 # Documents to append as an appendix to all manuals.

perf_tests/test_dependencies.py

@@ -1,4 +1,5 @@
 from unittest import mock
+from textwrap import dedent
 
 import pytest
 from perf_tests.util import TimedSorter
@@ -10,21 +11,23 @@
 def fixture_path_relative(testdir):
     for i_mod in range(10):
         test_name = testdir.tmpdir.join("test_dep_perf{}.py".format(i_mod))
-        test_contents = """
-import pytest
-"""
+        test_contents = "import pytest\n"
         for i in range(40):
-            test_contents += """
-@pytest.mark.dependency(depends=["test_{}"])
-def test_{}():
-    assert True
-""".format(i + 50, i)
+            test_contents += dedent(
+                """
+                @pytest.mark.dependency(depends=["test_{}"])
+                def test_{}():
+                    assert True
+                """
+            ).format(i + 50, i)
         for i in range(60):
-            test_contents += """
-@pytest.mark.dependency
-def test_{}():
-    assert True
-""".format(i + 40)
+            test_contents += dedent(
+                """
+                @pytest.mark.dependency
+                def test_{}():
+                    assert True
+                """
+            ).format(i + 40)
         test_name.write(test_contents)
     yield testdir
 

perf_tests/test_ordinal.py

@@ -1,4 +1,5 @@
 from unittest import mock
+from textwrap import dedent
 
 import pytest
 from perf_tests.util import TimedSorter
@@ -10,15 +11,15 @@
 def fixture_path_ordinal(testdir):
     for i_mod in range(10):
         test_name = testdir.tmpdir.join("test_performance{}.py".format(i_mod))
-        test_contents = """
-import pytest
-"""
+        test_contents = "import pytest\n"
         for i in range(100):
-            test_contents += """
-@pytest.mark.order({})
-def test_{}():
-    assert True
-""".format(50 - i, i)
+            test_contents += dedent(
+                """
+                @pytest.mark.order({})
+                def test_{}():
+                    assert True
+                """
+            ).format(50 - i, i)
         test_name.write(test_contents)
     yield testdir
 

perf_tests/test_relative.py

@@ -1,4 +1,5 @@
 from unittest import mock
+from textwrap import dedent
 
 import pytest
 from perf_tests.util import TimedSorter
@@ -10,21 +11,24 @@
 def fixture_path_relative(testdir):
     for i_mod in range(10):
         test_name = testdir.tmpdir.join(
-            "test_relative_perf{}.py".format(i_mod))
-        test_contents = """
-import pytest
-"""
+            "test_relative_perf{}.py".format(i_mod)
+        )
+        test_contents = "import pytest\n"
         for i in range(40):
-            test_contents += """
-@pytest.mark.order(after="test_{}")
-def test_{}():
-    assert True
-""".format(i + 50, i)
+            test_contents += dedent(
+                """
+                @pytest.mark.order(after="test_{}")
+                def test_{}():
+                    assert True
+                """
+            ).format(i + 50, i)
         for i in range(60):
-            test_contents += """
-def test_{}():
-    assert True
-""".format(i + 40)
+            test_contents += dedent(
+                """
+                def test_{}():
+                    assert True
+                """
+            ).format(i + 40)
         test_name.write(test_contents)
     yield testdir
 

perf_tests/test_relative_dense.py

@@ -1,4 +1,5 @@
 from unittest import mock
+from textwrap import dedent
 
 import pytest
 from perf_tests.util import TimedSorter
@@ -10,21 +11,24 @@
 def fixture_path_relative_dense(testdir):
     for i_mod in range(10):
         test_name = testdir.tmpdir.join(
-            "test_relative_dense_perf{}.py".format(i_mod))
-        test_contents = """
-import pytest
-"""
+            "test_relative_dense_perf{}.py".format(i_mod)
+        )
+        test_contents = "import pytest\n"
         for i in range(90):
-            test_contents += """
-@pytest.mark.order(after="test_{}")
-def test_{}():
-    assert True
-""".format(i + 10, i)
+            test_contents += dedent(
+                """
+                @pytest.mark.order(after="test_{}")
+                def test_{}():
+                    assert True
+                """
+            ).format(i + 10, i)
         for i in range(10):
-            test_contents += """
-def test_{}():
-    assert True
-""".format(i + 90)
+            test_contents += dedent(
+                """
+                def test_{}():
+                    assert True
+                """
+            ).format(i + 90)
         test_name.write(test_contents)
     yield testdir
 

perf_tests/util.py

@@ -11,7 +11,8 @@ def sort_items(self):
         self.__class__.elapsed = 0
         start_time = time.time()
         items = super().sort_items()
-        self.__class__.elapsed = ((time.time() - start_time)
-                                  / self.nr_marks * 1000)
+        self.__class__.elapsed = (
+            (time.time() - start_time) / self.nr_marks * 1000
+        )
         print("\nTime per test: {:.3f} ms".format(self.__class__.elapsed))
         return items

pytest_order/item.py

@@ -3,7 +3,7 @@
 
 from _pytest.python import Function
 
-from pytest_order.settings import Scope, Settings
+from .settings import Scope, Settings
 
 
 class Item:
@@ -41,10 +41,14 @@ def node_id(self) -> str:
 class ItemList:
     """Handles a group of items with the same scope."""
 
-    def __init__(self, items: List[Item],
-                 settings: Settings, scope: Scope,
-                 rel_marks: List["RelativeMark"],
-                 dep_marks: List["RelativeMark"]) -> None:
+    def __init__(
+        self,
+        items: List[Item],
+        settings: Settings,
+        scope: Scope,
+        rel_marks: List["RelativeMark"],
+        dep_marks: List["RelativeMark"],
+    ) -> None:
         self.items = items
         self.settings = settings
         self.scope = scope
@@ -95,30 +99,37 @@ def sort_numbered_items(self) -> List[Item]:
         return sorted_list
 
     def print_unhandled_items(self) -> None:
-        msg = " ".join([mark.item.node_id for mark in self.rel_marks] +
-                       [mark.item.node_id for mark in self.dep_marks])
+        msg = " ".join(
+            [mark.item.node_id for mark in self.rel_marks]
+            + [mark.item.node_id for mark in self.dep_marks]
+        )
         if msg:
             sys.stdout.write(
-                "\nWARNING: cannot execute test relative to others: ")
+                "\nWARNING: cannot execute test relative to others: "
+            )
             sys.stdout.write(msg)
-            sys.stdout.write("- ignoring the marker.\n")
+            sys.stdout.write(" - ignoring the marker.\n")
             sys.stdout.flush()
 
     def number_of_rel_groups(self) -> int:
         return len(self.rel_marks) + len(self.dep_marks)
 
     def handle_rel_marks(self, sorted_list: List[Item]) -> None:
-        self.handle_relative_marks(self.rel_marks, sorted_list,
-                                   self.all_rel_marks)
+        self.handle_relative_marks(
+            self.rel_marks, sorted_list, self.all_rel_marks
+        )
 
     def handle_dep_marks(self, sorted_list: List[Item]) -> None:
-        self.handle_relative_marks(self.dep_marks, sorted_list,
-                                   self.all_dep_marks)
+        self.handle_relative_marks(
+            self.dep_marks, sorted_list, self.all_dep_marks
+        )
 
     @staticmethod
-    def handle_relative_marks(marks: List["RelativeMark"],
-                              sorted_list: List[Item],
-                              all_marks: List["RelativeMark"]):
+    def handle_relative_marks(
+        marks: List["RelativeMark"],
+        sorted_list: List[Item],
+        all_marks: List["RelativeMark"],
+    ):
         for mark in reversed(marks):
             if move_item(mark, sorted_list):
                 marks.remove(mark)
@@ -136,8 +147,9 @@ class ItemGroup:
     Used for sorting groups similar to Item for sorting items.
     """
 
-    def __init__(self, items: Optional[List[Item]] = None,
-                 order: Optional[int] = None) -> None:
+    def __init__(
+        self, items: Optional[List[Item]] = None, order: Optional[int] = None
+    ) -> None:
         self.items = items or []
         self.order = order
         self.nr_rel_items = 0
@@ -161,17 +173,20 @@ class RelativeMark:
     Holds two related items or groups and their relationship.
     """
 
-    def __init__(self, item: Union[Item, ItemGroup],
-                 item_to_move: Union[Item, ItemGroup],
-                 move_after: bool) -> None:
+    def __init__(
+        self,
+        item: Union[Item, ItemGroup],
+        item_to_move: Union[Item, ItemGroup],
+        move_after: bool,
+    ) -> None:
         self.item: Item = item
         self.item_to_move: Item = item_to_move
         self.move_after: bool = move_after
 
 
 def filter_marks(
-        marks: List[RelativeMark],
-        all_items: List[Item]) -> List[RelativeMark]:
+    marks: List[RelativeMark], all_items: List[Item]
+) -> List[RelativeMark]:
     result = []
     for mark in marks:
         if mark.item in all_items and mark.item_to_move in all_items:
@@ -181,11 +196,14 @@ def filter_marks(
     return result
 
 
-def move_item(mark: RelativeMark,
-              sorted_items: List[Union[Item, ItemGroup]]) -> bool:
-    if (mark.item not in sorted_items or
-            mark.item_to_move not in sorted_items or
-            mark.item.nr_rel_items):
+def move_item(
+    mark: RelativeMark, sorted_items: List[Union[Item, ItemGroup]]
+) -> bool:
+    if (
+        mark.item not in sorted_items
+        or mark.item_to_move not in sorted_items
+        or mark.item.nr_rel_items
+    ):
         return False
     pos_item = sorted_items.index(mark.item)
     pos_item_to_move = sorted_items.index(mark.item_to_move)