Merge pull request #24 from BeyondEvil/use-pre-commit

black styling and pre-commit changes

Author: BeyondEvil

.gitignore

@@ -2,7 +2,10 @@ __pycache__
 .cache
 .DS_Store
 .tox
+.eggs
+.vscode
 build
 dist
 *.egg-info
 *.pyc
+Pipfile.lock

.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,19 +1,39 @@
 language: python
-python:
-  - 2.7
-  - 3.4
-  - 3.5
-  - 3.6
-  - pypy
-  - pypy3
-  - nightly
 jobs:
   include:
-    - stage:
+    - 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=flake8
+      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.6
+      python: 3.7
+      dist: xenial
+      sudo: required
       install: skip
       script: skip
       deploy:
@@ -25,7 +45,9 @@ jobs:
         on:
           tags: true
           repo: pytest-dev/pytest-variables
-cache:
-  pip: true
-install: pip install tox-travis
+
+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-variables = {editable = true,extras = ["hjson", "yaml"],path = "."}

README.rst

@@ -63,6 +63,13 @@ languages. To install YAML support:
 
   $ pip install pytest-variables[yaml]
 
+Contributing
+------------
+
+We welcome contributions.
+
+To learn more, see `Development <https://github.com/pytest-dev/pytest-variables/blob/master/development.rst>`_
+
 Specifying variables
 --------------------
 

development.rst

@@ -0,0 +1,69 @@
+Development
+===========
+
+To contribute to `pytest-variables` you can use `Pipenv`_ to manage
+a python virtual environment and `pre-commit <https://pre-commit.com/>`_ to help you with
+styling and formatting.
+
+To setup the virtual environment and pre-commit, run:
+
+.. code-block:: bash
+
+  $ pipenv install --dev
+  $ pipenv run pre-commit install
+
+If you're not using `Pipenv`_, to install `pre-commit`, run:
+
+.. code-block:: bash
+
+  $ pip install pre-commit
+  $ pre-commit install
+
+Automated Testing
+-----------------
+
+All pull requests and merges are tested in `Travis CI <https://travis-ci.org/>`_
+based on the ``.travis.yml`` file.
+
+Usually, a link to your specific travis build appears in pull requests, but if
+not, you can find it on the
+`pull requests page <https://travis-ci.org/pytest-dev/pytest-variables/pull_requests>`_
+
+The only way to trigger Travis CI to run again for a pull request, is to submit
+another change to the pull branch.
+
+You can do this with `git commit --allow-empty`
+
+Running Tests
+-------------
+
+You will need `Tox <http://tox.testrun.org/>`_ installed to run the tests
+against the supported Python versions. If you're using `Pipenv`_ it will be
+installed for you.
+
+With `Pipenv`_, run:
+
+.. code-block:: bash
+
+  $ pipenv run tox
+
+Otherwise, to install and run, do:
+
+.. code-block:: bash
+
+  $ pip install tox
+  $ tox
+
+Releasing a new version
+-----------------------
+
+Follow these steps to release a new version of the project:
+
+1. Update your local master with the upstream master (``git pull --rebase upstream master``)
+2. Create a new branch and update ``CHANGES.rst`` with the new version, today's date, and all changes/new features
+3. Commit and push the new branch and then create a new pull request
+4. Wait for tests and reviews and then merge the branch
+5. Once merged, update your local master again (``git pull --rebase upstream master``)
+6. Tag the release with the new release version (``git tag v<new tag>``)
+7. Push the tag (``git push upstream --tags``)
+8. Done. You can monitor the progress on `Travis <https://travis-ci.org/pytest-dev/pytest-variables/>`_

pytest_variables/errors.py

@@ -5,4 +5,5 @@
 
 class ValueError(Exception):
     """pytest-variables usage error."""
+
     pass

pytest_variables/plugin.py

@@ -14,41 +14,45 @@
 
 
 def default(module, path):
-    with io.open(path, 'r', encoding='utf8') as f:
+    with io.open(path, "r", encoding="utf8") as f:
         return module.load(f)
 
 
 parser_table = {
-    'json': ('json', default),
-    'hjson': ('hjson', default),
-    'yml': ('yaml', default),
-    'yaml': ('yaml', default)}
+    "json": ("json", default),
+    "hjson": ("hjson", default),
+    "yml": ("yaml", default),
+    "yaml": ("yaml", default),
+}
 
 
 def import_parser(path, import_type, parser_func):
     try:
         __import__(import_type)
         mod = sys.modules[import_type]
     except ImportError:
-        sys.exit('{0} import error, please make sure that {0} is '
-                 'installed'.format(import_type))
+        sys.exit(
+            "{0} import error, please make sure that {0} is "
+            "installed".format(import_type)
+        )
     return parser_func(mod, path)
 
 
 def pytest_addoption(parser):
-    group = parser.getgroup('debugconfig')
+    group = parser.getgroup("debugconfig")
     group.addoption(
-        '--variables',
-        action='append',
+        "--variables",
+        action="append",
         default=[],
-        metavar='path',
-        help='path to variables file.')
+        metavar="path",
+        help="path to variables file.",
+    )
 
 
 def _merge(a, b, path=None):
     """ merges b and a configurations.
         Based on http://bit.ly/2uFUHgb
-     """
+    """
     if path is None:
         path = []
 
@@ -68,29 +72,31 @@ def _merge(a, b, path=None):
 
 def pytest_configure(config):
     config._variables = {}
-    paths = config.getoption('variables')
+    paths = config.getoption("variables")
     for path in paths:
-        ext = os.path.splitext(path)[1][1:].lower() or 'json'
+        ext = os.path.splitext(path)[1][1:].lower() or "json"
         try:
             variables = import_parser(path, *parser_table[ext])
         except KeyError:
-            warnings.warn(UserWarning(
-                "Could not find a parser for the file extension '{0}'. "
-                'Supported extensions are: {1}'.format(
-                    ext, ', '.join(sorted(parser_table.keys())))))
-            variables = import_parser(path, *parser_table['json'])
+            warnings.warn(
+                UserWarning(
+                    "Could not find a parser for the file extension '{0}'. "
+                    "Supported extensions are: {1}".format(
+                        ext, ", ".join(sorted(parser_table.keys()))
+                    )
+                )
+            )
+            variables = import_parser(path, *parser_table["json"])
         except ValueError as e:
-            raise errors.ValueError('Unable to parse {0}: {1}'.format(
-                path, e))
+            raise errors.ValueError("Unable to parse {0}: {1}".format(path, e))
 
         if not isinstance(variables, dict):
-            raise errors.ValueError('Unable to parse {0}'.format(
-                path))
+            raise errors.ValueError("Unable to parse {0}".format(path))
 
         reduce(_merge, [config._variables, variables])
 
 
-@pytest.fixture(scope='session')
+@pytest.fixture(scope="session")
 def variables(pytestconfig):
     """Provide test variables from a specified file"""
     return pytestconfig._variables

setup.py

@@ -1,32 +1,34 @@
 from setuptools import setup
 
-setup(name='pytest-variables',
-      use_scm_version=True,
-      description='pytest plugin for providing variables to tests/fixtures',
-      long_description=open('README.rst').read(),
-      author='Dave Hunt',
-      author_email='[email protected]',
-      url='https://github.com/pytest-dev/pytest-variables',
-      packages=['pytest_variables'],
-      entry_points={'pytest11': ['variables = pytest_variables.plugin']},
-      install_requires=['pytest>=2.4.2'],
-      setup_requires=['setuptools_scm'],
-      extras_require={
-          'hjson': ['hjson'],
-          'yaml': ['PyYAML']},
-      license='Mozilla Public License 2.0 (MPL 2.0)',
-      keywords='py.test pytest json variables',
-      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'])
+setup(
+    name="pytest-variables",
+    use_scm_version=True,
+    description="pytest plugin for providing variables to tests/fixtures",
+    long_description=open("README.rst").read(),
+    author="Dave Hunt",
+    author_email="[email protected]",
+    url="https://github.com/pytest-dev/pytest-variables",
+    packages=["pytest_variables"],
+    entry_points={"pytest11": ["variables = pytest_variables.plugin"]},
+    install_requires=["pytest>=2.4.2"],
+    setup_requires=["setuptools_scm"],
+    extras_require={"hjson": ["hjson"], "yaml": ["PyYAML"]},
+    license="Mozilla Public License 2.0 (MPL 2.0)",
+    keywords="py.test pytest json variables",
+    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 :: 3.7",
+    ],
+)