xontrib-readable-traceback
Make traceback easier to see for xonsh.
Python work very often with large libraries like pandas, or matplotlib. This means that exceptions often produce long stack traces. Since we don't need to see the library detail in the vast majority of cases. Especially with a shell like xonsh.
This xontrib making readable and short traceback.
example: Simple division by zero error.
example: This simple pandas error produces a stacktrace containing 28 lines. But xontrib load...
Install
Install using pip
pip install xontrib-readable-traceback
Write .xonshrc
xontrib load readable-traceback
Usage
This xontrib use backtrace package.
For the main usage, please refer to the following.
https://github.com/nir0s/backtrace#usage
Example xonshrc
xonshrc sample.
~~~
xontrib load readable-traceback
$READABLE_TRACE_STRIP_PATH_ENV=True
$READABLE_TRACE_REVERSE=True
~~~
Setting backtrace
The correspondence with the variable of backtrace is as follows.
| backtrace | xontrib-readable-traceback | Type |
|---|---|---|
| reverse | $READABLE_TRACE_REVERSE | bool |
| align | $READABLE_TRACE_ALIGN | bool |
| strip_path | $READABLE_TRACE_STRIP_PATH_ENV | bool |
| enable_on_envvar_only | $READABLE_TRACE_ENVVAR_ONLY | bool |
| on_tty | $READABLE_TRACE_ON_TTY | bool |
| conservative | $READABLE_TRACE_CONSERVATIVE | bool |
| style | $READABLE_TRACE_STYLES | dict |
For details of style please refer to backtrace#style and colorama.
Switching readable-traceback
If we want to turn trace off, we can use:
$XONSH_READABLE_TRACEBACK=False
If so, the notation of traceback follows xonsh_env($XONSH_SHOW_TRACEBACK).
Xonsh traceback log
Xonsh can keep a log of traceback.
To keep the log, write "ABSOLUTE PATH TO TRACEBACK LOG" below.
$XONSH_TRACEBACK_LOGFILE="PATH"
If it is None, no log is kept. Default is None.
Thanks
Thanks
- https://github.com/xonsh/xonsh
- https://github.com/nir0s/backtrace
- https://github.com/laerus/cookiecutter-xontrib
I appreciate all Python's assets and xonsh.
If there is something problem, up to github issue.
@vaaaaanquish
Metadata
Release files for xontrib-readable-traceback 0.4.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| xontrib-readable-traceback-0.4.0.tar.gz | 3.5 kB | Without provenance | Details for xontrib-readable-traceback-0.4.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| xontrib_readable_traceback-0.4.0-py3-none-any.whl | Python 3 | none | any | Details for xontrib_readable_traceback-0.4.0-py3-none-any.whl |
Total release size: 7.9 kB
Release files / xontrib-readable-traceback-0.4.0.tar.gz
| Download URL | xontrib-readable-traceback-0.4.0.tar.gz |
|---|---|
| Size | 3.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b5e841f0aa32dc941741cda784b67d5a4434352a4b9ffdd2da2cdb1dce850ebf
|
|
BLAKE2b-256 checksum How to use checksums |
ad42707ef7c194cabbf2209a51ae21c72408365948fe8453c8d4c2ec1e6f4114
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.8.10
|
Release files / xontrib_readable_traceback-0.4.0-py3-none-any.whl
| Download URL | xontrib_readable_traceback-0.4.0-py3-none-any.whl |
|---|---|
| Size | 4.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
46e81f86bc0fca724907844f7b1b00b3366ece9ed261108d7bc505933f6e08c0
|
|
BLAKE2b-256 checksum How to use checksums |
d2f065ea7a80b1c9f8f42156a2eca9dc845889c6e7e6abac04b6d70d352bbaf1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.8.10
|
Security for xontrib-readable-traceback 0.4.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.