https://github.com/louisbrulenaudet/mswp
Decorator that automatically clears temporary local variables upon function execution, effectively preventing clutter and mitigating memory leaks.
https://github.com/louisbrulenaudet/mswp
Last synced: 6 months ago
JSON representation
Decorator that automatically clears temporary local variables upon function execution, effectively preventing clutter and mitigating memory leaks.
- Host: GitHub
- URL: https://github.com/louisbrulenaudet/mswp
- Owner: louisbrulenaudet
- License: apache-2.0
- Created: 2024-02-21T16:40:34.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-02-22T22:25:30.000Z (over 1 year ago)
- Last Synced: 2024-05-02T01:48:17.393Z (over 1 year ago)
- Language: Python
- Size: 18.6 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Citation: CITATION.cff
- Security: SECURITY.md
Awesome Lists containing this project
README
# mswp, a decorator that clears temporary local variables upon function execution, preventing clutter and mitigating memory leaks
[](https://badge.fury.io/py/tensorflow) [](https://opensource.org/licenses/Apache-2.0) 
mswp is a Python decorator designed to enhance code cleanliness and mitigate potential memory leaks by automatically clearing temporary local variables after function execution.
## Overview
Python functions often create temporary variables for intermediate computations, which can clutter the local namespace and potentially lead to memory leaks if not properly managed. mswp addresses this issue by providing a simple yet powerful decorator that automatically cleans up temporary local variables, ensuring an efficient execution environment.
## Installation
You can install mswp via pip:
```bash
pip3 install mswp
```
## Usage
To use mswp, simply decorate your functions with @mswp. This ensures that any temporary local variables used within the function are cleared upon completion, promoting code cleanliness and efficient memory usage.
```python
from mswp import clear
@clear
def my_function():
temp_var = 10
# Your code here
return result
```
In this example, my_function is decorated with @clear, ensuring that any temporary local variables used within it are cleared upon completion.
### Parameters
`func`: The function to be decorated.
### Returns
`function`: The decorated function.
## Features
- Automatic Cleanup: mswp automatically clears temporary local variables after function execution, preventing clutter and potential memory leaks.
- Simplified Syntax: With a simple decorator, mswp streamlines code maintenance and promotes readability.
- Error Handling: mswp provides robust error handling to ensure reliable execution even in the presence of exceptions.
## Citing this project
If you use this code in your research, please use the following BibTeX entry.
```BibTeX
@misc{louisbrulenaudet2023,
author = {Louis Brulé Naudet},
title = {mswp, a decorator that automatically clears temporary local variables upon function execution, effectively preventing clutter and mitigating memory leaks},
howpublished = {\url{https://github.com/louisbrulenaudet/mswp}},
year = {2024}
}
```
## Feedback
If you have any feedback, please reach out at [louisbrulenaudet@icloud.com](mailto:louisbrulenaudet@icloud.com).