line-profiler-extended 0.0.3

Inherits awesome rkern's line-profiler and adds some useful features

line-profiler-extended

---

Inherits awesome rkern's line-profiler and adds some useful features.

Installation

pip install line-profiler-extended

Using the API

from line_profiler_extended import LineProfilerExtended

def foo():
    pass

# profile the foo function
profiler = LineProfilerExtended(foo)

# profile all functions from some_module
import some_module
profiler = LineProfilerExtended(some_module)

# profile all functions from all modules found recursively
# starting from the grandparent directory of the current file
from pathlib import Path
profiler = LineProfilerExtended(Path(__file__).parent.parent)

# profile all functions from all modules found recursively in "path",
# reporting only functions that took at least 1 millisecond
profiler = LineProfilerExtended("path", eps=0.001)

# profile all functions from all modules found recursively in "path" with "m" in module name but without "mm"
profiler = LineProfilerExtended("path", include_regex="m", exclude_regex="mm")

# all types of locations can be combined
profiler = LineProfilerExtended(
    Path("/some/path"), "path", some_module, foo,
    eps=0.001, include_regex="m", exclude_regex="mm"
)

profiler.enable_by_count()
profiler.runcall(foo)
profiler.print_stats()

Usage with IPython

%load_ext line_profiler_extended

# profile the foo function
%lpext -p foo foo()

# profile all functions from some_module
%lpext -p some_module foo()

# profile all functions from all modules found recursively in some path
from pathlib import Path
%lpext -p Path("/some/path") foo()

# profile all functions from all modules found recursively in "path",
# reporting only functions that took at least 1 millisecond
%lpext -p "path" --eps 0.001 foo()

# profile all functions from all modules found recursively in "path" with "m" in module name but without "mm"
%lpext -p "path" --include "m" --exclude "mm" foo()

# all types of locations can be combined
%lpext -p Path(__file__).parent.parent -p "path" -p some_module -p foo --eps 0.001 --include "m" --exclude "mm" foo()

Usage with pytest

import pytest
from pathlib import Path

# all args are passed directly to the LineProfilerExtended constructor
@pytest.mark.line_profile.with_args(Path(__file__).parent.parent, eps=0.01)
def test_foo():
    pass

Development

• Clone this repository
• Requirements:
  • Poetry
  • Python 3.7+
• Create a virtual environment and install the dependencies

poetry install

• Activate the virtual environment

poetry shell

Testing

pytest

Releasing

Trigger the Draft release workflow (press Run workflow). This will update the changelog & version and create a GitHub release which is in Draft state.

Find the draft release from the GitHub releases and publish it. When a release is published, it'll trigger release workflow which creates PyPI release.

Pre-commit

Pre-commit hooks run all the auto-formatters (e.g. black, isort), linters (e.g. mypy, flake8), and other quality checks to make sure the changeset is in good shape before a commit/push happens.

You can install the hooks with (runs for each commit):

pre-commit install

Or if you want them to run only for each push:

pre-commit install -t pre-push

Or if you want e.g. want to run all checks manually for all files:

pre-commit run --all-files

---

This project was generated using the wolt-python-package-cookiecutter template.