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 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 hook:
import os

def pytest_logger_config(logger_config):
    logger_config.add_loggers(['foo', 'bar', 'baz'], stdout_level='info')

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

have logging tests or libraries (including fixtures):
import pytest
import logging

foo = logging.getLogger('foo')
bar = logging.getLogger('bar')
baz = logging.getLogger('baz')

def session_thing():
    foo.debug('constructing session thing')
    foo.debug('destroying session thing')

def testcase_thing():
    foo.debug('constructing testcase thing')
    foo.debug('destroying testcase thing')

def test_one(session_thing, testcase_thing):'one executes')
    bar.warning('this test does nothing aside from logging')'extra log, rarely read')

def test_two(session_thing, testcase_thing):'two executes')
    bar.warning('neither does this')'extra log, not enabled by default')

and expect output in terminal (if not captured):

$ py.test -s -v
00:00.002 inf foo: one executes
00:00.002 wrn bar: this test does nothing aside from logging
00:00.000 inf foo: two executes
00:00.000 wrn bar: neither does this

being able to change this output by cmdline option:

$ pytest -s -v --log foo.debug,baz
00:00.002 dbg foo: constructing session thing
00:00.002 dbg foo: constructing testcase thing
00:00.002 inf foo: one executes
00:00.003 inf baz: extra log, rarely read
00:00.000 dbg foo: constructing testcase thing
00:00.000 inf foo: two executes
00:00.001 inf baz: extra log, not enabled by default

and - the same - in filesystem:

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

$ tree mylogs
    |-- test_one
    |   |-- bar
    |   |-- baz
    |   `-- foo
    `-- test_two
        |-- bar
        |-- baz
        `-- foo

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

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-1.1.1.tar.gz (27.7 kB view hashes)

Uploaded Source

Built Distribution

pytest_logger-1.1.1-py2.py3-none-any.whl (8.9 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