用于python命令行应用程序的优雅控制台记录器
signalep的Python项目详细描述
安装
signale.py可以使用pip安装。
[sudo] pip install signalepy
用法
包由一个类signale组成，它是主构造函数类。创建的对象中包含所有记录器功能。
使用记录器
每个logger函数都有三个参数：-
文本前缀（可选）后缀（可选）
它们都在logger对象中可用。要创建一个，请执行以下操作：-
fromsignalepyimportSignalelogger=Signale()
现在您可以使用默认的记录器使用这个对象，比如：-
...logger.success("Started Successfully",prefix="Debugger")logger.warning("`a` function is deprecated",suffix="main.py")logger.complete("Run Complete")...
这将产生以下结果：-
< div >简单成功错误警告开始停止观看重要挂起完成调试暂停信息喜欢居中粗体下划线颠倒彩色
作用域记录器
要创建作用域记录器，请在构造函数的选项参数中定义作用域字段，例如：-
fromsignalepyimportSignalelogger=Signale({"scope":"global scope"})logger.success("Scoped Logger Works!")
这将产生以下结果：-
< div >您还可以通过将作用域字段设置为字符串列表来创建多个作用域，例如：-
fromsignalepyimportSignalelogger=Signale({"scope":["global scope","inner scope"]})logger.success("Scoped Logger Works!")
这将产生以下结果：-
< div >您还可以通过使用scoped这样的函数创建scoped a logger，它只是other的克隆：-
fromsignalepyimportSignalelogger=Signale({"scope":"global scope"})logger2=logger.scoped("inner")logger2.like("I love Signale.py",prefix="Shardul Nalegave",suffix="Creator")
这将产生以下结果：-
< div >注意：-所有配置都将复制到新的记录器，只是范围将被扩展。
自定义记录器
可以通过将自定义记录器配置数组传递给传递给构造函数的选项中的字段custom来创建自定义记录器。甚至克隆记录器也继承了父级的自定义记录器。例如：-
fromsignalepyimportSignalelogger=Signale({"scope":"global scope","custom":[{"badge":"!","label":"Attention","color":"red","name":"attention"}]})logger2=logger.scoped("inner")logger.attention("It Works!")logger2.attention("With Logger2")
这将产生以下结果：-
< div >带下划线的标签
通过将传递给构造函数的选项中的下划线字段设置为真可以将标签设置为下划线。例如：-
fromsignalepyimportSignales=Signale({"underlined":True})s.center("Testing Logger")s.simple("ABC",prefix="Debugger",suffix="xyz")s.info("Starting",prefix="Debugger")s.success("Started Successfully",prefix="Debugger",suffix="xyz")s.watch("Watching All Files",prefix="Debugger")s.error("Something Went Wrong",prefix="Debugger")s.warning("Deprecation Warning",prefix="Debugger")s.pending("Postponed",prefix="Debugger")s.debug("Found A Bug on L55",prefix="Debugger")s.start("Started New Process",prefix="Debugger")s.pause("Process Paused",prefix="Debugger")s.complete("Task Completed",prefix="Debugger")s.important("New Update Available. Please Update!",prefix="Debugger")s.like("I Love Signale",prefix="Debugger")s.stop("Stopping",prefix="Debugger")
这将产生以下结果：-
< div >选项
选项>选项由构造函数获取
< BR>范围- 键入：
str或list
信号记录器范围
- 键入：
带下划线的
< BR>- 类型：
bool
标签是否应加下划线
- 类型：
< BR>自定义- 键入：
列表
自定义记录器配置列表。
配置类型：
dict自定义记录器配置字典
键
名称- 类型：
str
记录器的名称
- 类型：
标签- 类型：
str
图标旁边显示的标签（彩色文本）
- 类型：
徽章- 类型：
str
图标
- 类型：
颜色- 类型：
str
图标和标签的颜色。应该来自：-
红色暗蓝色粉色绿色灰色紫色黄色青色重置（颜色重置代码）
- 类型：
- 键入：
API
记录器=
< BR>信号（<；选项>；）信号- 类型：
类
从
< BR>signalepy模块导入的signale类选项- 键入：
dict
记录器的选项字典。
< BR>- 返回：signale logger对象
可用于记录的记录器对象
- 类型：
记录器。
< BR><；logger>；（消息="，前缀="，后缀="）记录器- 类型：
函数
可以是任何默认记录器
< BR>消息- 类型：
str
要显示的消息
< BR>前缀- 类型：
str - 必需：false
前缀文本
< BR>后缀- 类型：
str - 必需：false
后缀文本
< BR>- 返回：
无
- 类型：
logger2=
< BR>记录器。作用域（<；new scope>；）记录器- 类型：信号记录器对象
父记录器
< BR>新范围- 类型：
str
新作用域名称
< BR>- 返回：signale logger对象
使用扩展作用域克隆记录器对象
在麻省理工学院许可证下获得许可
Shardul Nalegave的项目
欢迎加入QQ群-->： 979659372
推荐PyPI第三方库
