Refactor plugin module into a package

Author: jbasko

pytest_random_order/__init__.py

@@ -0,0 +1,59 @@
+import sys
+import traceback
+
+from pytest_random_order.shuffler import _get_set_of_item_ids, _shuffle_items, _disable
+
+
+def pytest_addoption(parser):
+    group = parser.getgroup('random-order')
+    group.addoption(
+        '--random-order-bucket',
+        action='store',
+        dest='random_order_bucket',
+        default='module',
+        choices=('global', 'package', 'module', 'class'),
+        help='Limit reordering of test items across units of code',
+    )
+
+
+def pytest_report_header(config):
+    out = None
+
+    if config.getoption('random_order_bucket'):
+        bucket = config.getoption('random_order_bucket')
+        out = "Using --random-order-bucket={0}".format(bucket)
+
+    return out
+
+
+def pytest_collection_modifyitems(session, config, items):
+    failure = None
+
+    item_ids = _get_set_of_item_ids(items)
+
+    try:
+        bucket_type = config.getoption('random_order_bucket')
+        _shuffle_items(items, key=_random_order_item_keys[bucket_type], disable=_disable)
+
+    except Exception as e:
+        # See the finally block -- we only fail if we have lost user's tests.
+        _, _, exc_tb = sys.exc_info()
+        failure = 'pytest-random-order plugin has failed with {!r}:\n{}'.format(
+            e, ''.join(traceback.format_tb(exc_tb, 10))
+        )
+        config.warn(0, failure, None)
+
+    finally:
+        # Fail only if we have lost user's tests
+        if item_ids != _get_set_of_item_ids(items):
+            if not failure:
+                failure = 'pytest-random-order plugin has failed miserably'
+            raise RuntimeError(failure)
+
+
+_random_order_item_keys = {
+    'global': lambda x: None,
+    'package': lambda x: x.module.__package__,
+    'module': lambda x: x.module.__name__,
+    'class': lambda x: (x.module.__name__, x.cls.__name__) if x.cls else x.module.__name__,
+}

pytest_random_order/plugin.py

@@ -1,40 +1,7 @@
 # -*- coding: utf-8 -*-
 
-import random
-import sys
-import traceback
-
 import operator
-
-
-def pytest_addoption(parser):
-    group = parser.getgroup('random-order')
-    group.addoption(
-        '--random-order-bucket',
-        action='store',
-        dest='random_order_bucket',
-        default='module',
-        choices=('global', 'package', 'module', 'class'),
-        help='Limit reordering of test items across units of code',
-    )
-
-
-def pytest_report_header(config):
-    out = None
-
-    if config.getoption('random_order_bucket'):
-        bucket = config.getoption('random_order_bucket')
-        out = "Using --random-order-bucket={0}".format(bucket)
-
-    return out
-
-
-_random_order_item_keys = {
-    'global': lambda x: None,
-    'package': lambda x: x.module.__package__,
-    'module': lambda x: x.module.__name__,
-    'class': lambda x: (x.module.__name__, x.cls.__name__) if x.cls else x.module.__name__,
-}
+import random
 
 
 def _shuffle_items(items, key=None, disable=None, preserve_bucket_order=False):
@@ -120,28 +87,3 @@ def _disable(item):
     except AttributeError:
         pass
     return False
-
-
-def pytest_collection_modifyitems(session, config, items):
-    failure = None
-
-    item_ids = _get_set_of_item_ids(items)
-
-    try:
-        bucket_type = config.getoption('random_order_bucket')
-        _shuffle_items(items, key=_random_order_item_keys[bucket_type], disable=_disable)
-
-    except Exception as e:
-        # See the finally block -- we only fail if we have lost user's tests.
-        _, _, exc_tb = sys.exc_info()
-        failure = 'pytest-random-order plugin has failed with {!r}:\n{}'.format(
-            e, ''.join(traceback.format_tb(exc_tb, 10))
-        )
-        config.warn(0, failure, None)
-
-    finally:
-        # Fail only if we have lost user's tests
-        if item_ids != _get_set_of_item_ids(items):
-            if not failure:
-                failure = 'pytest-random-order plugin has failed miserably'
-            raise RuntimeError(failure)

pytest_random_order.py renamed to pytest_random_order/shuffler.py

@@ -13,7 +13,7 @@ def read(fname):
 
 setup(
     name='pytest-random-order',
-    version='0.3.1',
+    version='0.4.0',
     author='Jazeps Basko',
     author_email='[email protected]',
     maintainer='Jazeps Basko',
@@ -22,7 +22,7 @@ def read(fname):
     url='https://github.com/jbasko/pytest-random-order',
     description='Randomise the order in which pytest tests are run with some control over the randomness',
     long_description=read('README.rst'),
-    py_modules=['pytest_random_order'],
+    py_modules=['pytest_random_order.plugin', 'pytest_random_order.shuffler'],
     install_requires=['pytest>=2.9.2'],
     classifiers=[
         'Development Status :: 4 - Beta',
@@ -38,7 +38,7 @@ def read(fname):
     ],
     entry_points={
         'pytest11': [
-            'random-order = pytest_random_order',
+            'random-order = pytest_random_order.plugin',
         ],
     },
 )

setup.py

@@ -30,7 +30,7 @@ def test_a2():
 
 
 def test_faulty_shuffle_that_preserves_items_does_not_fail_test_run(monkeypatch, simple_testdir):
-    monkeypatch.setattr('pytest_random_order._shuffle_items', acceptably_failing_shuffle_items)
+    monkeypatch.setattr('pytest_random_order.plugin._shuffle_items', acceptably_failing_shuffle_items)
 
     result = simple_testdir.runpytest()
     result.assert_outcomes(passed=2)
@@ -40,7 +40,7 @@ def test_faulty_shuffle_that_preserves_items_does_not_fail_test_run(monkeypatch,
 
 
 def test_faulty_shuffle_that_loses_items_fails_test_run(monkeypatch, simple_testdir):
-    monkeypatch.setattr('pytest_random_order._shuffle_items', critically_failing_shuffle_items)
+    monkeypatch.setattr('pytest_random_order.plugin._shuffle_items', critically_failing_shuffle_items)
     result = simple_testdir.runpytest()
     result.assert_outcomes(passed=0, failed=0, skipped=0)
     result.stdout.fnmatch_lines("""
@@ -49,7 +49,7 @@ def test_faulty_shuffle_that_loses_items_fails_test_run(monkeypatch, simple_test
 
 
 def test_seemingly_ok_shuffle_that_loses_items_fails_test_run(monkeypatch, simple_testdir):
-    monkeypatch.setattr('pytest_random_order._shuffle_items', critically_not_failing_shuffle_items)
+    monkeypatch.setattr('pytest_random_order.plugin._shuffle_items', critically_not_failing_shuffle_items)
     result = simple_testdir.runpytest()
     result.assert_outcomes(passed=0, failed=0, skipped=0)
     result.stdout.fnmatch_lines("""

tests/test_plugin_failure.py

@@ -1,7 +1,7 @@
 import pytest
 
 
-from pytest_random_order import _shuffle_items
+from pytest_random_order.shuffler import _shuffle_items
 
 
 def identity_key(x):

tests/test_shuffle.py

@@ -9,4 +9,4 @@ commands = py.test {posargs:tests}
 [testenv:flake8]
 skip_install = true
 deps = flake8
-commands = flake8 pytest_random_order.py setup.py tests
+commands = flake8 pytest_random_order setup.py tests