Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add context manager to enable/disable profiling #709

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add context manager to enable/disable profiling #709

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 7 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,13 @@ scalene_profiler.start()
scalene_profiler.stop()
```

```Python
from scalene.scalene_profiler import enable_profiling

with enable_profiling():
# do something
```

</details>

<details>
Expand Down
10 changes: 9 additions & 1 deletion scalene/scalene_profiler.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ def nada(*args):
Tuple,
Type,
Union,
cast,
cast, Generator,
)

from scalene.scalene_arguments import ScaleneArguments
Expand Down Expand Up @@ -160,6 +160,14 @@ def stop() -> None:
Scalene.stop()


@contextlib.contextmanager
def enable_profiling() -> Generator[None, None, None]:
"""Contextmanager that starts and stops profiling"""
start()
yield
stop()


def _get_module_details(
mod_name: str,
error: Type[Exception] = ImportError,
Expand Down