Use nodeid instead of dot notation of relative markers

- closes #24

Author: mrbean-bremen

CHANGELOG.md

@@ -2,13 +2,11 @@
 
 ## Unreleased
 
-_Breaking changes in next major version_:
-With that version the notation of relative markers in other modules is also 
-planned to change - instead of using the dot notation, the standard pytest
-nodeid will be used. 
-
 ### Breaking changes
 - removed support for Python 2.7 and 3.5
+- changed notation of relative markers in other modules - instead of using
+  the dot notation, the standard pytest nodeid is used,
+  see [#24](https://github.com/pytest-dev/pytest-order/issues/24)
 
 ## [Version 0.11.0](https://pypi.org/project/pytest-order/0.11.0/) (2021-04-11)
 Adds support for multiple relative markers for the same test.

docs/source/index.rst

@@ -356,9 +356,11 @@ with a ``::`` suffix has to be prepended to the test name:
      def test_c(self):
          assert True
 
-If the referenced test lives in another module, the test name has to be
-prepended by the module path to be uniquely identifiable. Let's say we have
-the following module and test layout:
+If the referenced test lives in another module, you have to use the nodeid
+of the test, or a part of the nodeid that is sufficient to make it uniquely
+identifiable (the nodeid is the test ID that pytest prints if you run it with
+the ``-v`` option).
+Let's say we have the following module and test layout:
 
 ::
 
@@ -383,11 +385,11 @@ modules, this could be expressed like:
 
  import pytest
 
- @pytest.mark.order(after="test_module_a.TestA::test_a")
+ @pytest.mark.order(after="test_module_a.py::TestA::test_a")
  def test_a():
      assert True
 
- @pytest.mark.order(before="test_module_c.test_submodule.test_2")
+ @pytest.mark.order(before="test_module_c/test_submodule.py::test_2")
  def test_b():
      assert True
 
@@ -466,15 +468,15 @@ attributes by using a list or tuple of test names:
 
  import pytest
 
- @pytest.mark.order(after=["test_second", "other_module.test_other"])
+ @pytest.mark.order(after=["test_second", "other_module.py::test_other"])
  def test_first():
      assert True
 
  def test_second():
      assert True
 
 This will ensure that ``test_first`` is executed both after ``test_second``
-and after ``test_other`` which resides in the module ``other_module``.
+and after ``test_other`` which resides in the module ``other_module.py``.
 
 Configuration
 =============
@@ -784,7 +786,7 @@ Here is a similar example using relative markers:
 
   import pytest
 
-  @pytest.mark.order(after="test_module2.test1")
+  @pytest.mark.order(after="test_module2.py::test1")
   def test1():
       pass
 

example/test_modules_b.py

@@ -4,11 +4,11 @@
 import pytest
 
 
-@pytest.mark.order(after="test_module_a.TestA::test_a")
+@pytest.mark.order(after="test_module_a.py::TestA::test_a")
 def test_a():
     assert True
 
 
-@pytest.mark.order(before="test_module_c.test_submodule.test_2")
+@pytest.mark.order(before="test_module_c.py::test_submodule.test_2")
 def test_b():
     assert True

pytest_order/item.py

@@ -37,10 +37,6 @@ def node_id(self) -> str:
             self._node_id = self.item.nodeid.replace("::()", "")
         return self._node_id
 
-    @property
-    def label(self) -> str:
-        return self.node_id.replace(".py::", ".").replace("/", ".")
-
 
 class ItemList:
     """Handles a group of items with the same scope."""
@@ -99,8 +95,8 @@ def sort_numbered_items(self) -> List[Item]:
         return sorted_list
 
     def print_unhandled_items(self):
-        msg = " ".join([mark.item.label for mark in self.rel_marks] +
-                       [mark.item.label 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: ")

pytest_order/sorter.py

@@ -141,7 +141,6 @@ def item_from_label(
             self, label: str,
             item: Item,
             is_cls_mark: bool) -> Optional[Item]:
-        label = self.node_id_from_label(label)
         item_id = item.node_id
         label_len = len(label)
         last_comp = label.split("/")[-1].split("::")[-1]
@@ -159,7 +158,6 @@ def item_from_label(
 
     def items_from_class_label(self, label: str, item: Item) -> List[Item]:
         items = []
-        label = self.node_id_from_label(label)
         item_id = item.node_id
         label_len = len(label)
         for node_id in self.node_ids:
@@ -171,13 +169,6 @@ def items_from_class_label(self, label: str, item: Item) -> List[Item]:
                         items.append(self.node_ids[node_id])
         return items
 
-    @staticmethod
-    def node_id_from_label(label: str) -> str:
-        if "." in label:
-            label_comp = label.split(".")
-            label = ".py::".join(["/".join(label_comp[:-1]), label_comp[-1]])
-        return label
-
     def handle_before_or_after_mark(
             self,
             item: Item,

setup.cfg

@@ -2,6 +2,6 @@
 description-file = README.md
 license_files = LICENSE
 [bdist_wheel]
-universal=1
+universal=0
 [tool:pytest]
 testpaths = tests

tests/test_order_group_scope_relative.py

@@ -22,7 +22,7 @@ class Test2:
         def test_one(self):
             assert True
 
-        @pytest.mark.order(after='test_rel3.test_two')
+        @pytest.mark.order(after='test_rel3.py::test_two')
         def test_two(self):
             assert True
     """,
@@ -39,7 +39,7 @@ def test_two():
     def test_one():
         assert True
 
-    @pytest.mark.order(before='test_rel2.test_one')
+    @pytest.mark.order(before='test_rel2.py::test_one')
     def test_two():
         assert True
     """,

tests/test_relative_ordering.py

@@ -138,11 +138,11 @@ def fixture_path(test_path):
     import pytest
 
     class TestA:
-        @pytest.mark.order(after="mod2_test.TestB::test_b")
+        @pytest.mark.order(after="mod2_test.py::TestB::test_b")
         def test_a(self):
             pass
 
-        @pytest.mark.order(after="sub.mod3_test.test_b")
+        @pytest.mark.order(after="sub/mod3_test.py::test_b")
         def test_b(self):
             pass
 
@@ -153,7 +153,7 @@ def test_c(self):
     import pytest
 
     class TestB:
-        @pytest.mark.order(before="mod1_test.TestA::test_c")
+        @pytest.mark.order(before="mod1_test.py::TestA::test_c")
         def test_a(self):
             pass
 
@@ -168,7 +168,7 @@ def test_c(self):
     path.write("""
 import pytest
 
-@pytest.mark.order(before="mod2_test.TestB::test_c")
+@pytest.mark.order(before="mod2_test.py::TestB::test_c")
 def test_a():
     pass
 
@@ -356,7 +356,7 @@ def test_dependency_after_unknown_test(item_names_for, capsys):
     test_content = """
     import pytest
 
-    @pytest.mark.order(after="some_module.test_2")
+    @pytest.mark.order(after="some_module.py::test_2")
     def test_1():
         pass
 
@@ -366,7 +366,7 @@ def test_2():
     assert item_names_for(test_content) == ["test_1", "test_2"]
     out, err = capsys.readouterr()
     warning = ("cannot execute test relative to others: "
-               "some_module.test_2 - ignoring the marker")
+               "some_module.py::test_2 - ignoring the marker")
     assert warning in out
 
 
@@ -434,5 +434,5 @@ def test_3():
     assert item_names_for(test_content) == ["test_2", "test_1", "test_3"]
     out, err = capsys.readouterr()
     warning = ("cannot execute test relative to others: "
-               "test_dependency_loop.test_3")
+               "test_dependency_loop.py::test_3")
     assert warning in out