Skip to content

Commit 8cfba06

Browse files
mikethemanmiketheman
committed
Initial commit
Signed-off-by: Mike Fiedler <miketheman@gmail.com>
0 parents  commit 8cfba06

13 files changed

Lines changed: 550 additions & 0 deletions

File tree

‎.editorconfig‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# http://editorconfig.org
2+
3+
root = true
4+
5+
[*]
6+
indent_style = space
7+
insert_final_newline = true
8+
trim_trailing_whitespace = true
9+
end_of_line = lf
10+
charset = utf-8
11+
12+
[*.py]
13+
indent_size = 4

‎.github/FUNDING.yml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# These are supported funding model platforms
2+
3+
github: miketheman

‎.github/workflows/pytest.yml‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
2+
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
3+
4+
name: Python Tests
5+
6+
on:
7+
# Trigger the workflow on push or pull request,
8+
# but only for the main branch
9+
push:
10+
branches:
11+
- main
12+
pull_request:
13+
branches:
14+
- main
15+
16+
jobs:
17+
build:
18+
19+
runs-on: ${{ matrix.os }}
20+
strategy:
21+
matrix:
22+
os:
23+
- macos-latest
24+
- ubuntu-latest
25+
- windows-latest
26+
python-version: ["3.7", "3.8", "3.9", "3.10"]
27+
28+
steps:
29+
- uses: actions/checkout@v2
30+
- name: Set up Python ${{ matrix.python-version }}
31+
uses: actions/setup-python@v2
32+
with:
33+
python-version: ${{ matrix.python-version }}
34+
- name: Install dependencies
35+
run: |
36+
python -m pip install --upgrade pip poetry
37+
poetry install
38+
- name: Test with coverage/pytest
39+
run: |
40+
poetry run coverage run -m pytest ; poetry run coverage report --show-missing

‎.gitignore‎

Lines changed: 153 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,153 @@
1+
# Byte-compiled / optimized / DLL files
2+
__pycache__/
3+
*.py[cod]
4+
*$py.class
5+
6+
# C extensions
7+
*.so
8+
9+
# Distribution / packaging
10+
.Python
11+
build/
12+
develop-eggs/
13+
dist/
14+
downloads/
15+
eggs/
16+
.eggs/
17+
lib/
18+
lib64/
19+
parts/
20+
sdist/
21+
var/
22+
wheels/
23+
share/python-wheels/
24+
*.egg-info/
25+
.installed.cfg
26+
*.egg
27+
MANIFEST
28+
29+
# PyInstaller
30+
# Usually these files are written by a python script from a template
31+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
32+
*.manifest
33+
*.spec
34+
35+
# Installer logs
36+
pip-log.txt
37+
pip-delete-this-directory.txt
38+
39+
# Unit test / coverage reports
40+
htmlcov/
41+
.tox/
42+
.nox/
43+
.coverage
44+
.coverage.*
45+
.cache
46+
nosetests.xml
47+
coverage.xml
48+
*.cover
49+
*.py,cover
50+
.hypothesis/
51+
.pytest_cache/
52+
cover/
53+
54+
# Translations
55+
*.mo
56+
*.pot
57+
58+
# Django stuff:
59+
*.log
60+
local_settings.py
61+
db.sqlite3
62+
db.sqlite3-journal
63+
64+
# Flask stuff:
65+
instance/
66+
.webassets-cache
67+
68+
# Scrapy stuff:
69+
.scrapy
70+
71+
# Sphinx documentation
72+
docs/_build/
73+
74+
# PyBuilder
75+
.pybuilder/
76+
target/
77+
78+
# Jupyter Notebook
79+
.ipynb_checkpoints
80+
81+
# IPython
82+
profile_default/
83+
ipython_config.py
84+
85+
# pyenv
86+
# For a library or package, you might want to ignore these files since the code is
87+
# intended to run in multiple environments; otherwise, check them in:
88+
.python-version
89+
90+
# pipenv
91+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
92+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
93+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
94+
# install all needed dependencies.
95+
#Pipfile.lock
96+
97+
# poetry
98+
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
99+
# This is especially recommended for binary packages to ensure reproducibility, and is more
100+
# commonly ignored for libraries.
101+
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
102+
poetry.lock
103+
104+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow
105+
__pypackages__/
106+
107+
# Celery stuff
108+
celerybeat-schedule
109+
celerybeat.pid
110+
111+
# SageMath parsed files
112+
*.sage.py
113+
114+
# Environments
115+
.env
116+
.envrc
117+
.venv
118+
env/
119+
venv/
120+
ENV/
121+
env.bak/
122+
venv.bak/
123+
124+
# Spyder project settings
125+
.spyderproject
126+
.spyproject
127+
128+
# Rope project settings
129+
.ropeproject
130+
131+
# mkdocs documentation
132+
/site
133+
134+
# mypy
135+
.mypy_cache/
136+
.dmypy.json
137+
dmypy.json
138+
139+
# Pyre type checker
140+
.pyre/
141+
142+
# pytype static type analyzer
143+
.pytype/
144+
145+
# Cython debug symbols
146+
cython_debug/
147+
148+
# PyCharm
149+
# JetBrains specific template is maintainted in a separate JetBrains.gitignore that can
150+
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
151+
# and can be added to the global gitignore or merged into this file. For a more nuclear
152+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
153+
.idea/

‎.pre-commit-config.yaml‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# See https://pre-commit.com for more information
2+
# See https://pre-commit.com/hooks.html for more hooks
3+
repos:
4+
- repo: https://github.com/pre-commit/pre-commit-hooks
5+
rev: v4.0.1
6+
hooks:
7+
- id: check-yaml
8+
- id: check-added-large-files
9+
- repo: https://github.com/editorconfig-checker/editorconfig-checker.python
10+
rev: '2.4.0'
11+
hooks:
12+
- id: editorconfig-checker
13+
alias: ec
14+
- repo: https://github.com/pycqa/isort
15+
rev: 5.10.1
16+
hooks:
17+
- id: isort
18+
name: isort (python)
19+
- repo: https://github.com/psf/black
20+
rev: 21.12b0
21+
hooks:
22+
- id: black

‎LICENSE‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
2+
The MIT License (MIT)
3+
4+
Copyright (c) 2021 Mike Fiedler
5+
6+
Permission is hereby granted, free of charge, to any person obtaining a copy
7+
of this software and associated documentation files (the "Software"), to deal
8+
in the Software without restriction, including without limitation the rights
9+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10+
copies of the Software, and to permit persons to whom the Software is
11+
furnished to do so, subject to the following conditions:
12+
13+
The above copyright notice and this permission notice shall be included in
14+
all copies or substantial portions of the Software.
15+
16+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22+
THE SOFTWARE.

‎README.md‎

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
# pytest-execution-timer
2+
3+
A plugin to use with Pytest to measure execution time of tests.
4+
5+
Distinctly different from the `--durations` option of pytest,
6+
this plugin measures specific pytest startup/collection phases.
7+
8+
Leverages `pytest` hooks to measure execution time of phases.
9+
10+
---
11+
12+
## Installation
13+
14+
Requires:
15+
16+
- Python 3.7 or later.
17+
- Pytest 6.2 or later.
18+
19+
Install the plugin with any approach for your project.
20+
21+
Some examples:
22+
23+
```shell
24+
pip install pytest-execution-timer
25+
```
26+
27+
```shell
28+
poetry add --dev pytest-execution-timer
29+
```
30+
31+
```shell
32+
pipenv install --dev pytest-execution-timer
33+
```
34+
35+
Or add it to your `requirements.txt` file.
36+
37+
## Usage
38+
39+
Enable the plugin with the `--execution-timer` option when running `pytest`:
40+
41+
```console
42+
$ pytest --execution-timer
43+
...
44+
Durations of pytest phases in seconds (min 100ms):
45+
0.662 pytest_runtestloop
46+
```
47+
48+
Control the threshold (default 100ms) by passing `--minimum-duration=<value in ms>`:
49+
50+
```console
51+
$ pytest --execution-timer --minimum-duration=1000 # 1 second
52+
```
53+
54+
## Understanding the output
55+
56+
The best ay to start is to compare the difference of the `pytest_runtestloop` duration
57+
and the overall duration of the test run. Example:
58+
59+
```console
60+
Durations of pytest phases in seconds (min 100ms):
61+
0.666 pytest_runtestloop
62+
====== 4 passed in 0.68s ======
63+
```
64+
65+
In this example, there's not much lost between the test run and the `pytest_runtestloop`
66+
meaning that the startup and collection phases are not taking too much time.
67+
68+
If there's a larger difference in the timings,
69+
look to other emitted phases to understand what's taking the most time.
70+
71+
These can then be examined directly,
72+
or use other tools like [profilers](https://docs.python.org/3/library/profile.html)
73+
or [import timings](https://docs.python.org/3/using/cmdline.html#cmdoption-X).
74+
75+
## License
76+
77+
Distributed under the terms of the MIT license,
78+
"pytest-execution-timer" is free and open source software.
79+
See `LICENSE` for more information.

‎pyproject.toml‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
[tool.poetry]
2+
name = "pytest-execution-timer"
3+
version = "0.1.0"
4+
description = "A timer for the phases of Pytest's execution."
5+
authors = ["Mike Fiedler <miketheman@gmail.com>"]
6+
license = "MIT"
7+
readme = "README.md"
8+
homepage = "https://pypi.org/project/pytest-execution-timer/"
9+
repository = "https://github.com/miketheman/pytest-execution-timer"
10+
include = [
11+
{ path = "LICENSE" },
12+
{ path = "README.md" },
13+
{ path = "tests", format = "sdist" },
14+
]
15+
classifiers = [
16+
"Development Status :: 4 - Beta",
17+
"Framework :: Pytest",
18+
"Intended Audience :: Developers",
19+
"Topic :: Software Development :: Testing",
20+
"Programming Language :: Python",
21+
"Programming Language :: Python :: 3.7",
22+
"Programming Language :: Python :: 3.8",
23+
"Programming Language :: Python :: 3.9",
24+
"Programming Language :: Python :: 3.10",
25+
"Programming Language :: Python :: Implementation :: CPython",
26+
"Operating System :: OS Independent",
27+
"License :: OSI Approved :: MIT License",
28+
]
29+
30+
31+
[tool.poetry.dependencies]
32+
python = "^3.7"
33+
34+
[tool.poetry.dev-dependencies]
35+
pytest = "^6.2"
36+
coverage = {extras = ["toml"], version = "^6.2"}
37+
38+
[tool.poetry.plugins.pytest11]
39+
execution_timer = "pytest_execution_timer.plugin"
40+
41+
[tool.poetry.urls]
42+
"Bug Tracker" = "https://github.com/miketheman/pytest-execution-timer/issues"
43+
44+
[tool.coverage.run]
45+
branch = true
46+
source = ["pytest_execution_timer"]
47+
48+
[tool.isort]
49+
# https://black.readthedocs.io/en/stable/guides/using_black_with_other_tools.html#profilegcm
50+
profile = "black"
51+
52+
[build-system]
53+
requires = ["poetry-core>=1.0.0"]
54+
build-backend = "poetry.core.masonry.api"

‎pytest_execution_timer/__init__.py‎

Whitespace-only changes.

0 commit comments

Comments
 (0)