Metadata-Version: 2.0
Name: pytest-flake8dir
Version: 1.1.0
Summary: A pytest fixture for testing flake8 plugins.
Home-page: https://github.com/adamchainz/pytest-flake8dir
Author: Adam Johnson
Author-email: me@adamj.eu
License: ISC License
Keywords: p,y,t,e,s,t,,, ,f,l,a,k,e,8
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Framework :: Pytest
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: ISC License (ISCL)
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Requires-Dist: flake8
Requires-Dist: pytest
Requires-Dist: six

================
pytest-flake8dir
================

.. image:: https://img.shields.io/travis/adamchainz/pytest-flake8dir/master.svg
        :target: https://travis-ci.org/adamchainz/pytest-flake8dir

.. image:: https://img.shields.io/pypi/v/pytest-flake8dir.svg
        :target: https://pypi.python.org/pypi/pytest-flake8dir

A pytest fixture for testing flake8 plugins.

A quick example:

.. code-block:: python

    def test_simple_run(flake8dir):
        flake8dir.make_py_files(example='''
            x  = 1
        ''')
        result = flake8dir.run_flake8()
        assert result.out_lines == [
            './example.py:1:2: E221 multiple spaces before operator'
        ]

Installation
============

Use **pip**:

.. code-block:: sh

    pip install pytest-flake8dir

Tested on Python 2.7 and Python 3.6.

API
===

``flake8dir`` fixture
---------------------

A pytest fixture that wraps Pytest's built-in ``tmpdir`` fixture
(`docs <https://docs.pytest.org/en/latest/tmpdir.html>`_), to create a
temporary directory, allow adding files, and running flake8.

``flake8dir.make_py_files(**kwargs)``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Creates one python file for each passed keyword argument, with name
corresponding to the keyword argument + '.py', and content according the string
value of the argument. The value will be processed with ``textwrap.dedent()``
so indentation is not a problem when writing tests.

For example, this creates two python files in the temporary directory, called
``example1.py`` and ``example2.py``, each containing one line with an
assignment:

.. code-block:: python

    def test_sample(flake8dir):
        flake8dir.make_py_files(
            example1='''
                x = 1
            ''',
            example2='''
                y = 1
            '''
        )

``flake8dir.make_example_py(content)``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

A shortcut for ``make_py_files(example=content)``, for when you are using a
single file over and over. This creates just ``example.py``, which is often
all you need for testing a rule.

For example:

.. code-block:: python

    def test_sample(flake8dir):
        flake8dir.make_example_py('''
            x = 1
        ''')

``flake8dir.make_setup_cfg(contents)``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Makes the file ``setup.cfg`` in the test directory with contents equal to the
string passed in. This is again processed with ``textwrap.dedent()`` so
indentation is not a worry. You'll probably want to set the ``[flake8]``
section header to configure flake8.

For example, this makes flake8 ignore rule E101:

.. code-block:: python

    def test_sample(flake8dir):
        flake8dir.make_setup_cfg('''
            [flake8]
            ignore = E101
        ''')

``flake8dir.make_file(filename, content)``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Make an arbitrary file with the given filename - this function is the inner
implementation for ``make_py_files`` and ``make_setup_cfg``. ``filename`` may
include directories, like ``mydir/foo.py``, and they will be created.
``content`` is subject to the same ``textwrap.dedent()`` processing as
mentioned above.

For example:

.. code-block:: python

    def test_sample(flake8dir):
        flake8dir.make_file('myfile/foo.py', '''
            x = 1
        ''')

``flake8dir.run_flake8(extra_args=None)``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Runs flake8 in the current process, and returns a ``Flake8Result`` representing
the results.

``extra_args`` may be a list of extra flags to pass to flake8, for example
passing ``['--ignore', 'E101']`` would achieve the same thing as the above
``setup.cfg`` example. Note some arguments are already passed to ensure it runs
in the same process without multiprocessing - see source.


``Flake8Result``
----------------

Represents the parsed output of a flake8 run.

``Flake8Result.out``
~~~~~~~~~~~~~~~~~~~~

The full string of output generated by flake8.

``Flake8Result.out_lines``
~~~~~~~~~~~~~~~~~~~~~~~~~~

A list of individual lines of output, without trailing newlines. This is the
most useful tool for making assertions against.

For example, given a result you can check for a particular line being output:

.. code-block:: python

    result = flake8dir.run_flake8()
    expected = './example.py:1:2: E221 multiple spaces before operator'
    assert expected in result.out_lines

.. _tmpdir: https://docs.pytest.org/en/latest/tmpdir.html




History
=======

Pending Release
---------------

.. Insert new release notes below this line

1.1.0 (2017-06-23)
------------------

* Add convenience methods ``make_example_py`` and ``make_file``.

1.0.0 (2017-06-22)
------------------

* First version with basic fixture supporting ``make_py_files``,
  ``make_setup_cfg`` and ``run_flake8``.


