如何在我的代码中传递全局调试标志变量;我应该使用argparse吗?

时间:2018-04-11 17:52:54

标签: python logging argparse globals debug-mode

假设我有一个主程序(test.py)和一个小程序实用程序(test_utils.py),它具有主程序调用的辅助函数。 我希望通过传递debug_flag布尔值来启用代码中的调试语句,该布尔值通过argparse读取。

现在我希望我的test_utils.py程序中的函数也可以根据debug_flag的值打印调试语句。我总是可以将debug_flag作为参数添加到test_utils.py中的每个函数定义中,并在调用函数时传递参数,但这里有更好的方法,比如make debug_flag一个全局变量?但是,如果我确实将debug_flag声明为test.py的全局,那么如何将其导入test_utils.py

这里最优雅/ Pythonic的方法是什么?

test.py:

import argparse
from test_utils import summation

def main():
    args = get_args()
    debug_flag = True if args[debug] == 'True' else False
    print summation(5, 6, 7)

def get_args():
    parser = argparse.ArgumentParser(description='Test program')
    parser.add_argument('-d','--debug', help='Debug True/False', default=False)
    args = vars(parser.parse_args())
    return args

test_utils.py:

from test import debug_flag

def summation(x, y, z):
    if debug_flag:
        print 'I am going to add %s %s and %s' % (x, y, z)
    return x + y + z

EDIT1:澄清 - 如果我通过argparse传递调试标志,从而将debug_flag设置为True - 如何将其传播到test_utils.py内的函数?

EDIT2:根据@joran-beasley的建议,这就是我所拥有的。

test.py:

import argparse
import logging
from test_utils import summation

def main():
    args = get_args()
    logging.getLogger("my_logger").setLevel(logging.DEBUG if args['debug'] == 'True' else logging.WARNING)
    print summation(5, 6, 7)

def get_args():
    parser = argparse.ArgumentParser(description='Test program')
    parser.add_argument('-d','--debug', help='Debug True/False', required=True)
    args = vars(parser.parse_args())
    return args

main()

test_utils.py

import logging

log = logging.getLogger('my_logger')

def summation(x, y, z):
    log.debug('I am going to add %s %s and %s' % (x, y, z))
    return x + y + z

当我运行test.py时,我得到:

$ python test.py -d True
No handlers could be found for logger "my_logger"
18

3 个答案:

答案 0 :(得分:3)

使用记录

# this logger will always now be logging.DEBUG level
logging.getLogger("my_logger").setLevel(logging.DEBUG if args.debug else logging.WARNING)

然后使用

log = logging.getLogger("my_logger")
...
log.warn("some text that should always be seen!")
log.debug("some debug info!")

然后,您可以执行多级记录的事情

log_level = logging.WARNING
if args.verbose > 0:
   log_level = logging.INFO
elif args.verbose > 3:
   log_level = logging.DEBUG

如果由于某种原因你需要检索currentEffectiveLogLevel(在大多数情况下你真的不应该......当你需要调试级别输出时只需使用log.debug

logging.getLogger("my_logger").getEffectiveLevel()

[编辑澄清]

log = logging.getLogger('my_logger')

def summation(x, y, z):
   log.debug('I am going to add %s %s and %s' % (x, y, z)) # will not print if my_logger does not have an effective level of debug
   return x + y + z

print(summation(2, 3, 4))
log.setLevel(logging.DEBUG)
print(summation(4, 5, 6))

或者你可以写一个助手功能

def is_debug():
    return logging.getLogger("my_logger").getEffectiveLevel() == logging.DEBUG
粗略的,你总是可以做一些可怕的hacky废话,比如把它写成平面文件并阅读或使用真正的全局变量(比你想象的更难以及许多边缘情况需要担心)

答案 1 :(得分:0)

你可以通过传递一个mutable来实现Python中的“全包”全局。在这些情况下,我最喜欢的方法是创建一个自定义的Flags类。然后,您在所有模块之间共享Flags的实例,其属性的功能类似于globals。以下是您发布的代码的示例:

test_utils.py

__all__ = ['flags', 'summation']

class Flags(object):
    def __init__(self, *items):
        for key,val in zip(items[:-1], items[1:]):
            setattr(self,key,val)

flags = Flags('debug', False)

def summation(x, y, z):
    if flags.debug:
        print 'I am going to add %s %s and %s' % (x, y, z)
    return x + y + z

test.py

#!/usr/bin/env python2
import argparse
import sys

from test_utils import summation, flags

def main():
    args = get_args()
    flags.debug = args['debug']
    print summation(5, 6, 7)

def get_args():
    parser = argparse.ArgumentParser(description='Test program')
    parser.add_argument('-d','--debug', action='store_true', help='Debug True/False', default=False)
    args = vars(parser.parse_args())
    return args

if __name__=='__main__':
    main()

我将标记移动到test_utils.py以避免循环导入问题,但这不会影响任何内容。一个更强大的解决方案(适用于大型项目)将有一个单独的config.py(或其他)模块,其中flags被初始化。

答案 2 :(得分:0)

简单的回答。在主文件中分配一个dict。然后通过所有其他模块导入它。

Test.py

<View>
          <Modal
            animationType="slide"
            transparent={true}
            style={{width: '100%', alignSelf: 'center', height: '100%', justifyContent: 'flex-start', backgroundColor:'green'}}
            visible={this.state.modalVisible}
            onRequestClose={() => {
              alert('Modal has been closed.');
            }}>
            <TouchableWithoutFeedback onPress={() => {
              this.setModalVisible(!this.state.modalVisible);
            }}>
            <View style={{ backgroundColor: 'red', flex: 1}} >

                <View pointerEvents="none" style={{alignSelf: 'center', width: '80%', height: '50%', backgroundColor: 'purple', top: 100}}>
                  <Text pointerEvents="none" >Hello World!</Text>


                </View>

            </View>
            </TouchableWithoutFeedback>
          </Modal>
        </View>

test_utils.py

debug_flag = {'setting' : False}

现在,只要您从主模块导入debug_flag,它就会在您处理arg解析后设置标志的任何设置。然后,您可以随时更改此设置,随后的呼叫将接收更改。