Skip to main content

Plugin configuring handlers for loggers from Python logging module.

Project description

Pypi Package Version Supported Python Versions Documentation Status Coverage Status Travis-CI Build Status AppVeyor-CI Build Status

Pytest-logger is a pytest plugin configuring handlers for loggers from Python logging module.

You can install pytest-logger via pip from PyPI:

$ [sudo] pip install pytest-logger

Plugin puts logs on per-logger basis to:

  • standard output,

  • files within log-specific directory under pytest’s tmpdir_factory session directory.

You can setup plugin using hooks:

#conftest.py
import os

def pytest_logger_stdoutloggers(item):
    return ['foo', 'bar']

def pytest_logger_fileloggers(item):
    return ['foo', 'bar']

def pytest_logger_logdirlink(config):
    return os.path.join(os.path.dirname(__file__), 'mylogs')

have logging tests or libraries (including fixtures):

#test_something.py
import pytest
import logging

foo = logging.getLogger('foo')
foo.setLevel(logging.INFO)

bar = logging.getLogger('bar')

@pytest.yield_fixture(scope='session')
def session_thing():
    foo.info('constructing session thing')
    yield
    foo.info('destroying session thing')

@pytest.yield_fixture
def testcase_thing():
    foo.info('constructing testcase thing')
    yield
    foo.info('destroying testcase thing')

def test_one(session_thing, testcase_thing):
    foo.info('one executes')
    bar.warning('this test does nothing aside from logging')

def test_two(session_thing, testcase_thing):
    foo.info('two executes')
    bar.warning('neither does this')

and expect output in terminal (if not captured):

$ py.test -s -v
(...)
test_something.py::test_one
00:00.001 inf foo: constructing session thing
00:00.001 inf foo: constructing testcase thing
00:00.002 inf foo: one executes
00:00.002 wrn bar: this test does nothing aside from logging
PASSED
00:00.002 inf foo: destroying testcase thing

test_something.py::test_two
00:00.000 inf foo: constructing testcase thing
00:00.000 inf foo: two executes
00:00.000 wrn bar: neither does this
PASSED
00:00.001 inf foo: destroying testcase thing
00:00.001 inf foo: destroying session thing
(...)

and - the same - in filesystem:

$ file mylogs
mylogs: symbolic link to `/tmp/pytest-of-aurzenligl/pytest-48/logs'

$ tree mylogs
mylogs
`-- test_something.py
    |-- test_one
    |   |-- bar
    |   `-- foo
    `-- test_two
        |-- bar
        `-- foo

Distributed under the terms of the MIT license, pytest-logger is free and open source software.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pytest-logger-0.1.5.tar.gz (20.4 kB view hashes)

Uploaded Source

Built Distribution

pytest_logger-0.1.5-py2.py3-none-any.whl (8.4 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page