use-breadcrumbs 0.2

面包屑：跟踪正在进行的事情

这个库的初始目标非常简单：跟踪一系列转换步骤。

它非常易于使用

>>> import breadcrumbs as bc
>>> crumb = bc.Crumb("start")
>>> crumb.info.update(value=35)
>>> crumb.info.update(other_value=70)
>>> print(crumb.info)
{'value': 35, 'other_value': 70}

一个 Crumb 有三个属性：一个名称（这里 Start），以及两个字典（info 和 extra）来存储额外的信息。您还可以使用 put_crumb 方法存储依赖的 Crumb。

“这有什么大不了的？”你可能会问，“你只是写了一个字典！”确实如此，但酷的地方在于它有点像日志记录，因此您可以在代码中解耦地使用它

>>> def func1():
...     bc.info.update(value=35)
>>> def func2():
...     bc.extra.update(other_value=70)
>>> crumb = bc.Crumb("start")
>>> with bc.context(crumb):
...     func2()
...     func1()
>>> print(crumb.info)
{'value': 35}
>>> print(crumb.extra)
{'other_value': 70}

func1 和 func2 现在关于 crumb 没有什么，但它只是正常工作。

您还可以装饰一个函数来自动为您执行某些操作。

>>> @bc.aware()
... def func1(x, y):
...     return x + y
>>> crumb = bc.Crumb("start")
>>> with bc.context(crumb):
...     func1(1, 2)
>>> print(crumb.trail)
(Crumb('func1', info={'x': 1, y: '2'}, extra={}))

因此，在追踪中，您可以看到 func1 已使用某些参数被调用。您可以删除一些可能占用内存密集或无意义的参数。

>>> @bc.aware(redact_params='y')
... def func1(x, y):
...     return x + y
>>> crumb = bc.Crumb("start")
>>> with bc.context(crumb):
...     func1(1, 2)
>>> print(crumb.trail)
(Crumb('func1', info={'x': 1}, extra={}))

要删除更多参数，只需传递一个可迭代对象。

一个有用的特性是 TrailMixin 允许您添加特定于对象的注释并将这些注释传递给函数。

>>> class MyCoolClass(bc.TrailMixin):
...     # Here goes your cool class
...     internal = 10
>>> @bc.aware(trail_param="obj")
... def func1(obj, x, y):
...     return (x + y) * obj.internal
>>> myobj = MyCoolClass()
>>> func1(myobj, 1, 2)
>>> print(myobj.trail)
(Crumb('func1', info={'x': 1, 'y': 2}, extra={}))

$ pip install use-breadcrumbs