启用详细日志记录的更简单方法

如果我--verbose从命令行启用并且脚本中包含以下内容，则想添加调试打印语句测试。

logger.info("test")

我经历了以下问题，但无法获得答案...

• 如何在脚本中实现--verbose或-v选项？

• Python日志记录-DEBUG下方是否有内容？

您需要将Argparse教程的智慧与Python的Logging HOWTO结合起来。这是一个例子

> cat verbose.py 
#!/usr/bin/env python

import argparse
import logging

parser = argparse.ArgumentParser(
    description='A test script for http://stackoverflow.com/q/14097061/78845'
)
parser.add_argument("-v", "--verbose", help="increase output verbosity",
                    action="store_true")

args = parser.parse_args()
if args.verbose:
    logging.basicConfig(level=logging.DEBUG)

logging.debug('Only shown in debug mode')

运行帮助：

> ./verbose.py -h
usage: verbose.py [-h] [-v]

A test script for http://stackoverflow.com/q/14097061/78845

optional arguments:
  -h, --help     show this help message and exit
  -v, --verbose  increase output verbosity

在详细模式下运行：

> ./verbose.py -v
DEBUG:root:Only shown in debug mode

静默运行：

> ./verbose.py   
> 

我发现--verbose（对于用户）和--debug（对于开发人员）都很有用。这是我使用logging和的方式argparse：

import argparse
import logging

parser = argparse.ArgumentParser()
parser.add_argument(
    '-d', '--debug',
    help="Print lots of debugging statements",
    action="store_const", dest="loglevel", const=logging.DEBUG,
    default=logging.WARNING,
)
parser.add_argument(
    '-v', '--verbose',
    help="Be verbose",
    action="store_const", dest="loglevel", const=logging.INFO,
)
args = parser.parse_args()    
logging.basicConfig(level=args.loglevel)

因此，如果--debug设置为，则日志记录级别设置为DEBUG。如果是--verbose，则日志记录设置为INFO。如果两者都不是，则缺少--debug设置会将日志记录级别设置为默认值WARNING。

这是一种更简洁的方法，它进行边界检查，并将在帮助中列出有效值：

parser = argparse.ArgumentParser(description='This is a demo.')
parser.add_argument("-l", "--log", dest="logLevel", choices=['DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL'], help="Set the logging level")

args = parser.parse_args()
if args.logLevel:
    logging.basicConfig(level=getattr(logging, args.logLevel))

用法：

demo.py --log DEBUG

另一个变体是计算a的数量，-v并将其用作a的索引，list实际水平为logging：

import argparse
import logging

parser = argparse.ArgumentParser()
parser.add_argument('-v', '--verbose', action='count', default=0)
args = parser.parse_args()

levels = [logging.WARNING, logging.INFO, logging.DEBUG]
level = levels[min(len(levels)-1,args.verbose)]  # capped to number of levels

logging.basicConfig(level=level,
                    format="%(asctime)s %(levelname)s %(message)s")

logging.debug("a debug message")
logging.info("a info message")
logging.warning("a warning message")

这适用于-vvvv，-vvv，-vv，-v，-v -v，等，如果没有-v则logging.WARNING选择更多，如果-v提供的话，将会给INFO和DEBUG

您可以在-v标志后显式指定一个级别为整数：

parser = argparse.ArgumentParser()
parser.add_argument("-v", "--verbose", const=1, default=0, type=int, nargs="?",
                    help="increase verbosity: 0 = only warnings, 1 = info, 2 = debug. No number means info. Default is no verbosity.")
args = parser.parse_args()

logger = logging.getLogger()
if args.verbose == 0:
    logger.setLevel(logging.WARN) 
elif args.verbose == 1:
    logger.setLevel(logging.INFO) 
elif args.verbose == 2:
    logger.setLevel(logging.DEBUG) 

这是让argparse对-v选项进行计数的另一种方法，以将详细程度从默认的WARNING到INFO（-v）到DEBUG（-vv）增加两个级别。这不会映射到由定义的常量，logging而是直接计算值，从而限制了输入：

print( "Verbosity / loglevel:", args.v )
logging.basicConfig( level=10*(3-max(0,min(args.v,3))) )
logging.debug("debug") # 10
logging.info("info") # 20
logging.warning("warning") # 30 - The default level is WARNING, which means that only events of this level and above will be tracked
logging.error("error") # 40
logging.critical("critical") # 50

如果要为不想（或无法）编辑的脚本启用logging.DEBUG级别，则可以自定义启动：

jcomeau@aspire:~$ python -c "import site; site._script()"
[snip]...
USER_BASE: '/home/jcomeau/.local' (exists)
USER_SITE: '/home/jcomeau/.local/lib/python2.7/site-packages' (exists)
ENABLE_USER_SITE: True
jcomeau@aspire:~$ mkdir -p ~/.local/lib/python2.7/site-packages
jcomeau@aspire:~$ vi ~/.local/lib/python2.7/site-packages/usercustomize.py

输入以下内容：

import os, logging
if os.getenv('DEBUGGING'):
    logging.basicConfig(level = logging.DEBUG)

那么您可以：

jcomeau@aspire:~$ mkdir -p /tmp/some/random/
jcomeau@aspire:~$ echo 'import logging; logging.debug("test")' >> /tmp/some/random/script.py
jcomeau@aspire:~$ DEBUGGING=1 python /tmp/some/random/script.py 
DEBUG:root:test

来自Paul Ollis，网址为http://nedbatchelder.com/blog/201001/running_code_at_python_startup.html

2017-07-18：此后我改用其他方法：

logging.basicConfig(level=logging.DEBUG if __debug__ else logging.INFO)

它的作用是，如果运行时未进行优化（如所示python script.py），则将获得DEBUG级的内容，而如果不进行优化，则python -OO script.py不会。没有设置环境变量。