使用方法

✅️️ 创建Pinner对象

参数名称	类型	默认值	说明
pin	bool	False	初始化时是否同时开始记录
show_everytime	bool	True	是否每次记录时打印时间差

示例：

from TimePinner import Pinner

pinner = Pinner()

---

✅️️ 记录时间点

使用pin()方法记录一个时间点，并返回时间差。

参数名称	类型	默认值	说明
text	str	''	时间点说明文本
all_time	bool	False	时间点与起始点的时间差，或时间点之间的时间差
show	bool	None	是否打印时间差

返回类型	说明
float	时间差，all_time为True时返回与第一个时间点之间的差，否则返回与上一个时间点之间的差

from time import sleep
from TimePinner import Pinner

pinner = Pinner()
pinner.pin()  # 记录起始点
sleep(1)
pinner.pin('记录1')
sleep(2)
pinner.pin('记录2', show=False)  # 不打印该节点

输出：

0.0
记录1：1.0084643

---

✅️️ 跳过时间段

有些时间段无须记录，用skip()方法跳过。下一个记录会以当前点作为起始。

参数： 无

返回：None

pinner.skip()

---

✅️️ 打印结果

通过show()方法，可以把记录到的时间段打印出来。

参数名称	类型	默认值	说明
all_time	bool	False	每个时间点与起始点的时间差，或时间点之间的时间差

返回：None

记录1：1.007383
记录2：2.0145351000000002

---

✅️️ 获取结果

通过records()方法获取各个记录的时间段，每个时间段为一个两位元组。

参数名称	类型	默认值	说明
all_time	bool	False	每个时间点与起始点的时间差，或时间点之间的时间差

返回类型	说明
List[tuple]	时间节点列表，每个时间点格式为(文本, 时间差)

print(pinner.records())

输出：

[('记录1', 1.0084643), ('记录2', 2.0126551999999998)]

---

✅️️ 获取最短的时间段

通过winner()方法可以获取最短的时间段，用于对比几段代码运行时间。

参数名称	类型	默认值	说明
all_time	bool	False	每个时间点与起始点的时间差，或时间点之间的时间差

返回类型	说明
tuple	标签与时间组成的tuple

print(pinner.winner())

输出：

('记录1', 1.0084643)

---

✅️️ 重置

使用reset()方法清空已有记录并重新开始计时。

参数名称	类型	默认值	说明
text	str	''	记录点说明文本，不传入默认为'起始点'
show	bool	None	是否打印信息，为None时根据初始化时shwo_everytime参数设置

返回：None