Skip to content

Gufo Err Example: Global Hook, Expanded Dump.

Lets modify our global.py example to get more information beyound default error traceback.

globalextend.py
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from gufo.err import err

err.setup(catch_all=True, format="extend")


def fail():
    x = 1
    x += 1
    msg = "failing"
    raise RuntimeError(msg)


fail()

The code is straightforward:

globalextend.py
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from gufo.err import err

err.setup(catch_all=True, format="extend")


def fail():
    x = 1
    x += 1
    msg = "failing"
    raise RuntimeError(msg)


fail()

All error configuration is performed via err singleton, so we need to import it first.

globalextend.py
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from gufo.err import err

err.setup(catch_all=True, format="extend")


def fail():
    x = 1
    x += 1
    msg = "failing"
    raise RuntimeError(msg)


fail()

err.setup() function must be called to initialize and confugure the error protection. catch_all argument set to true to replace the Python global error handling. format argument sets traceback format to extended version. See Err.setup() for details.

globalextend.py
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from gufo.err import err

err.setup(catch_all=True, format="extend")


def fail():
    x = 1
    x += 1
    msg = "failing"
    raise RuntimeError(msg)


fail()

Lets define the function which will intentionally fail. We define the x variable to catch it in the trace later.

globalextend.py
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from gufo.err import err

err.setup(catch_all=True, format="extend")


def fail():
    x = 1
    x += 1
    msg = "failing"
    raise RuntimeError(msg)


fail()

And call it.

Running

Run example as:

$ python3 examples/globalextend.py

And got the output:

Error: 70173ec8-930f-5579-bb26-623847905f64
RuntimeError: failing
Traceback (most resent call last):
-------------------------------------------------------------------------------
File: /workspaces/gufo_err/examples/globalextend.py (line 12)
    5     
    6     def fail():
    7         x = 1
    8         x += 1
    9         raise RuntimeError("failing")
   10     
   11     
   12 ==> fail()
Locals:
            __name__ = '__main__'
             __doc__ = None
         __package__ = None
          __loader__ = <_frozen_importlib_external.SourceFileLoader object at 0x7f47a335cc10>
            __spec__ = None
     __annotations__ = {}
        __builtins__ = <module 'builtins' (built-in)>
            __file__ = '/workspaces/gufo_err/examples/globalextend.py'
          __cached__ = None
                 err = <gufo.err.err.Err object at 0x7f47a2fbd240>
                fail = <function fail at 0x7f47a3497d90>
-------------------------------------------------------------------------------
File: /workspaces/gufo_err/examples/globalextend.py (line 9)
    2     
    3     err.setup(catch_all=True, format="extend")
    4     
    5     
    6     def fail():
    7         x = 1
    8         x += 1
    9 ==>     raise RuntimeError("failing")
   10     
   11     
   12     fail()
Locals:
                   x = 2
-------------------------------------------------------------------------------

Wow, much more details. Note, the fingerprint is differs. We also got a source code context and local variables for each frame. Such great improvement to analysis.