Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/infinitode/funcprofiler
An open-source Python library for identifying bottlenecks in code. It includes function profiling, data exports, logging, and line-by-line profiling for more granular control.
https://github.com/infinitode/funcprofiler
csv data-export functions html json logging minimal profiling profiling-library python
Last synced: 27 days ago
JSON representation
An open-source Python library for identifying bottlenecks in code. It includes function profiling, data exports, logging, and line-by-line profiling for more granular control.
- Host: GitHub
- URL: https://github.com/infinitode/funcprofiler
- Owner: Infinitode
- License: other
- Created: 2024-09-22T18:48:11.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-12-11T07:39:59.000Z (about 1 month ago)
- Last Synced: 2024-12-11T08:31:44.652Z (about 1 month ago)
- Topics: csv, data-export, functions, html, json, logging, minimal, profiling, profiling-library, python
- Language: Python
- Homepage: https://infinitode.netlify.app
- Size: 7.81 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# FuncProfiler
[](https://github.com/infinitode/funcprofiler)
An open-source Python library for identifying bottlenecks in code. It includes function profiling, data exports, logging, and line-by-line profiling for more granular control.
## Installation
You can install FuncProfiler using pip:
```bash
pip install funcprofiler
```
## Supported Python Versions
FuncProfiler supports the following Python versions:
- Python 3.6
- Python 3.7
- Python 3.8
- Python 3.9
- Python 3.10
- Python 3.11 and later (preferred)
Please ensure that you have one of these Python versions installed. FuncProfiler may not function as expected on earlier versions.
## Features
- **Function Profiling**: Monitor a function's memory usage and execution time to identify performance issues.
- **Line-by-Line Profiling**: Return execution time and memory usage for each line of any given function.
- **Shared Logging**: Log outputs of functions triggered by the line-by-line and function profilers, storing results in a `.txt` file.
- **File Exports**: Export profiling data from functions in `csv`, `json`, or `html` formats.
> [!NOTE]
> View more export types in the [official documentation](https://infinitode-docs.gitbook.io/documentation/package-documentation/funcprofiler-package-documentation).
## Usage
### Function Profiling
```python
from funcprofiler import function_profile
# Exporting as `html` with logging enabled
@function_profile(export_format="html", shared_log=True)
def some_function():
return "Hello World."
# Call the function
message = some_function()
```
### Line-by-Line Profiling
```python
from funcprofiler import line_by_line_profile
# Logging enabled without exports
@line_by_line_profile(shared_log=True)
def some_complicated_function(n):
total = 0
for i in range(n):
for j in range(i):
total += (i * j) ** 0.5 # Square root calculation
return total
# Call the function
total = some_complicated_function(1000)
```
> [!NOTE]
> FuncProfiler can be added to any function using the callable format: `@funcprofiler_function_name(expected_arguments)`.
## Contributing
Contributions are welcome! If you encounter issues, have suggestions, or wish to contribute to FuncProfiler, please open an issue or submit a pull request on [GitHub](https://github.com/infinitode/funcprofiler).
## License
FuncProfiler is released under the terms of the **MIT License (Modified)**. Please see the [LICENSE](https://github.com/infinitode/funcprofiler/blob/main/LICENSE) file for the full text.
**Modified License Clause**: The modified license clause allows users to create derivative works based on the FuncProfiler software. However, it requires that any substantial changes to the software be clearly distinguished from the original work and distributed under a different name.