hell

When you've got to debug your code.

Installing

pip install hell

Requirements

• python >= 3.10
• termcolor

Usage

There is a collection of functions with short uppercase names.
Most of them print colorized formatted output.
Most of them accept short keyword arguments as options.

Colors

• black
• grey (Actually black but kept for backwards compatibility)
• red
• green
• yellow
• blue
• magenta
• cyan
• light_grey
• dark_grey
• light_red
• light_green
• light_yellow
• light_blue
• light_magenta
• light_cyan
• white

The first letters are shortcuts for colors: r, g, b, c, m, y, w . grey has no shortcut.

Attributes

• bold
• concealed
• dark
• reverse
• underline
• blink

The first letters can be used as well: b, c, d, r, u. blink has no shortcut.

Configuration

There is a Config class to adjust hell. Options are:

Example configuration change:

import hell
hell.Config.OUT = open('/tmp/debug.out', 'a')

Functions

• C
• F
• I
• L
• M
• P
• PP
• T

C

C(*args, sep=' ', end='\n', c=C_DEFAULT_COLOR, b=None, a=None)

Print args, colorized and formatted according to kwargs.

Examples:

from hell import C
C('Some', 'variables')
C('debug note', c='yellow', b='white', a='underline')
C('shortcuts', c='y', b='w', a='u') # yellow underlined on white
C('multiple attributes', a=['bold', 'underline'])
C('multiple attributes as space-delimited string', a='bold underline')
C('multiple attributes as space-delimited string with shortcuts', a='b u')
C(123, 456, sep='|', end='.')

F

F(frame=None, c=None, b=None, a=None, depth=1)

"Where am I?"

Print info about stack frame.

If frame is not provided, frame called F() will be used.

Info includes:

• python filename
• line number
• name of function that called F.
• name of type if function is its method or classmethod

Info is being formatted using Config.F_TEMPLATE

depth is to control number of stack frames to inspect. E.g. depth=2 is to print info on the function calling F and its caller.

c, b, a are optional termcolor related arguments. See C for details.

Example usage:

class Class:
    def function(self):
        F() # E.g. this lineno is 114

Will print:

/path/to/module.py line 114 Class.function()

I

I(banner='', ipython=True, call_f=True, c=None, b=None, a=None)

Emulate interactive Python console.

Current locals and globals will be available.

banner will be printed before first interaction.
banner=None is for printing default console banner.
See built-in code.InteractiveConsole.interact.

ipython=True indicates using IPython console if available.

When call_f is true, F() will be called printing info where I() was called.

c, b, a are optional termcolor related arguments. See C for details.

L

L(sized, c=None, b=None, a=None)

Print the length of sized, colorized and formatted according to keyword arguments.

c, b, a are optional termcolor related arguments. See C for details.

L('abc', c='b', a='underline')

Returns length with "pipe":

>>> 'abc' | L
3

M

M(obj, c=None, b=None, a=None, sep=' | ')

Print the base classes of type of the obj,
or of the obj itself when it is a type.

Bases will be in Method Resolution Order,
separated with sep,
colorized and formatted according to keyword arguments.

c, b, a are optional termcolor related arguments. See C for details.

P

P(*args, sep=' ', end='\n')

Shortcut for built-in function print writing to Config.OUT

PP

PP(obj, indent=4, width=80, depth=None, compact=False, c=None, b=None, a=None)

Pretty-print colorized python object.

from hell import PP
numbers = list(range(10))
PP(numbers, indent=4, width=15, compact=True)

will print

[   0, 1, 2, 3, 4,
    5, 6, 7, 8, 9,
        10, 11]

T

T(obj, c=None, b=None, a=None)

Print the type of obj, colorized and formatted according to keyword arguments.

c, b, a are optional termcolor related arguments. See C for details.

T(0, c='r', a='bold')

Returns type with "pipe":

>>> 123 | T
<class 'int'>

Contributing

Read here