https://github.com/guicho271828/fattrace

Provides an informative (fat) stacktrace that shows everything on the stack.
https://github.com/guicho271828/fattrace

Last synced: 29 days ago
JSON representation

Provides an informative (fat) stacktrace that shows everything on the stack.

• Host: GitHub
• URL: https://github.com/guicho271828/fattrace
• Owner: guicho271828
• Created: 2024-03-11T18:10:10.000Z (10 months ago)
• Default Branch: master
• Last Pushed: 2024-03-11T19:03:48.000Z (10 months ago)
• Last Synced: 2024-10-16T14:10:44.436Z (3 months ago)
• Language: Python
• Size: 60.5 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        

# Fattrace

Provides an informative (fat) stacktrace that shows everything on the stack.

## Examples

Before:



After:



## Highlights

* Removes the need for printf and debugger

* Special handling for array-like objects which have members that are named one of:

  * dtype

  * shape

  * device

  * layout

* Similar to [tbvaccine](https://github.com/skorokithakis/tbvaccine), optionally ignores frames from external libraries

## Usage

Run `fattrace.install()` anywhere to replace the standard stack-trace hook ([`sys.excepthook`](https://docs.python.org/3/library/sys.html#sys.excepthook)).

Customization is done by the keyword arguments:

``` python

def install(threshold:int=3,

            include_self:bool=True,

            include_private:bool=False,

            include_external:bool=False,

            ignore:set[str]={},

            ignore_type:set[type]={},

            ):

    ...

```

* `threshold` : the maximum number of elements to print in a list, tuple, dict, etc.

* `include_self` : in a method call, whether to print the members of `self`.

* `include_private` : If true, private variables and members whose names start with "__" are excluded from the trace.

* `include_external` : if false (default), include assignments only if the code is under the current directory.

* `ignore` : A set of strings. Variables and members matching any of the names are excluded from the trace.

* `ignore_type` : A set of types. Variables and members matching any of the types are excluded from the trace.