pytest-profiling

Profiling plugin for py.test

These details have not been verified by PyPI

Project links

Homepage

Project description

Profiling plugin for pytest, with tabular and heat graph output.

Tests are profiled with cProfile and analysed with pstats; heat graphs are generated using gprof2dot and dot.

Installation

Install using your favourite package installer:

pip install pytest-profiling
# or
easy_install pytest-profiling

Enable the fixture explicitly in your tests or conftest.py (not required when using setuptools entry points):

pytest_plugins = ['pytest_profiling']

Usage

Once installed, the plugin provides extra options to pytest:

$ py.test --help
...
  Profiling:
    --profile           generate profiling information
    --profile-svg       generate profiling graph (using gprof2dot and dot
                        -Tsvg)

The --profile and profile-svg options can be combined with any other option:

$ py.test tests/unit/test_logging.py --profile
============================= test session starts ==============================
platform linux2 -- Python 2.6.2 -- pytest-2.2.3
collected 3 items

tests/unit/test_logging.py ...
Profiling (from prof/combined.prof):
Fri Oct 26 11:05:00 2012    prof/combined.prof

         289 function calls (278 primitive calls) in 0.001 CPU seconds

   Ordered by: cumulative time
   List reduced from 61 to 20 due to restriction <20>

   ncalls  tottime  percall  cumtime  percall filename:lineno(function)
        3    0.000    0.000    0.001    0.000 <string>:1(<module>)
      6/3    0.000    0.000    0.001    0.000 core.py:344(execute)
        3    0.000    0.000    0.001    0.000 python.py:63(pytest_pyfunc_call)
        1    0.000    0.000    0.001    0.001 test_logging.py:34(test_flushing)
        1    0.000    0.000    0.000    0.000 _startup.py:23(_flush)
        2    0.000    0.000    0.000    0.000 mock.py:979(__call__)
        2    0.000    0.000    0.000    0.000 mock.py:986(_mock_call)
        4    0.000    0.000    0.000    0.000 mock.py:923(_get_child_mock)
        6    0.000    0.000    0.000    0.000 mock.py:512(__new__)
        2    0.000    0.000    0.000    0.000 mock.py:601(__get_return_value)
        4    0.000    0.000    0.000    0.000 mock.py:695(__getattr__)
        6    0.000    0.000    0.000    0.000 mock.py:961(__init__)
    22/14    0.000    0.000    0.000    0.000 mock.py:794(__setattr__)
        6    0.000    0.000    0.000    0.000 core.py:356(getkwargs)
        6    0.000    0.000    0.000    0.000 mock.py:521(__init__)
        3    0.000    0.000    0.000    0.000 skipping.py:122(pytest_pyfunc_call)
        6    0.000    0.000    0.000    0.000 core.py:366(varnames)
        3    0.000    0.000    0.000    0.000 skipping.py:125(check_xfail_no_run)
        2    0.000    0.000    0.000    0.000 mock.py:866(assert_called_once_with)
        6    0.000    0.000    0.000    0.000 mock.py:645(__set_side_effect)


=========================== 3 passed in 0.13 seconds ===========================

pstats files (one per test item) are retained for later analysis in prof directory, along with a combined.prof file:

$ ls -1 prof/
combined.prof
test_app.prof
test_flushing.prof
test_import.prof

By default the pstats files are named after their corresponding test name, with illegal filesystem characters replaced by underscores. If the full path is longer that operating system allows then it will be renamed to first 4 bytes of an md5 hash of the test name:

$ ls -1 prof/
combined.prof
test_not_longer_than_max_allowed.prof
68b329da.prof

If the --profile-svg option is given, along with the prof files and tabular output a svg file will be generated:

$ py.test tests/unit/test_logging.py --profile-svg
...
SVG profile in prof/combined.svg.

This is best viewed with a good svg viewer e.g. Chrome.

Changelog

1.4.0 (Unreleased)

Fixing python 3 compatibility in Simple HTTP Server fixture
Fixed broken tests in pytest-profiling
Pinned pytest<4.0.0 until all deprecation warnings are fixed.
pytest-webdriver: replaced deprecated phantomjs with headless Google Chrome.
Add Vagrantfile to project to make test environment portable.
Add .editorconfig file to project.
pytest-server-fixtures: add TestServerV2 with Docker and Kubernetes support.
pytest-server-fixtures: fix for an issue where MinioServer is not cleaned up after use.
pytest-server-fixtures: fix deprecation warnings when calling pymongo.
pytest-server-fixtures: close pymongo client on MongoTestServer teardown.
pytest-server-fixtures: upgrade Mongo, Redis and RethinkDB to TestServerV2.
coveralls: fix broken coveralls

1.3.1 (2018-06-28)

Use pymongo list_database_names() instead of the deprecated database_names(), added pymongo>=3.6.0 dependency

1.3.0 (2017-11-17)

Fixed workspace deletion when teardown is None
Fixed squash of root logger in pytest-listener
Added S3 Minio fixture (many thanks to Gavin Bisesi)
Added Postgres fixture (many thanks to Gavin Bisesi)
Use requests for server fixtures http gets as it handles redirects and proxies properly

1.2.12 (2017-8-1)

Fixed regression on cacheing ephemeral hostname, some clients were relying on this. This is now optional.

1.2.11 (2017-7-21)

Fix for OSX binding to illegal local IP range (Thanks to Gavin Bisesi)
Setup and Py3k fixes for pytest-profiling (Thanks to xoviat)
We no longer try and bind port 5000 when reserving a local IP host, as someone could have bound it to 0.0.0.0
Fix for #46 sourcing gprof2dot when the local venv has not been activated

1.2.10 (2017-2-23)

Handle custom Pytest test items in pytest-webdriver

1.2.9 (2017-2-23)

Add username into mongo server fixture tempdir path to stop collisions on shared multiuser filesystems

1.2.8 (2017-2-21)

Return function results in shutil.run.run_as_main

1.2.7 (2017-2-20)

More handling for older versions of path.py
Allow virtualenv argument passing in pytest-virtualenv

1.2.6 (2017-2-16 )

Updated devpi server server setup for devpi-server >= 2.0
Improvements for random port picking
HTTPD server now binds to 0.0.0.0 by default to aid Selenium-style testing
Updated mongodb server args for mongodb >= 3.2
Corrections for mongodb fixture config and improve startup logic
Added module-scoped mongodb fixture
Handling for older versions of path.py
Fix for #40 where tests that chdir break pytest-profiling

1.2.5 (2016-12-09)

Improvements for server runner host and port generation, now supports random local IPs
Bugfix for RethinkDB fixture config

1.2.4 (2016-11-14)

Bugfix for pymongo extra dependency
Windows compatibility fix for pytest-virtualenv (Thanks to Jean-Christophe Fillion-Robin for PR)
Fix symlink handling for pytest-shutil.cmdline.get_real_python_executable

1.2.3 (2016-11-7)

Improve resiliency of Mongo fixture startup checks

1.2.2 (2016-10-27)

Python 3 compatibility across most of the modules
Fixed deprecated Path.py imports (Thanks to Bryan Moscon)
Fixed deprecated multicall in pytest-profiling (Thanks to Paul van der Linden for PR)
Added devpi-server fixture to create an index per test function
Added missing licence file
Split up httpd server fixture config so child classes can override loaded modules easier
Added ‘preserve_sys_path’ argument to TestServer base class which exports the current python sys.path to subprocesses.
Updated httpd, redis and jenkins runtime args and paths to current Ubuntu spec
Ignore errors when tearing down workspaces to avoid race conditions in ‘shutil.rmtree’ implementation

1.2.1 (2016-3-1)

Fixed pytest-verbose-parametrize for latest version of py.test

1.2.0 (2016-2-19)

New plugin: git repository fixture

1.1.1 (2016-2-16)

pytest-profiling improvement: escape illegal characters in .prof files (Thanks to Aarni Koskela for the PR)

1.1.0 (2016-2-15)

New plugin: devpi server fixture
pytest-profiling improvement: overly-long .prof files are saved as the short hash of the test name (Thanks to Vladimir Lagunov for PR)
Changed default behavior of workspace.run() to not use a subshell for security reasons
Corrected virtualenv.run() method to handle arguments the same as the parent method workspace.run()
Removed deprecated ‘–distribute’ from virtualenv args

1.0.1 (2015-12-23)

Packaging bugfix

1.0.0 (2015-12-21)

Initial public release

Project details

These details have not been verified by PyPI

Project links

Homepage

Release history Release notifications | RSS feed

1.8.0 yanked

Oct 17, 2024

Reason this release was yanked:

Installation issues with newer python versions

1.7.0

May 28, 2019

1.6.0

Feb 12, 2019

This version

1.4.0

Jan 15, 2019

1.3.0

Mar 8, 2018

1.2.11

Jul 21, 2017

1.2.6

Feb 17, 2017

1.2.2

Oct 27, 2016

1.1.1

Feb 16, 2016

1.1.0

Feb 15, 2016

1.0.1

Dec 23, 2015

1.0.0

Dec 23, 2015

Download files

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

Source Distribution

pytest-profiling-1.4.0.tar.gz (28.8 kB view details)

Uploaded Jan 15, 2019 Source

Built Distributions

pytest_profiling-1.4.0-py2.7.egg (6.6 kB view details)

Uploaded Jan 15, 2019 Source

pytest_profiling-1.4.0-py2-none-any.whl (7.5 kB view details)

Uploaded Jan 15, 2019 Python 2

File details

Details for the file pytest-profiling-1.4.0.tar.gz.

File metadata

Download URL: pytest-profiling-1.4.0.tar.gz
Upload date: Jan 15, 2019
Size: 28.8 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.29.1 CPython/2.7.13

File hashes

Hashes for pytest-profiling-1.4.0.tar.gz
Algorithm	Hash digest
SHA256	`f826859197a41f719a853b7e14ea0fd9b8f9de5515aad6827451f204813c0e4f`
MD5	`f1d83335b761c60827ca009badf86e44`
BLAKE2b-256	`02e470dd97d1f0ad3d7bd124391bfc4fa7bfdbec8a149fa26301a2ef09f87b54`

See more details on using hashes here.

File details

Details for the file pytest_profiling-1.4.0-py2.7.egg.

File metadata

Download URL: pytest_profiling-1.4.0-py2.7.egg
Upload date: Jan 15, 2019
Size: 6.6 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.29.1 CPython/2.7.13

File hashes

Hashes for pytest_profiling-1.4.0-py2.7.egg
Algorithm	Hash digest
SHA256	`51a523258703202d211488d0e0aee320b244b069d1250433ce02425e7a66124f`
MD5	`75603042ead0b38a70bd6171fdf5612d`
BLAKE2b-256	`300b16392f95d1683aee0091b1d87208f7fbe629164a1cfb8726abfae32676bd`

See more details on using hashes here.

File details

Details for the file pytest_profiling-1.4.0-py2-none-any.whl.

File metadata

Download URL: pytest_profiling-1.4.0-py2-none-any.whl
Upload date: Jan 15, 2019
Size: 7.5 kB
Tags: Python 2
Uploaded using Trusted Publishing? No
Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.29.1 CPython/2.7.13

File hashes

Hashes for pytest_profiling-1.4.0-py2-none-any.whl
Algorithm	Hash digest
SHA256	`437be67114009b40aac145bb135fcd9a4cf2cc6bbf8ccb3d2921894396e92640`
MD5	`ba1c58cf97738d649aa0878093c90581`
BLAKE2b-256	`c4fda74515ca5bf9d9ec558d92a3637a84e1cd777de44195beec10e7e2d61c9b`

See more details on using hashes here.

pytest-profiling 1.4.0

Navigation

Verified details

Maintainers

Unverified details

Project links

Meta

Classifiers

Project description

Installation

Usage

Changelog

1.4.0 (Unreleased)

1.3.1 (2018-06-28)

1.3.0 (2017-11-17)

1.2.12 (2017-8-1)

1.2.11 (2017-7-21)

1.2.10 (2017-2-23)

1.2.9 (2017-2-23)

1.2.8 (2017-2-21)

1.2.7 (2017-2-20)

1.2.6 (2017-2-16 )

1.2.5 (2016-12-09)

1.2.4 (2016-11-14)

1.2.3 (2016-11-7)

1.2.2 (2016-10-27)

1.2.1 (2016-3-1)

1.2.0 (2016-2-19)

1.1.1 (2016-2-16)

1.1.0 (2016-2-15)

1.0.1 (2015-12-23)

1.0.0 (2015-12-21)

Project details

Verified details

Maintainers

Unverified details

Project links

Meta

Classifiers

Release history Release notifications | RSS feed

Download files

Source Distribution

Built Distributions

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes