devtools

注意

声明: 我(Pydantic 的主要开发者)也开发 python-devtools。

python-devtools (pip install devtools) 提供了一些在 Python 开发期间非常有用的工具,包括 debug(),它是 print() 的替代方案,它以一种比 print 更易于阅读的方式格式化输出,并提供有关 print 语句所在的 文件/行 以及打印的值的信息。

Pydantic 通过在大多数公共类上实现 __pretty__ 方法来与 devtools 集成。

特别是,当检查模型时,debug() 非常有用

from datetime import datetime

from devtools import debug

from pydantic import BaseModel


class Address(BaseModel):
    street: str
    country: str
    lat: float
    lng: float


class User(BaseModel):
    id: int
    name: str
    signup_ts: datetime
    friends: list[int]
    address: Address


user = User(
    id='123',
    name='John Doe',
    signup_ts='2019-06-01 12:22',
    friends=[1234, 4567, 7890],
    address=dict(street='Testing', country='uk', lat=51.5, lng=0),
)
debug(user)
print('\nshould be much easier read than:\n')
print('user:', user)

将在您的终端中输出


devtools_example.py:30 <module>
    user: User(
        id=123,
        name='John Doe',
        signup_ts=datetime.datetime(2019, 6, 1, 12, 22),
        friends=[
            1234,
            4567,
            7890,
        ],
        address=Address(
            street='Testing',
            country='uk',
            lat=51.5,
            lng=0.0,
        ),
    ) (User)

should be much easier read than:

user: id=123 name='John Doe' signup_ts=datetime.datetime(2019, 6, 1, 12, 22) friends=[1234, 4567, 7890] address=Address(street='Testing', country='uk', lat=51.5, lng=0.0)

注意

python-devtools 尚不支持 Python 3.13。