Introduction

Do you use print() or log() to debug your code? If so, peek will make printing debug information really easy. And on top of that, you get some basic benchmarking functionality.

Table of contents

• Installation

• Importing peek

• Inspect variables and expressions

• Inspect execution

• Return value

• Debug entry and exit of function calls

• Benchmarking with peek

• Configuration

• Use peek.print to use peek like print with extras

• Peeking locals and globals

• Return a string instead of sending to output

• Disabling peek's output

• Using filter to control peek output

• Copying to the clipboard

• Interpreting the line number information

• Configuring at import time

• Working with multiple instances of peek

• Test script

• Using peek in a REPL

• Limitations

• Changelog

• Acknowledgement

• Differences with IceCream

Installation

Installing peek with pip is easy.

xxxxxxxxxx
pip install peek-python

or when you want to upgrade,

xxxxxxxxxx
pip install peek-python --upgrade

Note that peek requires the asttokens, colorama, executing. six, tomli and pyperclip modules, all of which will be automatically installed.

Importing peek

All you need is:

xxxxxxxxxx
import peek

, or the more conventional, but more verbose

xxxxxxxxxx
from peek import peek

Note that after this, peek is automatically a builtin and can thus be used in any module without importing it there.

Inspect variables and expressions

Have you ever printed variables or expressions to debug your program? If you've ever typed something like

xxxxxxxxxx
print(add2(1000))

or the more thorough

xxxxxxxxxx
print("add2(1000)", add2(1000)))

or:

xxxxxxxxxx
print(f"{add2(1000)=}")

then peek() is here to help. With arguments, peek() inspects itself and prints both its own arguments and the values of those arguments.

xxxxxxxxxx
def add2(i):
    return i + 2

peek(add2(1000))

prints

xxxxxxxxxx
add2(1000)=1002

Similarly,

xxxxxxxxxx
class X:
    a = 3
world = {"EN": "world", "NL": "wereld", "FR": "monde", "DE": "Welt"}

peek(world, X.a)

prints

xxxxxxxxxx
world={"EN": "world ", "NL": "wereld", "FR": "monde", "DE": "Welt"}, X.a=3

Just give peek() a variable or expression and you're done.

And you can even add color to distinguish between peek's output lines:

xxxxxxxxxx
for number in range(10):
    number_divided_by_3 = number / 3
    if number % 3 == 0:
        peek(number, number_divided_by_3, color="red")
    else:
        peek(number, number_divided_by_3, color="yellow")

This will result in:

Inspect execution

Have you ever used print() to determine which parts of your program are executed, and in which order they're executed? For example, if you've ever added print statements to debug code like

xxxxxxxxxx
def add2(i):
    print("***add2 1")
    result = i + 2
    print("***add2 2")
    return result

then peek() helps here, too. Without arguments, peek() inspects itself and prints the calling line number and -if applicable- the file name and parent function.

xxxxxxxxxx
def add2(i):
    peek()
    result = i + 2
    peek()
    return result
peek(add2(1000))

prints something like

xxxxxxxxxx
#3 in add2()
#5 in add2()
add2(1000)=1002

Return Value

peek() returns its argument(s), so peek() can easily be inserted into pre-existing code.

xxxxxxxxxx
def add2(i):
    return i + 2
b = peek(add2(1000))
peek(b)

prints

xxxxxxxxxx
add2(1000)=1002
b=1002

Debug entry and exit of function calls

When you apply peek() as a decorator to a function or method, both the entry and exit can be tracked. The (keyword) arguments passed will be shown and upon return, the return value.

xxxxxxxxxx
@peek()
def mul(x, y):
    return x * y
    
print(mul(5, 7))

prints

xxxxxxxxxx
called mul(5, 7)
returned 35 from mul(5, 7) in 0.000006 seconds
35

It is possible to suppress the print-out of either the enter or the exit information with the show_enter and show_exit parameters, like:

xxxxxxxxxx
@peek(show_exit=False)
def mul(x, peek):
    return x * peek
    
print(mul(5, 7))

prints

xxxxxxxxxx
called mul(5, 7)
35

Benchmarking with peek

If you decorate a function or method with peek(), you will be offered the duration between entry and exit (in seconds) as a bonus.

That opens the door to simple benchmarking, like:

xxxxxxxxxx
import time

@peek(show_enter=False,show_line_number=True)
def do_sort(i):
    n = 10 ** i
    x = sorted(list(range(n)))
    return f"{n:9d}"  
    
for i in range(8):
    do_sort(i)

the ouput will show the effects of the population size on the sort speed:

xxxxxxxxxx
#5 ==> returned '        1' from do_sort(0) in 0.000027 seconds
#5 ==> returned '       10' from do_sort(1) in 0.000060 seconds
#5 ==> returned '      100' from do_sort(2) in 0.000748 seconds
#5 ==> returned '     1000' from do_sort(3) in 0.001897 seconds
#5 ==> returned '    10000' from do_sort(4) in 0.002231 seconds
#5 ==> returned '   100000' from do_sort(5) in 0.024014 seconds
#5 ==> returned '  1000000' from do_sort(6) in 0.257504 seconds
#5 ==> returned ' 10000000' from do_sort(7) in 1.553495 seconds

It is also possible to time any code by using peek() as a context manager, e.g.

xxxxxxxxxx
with peek():
    time.sleep(1)

wil print something like

xxxxxxxxxx
enter
exit in 1.000900 seconds

You can include parameters here as well:

xxxxxxxxxx
with peek(show_line_number=True, show_time=True):
    time.sleep(1)

will print somethink like:

xxxxxxxxxx
#8 @ 13:20:32.605903 ==> enter
#8 @ 13:20:33.609519 ==> exit in 1.003358 seconds

Finally, to help with timing code, you can request the current delta with

xxxxxxxxxx
peek.delta

or (re)set it with

xxxxxxxxxx
peek.delta = 0

So, e.g. to time a section of code:

xxxxxxxxxx
peek.delta = 0
time.sleep(1)
duration = peek.delta
peek(duration)

might print something like:

xxxxxxxxxx
duration=1.0001721999999997

Configuration

For the configuration, it is important to realize that peek is an instance of a class, which has a number of configuration attributes:

xxxxxxxxxx
------------------------------------------------------
attribute               alternative     default
------------------------------------------------------
color                   col             "-"
color_value             col_val         "-"
compact                 -               False
context_separator       cs              " ==> "
depth                   -               1000000
delta                   -               0
enabled                 -               True
end                     -               "\n"
equals_separator        -               "="
filter                  f               ""
format                  fmt             ""
indent                  -               1
level                   lvl             0
line_length             ll              80
output                  -               "stdout"
prefix                  pr              ""
print_like              print           False
quote_string            qs              True
return_none             -               False
separator               sep             ", "
separator_print         sepp            "" "
serialize               -               pprint.pformat
show_delta              sd              False
show_enter              se              True
show_exit               sx              True
show_line_number        sln             False
show_time               st              False
show_traceback          -               False
sort_dicts              -               False
to_clipboard            clip            False
underscore_numbers      un              False   
values_only             vo              False
value_only_for_fstrings voff            False 
wrap_indent             -               "     "
------------------------------------------------------

It is perfectly ok to set/get any of these attributes directly, like

xxxxxxxxxx
peek.prefix = "==> "
print(peek.prefix)

But, it is also possible to apply configuration directly, only here, in the call to peek: So, it is possible to say

xxxxxxxxxx
peek(12, prefix="==> ")

, which will print

xxxxxxxxxx
==> 12

It is also possible to configure several attributes permanently with the configure method.

xxxxxxxxxx
peek.configure(prefix="==> ", color="blue")
peek(12)

will print in blue

xxxxxxxxxx
==> 12

It is arguably easier to say:

xxxxxxxxxx
peek.prefix = "==> "
peek.color = "blue"
peek(12)

or even

xxxxxxxxxx
peek.pr = "==> "
peek.col = "blue"
peek(12)

to print

xxxxxxxxxx
==> 12

Yet another way to configure peek is to get a new instance of peek with peek.new() and the required configuration:

xxxxxxxxxx
peek0 = peek.new(prefix="==> ", color="blue")
peek0(12)

will print

xxxxxxxxxx
==> 12

Or, yet another possibility is to clone peek (optionally with modified attributes):

xxxxxxxxxx
peek1 = peek.clone(show_time=True)
peek2 = peek.clone()
peek2.show_time = True

After this peek1 and peek2 will behave similarly (but they are not the same!)

prefix / pr

xxxxxxxxxx
peek('world', prefix='hello -> ')

prints

xxxxxxxxxx
hello -> 'world'

prefix can be a function, too.

xxxxxxxxxx
import time
def unix_timestamp():
    return f"{int(time.time())} "
hello = "world"
peek.prefix = unix_timestamp
peek(hello) 

prints something like

xxxxxxxxxx
1613635601 hello='world'

output

This will allow the output to be handled by something else than the default (output being written to stdout).

The output attribute can be

• a callable that accepts at least one parameter (the text to be printed)

• a string or Path object that will be used as the filename

• a text file that is open for writing/appending

In the example below,

xxxxxxxxxx
import sys
peek(1, output=print)
peek(2, output=sys.stderr)
with open("test", "a+") as f:
    peek(3, output=f)
peek(4, output="")

• 1 will be printed to stdout

• 2 will be printed to stderr

• 3 will be appended to the file test

• nothing will be printed/written

As output may be a callable, you can even use this to automatically log any peek output:

xxxxxxxxxx
import logging
logging.basicConfig(level="INFO")
log = logging.getLogger("demo")
peek.configure(output=log.info)
a = {1, 2, 3, 4, 5}
peek(a)
a.remove(4)
peek(a)

will print to stdout:

xxxxxxxxxx
INFO:demo:a={1, 2, 3, 4, 5}
INFO:demo:a={1, 2, 3, 5}

Finally, you can specify the following strings:

xxxxxxxxxx
"stderr"           to print to stderr
"stdout"           to print to stdout
"stdout_nocolor"   to print to stdout without any colors
"null" or ""       to completely ignore (dummy) output 
"logging.debug"    to use logging.debug
"logging.info"     to use logging.info
"logging.warning"  to use logging.warning
"logging.error"    to use logging.error
"logging.critical" to use logging.critical

E.g.

xxxxxxxxxx
peek.output = "stderr"

to print to stderr.

serialize

This will allow to specify how argument values are to be serialized to displayable strings. The default is pformat (from pprint), but this can be changed. For example, to handle non-standard datatypes in a custom fashion. The serialize function should accept at least one parameter. The function may optionally accept the keyword arguments width and sort_dicts, compact, indent, underscore_numbers and depth.

xxxxxxxxxx
def add_len(obj):
    if hasattr(obj, "__len__"):
        add = f" [len={len(obj)}]"
    else:
        add = ""
    return f"{repr(obj)}{add}"

zero_to_six = list(range(7))
hello = "world"
peek(7, hello, zero_to_six, serialize=add_len)

prints

xxxxxxxxxx
7, hello='world' [len=5], zero_to_six=[0, 1, 2, 3, 4, 5, 6] [len=7]

show_line_number / sln

If True, adds the peek() call's line number and possibly the filename and parent function to peek()'s output.

xxxxxxxxxx
peek.configure(show_line_number=True)
def shout():
    hello="world"
    peek(hello)
shout()

prints something like

xxxxxxxxxx
#5 in shout() ==> hello='world'

If "no parent" or "n", the parent function will not be shown.

xxxxxxxxxx
peek.show_line_number = "n"
def shout():
    hello="world"
    peek(hello)
shout()

prints something like

xxxxxxxxxx
#5 ==> hello='world'

Note that if you call peek without any arguments, the line number is always shown, regardless of the status show_line_number.

See below for an explanation of the information provided.

show_time / st

If True, adds the current time to peek()'s output.

xxxxxxxxxx
peek.configure(show_time=True)
hello="world"
peek(hello)

prints something like

xxxxxxxxxx
@ 13:01:47.588125 ==> hello='world'

show_delta / sd

If True, adds the number of seconds since the start of the program to peek()'s output.

xxxxxxxxxx
import time
peek.show_delta = True
french = "bonjour le monde"
english = "hallo world"
peek(english)
time.sleep(1)
peek(french)

prints something like

xxxxxxxxxx
delta=0.088 ==> english='hallo world'
delta=1.091 ==> french='bonjour le monde'

show_enter / se

When used as a decorator or context manager, by default, peek ouputs a line when the decorated the function is called or the context manager is entered.

With show_enter=False this line can be suppressed.

show_exit / sx

When used as a decorator or context manager, by default, peek ouputs a line when the decorated the function returned or the context manager is exited.

With show_exit=False this line can be suppressed.

show_traceback

When show_traceback is True, the ordinary output of peek() will be followed by a printout of the traceback, similar to an error traceback.

xxxxxxxxxx
def x():
    peek(show_traceback=True)

x()
x()

prints something like

xxxxxxxxxx
#4 in x()
    Traceback (most recent call last)
      File "c:\Users\Ruud\Dropbox (Personal)\Apps\Python Ruud\peek\x.py", line 6, in <module>
        x()
      File "c:\Users\Ruud\Dropbox (Personal)\Apps\Python Ruud\peek\x.py", line 4, in x
        peek()
#4 in x()
    Traceback (most recent call last)
      File "c:\Users\Ruud\Dropbox (Personal)\Apps\Python Ruud\peek\x.py", line 7, in <module>
        x()
      File "c:\Users\Ruud\Dropbox (Personal)\Apps\Python Ruud\peek\x.py", line 4, in x
        peek()

The show_traceback functionality is also available when peek is used as a decorator or context manager.

line_length / ll

This attribute is used to specify the line length (for wrapping). The default is 80. Peek tries to keep all output on one line, but if it can't it will wrap:

xxxxxxxxxx
d = dict(a1=1,a2=dict(a=1,b=1,c=3),a3=list(range(10)))
peek(d)
peek(d, line_length=160)

prints

xxxxxxxxxx
d=
    {'a1': 1,
     'a2': {'a': 1, 'b': 1, 'c': 3},
     'a3': [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]}
 d={'a1': 1, 'a2': {'a': 1, 'b': 1, 'c': 3}, 'a3': [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]}

color / col and color_value / colv

The color attribute is used to specify the color of the output.

There's a choice of "black", "white", "red", "green", "blue", "cyan", "magenta", "yellow", " dark_black", "dark_white", "dark_red", "dark_green", "dark_blue", "dark_cyan", "dark_magenta" and "dark_yellow":

To set the color to 'nothing'", "use "-".

On top of that, color_value may be used to specify the value part of an output item. By specifying color_value as "" (the default), the value part will be displayed with the same color as the rest of the output.

For instance:

xxxxxxxxxx
item1 = "value1"
item2 = "value2"
peek.color="yellow"
peek(item1, item2)
peek(item1, item2, color_value="green")
peek(item1, item2, color="red")
peek(item1, item2, color="red", color_value="green")

will result in:

Of course, color and color_value may be specified in a peek.toml file, to make all peek output in a specified color.

compact

This attribute is used to specify the compact parameter for pformat (see the pprint documentation for details). compact is False by default.

xxxxxxxxxx
a = 9 * ["0123456789"]
peek.line_length = 80
peek(a)
peek(a, compact=True)

prints

xxxxxxxxxx
a=
    ['0123456789',
     '0123456789',
     '0123456789',
     '0123456789',
     '0123456789',
     '0123456789',
     '0123456789',
     '0123456789',
     '0123456789']
a=
    ['0123456789', '0123456789', '0123456789', '0123456789', '0123456789',
     '0123456789', '0123456789', '0123456789', '0123456789']

indent

This attribute is used to specify the indent parameter for pformat (see the pprint documentation for details). indent is 1 by default.

xxxxxxxxxx
s = "01234567890012345678900123456789001234567890"
peek.line_length = 80
peek( [s, [s]])
peek( [s, [s]], indent=4)

prints

xxxxxxxxxx
[s, [s]]=
    ['01234567890012345678900123456789001234567890',
     ['01234567890012345678900123456789001234567890']]
[s, [s]]=
    [   '01234567890012345678900123456789001234567890',
        ['01234567890012345678900123456789001234567890']]

depth

This attribute is used to specify the depth parameter for pformat (see the pprint documentation for details). depth is 1000000 by default.

xxxxxxxxxx
s = "01234567890012345678900123456789001234567890"
peek([s,[s,[s,[s,s]]]])
peek([s,[s,[s,[s,s]]]], depth=3)

prints

xxxxxxxxxx
[s,[s,[s,[s,s]]]]=
    ['01234567890012345678900123456789001234567890',
     ['01234567890012345678900123456789001234567890',
      ['01234567890012345678900123456789001234567890',
       ['01234567890012345678900123456789001234567890',
        '01234567890012345678900123456789001234567890']]]]
[s,[s,[s,[s,s]]]]=
    ['01234567890012345678900123456789001234567890',
     ['01234567890012345678900123456789001234567890',
      ['01234567890012345678900123456789001234567890', [...]]]]

wrap_indent

This specifies the indent string if the output does not fit in the line_length (has to be wrapped). Rather than a string, wrap_indent can be also be an integer, in which case the wrap_indent will be that amount of blanks. The default is 4 blanks.

E.g.

xxxxxxxxxx
d = dict(a1=1,a2=dict(a=1,b=1,c=3),a3=list(range(10)))
peek.line_length = 80
peek(d, wrap_indent="  ")
peek(d, wrap_indent="....")
peek(d, wrap_indent=2)

prints

xxxxxxxxxx
d=
  {'a1': 1,
   'a2': {'a': 1, 'b': 1, 'c': 3},
   'a3': [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]}
d=
....{'a1': 1,
.... 'a2': {'a': 1, 'b': 1, 'c': 3},
.... 'a3': [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]}
d=
  {'a1': 1,
   'a2': {'a': 1, 'b': 1, 'c': 3},
   'a3': [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]}

enabled

Can be used to disable the output:

xxxxxxxxxx
peek.enabled = False
s = 'the world is '
peek(s + 'perfect.')
peek.enabled = True
peek(s + 'on fire.')

prints

xxxxxxxxxx
s + 'on fire.'='the world is on fire.'

and nothing about a perfect world.

sort_dicts

By default, peek does not sort dicts (printed by pprint). However, it is possible to get the default pprint behaviour (i.e. sorting dicts) with the sorted_dicts attribute:

xxxxxxxxxx
world = {"EN": "world", "NL": "wereld", "FR": "monde", "DE": "Welt"}
peek(world))
peek(world, sort_dicts=False)
peek(world, sort_dicts=True)

prints

xxxxxxxxxx
world={'EN': 'world', 'NL': 'wereld', 'FR': 'monde', 'DE': 'Welt'}
world={'EN': 'world', 'NL': 'wereld', 'FR': 'monde', 'DE': 'Welt'}
world={'DE': 'Welt', 'EN': 'world', 'FR': 'monde', 'NL': 'wereld'}

Note that under Python <=3.7, dicts are always printed sorted.

underscore_numbers / un

By default, peek does not add underscores in big numbers (printed by pprint). However, it is possible to get the default pprint behaviour with the underscore_numbers attribute:

xxxxxxxxxx
numbers = dict(one= 1, thousand= 1000, million=1000000, x1234567890= 1234567890)
peek(numbers)
peek(numbers, underscore_numbers=True)
peek(numbers, un=False)

prints

xxxxxxxxxx
numbers={'one': 1, 'thousand': 1000, 'million': 1000000, 'x1234567890': 1234567890}
numbers={'one': 1, 'thousand': 1_000, 'million': 1_000_000, 'x1234567890': 1_234_567_890}
numbers={'one': 1, 'thousand': 1000, 'million': 1000000, 'x1234567890': 1234567890}

Note that under Python <=3.7, numbers are never underscored.

seperator / sep

By default, pairs (on one line) are separated by ", ". It is possible to change this with the attribute separator:

xxxxxxxxxx
a = "abcd"
b = 1
c = 1000
d = list("peek")
peek(a, (b, c), d)
peek(a, (b, c), d, separator=" | ")

prints

xxxxxxxxxx
a='abcd', (b,c)=(1, 1000), d=['p', 'e', 'e', 'k']
a='abcd' | (b,c)=(1, 1000) | d=['p', 'e', 'e', 'k']

context_separator

By default the line_number, time and/or delta are followed by ==>. It is possible to change this with the attribute context_separator:

xxxxxxxxxx
a = "abcd"
peek(a,show_time=True)
peek(a, show_time=True, context_separator = ' \u279c ')

prints:

xxxxxxxxxx
@ 09:05:38.693840 ==> a='abcd'
@ 09:05:38.707914 ➜ a='abcd'

equals_separator

By default name of a variable and its value are separated by =. It is possible to change this with the attribute equals_separator:

xxxxxxxxxx
a = "abcd"
peek(a)
peek(a, equals_separator = ' == ")

prints:

xxxxxxxxxx
a='abcd'
a == 'abcd'

quote_string / qs

If True (the default setting) strings will be displayed with surrounding quotes (like repr). If False, string will be displayed without surrounding quotes (like str). E.g.

xxxxxxxxxx
test='test'
peek('==>', test)
peek('==>', test, quote_string=False)

This will print:

xxxxxxxxxx
'==>', test='test'
==>, test=test

format / fmt

With the format attribute, it is possible to apply a format specifier to each of the values to be printed, like

xxxxxxxxxx
test_float = 1.3
peek(test_float, format="06.3f")

This will print

xxxxxxxxxx
test_float=01.300

The format should be like the Python format specifiers, with or without the : prefix, like "6.3f", ">10", "06d", :6.3d. It is also possible to use the ! format specifier: "!r", "!r:>10".

If format is the null string ("") (the default), this functionality is skipped completely.

It is also possible to use a list (or tuple) of format specifiers, which are tried in succession. If they all fail, the 'normal' serializer will be used.

xxxxxxxxxx
test_float = 1.3
test_integer=10
test_string = "test"
test_dict=dict(one=1, two=2)
peek(test_float, test_integer, test_string, test_dict, format=["04d", "06.3f", ">10"])

will result in

xxxxxxxxxx
test_float=01.300, test_integer=0010, test_string=      test, test_dict={'one': 1, 'two': 2}

Of course, format may be put in a peek.toml file.

values_only / vo

If False (the default), both the left-hand side (if possible) and the value will be printed. If True, the left hand side will be suppressed:

xxxxxxxxxx
hello = "world"
peek(hello, 2 * hello)
peek(hello, 2 * hello, values_only=True)

prints

xxxxxxxxxx
hello='world', 2 * hello='worldworld'
'world', 'worldworld'

values_only_for_fstrings / voff

If False (the default), both the original f-string and the value will be printed for f-strings. If True, the left_hand side will be suppressed in case of an f-string:

xxxxxxxxxx
x = 12.3
peek.quote_string = False
peek(f"{x=:0.3e}")
peek.values_only_for_fstrings = True
peek(f"{x=:0.3e}")

prints

xxxxxxxxxx
f"{x=:0.3e}"=x=1.230e+01
x=1.230e+01

Note that if values_only is True, f-string will be suppressed, regardless of values_only_for_fstrings.

end

The end attribute works like the end parameter of print. By default, end is "\n". This can be useful to have several peek outputs on one line, like:

xxxxxxxxxx
for i in range(5):
    peek(i*i, end=' ')
peek('')

Maybe more useful is to show the output change on the same line, e.g. a status.

xxxxxxxxxx
import time
for i in range(50):
  peek(f"time {time.time()}",end="\r")
  time.sleep(0.1)
peek('')

The end parameter will be only applied when output is stdout, stdout_nocolor or stderr.

return_none

Normally, peek()returns the values passed directly, which is usually fine. However, when used in a notebook or REPL, that value will be shown, and that can be annoying. Therefore, if return_noneis True, peek()will return None and thus not show anything.

xxxxxxxxxx
a = 3
b = 4
print(peek(a, b))
peek.return_none = True
print(peek(a, b))

prints

xxxxxxxxxx
a=3, b=4
(3, 4)
a=3, b=4
None

delta

The delta attribute can be used to (re)set the current delta, e.g.

xxxxxxxxxx
peek.delta = 0
print(peek.delta)

prints a value that id slightly more than 0.

print_like / print

When print_like (or print) is False, peek will work by expanding the arguments to description/serialized value pairs. But, when print_like is True, peek becomes a kind of supercharged print:

xxxxxxxxxx
peek.print_like = True
peek(12, f"{min(1, 2)=}", list(range(4), color="yellow")

will print

xxxxxxxxxx
12 min(1, 2)=1 [0, 1, 2, 3]

in yellow, but only if peek.enabled is False, nothing will be printed.

You can also use peek.print (see below).

Use peek.print to use peek like print with extras

The method peek.print allows peek to be used as alternative to print. Note that peek.print applies the color, context_separator, enabled, filter and output, show_delta and show_time. It is also possible to redirect the output to as string with as_str.

So,

xxxxxxxxxx
peek.filter = "level==1"
peek.print(f"{max(1, 2)=}", color="blue")  # default level is 0, so this will be suppressed
peek.print(f"{min(1, 2)=}", color="red", level=1)

will print

xxxxxxxxxx
min(1, 2)=1

in red, but only if peek.enabled is True (which is the default).

The peek.print() method applies the prefix, show_delta, show_line_number, show_time, show_ end attributes to the output.

In order to behave similar to print, peek has an extra attribute, separator_print (alias: sepp). This attribute (default " ") will be used when peek.printing. When calling peek.print, sep may be used instead. So

xxxxxxxxxx
peek.sepp = "|"
peek.print("test")

Has the same effect as

xxxxxxxxxx
peek.print("test", sep="|")

and

xxxxxxxxxx
peek.print("test", sepp="|")

but not the same as

xxxxxxxxxx
peek.sep = "|"  # sets the 'normal' peek separator

Peeking locals and globals

It is possible to get the name and values of all local or global variables.

To do that, just put locals or globals in the call to peek, e.g.:

xxxxxxxxxx
def my_func():
    a = 10
    b = a * a
    peek(locals)
my_func()

will print all local variables, apart from those starting with __, so:

xxxxxxxxxx
a=10, b=100

Likewise,

xxxxxxxxxx
peek(globals)

will print all global variables, apart from those starting with __

Return a string instead of sending to output

peek(*args, as_str=True) is like peek(*args) but the output is returned as a string instead of written to output.

xxxxxxxxxx
hello = "world"
s = peek(hello, as_str=True)
print(s, end="")

prints

xxxxxxxxxx
hello='world'

Note that if enabled=False, the call will return the null string ("").

It is also possible to return a string with the embedded ANSI color escape strings, which can be useful to process the output in another program that supports ANSI colors, like salabim. This is done by setting the as_colored_str argument to True:

xxxxxxxxxx
hello = "world"
s = peek(hello, color="red", color_value="green", as_colored_str=True)
print(repr(s), end="")

prints

xxxxxxxxxx
"\x1b[1;31mhello=\x1b[1;32m'world'\x1b[1;31m\n\x1b[0m"

Disabling peek's output

xxxxxxxxxx
peek1 = peek.fork(show_delta=True)
peek(1)
peek1(2)
peek.enabled = False
peek(3)
peek1(4)
peek1.enabled = True
peek(5)
peek1(6)
print(peek1.enabled)

prints

xxxxxxxxxx
1
delta=0.011826 ==> 2
5
delta=0.044893 ==> 6
True

Of course peek() continues to return its arguments when disabled.

It is also possible to suppress output with the provided attribute (see above).

Using filter to control peek output

It is possible to define a filter function that determines whether peek output should be suppressed By default, the filter is defined as "" denoting no filter.

Suppose we a (float) level to a peek statement. By default, this level is 0. E.g.:

xxxxxxxxxx
peek("critical", level=0)
peek("important", level=1)
peek("warning", level=2)

With peek.filter ="level <= 1" the program makes sure that level=2 is not displayed at all.

It is possible to use more than one attribute, like

xxxxxxxxxx
peek.filter = "color == 'blue' and delta > 5"

As an alternative to enabled we can also say

xxxxxxxxxx
peek.filter = "False"

Copying to the clipboard

It is possible to copy a value to the clipboard. There are two ways:

With peek(to_clipboard=True)

With the optional keyword argument, to_clipboard:

• If to_clipboard==False (the default), nothing is copied to the clipboard.

• If to_clipboard==True, the value of the the last parameter will be copied to the clipboard. The output itself is as usual.

Examples:

xxxxxxxxxx
part1 = 200
extra = "extra"
peek(part1, extra, to_clipboard=True)
    # will print part1=200, extra='extra' and copy `extra` to the clipboard
peek(200, to_clipboard=True)\
    # will print 200 and copy 200 to the clipboard
peek(to_clipboard=True)
    # will print #5 (or similar) and empty the clipboard

Note that to_clipboard is a peek attribute.

If as_str==True, to_clipboard is ignored.

With peek.to_clipboard

Just use peek.to_clipboard to copy any value to the clipboard. So,

xxxxxxxxxx
part1 = 1234
peek.to_clipboard(part1)

will copy 1234 to the clipboard and write copied to clipboard: 1234 to the console. If the confirmation message is not wanted, just add confirm=False, like

xxxxxxxxxx
peek.to_clipboard(part1, confirm=False)

General

Implementation detail: the clipboard functionality uses pyperclip, apart from under Pythonista, where the builtin clipboard module is used.

This functionality is particularly useful for entering an answer of an Advent of Code solution to the site.

Interpreting the line number information

When show_line_number is True or peek() is used without any parameters, the output will contain the line number like:

xxxxxxxxxx
#3 ==> a='abcd'

If the line resides in another file than the main file, the filename (without the path) will be shown as well:

xxxxxxxxxx
#30[foo.py] ==> foo='Foo'

And finally when used in a function or method, that function/method will be shown as well:

xxxxxxxxxx
#456[foo.py] in square_root ==> x=123

The parent function can be suppressed by setting show_line_number or sln to "n" or "no parent".

Configuring at import time

It can be useful to configure peek at import time. This can be done by providing a peek.toml file which can contain any attribute configuration overriding the standard settings. E.g. if there is a peek.toml file with the following contents

xxxxxxxxxx
outpout = "stderr"
show_time = true
ll = 160
quote_string = false

in the same folder as the application, this program:

xxxxxxxxxx
hello = "world"
peek(hello)

will print something like this to stderr (rather than stdout):

xxxxxxxxxx
@ 14:53:41.392190 ==> hello=world

At import time current directory will be searched for peek.toml and if not found, one level up, etc. until the root directory is reached.

Please observe that toml values are slightly different from their Python equivalents:

xxxxxxxxxx
-----------------------------------
Python     toml
-----------------------------------
True       true
False      false
strings    preferably double quoted
-----------------------------------

Note that not-specified attributes will remain the default settings.

Just for your information, the core developer of peek uses a peek.toml file with the contents:

xxxxxxxxxx
line_length = 160
color = "yellow"
quote_string = false

Working with multiple instances of peek

Normally, only the peek object is used.

It can be useful to have multiple instances, e.g. when some of the debugging has to be done with context information and others requires an alternative prefix.

There are several ways to obtain a new instance of peek:

• by using peek.new()

  With this a new peek object is created with the default attributes

• by using peek.new(ignore_toml=True)

  With this a new peekobject is created with the default attributes. Any peek.toml files are ignored.

• by using peek.fork()

  With this a new peek object is created with the same attributes as the object it is created ('the parent') from. Note that any non set attributes are copied (propagated) from the parent.

• by using peek.clone(), which copies all attributes from peek()

  With this a new peek object is created with the same attributes as the object it is created ('the parent') from. Note that the attributes are not propagated from the parent, in this case.

• with peek() used as a context manager

In either case, attributes can be added to override the default ones.

Example

xxxxxxxxxx
peek_with_line_number = peek.fork(show_line_number=True)
peek_with_new_prefix = peek.new(prefix="==> ")
peek_with_new_prefix_and_time = peek_with_new_prefix.clone(show_time=True)
hello="world"
peek_with_line_number(hello)
peek_with_new_prefix(hello)
peek_with_new_prefix_and_time(hello)
peek.equals_separator = " == "  # this affects only the forked objects
peek_with_line_number(hello)
peek_with_new_prefix(hello)
peek_with_new_prefix_and_time(hello)
with peek(prefix="peek_cm ") as peek_cm:
    peek_cm(hello)
    peek(hello)

prints something like

xxxxxxxxxx
#28 ==> hello='world'
==> hello='world'
==> @ 09:55:52.122818 ==> hello='world'
#32 ==> hello == 'world'
==> hello='world'
==> @ 09:55:52.125928 ==> hello='world'
peek_cm enter
peek_cm hello == 'world'
hello == 'world'
peek_cm exit in 0.001843 seconds

ignore_toml

With peek.new(ignore_toml=True) an instance of peek without having applied any toml configuration file will be returned. That can be useful when guaranteeing the same output in several setups.

Example

Suppose we have a peek.toml file in the current directory with the contents

xxxxxxxxxx
{prefix="==>"}

Then

xxxxxxxxxx
peek_post_toml = peek.new()
peek_ignore_toml = peek.new(ignore_toml=True)
hello = "world"
peek(hello)
peek_post_toml(hello)
peek_ignore_toml(hello)

prints

xxxxxxxxxx
==>hello='world'
==>hello='world'
hello='world'

Test script

On GitHub is a file test_peek.py that tests (and thus also demonstrates) most of the functionality of peek.

It is very useful to have a look at the tests to see the features (some may be not covered (yet) in this readme).

Using peek in a REPL

Peek may be used in a REPL, but with limited functionality:

• all arguments are just presented as such, i.e. no left-hand side, e.g.

xxxxxxxxxx
  >> hello = "world"
  >>> peek(hello, hello * 2)
  'hello', 'hellohello'
  ('hello', 'hellohello')

• line numbers are never shown

• use as a decorator is not supported

• use as a context manager is not supported

Limitations

It is not possible to use peek:

• from a frozen application (e.g. packaged with PyInstaller)

• when the underlying source code has changed during execution

Changelog

The changelog can be found here:

• https://github.com/salabim/peek/blob/main/changelog.md or

• https://salabim.org/peek/changelog

Acknowledgement

The peek package is inspired by the IceCream package, but is a nearly complete rewrite. See https://github.com/gruns/icecream

Many thanks to the author Ansgar Grunseid / grunseid.com / grunseid@gmail.com .

The peek package is a rebrand of the ycecream package, with many enhancements.

Differences with IceCream

The peek module was originally a fork of IceCream, but has many differences:

xxxxxxxxxx
-----------------------------------------------------------------------------------------
characteristic                    peek                        IceCream
-----------------------------------------------------------------------------------------
default name                      peek                        ic
import method                     import peek                 from icecream import ic
number of files                   1                           several
usable without installation       yes                         no
can be used as a decorator        yes                         no
can be used as a context manager  yes                         no
can show traceback                yes                         no
can be used like print w/extras   yes (with peek.print)       no
allows non linefeed printing      yes (via end parameter)     requires patching
PEP8 (Pythonic) API               yes                         no
format specification              optional                    no
sorts dicts                       no by default, optional     yes
supports compact, indent,
and underscore_numbers
parameters of pprint              yes                         no
use from a REPL                   limited functionality       no
external configuration            via toml file               no
level control                     yes                         no 
observes line_length correctly    yes                         no
benchmarking functionality        yes                         no
can peek locals or globals        yes                         no
suppress f-strings at left hand   optional                    no
indentation                       4 blanks (overridable)      length of prefix
forking and cloning               yes                         no
handling of source problems       peeks only the value        warning issued
test script                       pytest                      unittest
colorize *)                       yes, off by default         yes, on by default
-----------------------------------------------------------------------------------------
*) peek allows selection of colors, whereas IceCream does coloring based on contents.