Provides functions for neatly printing debug information to the terminal output, well-suited for multithreaded programs.
Project description
DvG_debug_functions
Provides functions for neatly printing debug information to the terminal output, well-suited for multithreaded programs.
Supports PyQt5, PyQt6, PySide2 and PySide6.
Installation:
pip install dvg-debug-functions
API
Functions
print_fancy_traceback(err=None, back: int = 3, show_full_paths: bool = False)
Print the exception or the current regular call-stack traceback to the terminal, using ANSI color codes that mimic the IPython command shell.
- Args:
- err (Exception | str | None, optional):
When err is of type Exception, then an exception traceback will be printed. When err is of another type, then the current regular call-stack traceback will be printed.
Default: None
- back (int, optional):
Depth of the traceback to print.
Default: 3
- show_full_paths (bool, optional):
Shows the full filepath in the traceback when True, otherwise just the filename.
Default: False
Example output:
dprint(str_msg: str, ANSI_color: str = None)
‘Debug’ print a single line to the terminal with optional ANSI color codes. There is a lot of overhead using this print statement, but it is particularly well-suited for multithreaded PyQt programs where multiple threads are each printing information to the same terminal. The dprint() function ensure that each line sent to the terminal will remain as a continious single line, whereas a regular print() statement will likely result in the lines getting mixed up.
The line will be terminated with a newline character and the terminal output buffer is forced to flush before and after every print. In addition, if PyQt5 is present in the Python environment, then a mutex lock will be obtained and released again for each dprint() execution.
tprint(str_msg: str, ANSI_color: str = None)
Identical to dprint(), but now prepended with a time.perf_counter() timestamp.
Classes
class ANSI: NONE = "" RED = "\033[1;31m" GREEN = "\033[1;32m" YELLOW = "\033[1;33m" BLUE = "\033[1;34m" PURPLE = "\033[1;35m" # aka MAGENTA MAGENTA = "\033[1;35m" CYAN = "\033[1;36m" WHITE = "\033[1;37m"
Changelog
2.5.0 (2024-06-22)
Using qtpy library instead of my own Qt5/6 mechanism
Using f-strings
Resolved pylint and pylance warnings
2.4.0 (2023-02-27)
Neater support for PyQt5, PyQt6, PySide2 and PySide6
Migrated from travis to Github actions
2.2.0 (2022-09-13)
Added support for PyQt5, PyQt6, PySide2 and PySide6
2.1.1 (2020-07-18)
Added flag show_full_paths to print_fancy_traceback()
2.1.0 (2020-07-17)
Improved print_fancy_traceback()
2.0.0 (2020-07-02)
DvG module filenames changed to lowercase
1.1.2 (2020-06-08)
Code style: black
1.1.1 (2020-06-06)
Extended README
1.1.0 (2020-06-04)
Added tprint(…)
0.0.1 (2020-05-13)
First release on PyPI.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for dvg-debug-functions-2.5.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 092f82b50a7ed66d2d974878fcd4dec3b9fd536e2564c1ba1d87acba2d0336be |
|
MD5 | 2416e1e339d164f9bdbcced69135f235 |
|
BLAKE2b-256 | c6ede0ff24cdc8eaa5d4962573a46af44882c0684f2d9ea93a8521e7d335b6f5 |
Hashes for dvg_debug_functions-2.5.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b31be0b8ff8a4c46d67f928e0b525c74e2ccc98efc1264f0b9fdf55cc0e3d8f6 |
|
MD5 | 767cc84b3bdca9b339738f9b17115bd9 |
|
BLAKE2b-256 | f1d07719af0ef8840d2eb9babcb7b7e04343a126b81e056e6925ea78cf5a0d88 |