Отладка кода на Python с помощью «мороженого»

Зачем использовать print, если можно взять «мороженое»? Специалист по анализу данных Хуэн Тран поделилась в блоге на medium.com методом по отладке Python без использования команды print. Она призывает вместо привычного способа, который считает слишком неудобным, использовать библиотеку под названием мороженое Icecream.

Icecream — это библиотека Python, которая делает отладку более читаемой при минимум коде.

• Чтобы установить icecream используется следующая команда:

$ pip install icecream

$ pip install icecream

• Напечатаем вывод функции Python:

from icecream import ic 

def plus_five(num):
    return num + 5

ic(plus_five(4))
ic(plus_five(5))

ic| plus_five(4) : 9
ic| plus_five(5) : 10

#функция ic позволяет видеть не только возвращаемые данные, но и функцию с ее аргументами

• Чтобы определить, где бы выполнен код, можно воспользоваться следующими командами:

def hello(user:bool):
    if user:
        print("I'm user")
    else:
        print("I'm not user")

hello(user=True)

I’m user

icecream упрощает выполнение описанных выше действий простым вызовом функции ic без дополнительных параметров:

from icecream import ic 

def hello(user:bool):
    if user:
        ic()
    else:
        ic()

hello(user=True)

ic| icecream_example.py:5 in hello() at 01:44:20.394

#код в строке 5, который находится в функции hello, был выполнен, а код в строке 7 — нет

• icecream также позволяет вставить кастомный префикс, например, время выполнения кода:

from datetime import datetime
from icecream import ic 
import time

def time_format():
    return f'{datetime.now()}|> '

ic.configureOutput(prefix=time_format)

for _ in range(3):
    time.sleep(1)
    ic('Hello')

2021-01-12 20:08:45.107641|> 'Hello'
2021-01-12 20:08:46.124580|> 'Hello'
2021-01-12 20:08:47.127141|> 'Hello'

#теперь время выполнения кода будет автоматически отображаться в возвращаемых данных

• Помимо информации о коде, отвечающего за вывод, также можно узнать, из какой строки и файла был выполнен код. Чтобы узнать это, нужно добавить includeContext=True в ic.configureOutput():

from icecream import ic 

def plus_five(num):
    return num + 5

ic.configureOutput(includeContext=True)
ic(plus_five(4))
ic(plus_five(5))

ic| icecream_example.py:7 in <module>- plus_five(4): 9
ic| icecream_example.py:8 in <module>- plus_five(5): 10

#первый вывод был выполнен функцией plus_five из файла icecream_example.py в строке 7

• Можно использовать icecream не только для отладки, но и, например, для красивого отображения объектов Python.

from icecream import ic 

def plus_five(num):
    return num + 5

ic(plus_five(4))
ic(plus_five(5))

for i in range(10):
    print(f'****** Training model {i} ******')

ic| icecream_example.py:7 in <module>- plus_five(4): 9
ic| icecream_example.py:8 in <module>- plus_five(5): 10
****** Training model 0 ******
****** Training model 1 ******
****** Training model 2 ******
****** Training model 3 ******
****** Training model 4 ******
****** Training model 5 ******
****** Training model 6 ******
****** Training model 7 ******
****** Training model 8 ******
****** Training model 9 ******

#так проще искать и удалять все операторы ic после отладки, то есть сделать код чистым

Если вам не понравилась эта библиотека, ранее мы уже писали о пяти других эффективных инструментах отладки кода на Python.