printstream 0.1.3

Description:

printstream 0.1.3

printstream
A Python library that enhances the built-in print function for better debugging.
Table of Contents

Features
Installation
Usage
Configuration
Examples
Overhead Measurement
Contribution
License
Contact

Features

Prepend function name to print output.
Colorize function name based on hash for better visual distinction.
Align print output for improved readability.
Toggle enhanced print functionality on and off as needed.
Highly configurable via simple API.
Lightweight with minimal setup.

Installation
Install printstream via pip:
pip install printstream

Usage
Import and activate the library at the top of your script:
from printstream import activate, deactivate

activate()

# Your code here...

deactivate()

Configuration
Configure printstream to suit your needs:
from printstream import (
set_format, set_level, set_output, set_align, set_repeat_func_name,
set_colorize, activate, deactivate
)

# Configure the debugger
set_format("[{func_name}] {message}")
set_align(False)
set_repeat_func_name(True)
set_colorize(True)
set_level(1)

activate()

# Your code here...

deactivate()

Additional Configuration Details
Here are some additional details about the configuration options:

align: If repeat_func_name is set to False and align is set to True, the output of a single print statement with newlines will be indented such that the output is fully aligned.

align and repeat_func_name set to False:
[test] Hello World
How are you?


repeat_func_name: If a print statement has newlines, and this option is set to True, it will still print the function name before each line (even within the same print statement).

[test] Hello World
[test] How are you?


colorize: This option colorizes the function name based on its hash. This introduces some significant overhead (~200%). If anyone has any suggestions on improvements, please submit a PR.



levels: This option controls the output level.

-1: No output
0: Normal print
1: Debug activated



Examples
Example with printstream activated:
from printstream import activate, deactivate

activate()

def test():
print("Hello World\nHow are you?")

test()

deactivate()

Output:
[test] Hello World
[test] How are you?

Overhead Measurement
Measure the overhead of printstream:
import timeit

# ... setup code ...

# Measure time with standard print
time_without_debug = timeit.timeit("test()", setup=setup_code, number=10)

# Measure time with printstream activated
time_with_debug = timeit.timeit("activate(); test(); deactivate()", setup=setup_code, number=10)

# Calculate overhead percentage
overhead_percentage = ((time_with_debug - time_without_debug) / time_without_debug) * 100

Contribution
Contributions to printstream are welcome! Please submit a pull request or create an issue on the GitHub repository.
License
printstream is licensed under the MIT License. See the LICENSE file for details.
Contact

Author: Arnav
Email: [email protected]