gaogaotiantian / wthell

wthell is a debugging tool for python to interactively check frame stack when your code quit unexpectedly

wthell

wthell is a debugging tool for python to interactively check frame stack when your code did something unexpectedly

Install

You can install wthell from pip

pip install wthell

Usage

It's super easy to use wthell. Just run you script using wthell instead of python

wthell your_script.py args1 args2

In linux shell, you can simply use this right after you command failed:

wthell !!

Fun, isn't it?

Or you can import wthell in your script and run your script normally

import wthell

If there's an uncaught exception, you will enter an interactive shell like this:

/home/gaogaotiantian/programs/wthell/test.py(6)
  def g(a, b):
      a += h(a)
      b += 3
>     raise Exception("lol")


Exception raised: <class 'Exception'> lol

up(u)       -- go to outer frame  | down(d)  -- go to inner frame
clear(cl)   -- clear the console  | reset(r) -- back to trigger frame
continue(c) -- resume the program | ctrl+D   -- quit
show(s) <func> -- show source code of function <func>

>>> 

You will be in the frame(function) that raised exceptions in the beginning.

• Type up to go to outer frame(its caller).
• Type down to go to inner frame(when you already go out).
• Type clear to clear the console prints
• Type reset to go back to the original frame that triggered wthell
• Type continue to resume the program
• Type show <func_name> to show source code of a function

wthell will record the full call stack so you can check any frame.

While you are in a stack, you can type anything that you want to evaluation to help you debug.

>>> a
13
>>> a + 1
14
>>> h(a)
16
>>> 

Or you can trigger wthell anywhere in your code

def suspicious_function():
    # I want to check here!
    wthell.wth()

wthell behaves like an interactive shell.

Happy debugging!

License

Copyright Tian Gao, 2020.

Distributed under the terms of the Apache 2.0 license.

wthell's Issues

在windows下运行wthell报错

在windows下运行wthell报错

import wthell
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "C:\Users\Administrator\AppData\Local\Programs\Python\Python38\lib\site-p
ackages\wthell\__init__.py", line 2, in <module>
    from .wthell import WTHell
  File "C:\Users\Administrator\AppData\Local\Programs\Python\Python38\lib\site-p
ackages\wthell\wthell.py", line 5, in <module>
    import readline
ModuleNotFoundError: No module named 'readline'

尝试

pip install readline

得到的结果是

Collecting readline
  Downloading readline-6.2.4.1.tar.gz (2.3 MB)
     ---------------------------------------- 2.3/2.3 MB 715.8 kB/s eta 0:00:00
  Preparing metadata (setup.py) ... error
  error: subprocess-exited-with-error

  × python setup.py egg_info did not run successfully.
  │ exit code: 1
  ╰─> [1 lines of output]
      error: this module is not meant to work on Windows
      [end of output]

也就是说，readline不能在windows上运行

系统：windows 7