pytest-doctest-ellipsis-markers


Namepytest-doctest-ellipsis-markers JSON
Version 0.1.0 PyPI version JSON
download
home_pagehttps://github.com/wooyek/pytest-doctest-ellipsis-markers
SummarySetup additional values for ELLIPSIS_MARKER for doctests
upload_time2018-01-12 22:33:17
maintainer
docs_urlNone
authorJanusz Skonieczny
requires_python
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI
coveralls test coverage No coveralls.
            ===============================
pytest-doctest-ellipsis-markers
===============================

.. image:: https://travis-ci.org/wooyek/pytest-doctest-ellipsis-markers.svg?branch=master
    :target: https://travis-ci.org/wooyek/pytest-doctest-ellipsis-markers
    :alt: See Build Status on Travis CI

.. image:: https://ci.appveyor.com/api/projects/status/github/wooyek/pytest-doctest-ellipsis-markers?branch=master
    :target: https://ci.appveyor.com/project/wooyek/pytest-doctest-ellipsis-markers/branch/master
    :alt: See Build Status on AppVeyor

Setup additional values for ELLIPSIS_MARKER for doctests

----

This `Pytest`_ plugin was generated with `Cookiecutter`_ along with `@hackebrot`_'s `Cookiecutter-pytest-plugin`_ template.


Features
--------


Doctest has problems with matching default ELLIPSIS_MARKER at the begging of line and
interprets them as line continuation characters and not as ellipsis for the output.
The easy way was to use `# doctest: +SKIP`::

    >>> u'Tanie dranie niesłychanie' # doctest: +SKIP
    ...

Without `SKIP` it would not work. But then the statement is not tested :(

This plugin cant extend `ELLIPSIS_MARKER` mathing a little
without actually changing the default `ELLIPSIS_MARKER` value::

    >>> u'Adios pomidory'
    '...'


Installation
------------

You can install "pytest-doctest-ellipsis-markers" via `pip`_ from `PyPI`_::

    $ pip install pytest-doctest-ellipsis-markers


Usage
-----

By default the markers below will be treated as ELLIPSIS_MARKER, to change them
add `doctest_ellipsis_markers` to your `ini style configuration <https://docs.pytest.org/en/latest/customize.html>`_.

.. code-block:: ini

    [pytest]
    doctest_ellipsis_markers = [...] '...' "..."


Contributing
------------
Contributions are very welcome. Tests can be run with `tox`_, please ensure
the coverage at least stays the same before you submit a pull request.

License
-------

Distributed under the terms of the `MIT`_ license, "pytest-doctest-ellipsis-markers" is free and open source software


Issues
------

If you encounter any problems, please `file an issue`_ along with a detailed description.

.. _`Cookiecutter`: https://github.com/audreyr/cookiecutter
.. _`@hackebrot`: https://github.com/hackebrot
.. _`MIT`: http://opensource.org/licenses/MIT
.. _`BSD-3`: http://opensource.org/licenses/BSD-3-Clause
.. _`GNU GPL v3.0`: http://www.gnu.org/licenses/gpl-3.0.txt
.. _`Apache Software License 2.0`: http://www.apache.org/licenses/LICENSE-2.0
.. _`cookiecutter-pytest-plugin`: https://github.com/pytest-dev/cookiecutter-pytest-plugin
.. _`file an issue`: https://github.com/wooyek/pytest-doctest-ellipsis-markers/issues
.. _`pytest`: https://github.com/pytest-dev/pytest
.. _`tox`: https://tox.readthedocs.io/en/latest/
.. _`pip`: https://pypi.python.org/pypi/pip/
.. _`PyPI`: https://pypi.python.org/pypi

            

Raw data

            {
    "maintainer": "", 
    "docs_url": null, 
    "requires_python": "", 
    "maintainer_email": "", 
    "cheesecake_code_kwalitee_id": null, 
    "keywords": "", 
    "upload_time": "2018-01-12 22:33:17", 
    "author": "Janusz Skonieczny", 
    "home_page": "https://github.com/wooyek/pytest-doctest-ellipsis-markers", 
    "github_user": "wooyek", 
    "appveyor": true, 
    "download_url": "", 
    "platform": "", 
    "version": "0.1.0", 
    "cheesecake_documentation_id": null, 
    "description": "===============================\npytest-doctest-ellipsis-markers\n===============================\n\n.. image:: https://travis-ci.org/wooyek/pytest-doctest-ellipsis-markers.svg?branch=master\n    :target: https://travis-ci.org/wooyek/pytest-doctest-ellipsis-markers\n    :alt: See Build Status on Travis CI\n\n.. image:: https://ci.appveyor.com/api/projects/status/github/wooyek/pytest-doctest-ellipsis-markers?branch=master\n    :target: https://ci.appveyor.com/project/wooyek/pytest-doctest-ellipsis-markers/branch/master\n    :alt: See Build Status on AppVeyor\n\nSetup additional values for ELLIPSIS_MARKER for doctests\n\n----\n\nThis `Pytest`_ plugin was generated with `Cookiecutter`_ along with `@hackebrot`_'s `Cookiecutter-pytest-plugin`_ template.\n\n\nFeatures\n--------\n\n\nDoctest has problems with matching default ELLIPSIS_MARKER at the begging of line and\ninterprets them as line continuation characters and not as ellipsis for the output.\nThe easy way was to use `# doctest: +SKIP`::\n\n    >>> u'Tanie dranie nies\u0142ychanie' # doctest: +SKIP\n    ...\n\nWithout `SKIP` it would not work. But then the statement is not tested :(\n\nThis plugin cant extend `ELLIPSIS_MARKER` mathing a little\nwithout actually changing the default `ELLIPSIS_MARKER` value::\n\n    >>> u'Adios pomidory'\n    '...'\n\n\nInstallation\n------------\n\nYou can install \"pytest-doctest-ellipsis-markers\" via `pip`_ from `PyPI`_::\n\n    $ pip install pytest-doctest-ellipsis-markers\n\n\nUsage\n-----\n\nBy default the markers below will be treated as ELLIPSIS_MARKER, to change them\nadd `doctest_ellipsis_markers` to your `ini style configuration <https://docs.pytest.org/en/latest/customize.html>`_.\n\n.. code-block:: ini\n\n    [pytest]\n    doctest_ellipsis_markers = [...] '...' \"...\"\n\n\nContributing\n------------\nContributions are very welcome. Tests can be run with `tox`_, please ensure\nthe coverage at least stays the same before you submit a pull request.\n\nLicense\n-------\n\nDistributed under the terms of the `MIT`_ license, \"pytest-doctest-ellipsis-markers\" is free and open source software\n\n\nIssues\n------\n\nIf you encounter any problems, please `file an issue`_ along with a detailed description.\n\n.. _`Cookiecutter`: https://github.com/audreyr/cookiecutter\n.. _`@hackebrot`: https://github.com/hackebrot\n.. _`MIT`: http://opensource.org/licenses/MIT\n.. _`BSD-3`: http://opensource.org/licenses/BSD-3-Clause\n.. _`GNU GPL v3.0`: http://www.gnu.org/licenses/gpl-3.0.txt\n.. _`Apache Software License 2.0`: http://www.apache.org/licenses/LICENSE-2.0\n.. _`cookiecutter-pytest-plugin`: https://github.com/pytest-dev/cookiecutter-pytest-plugin\n.. _`file an issue`: https://github.com/wooyek/pytest-doctest-ellipsis-markers/issues\n.. _`pytest`: https://github.com/pytest-dev/pytest\n.. _`tox`: https://tox.readthedocs.io/en/latest/\n.. _`pip`: https://pypi.python.org/pypi/pip/\n.. _`PyPI`: https://pypi.python.org/pypi\n", 
    "tox": true, 
    "lcname": "pytest-doctest-ellipsis-markers", 
    "bugtrack_url": null, 
    "github": true, 
    "coveralls": false, 
    "name": "pytest-doctest-ellipsis-markers", 
    "license": "MIT", 
    "travis_ci": true, 
    "github_project": "pytest-doctest-ellipsis-markers", 
    "summary": "Setup additional values for ELLIPSIS_MARKER for doctests", 
    "split_keywords": [], 
    "author_email": "js+pypi@bravelabs.pl", 
    "urls": [
        {
            "has_sig": false, 
            "upload_time": "2018-01-12T22:33:17", 
            "comment_text": "", 
            "python_version": "2.7", 
            "url": "https://pypi.python.org/packages/74/1e/7d774892842e77bc1d5ac52e9fbd54fe749446be8b0055cd3c20e8ff4dec/pytest_doctest_ellipsis_markers-0.1.0-py2-none-any.whl", 
            "md5_digest": "217af94dcf01e9a005e5c54376735c54", 
            "downloads": 0, 
            "filename": "pytest_doctest_ellipsis_markers-0.1.0-py2-none-any.whl", 
            "packagetype": "bdist_wheel", 
            "path": "74/1e/7d774892842e77bc1d5ac52e9fbd54fe749446be8b0055cd3c20e8ff4dec/pytest_doctest_ellipsis_markers-0.1.0-py2-none-any.whl", 
            "size": 5998
        }, 
        {
            "has_sig": false, 
            "upload_time": "2018-01-12T22:38:47", 
            "comment_text": "", 
            "python_version": "3.5", 
            "url": "https://pypi.python.org/packages/72/71/5dc6be38df2f4fe67d6b0889190c7bbac75115b89268f5007dab87ba5065/pytest_doctest_ellipsis_markers-0.1.0-py3-none-any.whl", 
            "md5_digest": "796ffc67d9ff713ef2c3e0580646bec8", 
            "downloads": 0, 
            "filename": "pytest_doctest_ellipsis_markers-0.1.0-py3-none-any.whl", 
            "packagetype": "bdist_wheel", 
            "path": "72/71/5dc6be38df2f4fe67d6b0889190c7bbac75115b89268f5007dab87ba5065/pytest_doctest_ellipsis_markers-0.1.0-py3-none-any.whl", 
            "size": 5997
        }
    ], 
    "_id": null, 
    "cheesecake_installability_id": null
}