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

Add context manager to enable/disable profiling #709

Merged
merged 3 commits into from
Jul 8, 2024
Merged

Add context manager to enable/disable profiling #709

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c33086e
add enable_profiling contextmanager
provinzkraut Oct 4, 2023
832d496
Merge branch 'master' into master
emeryberger Jul 8, 2024
1c0738c
Update scalene_profiler.py
emeryberger Jul 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
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 @@ -112,6 +112,13 @@ scalene_profiler.start()
scalene_profiler.stop()
```

```Python
from scalene.scalene_profiler import enable_profiling

with enable_profiling():
# do something
```

</details>

<details>
Expand Down
9 changes: 8 additions & 1 deletion scalene/scalene_profiler.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@
Set,
Tuple,
Union,
cast,
cast, Generator,
)

import scalene.scalene_config
Expand Down Expand Up @@ -147,6 +147,13 @@ def stop() -> None:
Scalene.stop()


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

class Scalene:
"""The Scalene profiler itself."""

Expand Down
Loading