Moving pytest run fixture into pytest namespace.

Pytest namespaces are the proper place to put variables and functions,
instead of creating fixtures that just return functions.

Fixing broken lints due to changed dependencies.

Touching up CI files, docs conf.py file, and tox.ini file; from
PythonTemplates.

Author: Robpol86

.travis.yml

@@ -1,4 +1,5 @@
 # Configure.
+env: TOX_ENV=py
 language: python
 matrix:
   include:
@@ -27,7 +28,7 @@ install: pip install tox
 before_script:
   - git config --global user.email "[email protected]"
   - git config --global user.name "Travis CI"
-script: tox -e ${TOX_ENV:-py}
+script: tox -e $TOX_ENV
 after_success:
   - bash <(curl -s https://codecov.io/bash)
 

appveyor.yml

@@ -1,5 +1,6 @@
 # Configure.
 environment:
+  PATH: C:\%PYTHON%;C:\%PYTHON%\Scripts;%PATH%
   PYTHON: Python35
   matrix:
     - TOX_ENV: lint
@@ -17,7 +18,6 @@ environment:
       PYTHON: Python27-x64
 
 # Run.
-init: set PATH=C:\%PYTHON%;C:\%PYTHON%\Scripts;%PATH%
 build_script: pip install tox
 test_script: tox -e %TOX_ENV%
 on_success: IF %TOX_ENV% NEQ lint pip install codecov & codecov

docs/conf.py

@@ -1,18 +1,18 @@
 """Sphinx configuration file."""
 
 import os
+import sys
 import time
 
-from setup import NAME, VERSION
-
 
 # General configuration.
+sys.path.append(os.path.realpath(os.path.join(os.path.dirname(__file__), '..')))
 author = '@Robpol86'
 copyright = '{}, {}'.format(time.strftime('%Y'), author)
 master_doc = 'index'
-project = NAME
+project = __import__('setup').NAME
 pygments_style = 'friendly'
-release = version = VERSION
+release = version = __import__('setup').VERSION
 templates_path = ['_templates']
 extensions = list()
 
@@ -31,10 +31,12 @@
 html_theme = 'sphinx_rtd_theme'
 html_title = project
 
+
 # google analytics
 extensions.append('sphinxcontrib.googleanalytics')
 googleanalytics_id = 'UA-82627369-1'
 
+
 # SCVersioning.
 scv_banner_greatest_tag = True
 scv_grm_exclude = ('.gitignore', '.nojekyll', 'README.rst')

tests/conftest.py

@@ -11,6 +11,31 @@
 RE_URLS = re.compile('<li><a href="[^"]+">[^<]+</a></li>')
 
 
+def run(directory, command, *args, **kwargs):
+    """Run command using run_command() function. Supports string and py.path paths.
+
+    :param directory: Root git directory and current working directory.
+    :param iter command: Command to run.
+    :param iter args: Passed to run_command().
+    :param dict kwargs: Passed to run_command().
+
+    :return: run_command() output.
+    :rtype: str
+    """
+    return run_command(str(directory), [str(i) for i in command], *args, **kwargs)
+
+
+def pytest_namespace():
+    """Add objects to the pytest namespace. Can be retrieved by importing pytest and accessing pytest.<name>.
+
+    :return: Namespace dict.
+    :rtype: dict
+    """
+    return dict(
+        run=run,
+    )
+
+
 @pytest.fixture
 def config(monkeypatch):
     """Mock config from Click context.
@@ -26,19 +51,13 @@ def config(monkeypatch):
     return instance
 
 
-@pytest.fixture
-def run():
-    """run_command() wrapper returned from a pytest fixture."""
-    return lambda d, c, *args, **kwargs: run_command(str(d), [str(i) for i in c], *args, **kwargs)
-
-
 @pytest.fixture
 def banner():
     """Verify banner in HTML file match expected."""
     def match(path, expected_url=None, expected_base=None):
         """Assert equals and return file contents.
 
-        :param py.path path: Path to file to read.
+        :param py.path.local path: Path to file to read.
         :param str expected_url: Expected URL in <a href="" /> link.
         :param str expected_base: Expected base message.
 
@@ -61,7 +80,7 @@ def urls():
     def match(path, expected):
         """Assert equals and return file contents.
 
-        :param py.path path: Path to file to read.
+        :param py.path.local path: Path to file to read.
         :param list expected: Expected matches.
 
         :return: File contents.
@@ -75,11 +94,10 @@ def match(path, expected):
 
 
 @pytest.fixture
-def local_empty(tmpdir, run):
+def local_empty(tmpdir):
     """Local git repository with no commits.
 
     :param tmpdir: pytest fixture.
-    :param run: local fixture.
 
     :return: Path to repo root.
     :rtype: py.path
@@ -90,11 +108,10 @@ def local_empty(tmpdir, run):
 
 
 @pytest.fixture
-def remote(tmpdir, run):
+def remote(tmpdir):
     """Remote git repository with nothing pushed to it.
 
     :param tmpdir: pytest fixture.
-    :param run: local fixture.
 
     :return: Path to bare repo root.
     :rtype: py.path
@@ -105,11 +122,10 @@ def remote(tmpdir, run):
 
 
 @pytest.fixture
-def local_commit(local_empty, run):
+def local_commit(local_empty):
     """Local git repository with one commit.
 
     :param local_empty: local fixture.
-    :param run: local fixture.
 
     :return: Path to repo root.
     :rtype: py.path
@@ -121,12 +137,11 @@ def local_commit(local_empty, run):
 
 
 @pytest.fixture
-def local(local_commit, remote, run):
+def local(local_commit, remote):
     """Local git repository with branches, light tags, and annotated tags pushed to remote.
 
     :param local_commit: local fixture.
     :param remote: local fixture.
-    :param run: local fixture.
 
     :return: Path to repo root.
     :rtype: py.path
@@ -141,13 +156,12 @@ def local(local_commit, remote, run):
 
 
 @pytest.fixture
-def local_light(tmpdir, local, remote, run):
+def local_light(tmpdir, local, remote):
     """Light-weight local repository similar to how Travis/AppVeyor clone repos.
 
     :param tmpdir: pytest fixture.
     :param local: local fixture.
     :param remote: local fixture.
-    :param run: local fixture.
 
     :return: Path to repo root.
     :rtype: py.path
@@ -162,13 +176,12 @@ def local_light(tmpdir, local, remote, run):
 
 
 @pytest.fixture
-def outdate_local(tmpdir, local_light, remote, run):
+def outdate_local(tmpdir, local_light, remote):
     """Clone remote to other directory and push changes. Causes `local` fixture to be outdated.
 
     :param tmpdir: pytest fixture.
     :param local_light: local fixture.
     :param remote: local fixture.
-    :param run: local fixture.
 
     :return: Path to repo root.
     :rtype: py.path
@@ -190,11 +203,10 @@ def outdate_local(tmpdir, local_light, remote, run):
 
 
 @pytest.fixture
-def local_docs(local, run):
+def local_docs(local):
     """Local repository with Sphinx doc files. Pushed to remote.
 
     :param local: local fixture.
-    :param run: local fixture.
 
     :return: Path to repo root.
     :rtype: py.path
@@ -242,11 +254,10 @@ def local_docs(local, run):
 
 
 @pytest.fixture
-def local_docs_ghp(local_docs, run):
+def local_docs_ghp(local_docs):
     """Add an orphaned branch to remote.
 
     :param local_docs: local fixture.
-    :param run: local fixture.
     """
     run(local_docs, ['git', 'checkout', '--orphan', 'gh-pages'])
     run(local_docs, ['git', 'rm', '-rf', '.'])

tests/test__main__/test_arguments.py

@@ -88,14 +88,13 @@ def test_args(push):
 
 
 @pytest.mark.parametrize('push', [False, True])
-def test_global_options(monkeypatch, tmpdir, caplog, local_empty, run, push):
+def test_global_options(monkeypatch, tmpdir, caplog, local_empty, push):
     """Test options that apply to all sub commands.
 
     :param monkeypatch: pytest fixture.
     :param tmpdir: pytest fixture.
     :param caplog: pytest extension fixture.
     :param local_empty: conftest fixture.
-    :param run: conftest fixture.
     :param bool push: Run push sub command instead of build.
     """
     if push:
@@ -119,7 +118,7 @@ def test_global_options(monkeypatch, tmpdir, caplog, local_empty, run, push):
     # Defined.
     empty = tmpdir.ensure_dir('empty')
     repo = tmpdir.ensure_dir('repo')
-    run(repo, ['git', 'init'])
+    pytest.run(repo, ['git', 'init'])
     local_empty.ensure('conf.py')
     args = ['-L', '-l', 'conf.py', '-c', str(empty), '-g', str(repo), '-N', '-v', '-v'] + args
     result = CliRunner().invoke(cli, args)