Change "run" marker to "order", remove other markers

- the separate markers ("first", "last" etc) now are option used with
  the "order" marker (order("first"))

Author: mrbean-bremen

CHANGELOG.md

@@ -2,23 +2,27 @@
 
 ## Unreleased
 
+### Changes
+- changed the used marker from ``run`` to ``order``, removed all additional
+  markers (see [#38](https://github.com/ftobia/pytest-ordering/issues/38))
+
 ## [Version 0.7.0](https://pypi.org/project/pytest-ordering2/0.7.0/)
 Imported version from [pytest-ordering](https://github.com/ftobia/pytest-ordering), 
 including some PRs (manually merged).
 
 ### Added
-- Add support for markers like run(before=...), run(after=), run("first") etc.
+- added support for markers like run(before=...), run(after=),
+  run("first") etc.
   (imported from [PR #37](https://github.com/ftobia/pytest-ordering/pull/37))
-- Add ``--indulgent-ordering`` to request that the sort from
+- added ``--indulgent-ordering`` to request that the sort from
   pytest-ordering be run before other plugins.  This allows the built-in
   ``--failed-first`` implementation to override the ordering.
   (imported from [PR #50](https://github.com/ftobia/pytest-ordering/pull/50))
-- Include LICENSE file in distribution
+- include LICENSE file in distribution
   (imported from [PR #68](https://github.com/ftobia/pytest-ordering/pull/68))
 
 ### Infrastructure
-- PR #74 (imported)
-  Add more pytest versions, fix pytest-cov compatibility issue,
+- added more pytest versions, fix pytest-cov compatibility issue,
   remove Python 3.4, add Python 3.8
   (imported from [PR #74](https://github.com/ftobia/pytest-ordering/pull/74))
 - moved documentation to [GitHub Pages](https://mrbean-bremen.github.io/pytest-ordering2/)

docs/source/index.rst

@@ -1,14 +1,9 @@
-.. pytest-ordering documentation master file, created by
-   sphinx-quickstart on Mon Mar 17 18:20:44 2014.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
 pytest-ordering2: run your tests in  order
 ==========================================
 
 pytest-ordering2 is a pytest plugin to run your tests in any order that
-you specify. It provides custom markers_ that say when your tests should
-run in relation to each other. They can be absolute (i.e. first, or
+you specify. It provides the marker ``order``, that defines when your tests
+should run in relation to each other. They can be absolute (i.e. first, or
 second-to-last) or relative (i.e. run this test before this other test).
 
 Supported Python and pytest versions
@@ -52,11 +47,11 @@ With pytest-ordering, you can change the default ordering as follows:
 
  import pytest
 
- @pytest.mark.run(order=2)
+ @pytest.mark.order(2)
  def test_foo():
      assert True
 
- @pytest.mark..run(order=1)
+ @pytest.mark.order(1)
  def test_bar():
      assert True
 
@@ -80,25 +75,25 @@ By number
 ---------
 As already shown above, the order can be defined using ordinal numbers.
 Negative numbers are also allowed - they are used the same way as indexes
-used in Python lists, e.g. to count from the end:
+are used in Python lists, e.g. to count from the end:
 
 .. code:: python
 
  import pytest
 
- @pytest.mark.run(order=-2)
+ @pytest.mark.order(-2)
  def test_three():
      assert True
 
- @pytest.mark.run(order=-1)
+ @pytest.mark.order(-1)
  def test_four():
      assert True
 
- @pytest.mark.run(order=2)
+ @pytest.mark.order(2)
  def test_two():
      assert True
 
- @pytest.mark.run(order=1)
+ @pytest.mark.order(1)
  def test_one():
      assert True
 
@@ -129,19 +124,19 @@ as the numbers 1, 2, -1 and -2 that have been shown above:
 
  import pytest
 
- @pytest.mark.second_to_last
+ @pytest.mark.order('second_to_last')
  def test_three():
      assert True
 
- @pytest.mark.last
+ @pytest.mark.order('last')
  def test_four():
      assert True
 
- @pytest.mark.second
+ @pytest.mark.order('second')
  def test_two():
      assert True
 
- @pytest.mark.first
+ @pytest.mark.order('first')
  def test_one():
      assert True
 
@@ -170,7 +165,7 @@ by their name:
 
  import pytest
 
- @pytest.mark.run(after='test_second')
+ @pytest.mark.order(after='test_second')
  def test_third():
      assert True
 
@@ -206,7 +201,7 @@ your completion time. You can use the pytest-ordering2 plugin to inform pytest
 of this.
 Now suppose you also want to prioritize tests which failed during the
 previous run, by using the ``--failed-first`` option. By default,
-pytest-ordering will override the ``--failed-first`` order, but by adding the
+pytest-ordering2 will override the ``--failed-first`` order, but by adding the
 ``--indulgent-ordering`` option, you can ask pytest to run the sort from
 pytest-ordering2 *before* the sort from ``--failed-first``, allowing the failed
 tests to be sorted to the front.

example/test_number.py

@@ -1,21 +1,21 @@
 import pytest
 
 
-@pytest.mark.run(order=-2)
+@pytest.mark.order(-2)
 def test_three():
     assert True
 
 
-@pytest.mark.run(order=-1)
+@pytest.mark.order(-1)
 def test_four():
     assert True
 
 
-@pytest.mark.run(order=2)
+@pytest.mark.order(2)
 def test_two():
     assert True
 
 
-@pytest.mark.run(order=1)
+@pytest.mark.order(1)
 def test_one():
     assert True

example/test_ordinals.py

@@ -1,21 +1,21 @@
 import pytest
 
 
-@pytest.mark.run('second_to_last')
+@pytest.mark.order('second_to_last')
 def test_three():
     assert True
 
 
-@pytest.mark.run('last')
+@pytest.mark.order('last')
 def test_four():
     assert True
 
 
-@pytest.mark.run('second')
+@pytest.mark.order('second')
 def test_two():
     assert True
 
 
-@pytest.mark.run('first')
+@pytest.mark.order('first')
 def test_one():
     assert True

example/test_other.py

@@ -1,21 +1,21 @@
 import pytest
 
 
-@pytest.mark.second_to_last
+@pytest.mark.order('second_to_last')
 def test_three():
     assert True
 
 
-@pytest.mark.last
+@pytest.mark.order('last')
 def test_four():
     assert True
 
 
-@pytest.mark.second
+@pytest.mark.order('second')
 def test_two():
     assert True
 
 
-@pytest.mark.first
+@pytest.mark.order('first')
 def test_one():
     assert True

example/test_relative.py

@@ -1,7 +1,7 @@
 import pytest
 
 
-@pytest.mark.run(after='test_second')
+@pytest.mark.order(after='test_second')
 def test_third():
     assert True
 
@@ -10,6 +10,6 @@ def test_second():
     assert True
 
 
-@pytest.mark.run(before='test_second')
+@pytest.mark.order(before='test_second')
 def test_first():
     assert True

pytest_ordering2/__init__.py

@@ -2,6 +2,7 @@
 import os
 import re
 import sys
+from warnings import warn
 
 import pytest
 
@@ -28,16 +29,16 @@
 
 
 def pytest_configure(config):
-    """Register the "run" marker and configure the plugin depending on the CLI
-    options"""
+    """Register the "order" marker and configure the plugin depending
+     on the CLI options"""
 
     provided_by_pytest_ordering = (
         'Provided by pytest-ordering2. '
         'See also: http://pytest-ordering.readthedocs.org/'
     )
 
     config_line = (
-            'run: specify ordering information for when tests should run '
+            'order: specify ordering information for when tests should run '
             'in relation to one another. ' + provided_by_pytest_ordering
     )
     config.addinivalue_line('markers', config_line)
@@ -70,9 +71,9 @@ def pytest_addoption(parser):
     group = parser.getgroup('ordering')
     group.addoption('--indulgent-ordering', action='store_true',
                     dest='indulgent-ordering', help=
-                    '''Request that the sort \
-order provided by pytest-ordering be applied before other sorting, \
-allowing the other sorting to have priority''')
+                    'Request that the sort order provided by pytest-order '
+                    'be applied before other sorting, allowing the '
+                    'other sorting to have priority')
 
 
 class OrderingPlugin(object):
@@ -98,17 +99,24 @@ def mark_binning(item, keys, start, end, before, after, unordered):
         order = int(find_order.group(1))
         start.setdefault(order, []).append(item)
         return True
-    elif "run" in keys:
-        mark = item.get_closest_marker('run')
-        order = mark.kwargs.get('order')
+    elif "order" in keys:
+        mark = item.get_closest_marker('order')
+        order = mark.args[0] if mark.args else None
         before_mark = mark.kwargs.get('before')
         after_mark = mark.kwargs.get('after')
         if order is not None:
-            order = int(order)
-            if order < 0:
-                end.setdefault(order, []).append(item)
+            if isinstance(order, int):
+                order = int(order)
+            elif order in orders_map:
+                order = orders_map[order]
             else:
-                start.setdefault(order, []).append(item)
+                warn("Unknown order attribute:'{}'".format(order))
+                order = None
+            if order is not None:
+                if order < 0:
+                    end.setdefault(order, []).append(item)
+                else:
+                    start.setdefault(order, []).append(item)
         elif before_mark:
             if "." not in before_mark:
                 prefix = get_filename(item)
@@ -120,24 +128,7 @@ def mark_binning(item, keys, start, end, before, after, unordered):
                 after_mark = prefix + "." + after_mark
 
             after.setdefault(after_mark, []).append(item)
-        else:
-            for ordinal, position in orders_map.items():
-                if ordinal in mark.args:
-                    if position < 0:
-                        end.setdefault(position, []).append(item)
-                    else:
-                        start.setdefault(position, []).append(item)
-                    break
         return True
-    for mark_name, order in orders_map.items():
-        mark = item.get_closest_marker(mark_name)
-        if mark:
-            order = int(order)
-            if order < 0:
-                end.setdefault(order, []).append(item)
-            else:
-                start.setdefault(order, []).append(item)
-            return True
     unordered.append(item)
     return False
 

tests/test_indulgent_ordering.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
-import re
 
 import pytest
+
 import pytest_ordering2
 
 pytest_plugins = ["pytester"]
@@ -14,14 +14,14 @@ def test_run_marker_registered(capsys, tmpdir):
             """
 import pytest
 
-@pytest.mark.second
+@pytest.mark.order('second')
 def test_me_second():
     assert True
 
 def test_that_fails():
     assert False
 
-@pytest.mark.first
+@pytest.mark.order('first')
 def test_me_first():
     assert True
 """