用于日志记录的python实用程序
ctodd-python-lib-logging的Python项目详细描述
christopher h.todd用于配置日志记录的python库
ctodd python lib日志项目负责为python脚本配置日志记录。将设置消息的级别、格式和流。
目录
依赖关系
python包
- 不适用
库
loggers.py
用于获取python中特定配置的记录器的库。这将利用pythons内置的日志库，并返回一个日志实例，该实例可以在任何已经实现日志类的代码中实现。
功能：
def get_stdout_logging(
log_level=logging.INFO,
log_msg_fmt="%(asctime)s.%(msecs)03d %(levelname)s %(message)s",
log_date_fmt="%a, %d %b %Y %H:%M:%S",
log_prefix=None,
):
"""
Purpose:
Get Logger to standard out.
Args:
log_level (log level from logging): Minimum level for messages to log
log_msg_fmt (String): Mesage format for all logs with variable
substitution for known logging options
log_date_fmt (Stringg): Dateformat to append to message
log_prefix (String): prefix to append to message
Return:
logging (Python logging object): Configured logging object
Examples:
>>> logging = get_stdout_logging()
or
>>> logging =\
get_stdout_logging(
log_level=logging.DEBUG,
log_prefix='[test_script]: '',
)
"""
def get_file_logger(
log_file=None,
log_filemode="a",
log_level=logging.INFO,
log_msg_fmt="%(asctime)s %(levelname)s %(message)s",
log_date_fmt="%a, %d %b %Y %H:%M:%S",
log_prefix=None,
):
"""
Purpose:
Get Logger to file
Args:
log_level (log level from logging): Minimum level for messages to log
log_msg_fmt (String): Mesage format for all logs with variable
substitution for known logging options
log_date_fmt (Stringg): Dateformat to append to message
log_prefix (String): prefix to append to message
Return:
logging (Python logging object): Configured logging object
Examples:
>>> logging = get_file_logger()
or
>>> logging =\
get_file_logger(
log_level=logging.ERROR,
prefix='[test_script]: '',
log_file='./script_im_writing.log'
)
"""
def clear_log_handlers():
"""
Purpose:
Remove previous log handlers and configurations. This
will ensure that any new logging that is configured
will take precedence, as logging is first setting
is not overwritten.
Args:
N/A
Return:
N/A
"""
脚本示例
用于测试和与库交互的示例可执行python脚本/模块。这些示例显示了库的用例，可以用作与库一起开发的模板，也可以用作一次性开发工作。
example_stdout_logger.py
Example Logger. Configure to Output to CLI
注释
- 依赖于f-string符号，它仅限于python3.6。通过重构删除这些内容，可以使用python3.0.x到3.5.x进行开发
待办事项
- UnitTest框架已就位，但缺少测试
欢迎加入QQ群-->： 979659372
