Use pre-commit in project

Author: BeyondEvil

.gitignore

@@ -4,5 +4,7 @@ __pycache__
 .cache
 .DS_Store
 .tox
+.eggs
+.vscode/
 build
 dist

.pre-commit-config.yaml

@@ -0,0 +1,15 @@
+repos:
+
+-   repo: https://github.com/psf/black
+    rev: stable
+    hooks:
+    -   id: black
+        args: [--safe, --quiet]
+        language_version: python3
+
+-   repo: https://gitlab.com/pycqa/flake8
+    rev: 3.7.7
+    hooks:
+    -   id: flake8
+        exclude: docs
+        language_version: python3

.travis.yml

@@ -1,27 +1,53 @@
 language: python
-python:
-  - 2.7
-  - 3.6
-  - pypy
-  - pypy3
-  - nightly
-matrix:
+jobs:
   include:
-    - python: 2.7
-      env: TOXENV=flake8
-    - python: 3.6
-      env: TOXENV=flake8
-install:
-  - pip install tox-travis
-script:
-  - tox
-deploy:
-  provider: pypi
-  user: davehunt
-  password:
-    secure: "aSevNdJQLPH1S1TNaI+uSFdiZ+dEQkkvmLym5eA8vjvo0fV4FEQfjZg8rW69hfYAGA4EFkE3hQUs5IQIm5ug+A3FsMDjom4nAhCthq8g/5hviT+V6wVzoVdxf0JhlpLtDFteFTOKj5Z9PC/xhJJ/2/JrzmEwUwopiNtSNBdVwRXCOvb6L3aIU5DmTtuWokpBNmv4H2cdjCxwLROSlKdfFr4urUwiOst/A5W1HvdxWhEkQL7fLx/sUOHobYjkoL32miTpSHUJNH1L0G8uciMdtXTBY3HQ/uRfWaDs3iJ7Iwtk2hEB1ukPZiXtBX0FjTJXd71a4BvvG1FSQgeQ4zW1Fzf8Xz5qg0Z1Z+7DTFzekhd1AfcwDlr2Vh7xD6FCBSjFyAIXQ0n36mtoEfHDM6RQMQSQZm4j+4EOdFf9kfWsTn9XGWCr47r3qe+6SUzGSvHcD6LeoZZ2ZJjSk37vdQ0y28yvZr5goBFwY11MMjMVqLSA4mWhhueBWA7il9ciwfJbb6RThBfnHYdT8l4NRztkXz6QaW4KCJNVr3aE3MwPLzfux9JUUml//JUjuhChLpEvrAM6CRliZSawKdE9E2o5QOISt7yiEVdaxohAcfTkj5X+WTS5QBYjT/8+iV6KWDjghm/FH13/WZlcqMfC7be+EgXvqv3ffUanX7jnpzdg1sQ="
-  distributions: sdist bdist_wheel
-  on:
-    tags: true
-    repo: pytest-dev/pytest-base-url
-    python: 3.6
+    - stage: Tests
+      name: Linting
+      python: 3.7
+      dist: xenial
+      sudo: required
+      env: TOXENV=linting
+
+    -
+      python: 2.7
+      env: TOXENV=py27
+
+    -
+      python: 3.6
+      env: TOXENV=py36
+
+    -
+      python: 3.7
+      dist: xenial
+      sudo: required
+      env: TOXENV=py37
+
+    -
+      python: pypy
+      env: TOXENV=pypy
+
+    -
+      python: pypy3
+      env: TOXENV=pypy3
+
+    - stage: deploy
+      python: 3.7
+      dist: xenial
+      sudo: required
+      install: skip
+      script: skip
+      deploy:
+        provider: pypi
+        user: davehunt
+        password:
+          secure: "aSevNdJQLPH1S1TNaI+uSFdiZ+dEQkkvmLym5eA8vjvo0fV4FEQfjZg8rW69hfYAGA4EFkE3hQUs5IQIm5ug+A3FsMDjom4nAhCthq8g/5hviT+V6wVzoVdxf0JhlpLtDFteFTOKj5Z9PC/xhJJ/2/JrzmEwUwopiNtSNBdVwRXCOvb6L3aIU5DmTtuWokpBNmv4H2cdjCxwLROSlKdfFr4urUwiOst/A5W1HvdxWhEkQL7fLx/sUOHobYjkoL32miTpSHUJNH1L0G8uciMdtXTBY3HQ/uRfWaDs3iJ7Iwtk2hEB1ukPZiXtBX0FjTJXd71a4BvvG1FSQgeQ4zW1Fzf8Xz5qg0Z1Z+7DTFzekhd1AfcwDlr2Vh7xD6FCBSjFyAIXQ0n36mtoEfHDM6RQMQSQZm4j+4EOdFf9kfWsTn9XGWCr47r3qe+6SUzGSvHcD6LeoZZ2ZJjSk37vdQ0y28yvZr5goBFwY11MMjMVqLSA4mWhhueBWA7il9ciwfJbb6RThBfnHYdT8l4NRztkXz6QaW4KCJNVr3aE3MwPLzfux9JUUml//JUjuhChLpEvrAM6CRliZSawKdE9E2o5QOISt7yiEVdaxohAcfTkj5X+WTS5QBYjT/8+iV6KWDjghm/FH13/WZlcqMfC7be+EgXvqv3ffUanX7jnpzdg1sQ="
+        distributions: sdist bdist_wheel
+        on:
+          tags: true
+          repo: pytest-dev/pytest-base-url
+
+cache: pip
+
+install: pip install tox
+
+script: tox

Pipfile

@@ -0,0 +1,14 @@
+[[source]]
+name = "pypi"
+url = "https://pypi.org/simple"
+verify_ssl = true
+
+[dev-packages]
+pytest = "*"
+tox = "*"
+flake8 = "*"
+black = "*"
+pre-commit = "*"
+
+[packages]
+pytest-base-url = {editable = true,path = "."}

pytest_base_url/plugin.py

@@ -10,52 +10,53 @@
 from requests.adapters import HTTPAdapter
 
 
-@pytest.fixture(scope='session')
+@pytest.fixture(scope="session")
 def base_url(request):
     """Return a base URL"""
     config = request.config
-    base_url = config.getoption('base_url')
+    base_url = config.getoption("base_url")
     if base_url is not None:
         return base_url
 
 
-@pytest.fixture(scope='session', autouse=True)
+@pytest.fixture(scope="session", autouse=True)
 def _verify_url(request, base_url):
     """Verifies the base URL"""
     verify = request.config.option.verify_base_url
     if base_url and verify:
         session = requests.Session()
-        retries = Retry(backoff_factor=0.1,
-                        status_forcelist=[500, 502, 503, 504])
+        retries = Retry(backoff_factor=0.1, status_forcelist=[500, 502, 503, 504])
         session.mount(base_url, HTTPAdapter(max_retries=retries))
         session.get(base_url)
 
 
 def pytest_configure(config):
-    if hasattr(config, 'slaveinput'):
+    if hasattr(config, "slaveinput"):
         return  # xdist slave
-    base_url = config.getoption('base_url') or config.getini('base_url')
+    base_url = config.getoption("base_url") or config.getini("base_url")
     if base_url is not None:
         config.option.base_url = base_url
-        if hasattr(config, '_metadata'):
-            config._metadata['Base URL'] = base_url
+        if hasattr(config, "_metadata"):
+            config._metadata["Base URL"] = base_url
 
 
 def pytest_report_header(config, startdir):
-    base_url = config.getoption('base_url')
+    base_url = config.getoption("base_url")
     if base_url:
-        return 'baseurl: {0}'.format(base_url)
+        return "baseurl: {0}".format(base_url)
 
 
 def pytest_addoption(parser):
-    parser.addini('base_url', help='base url for the application under test.')
+    parser.addini("base_url", help="base url for the application under test.")
     parser.addoption(
-        '--base-url',
-        metavar='url',
-        default=os.getenv('PYTEST_BASE_URL', None),
-        help='base url for the application under test.')
+        "--base-url",
+        metavar="url",
+        default=os.getenv("PYTEST_BASE_URL", None),
+        help="base url for the application under test.",
+    )
     parser.addoption(
-        '--verify-base-url',
-        action='store_true',
-        default=not os.getenv('VERIFY_BASE_URL', 'false').lower() == 'false',
-        help='verify the base url.')
+        "--verify-base-url",
+        action="store_true",
+        default=not os.getenv("VERIFY_BASE_URL", "false").lower() == "false",
+        help="verify the base url.",
+    )

setup.py

@@ -1,33 +1,34 @@
 from setuptools import setup
 
-setup(name='pytest-base-url',
-      use_scm_version=True,
-      description='pytest plugin for URL based testing',
-      long_description=open('README.rst').read(),
-      author='Dave Hunt',
-      author_email='[email protected]',
-      url='https://github.com/pytest-dev/pytest-base-url',
-      packages=['pytest_base_url'],
-      install_requires=[
-          'pytest>=2.7.3',
-          'requests>=2.9'],
-      setup_requires=['setuptools_scm'],
-      entry_points={'pytest11': ['base_url = pytest_base_url.plugin']},
-      license='Mozilla Public License 2.0 (MPL 2.0)',
-      keywords='py.test pytest base url mozilla automation',
-      classifiers=[
-          'Development Status :: 5 - Production/Stable',
-          'Framework :: Pytest',
-          'Intended Audience :: Developers',
-          'License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)',
-          'Operating System :: POSIX',
-          'Operating System :: Microsoft :: Windows',
-          'Operating System :: MacOS :: MacOS X',
-          'Topic :: Software Development :: Quality Assurance',
-          'Topic :: Software Development :: Testing',
-          'Topic :: Utilities',
-          'Programming Language :: Python',
-          'Programming Language :: Python :: 2.7',
-          'Programming Language :: Python :: 3.6',
-          'Programming Language :: Python :: Implementation :: CPython',
-          'Programming Language :: Python :: Implementation :: PyPy'])
+setup(
+    name="pytest-base-url",
+    use_scm_version=True,
+    description="pytest plugin for URL based testing",
+    long_description=open("README.rst").read(),
+    author="Dave Hunt",
+    author_email="[email protected]",
+    url="https://github.com/pytest-dev/pytest-base-url",
+    packages=["pytest_base_url"],
+    install_requires=["pytest>=2.7.3", "requests>=2.9"],
+    setup_requires=["setuptools_scm"],
+    entry_points={"pytest11": ["base_url = pytest_base_url.plugin"]},
+    license="Mozilla Public License 2.0 (MPL 2.0)",
+    keywords="py.test pytest base url mozilla automation",
+    classifiers=[
+        "Development Status :: 5 - Production/Stable",
+        "Framework :: Pytest",
+        "Intended Audience :: Developers",
+        "License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)",
+        "Operating System :: POSIX",
+        "Operating System :: Microsoft :: Windows",
+        "Operating System :: MacOS :: MacOS X",
+        "Topic :: Software Development :: Quality Assurance",
+        "Topic :: Software Development :: Testing",
+        "Topic :: Utilities",
+        "Programming Language :: Python",
+        "Programming Language :: Python :: 2.7",
+        "Programming Language :: Python :: 3.6",
+        "Programming Language :: Python :: Implementation :: CPython",
+        "Programming Language :: Python :: Implementation :: PyPy",
+    ],
+)

tests/conftest.py

@@ -2,4 +2,4 @@
 # License, v. 2.0. If a copy of the MPL was not distributed with this
 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
-pytest_plugins = 'pytester'
+pytest_plugins = "pytester"

tests/test_base_url.py

@@ -4,65 +4,81 @@
 
 
 def test_fixture(testdir):
-    testdir.makepyfile("""
+    testdir.makepyfile(
+        """
         import pytest
         @pytest.fixture(scope='session')
         def base_url():
             return 'foo'
         def test_fixture(base_url):
             assert base_url == 'foo'
-    """)
+    """
+    )
     result = testdir.runpytest()
     assert result.ret == 0
 
 
 def test_cli(testdir):
-    testdir.makepyfile("""
+    testdir.makepyfile(
+        """
         def test_funcarg(base_url):
             assert base_url == 'foo'
-    """)
-    result = testdir.runpytest('--base-url', 'foo')
+    """
+    )
+    result = testdir.runpytest("--base-url", "foo")
     assert result.ret == 0
 
 
 def test_config(testdir):
-    testdir.makefile('.ini', pytest="""
+    testdir.makefile(
+        ".ini",
+        pytest="""
         [pytest]
         base_url=foo
-    """)
-    testdir.makepyfile("""
+    """,
+    )
+    testdir.makepyfile(
+        """
         def test_config(request, base_url):
             assert request.config.getvalue('base_url') == 'foo'
             assert request.config.getini('base_url') == 'foo'
             assert base_url == 'foo'
-    """)
+    """
+    )
     result = testdir.runpytest()
     assert result.ret == 0
 
 
 def test_skip_config(testdir):
-    testdir.makefile('.ini', pytest="""
+    testdir.makefile(
+        ".ini",
+        pytest="""
         [pytest]
         base_url=foo
-    """)
-    testdir.makepyfile("""
+    """,
+    )
+    testdir.makepyfile(
+        """
         import pytest
         @pytest.mark.skipif(
-            pytest.config.getoption('base_url') == 'foo',
+            "config.getoption('base_url') == 'foo'",
             reason='skip')
         def test_skip_config(): pass
-    """)
+    """
+    )
     result = testdir.runpytest()
     assert result.ret == 0
 
 
 def test_env_var_set(testdir, monkeypatch):
-    testdir.makepyfile("""
+    testdir.makepyfile(
+        """
         def test_config(request, base_url):
             assert request.config.getvalue('base_url')
             assert base_url == 'yeehaw'
-    """)
-    monkeypatch.setenv('PYTEST_BASE_URL', 'yeehaw')
+    """
+    )
+    monkeypatch.setenv("PYTEST_BASE_URL", "yeehaw")
     reprec = testdir.inline_run()
     passed, skipped, failed = reprec.listoutcomes()
     assert len(passed) == 1