141

我正在尝试了解应用程序的工作原理。为此，我将调试命令作为每个函数主体的第一行插入，目的是记录函数的名称以及我向日志输出发送消息的行号（在代码中）。最后，由于此应用程序包含许多文件，因此我想创建一个日志文件，以便更好地了解应用程序的控制流程。

这是我所知道的：

  1. 对于获取函数名称，我可以使用function_name.__name__但我不想使用 function_name（这样我可以快速复制并粘贴一个泛型Log.info("Message")到所有函数的主体中）。我知道这可以在 C 中使用__func__宏来完成，但我不确定 python。

  2. 为了获取文件名和行号，我已经看到（并且我相信）我的应用程序正在使用 Pythonlocals()函数，但使用的语法我并不完全了解，例如：options = "LOG.debug('%(flag)s : %(flag_get)s' % locals())我尝试使用 likeLOG.info("My message %s" % locals())生成类似{'self': <__main__.Class_name object at 0x22f8cd0>}. 请对此有任何意见吗？

  3. 我知道如何使用日志记录并向其添加处理程序以记录到文件，但我不确定是否可以使用单个文件以项目中函数调用的正确顺序记录所有日志消息。

我将不胜感激任何帮助。

谢谢！

4

4 回答 4

639

正确的答案是使用已经提供的funcName变量

import logging
logger = logging.getLogger(__name__)
FORMAT = "[%(filename)s:%(lineno)s - %(funcName)20s() ] %(message)s"
logging.basicConfig(format=FORMAT)
logger.setLevel(logging.DEBUG)

然后在您想要的任何地方，只需添加：

logger.debug('your message')

我正在处理的脚本的示例输出：

[invRegex.py:150 -          handleRange() ] ['[A-Z]']
[invRegex.py:155 -     handleRepetition() ] [[<__main__.CharacterRangeEmitter object at 0x10ba03050>, '{', '1', '}']]
[invRegex.py:197 -          handleMacro() ] ['\\d']
[invRegex.py:155 -     handleRepetition() ] [[<__main__.CharacterRangeEmitter object at 0x10ba03950>, '{', '1', '}']]
[invRegex.py:210 -       handleSequence() ] [[<__main__.GroupEmitter object at 0x10b9fedd0>, <__main__.GroupEmitter object at 0x10ba03ad0>]]
于 2013-11-21T04:28:35.840 回答
39

您在这里有一些边缘相关的问题。

我将从最简单的开始：（3）。使用logging您可以将所有调用聚合到单个日志文件或其他输出目标：它们将按照它们在过程中发生的顺序排列。

接下来：（2）。locals()提供当前范围的字典。因此，在没有其他参数的方法中，您具有self范围，其中包含对当前实例的引用。正在使用的让您感到困惑的技巧是使用 dict 作为%运算符的 RHS 的字符串格式。"%(foo)s" % bar将被替换为 is 的任何值bar["foo"]。

最后，您可以使用一些自省技巧，类似于那些pdb可以记录更多信息的技巧：

def autolog(message):
    "Automatically log the current function details."
    import inspect, logging
    # Get the previous frame in the stack, otherwise it would
    # be this function!!!
    func = inspect.currentframe().f_back.f_code
    # Dump the message + the name of this function to the log.
    logging.debug("%s: %s in %s:%i" % (
        message, 
        func.co_name, 
        func.co_filename, 
        func.co_firstlineno
    ))

这将记录传入的消息，加上（原始）函数名、定义出现的文件名以及该文件中的行。查看inspect - 检查活动对象以获取更多详细信息。

正如我在前面的评论中提到的，您还可以pdb随时通过插入该行import pdb; pdb.set_trace()并重新运行您的程序来进入交互式调试提示。这使您可以单步执行代码，并根据您的选择检查数据。

于 2012-06-11T04:29:29.937 回答
8

funcname，linename并lineno提供有关执行日志记录的最后一个函数的信息。

如果您有记录器的包装器（例如单例记录器），那么@synthesizerpatel 的答案可能不适合您。

要找出调用堆栈中的其他调用者，您可以执行以下操作：

import logging
import inspect

class Singleton(type):
    _instances = {}

    def __call__(cls, *args, **kwargs):
        if cls not in cls._instances:
            cls._instances[cls] = super(Singleton, cls).__call__(*args, **kwargs)
        return cls._instances[cls]

class MyLogger(metaclass=Singleton):
    logger = None

    def __init__(self):
        logging.basicConfig(
            level=logging.INFO,
            format="%(asctime)s - %(threadName)s - %(message)s",
            handlers=[
                logging.StreamHandler()
            ])

        self.logger = logging.getLogger(__name__ + '.logger')

    @staticmethod
    def __get_call_info():
        stack = inspect.stack()

        # stack[1] gives previous function ('info' in our case)
        # stack[2] gives before previous function and so on

        fn = stack[2][1]
        ln = stack[2][2]
        func = stack[2][3]

        return fn, func, ln

    def info(self, message, *args):
        message = "{} - {} at line {}: {}".format(*self.__get_call_info(), message)
        self.logger.info(message, *args)
于 2019-01-16T02:34:21.867 回答
2

我喜欢@synthesizerpatel 给出的答案，但我更喜欢这种格式以包含关卡名称

FORMAT = "[%(asctime)s %(filename)s->%(funcName)s():%(lineno)s]%(levelname)s: %(message)s"
logging.basicConfig(format=FORMAT, level=logging.INFO)

结果如下：

[2022-01-13 11:48:16,122 main.py->loop():62]INFO: looping
于 2021-11-16T12:37:13.123 回答