verboselogs 1.7

安装

verboselogs软件包可在PyPI上找到，这意味着安装应该像这样简单

$ pip install verboselogs

实际上有各种各样的方式来安装Python包（例如，用户的site-packages目录，虚拟环境或者直接全局安装），我并没有在这里深入讨论这个话题的意图，所以如果你感到害怕，请在回到这些说明之前先了解一下你的选项；:-)。

用法

开始使用verboselogs包非常简单

>>> import logging, verboselogs
>>> logger = verboselogs.VerboseLogger('verbose-demo')
>>> logger.addHandler(logging.StreamHandler())
>>> logger.setLevel(logging.VERBOSE)
>>> logger.verbose("Can we have verbose logging? %s", "Yes we can!")

以下是一个带有命令行界面和可配置日志的非常简单的Python程序框架

"""
Usage: demo.py [OPTIONS]

This is the usage message of demo.py. Usually
this text explains how to use the program.

Supported options:
  -v, --verbose  make more noise
  -h, --help     show this message and exit
"""

import getopt
import logging
import sys
import verboselogs

logger = verboselogs.VerboseLogger('demo')
logger.addHandler(logging.StreamHandler())
logger.setLevel(logging.INFO)

# Command line option defaults.
verbosity = 0

# Parse command line options.
opts, args = getopt.getopt(sys.argv[1:], 'vqh', ['verbose', 'quiet', 'help'])

# Map command line options to variables.
for option, argument in opts:
    if option in ('-v', '--verbose'):
        verbosity += 1
    elif option in ('-q', '--quiet'):
        verbosity -= 1
    elif option in ('-h', '--help'):
        print __doc__.strip()
        sys.exit(0)
    else:
        assert False, "Unhandled option!"

# Configure logger for requested verbosity.
if verbosity >= 4:
    logger.setLevel(logging.SPAM)
elif verbosity >= 3:
    logger.setLevel(logging.DEBUG)
elif verbosity >= 2:
    logger.setLevel(logging.VERBOSE)
elif verbosity >= 1:
    logger.setLevel(logging.NOTICE)
elif verbosity < 0:
    logger.setLevel(logging.WARNING)

# Your code goes here.
...

如果你想将VerboseLogger设置为所有后续日志实例的默认日志类，你可以使用verboselogs.install()来实现

import logging
import verboselogs

verboselogs.install()
logger = logging.getLogger(__name__) # will be a VerboseLogger instance

Pylint插件

如果你使用上述verboselogs.install()方法，那么Pylint可能无法足够智能地识别logging正在使用verboselogs，从而导致诸如以下错误

E:285,24: Module 'logging' has no 'VERBOSE' member (no-member)
E:375,12: Instance of 'RootLogger' has no 'verbose' member (no-member)

为了解决这个问题，verboselogs提供了一个Pylint插件verboselogs.pylint，当使用pylint --load-plugins verboselogs.pylint加载时，会将verboselogs方法和常量添加到Pylint对logging模块的理解中。

日志级别概述

下表显示了预定义的日志级别和由本包定义的VERBOSE、NOTICE和SPAM级别的名称、数值和描述，以及我添加的一些注释。

联系方式

verboselogs的最新版本可在PyPI和GitHub上找到。文档托管在Read the Docs。有关错误报告，请在GitHub上创建一个问题。如果你有任何问题、建议等，请随时通过peter@peterodding.com给我发电子邮件。

许可证

本软件遵循 MIT 许可协议 许可。

© 2017 Peter Odding.