skip to navigation
skip to content

pytest-hidecaptured 0.1.2

Hide captured output

I write tests that generate a lot of debug messages to console and file. PyTest captures all output from tests and displays them when a test fails. This behavior is exacerbated when there are a large number of tests within a test run. Since I already log these messages to file I don’t need PyTest to display them on the console. I’d rather it showed me its own reports only.

This issue is exacerbated when others run the same tests. All they care about is whether the test passed or failed and don’t need to see the details. In case the test failed the debug log files already have the required information.

When any test fails PyTest displays all captured output (stdout, stderr) as part of its report. For example:

==================================================================== test session starts =====================================================================
platform darwin -- Python 3.5.1, pytest-2.8.5, py-1.4.31, pluggy-0.3.1
rootdir: /home/example/code, inifile:
collected 1 items

test_logging.py F

========================================================================== FAILURES ==========================================================================
________________________________________________________________________ test_logging ________________________________________________________________________

    def test_logging():
        logger.debug('DEBUG!')
        logger.info('INFO!')
        logger.warning('WARNING!')
        logger.error('ERROR!')
        logger.critical('CRITICAL!')
>       assert False
E       assert False

test_logging.py:33: AssertionError
-------------------------------------------------------------------- Captured stderr call --------------------------------------------------------------------
2016-01-19 22:29:40,581 : test_logging : test_logging : test_logging : DEBUG : DEBUG!
2016-01-19 22:29:40,582 : test_logging : test_logging : test_logging : INFO : INFO!
2016-01-19 22:29:40,582 : test_logging : test_logging : test_logging : WARNING : WARNING!
2016-01-19 22:29:40,582 : test_logging : test_logging : test_logging : ERROR : ERROR!
2016-01-19 22:29:40,582 : test_logging : test_logging : test_logging : CRITICAL : CRITICAL!
================================================================== 1 failed in 0.03 seconds ==================================================================

pytest-hidecaptured removes the captured output so it is not displayed. For example, with pytest-hidecaputred installed, the report for the same test is:

==================================================================== test session starts =====================================================================
platform darwin -- Python 3.5.1, pytest-2.8.5, py-1.4.31, pluggy-0.3.1
rootdir: /home/example/code, inifile:
plugins: hidecaptured-0.1.0
collected 1 items

test_logging.py F

========================================================================== FAILURES ==========================================================================
________________________________________________________________________ test_logging ________________________________________________________________________

    def test_logging():
        logger.debug('DEBUG!')
        logger.info('INFO!')
        logger.warning('WARNING!')
        logger.error('ERROR!')
        logger.critical('CRITICAL!')
>       assert False
E       assert False

test_logging.py:33: AssertionError
================================================================== 1 failed in 0.02 seconds ==================================================================

This PyTest plugin was generated with Cookiecutter along with @hackebrot’s Cookiecutter-pytest-plugin template.

Requirements

  • Python 2.7 or 3.3+
  • PyTest 2.8.5+

Note: Older versions of PyTest may be compatible but I have not tested them.

Installation

You can install “pytest-hidecaptured” via pip from PyPI:

$ pip install pytest-hidecaptured

Usage

After installing pytest-hidecaputred use PyTest the way you have always used. There is no additional step required and no additional flag(s) added.

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-hidecaptured” is free and open source software

Issues

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

 
File Type Py Version Uploaded on Size
pytest-hidecaptured-0.1.2.tar.gz (md5) Source 2016-03-11 3KB