easy-exit-calls 1.0.0.dev1__tar.gz

easy_exit_calls-1.0.0.dev1/LICENSE.md

@@ -0,0 +1,19 @@
+Copyright (c) 2025 **Inspyre-Softworks**
+
+Permission is **hereby granted**, free of charge, to any person obtaining a copy
+of this software (*EasyExitCalls*) and associated documentation files (the "Software"), to deal
+in the Software without restriction, including **without limitation** the rights
+to *use*, *copy*, *modify*, *merge*, *publish*, *distribute*, **sub***license*, **and**/**or** *sell*
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, **subject to the following conditions**:
+
+*The above copyright notice and this permission notice shall be included in **all
+copies** or substantial portions of the Software.*
+
+**THE SOFTWARE IS PROVIDED **"*AS IS*"**, WITHOUT WARRANTY OF ANY KIND, *EXPRESS* OR
+*IMPLIED*, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR *ANY CLAIM*, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.**

easy_exit_calls-1.0.0.dev1/PKG-INFO

@@ -0,0 +1,156 @@
+Metadata-Version: 2.3
+Name: easy-exit-calls
+Version: 1.0.0.dev1
+Summary: A Python library for managing exit handlers with enhanced features like decorators, UUID tracking, and LIFO execution.
+Author: Taylor B.
+Author-email: tayjaybabee@gmail.com
+Requires-Python: >=3.12,<4.0
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Utilities
+Classifier: Typing :: Typed
+Requires-Dist: inspy-logger (==3.2.3)
+Requires-Dist: inspyre-toolbox (>=1.6.0-dev22)
+Requires-Dist: pytz (>=2025.1,<2026.0)
+Description-Content-Type: text/markdown
+
+# easy-exit-calls
+
+A Python library for managing exit handlers with enhanced features like decorators, UUID tracking, and LIFO execution.
+
+## Features
+
+- **Decorator Support**: Easily register functions as exit handlers using a decorator.
+- **LIFO Execution**: Handlers execute in Last-In-First-Out order by default (configurable).
+- **UUID Tracking**: Each handler is assigned a unique UUID for easy management.
+- **Thread Safety**: Uses threading locks to ensure safe registration/unregistration.
+- **Detailed Logging**: Integrated with a logging engine for debugging and tracking.
+- **Error Handling**: Captures exceptions during exit and logs them with tracebacks.
+
+## Installation
+
+```bash
+pip install easy-exit-calls
+```
+
+## Usage
+
+### Basic Decorator Usage
+
+```python
+from easy_exit_calls import register_exit_handler
+
+@register_exit_handler
+def cleanup():
+    print("Cleaning up resources...")
+
+# Exiting the program will automatically trigger this handler.
+```
+
+### Decorator with Arguments
+
+```python
+from easy_exit_calls import register_exit_handler
+
+@register_exit_handler("arg1", key="value")
+def cleanup_with_args(arg1, key=None):
+    print(f"Cleaning up with {arg1} and {key}")
+
+# Handler called with provided args/kwargs on exit.
+```
+
+### Manual Registration
+
+```python
+from easy_exit_calls import ExitCallHandler
+
+def manual_cleanup():
+    print("Manual cleanup")
+
+ExitCallHandler().register_handler(manual_cleanup)
+
+# Exiting the program will manually trigger this handler.
+```
+
+### Unregistering Handlers
+
+```python 
+from easy_exit_calls import ExitCallHandler
+
+def cleanup():
+    print("Cleaning up resources...")
+
+handler_uuid = ExitCallHandler().register_handler(cleanup)
+
+# Unregister the handler by UUID.
+ExitCallHandler().unregister_by_uuid(handler_uuid)
+```
+
+### Execution Order
+
+```python
+from easy_exit_calls import register_exit_handler
+
+@register_exit_handler
+def first_handler():
+    print("First handler")
+
+@register_exit_handler
+def second_handler():
+    print("Second handler")
+
+# Output on exit:
+# Second handler
+# First handler
+# (LIFO execution order)
+```
+
+## API Reference
+
+### `ExitCallHandler`
+
+Singleton class managing exit handlers.
+
+#### Methods:
+
+- `register_handler(func: Callable, *args, **kwargs) -> str`:
+    Register a new exit handler with optional args/kwargs. Returns the UUID of the handler.<br><br>
+- `unregister_by_uuid(uuid)`:
+    Unregister a handler by UUID.<br><br>
+- `unregister_handler(func, *args, **kwargs)`:
+    Unregister a handler by function reference and optional args/kwargs.<br><br>
+- `call_handlers()`:
+    Manually call all registered handlers.<br><br>
+
+### `register_exit_handler`
+
+Decorator for registering a function as an exit handler.
+
+#### Parameters:
+
+- `*handler_args`:
+    Optional arguments to pass to the handler function.<br><br>
+- `**handler_kwargs`:
+    Optional keyword arguments to pass to the handler function.<br><br>
+
+
+## Contributing
+
+Contributions are welcome! Here's how you can get started:
+  1) Fork the repository.<br><br>
+  2) Create a new branch (`git checkout -b feature-branch`).<br><br>
+  3) Make your changes.<br><br>
+  4) Commit your changes (`git commit -m 'Add feature'`).<br><br>
+  5) Push your changes to your fork (`git push origin feature-branch`).<br><br>
+  6) Create a pull request.<br><br>
+
+
+## License
+
+This project is released under the [MIT License](LICENSE.md).
+

easy_exit_calls-1.0.0.dev1/README.md

@@ -0,0 +1,134 @@
+# easy-exit-calls
+
+A Python library for managing exit handlers with enhanced features like decorators, UUID tracking, and LIFO execution.
+
+## Features
+
+- **Decorator Support**: Easily register functions as exit handlers using a decorator.
+- **LIFO Execution**: Handlers execute in Last-In-First-Out order by default (configurable).
+- **UUID Tracking**: Each handler is assigned a unique UUID for easy management.
+- **Thread Safety**: Uses threading locks to ensure safe registration/unregistration.
+- **Detailed Logging**: Integrated with a logging engine for debugging and tracking.
+- **Error Handling**: Captures exceptions during exit and logs them with tracebacks.
+
+## Installation
+
+```bash
+pip install easy-exit-calls
+```
+
+## Usage
+
+### Basic Decorator Usage
+
+```python
+from easy_exit_calls import register_exit_handler
+
+@register_exit_handler
+def cleanup():
+    print("Cleaning up resources...")
+
+# Exiting the program will automatically trigger this handler.
+```
+
+### Decorator with Arguments
+
+```python
+from easy_exit_calls import register_exit_handler
+
+@register_exit_handler("arg1", key="value")
+def cleanup_with_args(arg1, key=None):
+    print(f"Cleaning up with {arg1} and {key}")
+
+# Handler called with provided args/kwargs on exit.
+```
+
+### Manual Registration
+
+```python
+from easy_exit_calls import ExitCallHandler
+
+def manual_cleanup():
+    print("Manual cleanup")
+
+ExitCallHandler().register_handler(manual_cleanup)
+
+# Exiting the program will manually trigger this handler.
+```
+
+### Unregistering Handlers
+
+```python 
+from easy_exit_calls import ExitCallHandler
+
+def cleanup():
+    print("Cleaning up resources...")
+
+handler_uuid = ExitCallHandler().register_handler(cleanup)
+
+# Unregister the handler by UUID.
+ExitCallHandler().unregister_by_uuid(handler_uuid)
+```
+
+### Execution Order
+
+```python
+from easy_exit_calls import register_exit_handler
+
+@register_exit_handler
+def first_handler():
+    print("First handler")
+
+@register_exit_handler
+def second_handler():
+    print("Second handler")
+
+# Output on exit:
+# Second handler
+# First handler
+# (LIFO execution order)
+```
+
+## API Reference
+
+### `ExitCallHandler`
+
+Singleton class managing exit handlers.
+
+#### Methods:
+
+- `register_handler(func: Callable, *args, **kwargs) -> str`:
+    Register a new exit handler with optional args/kwargs. Returns the UUID of the handler.<br><br>
+- `unregister_by_uuid(uuid)`:
+    Unregister a handler by UUID.<br><br>
+- `unregister_handler(func, *args, **kwargs)`:
+    Unregister a handler by function reference and optional args/kwargs.<br><br>
+- `call_handlers()`:
+    Manually call all registered handlers.<br><br>
+
+### `register_exit_handler`
+
+Decorator for registering a function as an exit handler.
+
+#### Parameters:
+
+- `*handler_args`:
+    Optional arguments to pass to the handler function.<br><br>
+- `**handler_kwargs`:
+    Optional keyword arguments to pass to the handler function.<br><br>
+
+
+## Contributing
+
+Contributions are welcome! Here's how you can get started:
+  1) Fork the repository.<br><br>
+  2) Create a new branch (`git checkout -b feature-branch`).<br><br>
+  3) Make your changes.<br><br>
+  4) Commit your changes (`git commit -m 'Add feature'`).<br><br>
+  5) Push your changes to your fork (`git push origin feature-branch`).<br><br>
+  6) Create a pull request.<br><br>
+
+
+## License
+
+This project is released under the [MIT License](LICENSE.md).

easy_exit_calls-1.0.0.dev1/easy_exit_calls/__init__.py

@@ -0,0 +1,33 @@
+"""
+This module provides a simple way to register exit handlers for your Python applications.
+
+The main class is ExitCallHandler, which is used to register and manage exit handlers.
+
+Included is a decorator, register_exit_handler, which can be used to register an exit handler for a function. This is a
+convenient way to register exit handlers for functions.
+
+Example:
+    >>> from easy_exit_calls import register_exit_handler, ExitCallHandler
+    >>>
+    >>> @register_exit_handler()
+    ... def my_exit_handler():
+    ...     print("Exiting...")
+    ...
+    >>> # Create an instance of ExitCallHandler
+    >>> eh = ExitCallHandler()
+    >>>
+    >>> # Register an exit handler
+    >>> eh.register_handler(my_exit_handler)
+    >>>
+    >>> # Call the exit handlers
+    >>> eh.call_handlers()
+    Exiting...
+"""
+
+from easy_exit_calls.classes import ExitCallHandler
+from easy_exit_calls.decorator import register_exit_handler
+
+__all__ = [
+    'ExitCallHandler',
+    'register_exit_handler',
+]