APIs

Pinner对象的方法。

✅️️ 初始化参数

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

---

📌 pin()

此方法用于记录一个时间点。

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

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

---

📌 skip()

此方法用于跳过从上一个时间点到当前的时间。

参数： 无

返回：None

---

📌 show()

此方法用于打印所有时间差。

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

返回：None

---

📌 reset()

此方法用于清空数据并重新开始记录。

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

返回：None

---

📌 records()

此方法返回所有时间差组成的列表。

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

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

---

📌 winner()

此方法返回返回最短的时间差。

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

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