Rooba
/
PySnooper
mirror of https://github.com/cool-RR/PySnooper.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Show colored output

This commit is contained in:
Ram Rachum 2022-01-14 20:26:04 +02:00
parent 31bfc637bc
commit 0f1e67b26b
11 changed files with 134 additions and 96 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
ADVANCED_USAGE.md
View File

@ -89,4 +89,10 @@ can customize that:
You can also use `max_variable_length=None` to never truncate them.
Use `relative_time=True` to show timestamps relative to start time rather than
wall time.
wall time.
The output is colored for easy viewing by default, except on Windows. Disable colors like so:
```python
@pysnooper.snoop(color=False)
````

31
README.md
View File

@ -34,36 +34,7 @@ number_to_bits(6)
```
The output to stderr is:
```
Source path:... /my_code/foo.py
Starting var:.. number = 6
15:29:11.327032 call 4 def number_to_bits(number):
15:29:11.327032 line 5 if number:
15:29:11.327032 line 6 bits = []
New var:....... bits = []
15:29:11.327032 line 7 while number:
15:29:11.327032 line 8 number, remainder = divmod(number, 2)
New var:....... remainder = 0
Modified var:.. number = 3
15:29:11.327032 line 9 bits.insert(0, remainder)
Modified var:.. bits = [0]
15:29:11.327032 line 7 while number:
15:29:11.327032 line 8 number, remainder = divmod(number, 2)
Modified var:.. number = 1
Modified var:.. remainder = 1
15:29:11.327032 line 9 bits.insert(0, remainder)
Modified var:.. bits = [1, 0]
15:29:11.327032 line 7 while number:
15:29:11.327032 line 8 number, remainder = divmod(number, 2)
Modified var:.. number = 0
15:29:11.327032 line 9 bits.insert(0, remainder)
Modified var:.. bits = [1, 1, 0]
15:29:11.327032 line 7 while number:
15:29:11.327032 line 10 return bits
15:29:11.327032 return 10 return bits
Return value:.. [1, 1, 0]
Elapsed time: 00:00:00.000001
```
![](https://i.imgur.com/TrF3VVj.jpg)
Or if you don't want to trace an entire function, you can wrap the relevant part in a `with` block:

BIN
misc/output.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 181 KiB

90
pysnooper/tracer.py
View File

@ -202,10 +202,16 @@ class Tracer:
@pysnooper.snoop(relative_time=True)
The output is colored for easy viewing by default, except on Windows.
Disable colors like so:
@pysnooper.snoop(color=False)
'''
def __init__(self, output=None, watch=(), watch_explode=(), depth=1,
prefix='', overwrite=False, thread_info=False, custom_repr=(),
max_variable_length=100, normalize=False, relative_time=False):
max_variable_length=100, normalize=False, relative_time=False,
color=True):
self._write = get_write_function(output, overwrite)
self.watch = [
@ -233,6 +239,33 @@ class Tracer:
self.max_variable_length = max_variable_length
self.normalize = normalize
self.relative_time = relative_time
self.color = color and sys.platform in ('linux', 'linux2', 'cygwin',
'darwin')
if self.color:
self._FOREGROUND_BLUE = '\x1b[34m'
self._FOREGROUND_CYAN = '\x1b[36m'
self._FOREGROUND_GREEN = '\x1b[32m'
self._FOREGROUND_MAGENTA = '\x1b[35m'
self._FOREGROUND_RED = '\x1b[31m'
self._FOREGROUND_RESET = '\x1b[39m'
self._FOREGROUND_YELLOW = '\x1b[33m'
self._STYLE_BRIGHT = '\x1b[1m'
self._STYLE_DIM = '\x1b[2m'
self._STYLE_NORMAL = '\x1b[22m'
self._STYLE_RESET_ALL = '\x1b[0m'
else:
self._FOREGROUND_BLUE = ''
self._FOREGROUND_CYAN = ''
self._FOREGROUND_GREEN = ''
self._FOREGROUND_MAGENTA = ''
self._FOREGROUND_RED = ''
self._FOREGROUND_RESET = ''
self._FOREGROUND_YELLOW = ''
self._STYLE_BRIGHT = ''
self._STYLE_DIM = ''
self._STYLE_NORMAL = ''
self._STYLE_RESET_ALL = ''
def __call__(self, function_or_class):
if DISABLED:
@ -317,12 +350,19 @@ class Tracer:
### Writing elapsed time: #############################################
# #
_FOREGROUND_YELLOW = self._FOREGROUND_YELLOW
_STYLE_DIM = self._STYLE_DIM
_STYLE_NORMAL = self._STYLE_NORMAL
_STYLE_RESET_ALL = self._STYLE_RESET_ALL
start_time = self.start_times.pop(calling_frame)
duration = datetime_module.datetime.now() - start_time
elapsed_time_string = pycompat.timedelta_format(duration)
indent = ' ' * 4 * (thread_global.depth + 1)
self.write(
'{indent}Elapsed time: {elapsed_time_string}'.format(**locals())
'{indent}{_FOREGROUND_YELLOW}{_STYLE_DIM}'
'Elapsed time: {_STYLE_NORMAL}{elapsed_time_string}'
'{_STYLE_RESET_ALL}'.format(**locals())
)
# #
### Finished writing elapsed time. ####################################
@ -363,12 +403,24 @@ class Tracer:
else:
return None
# #
### Finished checking whether we should trace this line. ##############
if event == 'call':
thread_global.depth += 1
indent = ' ' * 4 * thread_global.depth
# #
### Finished checking whether we should trace this line. ##############
_FOREGROUND_BLUE = self._FOREGROUND_BLUE
_FOREGROUND_CYAN = self._FOREGROUND_CYAN
_FOREGROUND_GREEN = self._FOREGROUND_GREEN
_FOREGROUND_MAGENTA = self._FOREGROUND_MAGENTA
_FOREGROUND_RED = self._FOREGROUND_RED
_FOREGROUND_RESET = self._FOREGROUND_RESET
_FOREGROUND_YELLOW = self._FOREGROUND_YELLOW
_STYLE_BRIGHT = self._STYLE_BRIGHT
_STYLE_DIM = self._STYLE_DIM
_STYLE_NORMAL = self._STYLE_NORMAL
_STYLE_RESET_ALL = self._STYLE_RESET_ALL
### Making timestamp: #################################################
# #
@ -394,8 +446,9 @@ class Tracer:
source_path, source = get_path_and_source_from_frame(frame)
source_path = source_path if not self.normalize else os.path.basename(source_path)
if self.last_source_path != source_path:
self.write(u'{indent}Source path:... {source_path}'.
format(**locals()))
self.write(u'{_FOREGROUND_YELLOW}{_STYLE_DIM}{indent}Source path:... '
u'{_STYLE_NORMAL}{source_path}'
u'{_STYLE_RESET_ALL}'.format(**locals()))
self.last_source_path = source_path
source_line = source[line_no - 1]
thread_info = ""
@ -423,11 +476,13 @@ class Tracer:
for name, value_repr in local_reprs.items():
if name not in old_local_reprs:
self.write('{indent}{newish_string}{name} = {value_repr}'.format(
**locals()))
self.write('{indent}{_FOREGROUND_GREEN}{_STYLE_DIM}'
'{newish_string}{_STYLE_NORMAL}{name} = '
'{value_repr}{_STYLE_RESET_ALL}'.format(**locals()))
elif old_local_reprs[name] != value_repr:
self.write('{indent}Modified var:.. {name} = {value_repr}'.format(
**locals()))
self.write('{indent}{_FOREGROUND_GREEN}{_STYLE_DIM}'
'Modified var:.. {_STYLE_NORMAL}{name} = '
'{value_repr}{_STYLE_RESET_ALL}'.format(**locals()))
# #
### Finished newish and modified variables. ###########################
@ -468,11 +523,11 @@ class Tracer:
)
if ended_by_exception:
self.write('{indent}Call ended by exception'.
self.write('{_FOREGROUND_RED}{indent}Call ended by exception{_STYLE_RESET_ALL}'.
format(**locals()))
else:
self.write(u'{indent}{timestamp} {thread_info}{event:9} '
u'{line_no:4} {source_line}'.format(**locals()))
self.write(u'{indent}{_STYLE_DIM}{timestamp} {thread_info}{event:9} '
u'{line_no:4}{_STYLE_RESET_ALL} {source_line}'.format(**locals()))
if event == 'return':
self.frame_to_local_reprs.pop(frame, None)
@ -485,14 +540,17 @@ class Tracer:
max_length=self.max_variable_length,
normalize=self.normalize,
)
self.write('{indent}Return value:.. {return_value_repr}'.
self.write('{indent}{_FOREGROUND_CYAN}{_STYLE_DIM}'
'Return value:.. {_STYLE_NORMAL}{return_value_repr}'
'{_STYLE_RESET_ALL}'.
format(**locals()))
if event == 'exception':
exception = '\n'.join(traceback.format_exception_only(*arg[:2])).strip()
if self.max_variable_length:
exception = utils.truncate(exception, self.max_variable_length)
self.write('{indent}Exception:..... {exception}'.
format(**locals()))
self.write('{indent}{_FOREGROUND_RED}Exception:..... '
'{_STYLE_BRIGHT}{exception}'
'{_STYLE_RESET_ALL}'.format(**locals()))
return self.trace

2
tests/samples/exception.py
View File

@ -13,7 +13,7 @@ def bar():
raise
@pysnooper.snoop(depth=3)
@pysnooper.snoop(depth=3, color=False)
def main():
try:
bar()

4
tests/samples/indentation.py
View File

@ -1,7 +1,7 @@
import pysnooper
@pysnooper.snoop(depth=2)
@pysnooper.snoop(depth=2, color=False)
def main():
f2()
@ -14,7 +14,7 @@ def f3():
f4()
@pysnooper.snoop(depth=2)
@pysnooper.snoop(depth=2, color=False)
def f4():
f5()

2
tests/samples/recursion.py
View File

@ -1,7 +1,7 @@
import pysnooper
@pysnooper.snoop(depth=2)
@pysnooper.snoop(depth=2, color=False)
def factorial(x):
if x <= 1:
return 1

2
tests/test_chinese.py
View File

@ -26,7 +26,7 @@ from . import mini_toolbox
def test_chinese():
with mini_toolbox.create_temp_folder(prefix='pysnooper') as folder:
path = folder / 'foo.log'
@pysnooper.snoop(path)
@pysnooper.snoop(path, color=False)
def foo():
a = 1
x = '失败'

2
tests/test_multiple_files/multiple_files/foo.py
View File

@ -5,7 +5,7 @@ import pysnooper
from .bar import bar_function
@pysnooper.snoop(depth=2)
@pysnooper.snoop(depth=2, color=False)
def foo_function():
z = bar_function(3)
return z

4
tests/test_not_implemented.py
View File

@ -38,7 +38,7 @@ def test_rejecting_coroutine_functions():
assert pycompat.iscoroutinefunction(foo)
assert not pycompat.isasyncgenfunction(foo)
with pytest.raises(NotImplementedError):
pysnooper.snoop()(foo)
pysnooper.snoop(color=False)(foo)
def test_rejecting_async_generator_functions():
@ -56,6 +56,6 @@ def test_rejecting_async_generator_functions():
assert not pycompat.iscoroutinefunction(foo)
assert pycompat.isasyncgenfunction(foo)
with pytest.raises(NotImplementedError):
pysnooper.snoop()(foo)
pysnooper.snoop(color=False)(foo)

85
tests/test_pysnooper.py
View File

@ -25,7 +25,7 @@ from . import mini_toolbox
def test_string_io():
string_io = io.StringIO()
@pysnooper.snoop(string_io)
@pysnooper.snoop(string_io, color=False)
def my_function(foo):
x = 7
y = 8
@ -53,7 +53,7 @@ def test_string_io():
def test_relative_time():
snoop = pysnooper.snoop(relative_time=True)
snoop = pysnooper.snoop(relative_time=True, color=False)
def foo(x):
if x == 0:
@ -186,7 +186,7 @@ def test_relative_time():
def test_thread_info():
@pysnooper.snoop(thread_info=True)
@pysnooper.snoop(thread_info=True, color=False)
def my_function(foo):
x = 7
y = 8
@ -217,7 +217,7 @@ def test_thread_info():
def test_multi_thread_info():
@pysnooper.snoop(thread_info=True)
@pysnooper.snoop(thread_info=True, color=False)
def my_function(foo):
x = 7
y = 8
@ -306,7 +306,7 @@ def test_callable(normalize):
def write(msg):
string_io.write(msg)
@pysnooper.snoop(write, normalize=normalize)
@pysnooper.snoop(write, normalize=normalize, color=False)
def my_function(foo):
x = 7
y = 8
@ -347,7 +347,7 @@ def test_watch(normalize):
'foo.x',
'io.__name__',
'len(foo.__dict__["x"] * "abc")',
), normalize=normalize)
), normalize=normalize, color=False)
def my_function():
foo = Foo()
for i in range(2):
@ -395,7 +395,8 @@ def test_watch_explode(normalize):
self.x = x
self.y = y
@pysnooper.snoop(watch_explode=('_d', '_point', 'lst + []'), normalize=normalize)
@pysnooper.snoop(watch_explode=('_d', '_point', 'lst + []'), normalize=normalize,
color=False)
def my_function():
_d = {'a': 1, 'b': 2, 'c': 'ignore'}
_point = Foo(x=3, y=4)
@ -454,7 +455,7 @@ def test_variables_classes(normalize):
pysnooper.Attrs('_d'), # doesn't have attributes
pysnooper.Attrs('_s'),
pysnooper.Indices('_lst')[-3:],
), normalize=normalize)
), normalize=normalize, color=False)
def my_function():
_d = {'a': 1, 'b': 2, 'c': 'ignore'}
_s = WithSlots()
@ -501,7 +502,7 @@ def test_single_watch_no_comma(normalize):
def square(self):
self.x **= 2
@pysnooper.snoop(watch='foo', normalize=normalize)
@pysnooper.snoop(watch='foo', normalize=normalize, color=False)
def my_function():
foo = Foo()
for i in range(2):
@ -537,7 +538,7 @@ def test_single_watch_no_comma(normalize):
@pytest.mark.parametrize("normalize", (True, False))
def test_long_variable(normalize):
@pysnooper.snoop(normalize=normalize)
@pysnooper.snoop(normalize=normalize, color=False)
def my_function():
foo = list(range(1000))
return foo
@ -566,7 +567,7 @@ def test_long_variable(normalize):
@pytest.mark.parametrize("normalize", (True, False))
def test_long_variable_with_custom_max_variable_length(normalize):
@pysnooper.snoop(max_variable_length=200, normalize=normalize)
@pysnooper.snoop(max_variable_length=200, normalize=normalize, color=False)
def my_function():
foo = list(range(1000))
return foo
@ -595,7 +596,7 @@ def test_long_variable_with_custom_max_variable_length(normalize):
@pytest.mark.parametrize("normalize", (True, False))
def test_long_variable_with_infinite_max_variable_length(normalize):
@pysnooper.snoop(max_variable_length=None, normalize=normalize)
@pysnooper.snoop(max_variable_length=None, normalize=normalize, color=False)
def my_function():
foo = list(range(1000))
return foo
@ -628,7 +629,7 @@ def test_repr_exception(normalize):
def __repr__(self):
1 / 0
@pysnooper.snoop(normalize=normalize)
@pysnooper.snoop(normalize=normalize, color=False)
def my_function():
bad = Bad()
@ -669,7 +670,7 @@ def test_depth(normalize):
result2 = f3(x2)
return result2
@pysnooper.snoop(string_io, depth=3, normalize=normalize)
@pysnooper.snoop(string_io, depth=3, normalize=normalize, color=False)
def f1(x1):
result1 = f2(x1)
return result1
@ -722,7 +723,8 @@ def test_method_and_prefix(normalize):
def __init__(self):
self.x = 2
@pysnooper.snoop(watch=('self.x',), prefix='ZZZ', normalize=normalize)
@pysnooper.snoop(watch=('self.x',), prefix='ZZZ', normalize=normalize,
color=False)
def square(self):
foo = 7
self.x **= 2
@ -762,7 +764,7 @@ def test_file_output(normalize):
with mini_toolbox.create_temp_folder(prefix='pysnooper') as folder:
path = folder / 'foo.log'
@pysnooper.snoop(path, normalize=normalize)
@pysnooper.snoop(path, normalize=normalize, color=False)
def my_function(_foo):
x = 7
y = 8
@ -800,7 +802,7 @@ def test_confusing_decorator_lines(normalize):
@empty_decorator
@pysnooper.snoop(string_io, normalize=normalize,
depth=2) # Multi-line decorator for extra confusion!
depth=2, color=False)
@empty_decorator
@empty_decorator
def my_function(foo):
@ -840,7 +842,7 @@ def test_confusing_decorator_lines(normalize):
@pytest.mark.parametrize("normalize", (True, False))
def test_lambda(normalize):
string_io = io.StringIO()
my_function = pysnooper.snoop(string_io, normalize=normalize)(lambda x: x ** 2)
my_function = pysnooper.snoop(string_io, normalize=normalize, color=False)(lambda x: x ** 2)
result = my_function(7)
assert result == 49
output = string_io.getvalue()
@ -866,7 +868,7 @@ def test_unavailable_source():
python_file_path = folder / ('%s.py' % (module_name,))
content = textwrap.dedent(u'''
import pysnooper
@pysnooper.snoop()
@pysnooper.snoop(color=False)
def f(x):
return x
''')
@ -898,7 +900,7 @@ def test_no_overwrite_by_default():
path = folder / 'foo.log'
with path.open('w') as output_file:
output_file.write(u'lala')
@pysnooper.snoop(str(path))
@pysnooper.snoop(str(path), color=False)
def my_function(foo):
x = 7
y = 8
@ -932,7 +934,7 @@ def test_overwrite():
path = folder / 'foo.log'
with path.open('w') as output_file:
output_file.write(u'lala')
@pysnooper.snoop(str(path), overwrite=True)
@pysnooper.snoop(str(path), overwrite=True, color=False)
def my_function(foo):
x = 7
y = 8
@ -975,7 +977,7 @@ def test_overwrite():
def test_error_in_overwrite_argument():
with mini_toolbox.create_temp_folder(prefix='pysnooper') as folder:
with pytest.raises(Exception, match='can only be used when writing'):
@pysnooper.snoop(overwrite=True)
@pysnooper.snoop(overwrite=True, color=False)
def my_function(foo):
x = 7
y = 8
@ -1002,7 +1004,7 @@ def test_needs_parentheses():
@pytest.mark.parametrize("normalize", (True, False))
def test_with_block(normalize):
# Testing that a single Tracer can handle many mixed uses
snoop = pysnooper.snoop(normalize=normalize)
snoop = pysnooper.snoop(normalize=normalize, color=False)
def foo(x):
if x == 0:
@ -1151,7 +1153,7 @@ def test_with_block_depth(normalize):
def f1(x1):
str(3)
with pysnooper.snoop(string_io, depth=3, normalize=normalize):
with pysnooper.snoop(string_io, depth=3, normalize=normalize, color=False):
result1 = f2(x1)
return result1
@ -1210,7 +1212,7 @@ def test_cellvars(normalize):
return f3(a)
def f1(a):
with pysnooper.snoop(string_io, depth=4, normalize=normalize):
with pysnooper.snoop(string_io, depth=4, normalize=normalize, color=False):
result1 = f2(a)
return result1
@ -1275,7 +1277,7 @@ def test_var_order(normalize):
five, six, seven = 5, 6, 7
with pysnooper.snoop(string_io, depth=2, normalize=normalize):
with pysnooper.snoop(string_io, depth=2, normalize=normalize, color=False):
result = f(1, 2, 3, 4)
output = string_io.getvalue()
@ -1344,7 +1346,7 @@ def test_generator():
original_tracer_active = lambda: (sys.gettrace() is original_tracer)
@pysnooper.snoop(string_io)
@pysnooper.snoop(string_io, color=False)
def f(x1):
assert not original_tracer_active()
x2 = (yield x1)
@ -1441,7 +1443,7 @@ def test_custom_repr(normalize):
(large, print_list_size),
(dict, print_dict),
(evil_condition, lambda x: 'I am evil')),
normalize=normalize,)
normalize=normalize, color=False)
def sum_to_x(x):
l = list(range(x))
a = {'1': 1, '2': 2}
@ -1473,7 +1475,8 @@ def test_custom_repr(normalize):
def test_custom_repr_single(normalize):
string_io = io.StringIO()
@pysnooper.snoop(string_io, custom_repr=(list, lambda l: 'foofoo!'), normalize=normalize)
@pysnooper.snoop(string_io, custom_repr=(list, lambda l: 'foofoo!'),
normalize=normalize, color=False)
def sum_to_x(x):
l = list(range(x))
return 7
@ -1507,7 +1510,7 @@ def test_disable():
return x + y
with mini_toolbox.TempValueSetter((pysnooper.tracer, 'DISABLED'), True):
tracer = pysnooper.snoop(string_io)
tracer = pysnooper.snoop(string_io, color=False)
with tracer:
result = my_function('baba')
my_decorated_function = tracer(my_function)
@ -1521,7 +1524,7 @@ def test_disable():
def test_class(normalize):
string_io = io.StringIO()
@pysnooper.snoop(string_io, normalize=normalize)
@pysnooper.snoop(string_io, normalize=normalize, color=False)
class MyClass(object):
def __init__(self):
self.x = 7
@ -1568,7 +1571,7 @@ def test_class_with_decorated_method(normalize):
return result
return wrapper
@pysnooper.snoop(string_io, normalize=normalize)
@pysnooper.snoop(string_io, normalize=normalize, color=False)
class MyClass(object):
def __init__(self):
self.x = 7
@ -1617,13 +1620,13 @@ def test_class_with_decorated_method_and_snoop_applied_to_method(normalize):
return result
return wrapper
@pysnooper.snoop(string_io, normalize=normalize)
@pysnooper.snoop(string_io, normalize=normalize, color=False)
class MyClass(object):
def __init__(self):
self.x = 7
@decorator
@pysnooper.snoop(string_io, normalize=normalize)
@pysnooper.snoop(string_io, normalize=normalize, color=False)
def my_method(self, foo):
y = 8
return y + self.x
@ -1671,7 +1674,7 @@ def test_class_with_decorated_method_and_snoop_applied_to_method(normalize):
def test_class_with_property(normalize):
string_io = io.StringIO()
@pysnooper.snoop(string_io, normalize=normalize)
@pysnooper.snoop(string_io, normalize=normalize, color=False)
class MyClass(object):
def __init__(self):
self._x = 0
@ -1759,7 +1762,7 @@ def test_snooping_on_class_does_not_cause_base_class_to_be_snooped(normalize):
def method_on_base_class(self):
self.method_on_base_class_was_called = True
@pysnooper.snoop(string_io, normalize=normalize)
@pysnooper.snoop(string_io, normalize=normalize, color=False)
class MyClass(UnsnoopedBaseClass):
def method_on_child_class(self):
self.method_on_base_class()
@ -1793,7 +1796,7 @@ def test_normalize():
def __init__(self, a):
self.a = a
@pysnooper.snoop(string_io, normalize=True)
@pysnooper.snoop(string_io, normalize=True, color=False)
def add():
a = A(19)
b = A(22)
@ -1830,7 +1833,7 @@ def test_normalize_prefix():
def __init__(self, a):
self.a = a
@pysnooper.snoop(string_io, normalize=True, prefix=_prefix)
@pysnooper.snoop(string_io, normalize=True, prefix=_prefix, color=False)
def add():
a = A(19)
b = A(22)
@ -1866,7 +1869,7 @@ def test_normalize_thread_info():
def __init__(self, a):
self.a = a
@pysnooper.snoop(string_io, normalize=True, thread_info=True)
@pysnooper.snoop(string_io, normalize=True, thread_info=True, color=False)
def add():
a = A(19)
b = A(22)
@ -1879,7 +1882,7 @@ def test_normalize_thread_info():
def test_exception():
string_io = io.StringIO()
@pysnooper.snoop(string_io)
@pysnooper.snoop(string_io, color=False)
def f():
x = 8
raise MemoryError
@ -1905,7 +1908,7 @@ def test_exception():
def test_exception_on_entry():
@pysnooper.snoop()
@pysnooper.snoop(color=False)
def f(x):
pass