Giter VIP home page Giter VIP logo

xontrib-readable-traceback's Introduction

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

I appreciate all Python's assets and xonsh.
If there is something problem, up to github issue.
@vaaaaanquish

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.