149

debug()十分ではないと思うので、アプリケーションにログレベルのTRACE(5)を使用したいと思います。さらにlog(5, msg)、私が望むものではありません。Pythonロガーにカスタムログレベルを追加するにはどうすればよいですか?

私はmylogger.py次の内容を持っています:

import logging

@property
def log(obj):
    myLogger = logging.getLogger(obj.__class__.__name__)
    return myLogger

私のコードでは、次のように使用しています。

class ExampleClass(object):
    from mylogger import log

    def __init__(self):
        '''The constructor with the logger'''
        self.log.debug("Init runs")

今電話したいself.log.trace("foo bar")

編集(2016年12月8日):受け入れられた回答をpfaに変更しました。これは、EricSからの非常に優れた提案に基づく優れたソリューションであるIMHOです。

4

17 に答える 17

207

2022年以降に読んでいる人へ:おそらく、現在次に高い評価の回答をここでチェックする必要があります:https ://stackoverflow.com/a/35804945/1691778

私の最初の答えは以下の通りです。

-

@エリックS。

Eric S.の答えは素晴らしいですが、これにより、ログレベルが何に設定されているかに関係なく、常に新しいデバッグレベルでログに記録されたメッセージが出力されることが実験によってわかりました。したがって、新しいレベル番号を作成した9場合、を呼び出すsetLevel(50)と、下位レベルのメッセージが誤って出力されます。

これを防ぐには、「debugv」関数内に別の行を追加して、問題のログレベルが実際に有効になっているかどうかを確認する必要があります。

ロギングレベルが有効になっているかどうかをチェックする例を修正しました。

import logging
DEBUG_LEVELV_NUM = 9 
logging.addLevelName(DEBUG_LEVELV_NUM, "DEBUGV")
def debugv(self, message, *args, **kws):
    if self.isEnabledFor(DEBUG_LEVELV_NUM):
        # Yes, logger takes its '*args' as 'args'.
        self._log(DEBUG_LEVELV_NUM, message, args, **kws) 
logging.Logger.debugv = debugv

class LoggerPython 2.7のinのコードを見るとlogging.__init__.py、これはすべての標準ログ関数(.critical、.debugなど)が行うことです。

評判が悪いため、他の人の回答への返信を投稿できないようです...うまくいけば、エリックはこれを見たら投稿を更新します。=)

于 2012-11-30T02:17:06.237 に答える
93

既存のすべての回答と一連の使用経験を組み合わせて、新しいレベルを完全にシームレスに使用するために必要なすべてのことのリストを作成したと思います。TRACE以下の手順は、値を使用して新しいレベルを追加することを前提としていますlogging.DEBUG - 5 == 5

  1. logging.addLevelName(logging.DEBUG - 5, 'TRACE')名前で参照できるように、新しいレベルを内部的に登録するために呼び出す必要があります。
  2. logging一貫性を保つために、新しいレベルを属性としてそれ自体に追加する必要がありますlogging.TRACE = logging.DEBUG - 5
  3. 呼び出されたメソッドをモジュールtraceに追加する必要があります。、、などloggingのようdebugに動作する必要があります。info
  4. 呼び出されたメソッドはtrace、現在構成されているロガークラスに追加する必要があります。これは100%保証されているわけではないため、代わりlogging.Loggerに使用してください。logging.getLoggerClass()

すべての手順は、以下の方法で示されています。

def addLoggingLevel(levelName, levelNum, methodName=None):
    """
    Comprehensively adds a new logging level to the `logging` module and the
    currently configured logging class.

    `levelName` becomes an attribute of the `logging` module with the value
    `levelNum`. `methodName` becomes a convenience method for both `logging`
    itself and the class returned by `logging.getLoggerClass()` (usually just
    `logging.Logger`). If `methodName` is not specified, `levelName.lower()` is
    used.

    To avoid accidental clobberings of existing attributes, this method will
    raise an `AttributeError` if the level name is already an attribute of the
    `logging` module or if the method name is already present 

    Example
    -------
    >>> addLoggingLevel('TRACE', logging.DEBUG - 5)
    >>> logging.getLogger(__name__).setLevel("TRACE")
    >>> logging.getLogger(__name__).trace('that worked')
    >>> logging.trace('so did this')
    >>> logging.TRACE
    5

    """
    if not methodName:
        methodName = levelName.lower()

    if hasattr(logging, levelName):
       raise AttributeError('{} already defined in logging module'.format(levelName))
    if hasattr(logging, methodName):
       raise AttributeError('{} already defined in logging module'.format(methodName))
    if hasattr(logging.getLoggerClass(), methodName):
       raise AttributeError('{} already defined in logger class'.format(methodName))

    # This method was inspired by the answers to Stack Overflow post
    # http://stackoverflow.com/q/2183233/2988730, especially
    # http://stackoverflow.com/a/13638084/2988730
    def logForLevel(self, message, *args, **kwargs):
        if self.isEnabledFor(levelNum):
            self._log(levelNum, message, args, **kwargs)
    def logToRoot(message, *args, **kwargs):
        logging.log(levelNum, message, *args, **kwargs)

    logging.addLevelName(levelNum, levelName)
    setattr(logging, levelName, levelNum)
    setattr(logging.getLoggerClass(), methodName, logForLevel)
    setattr(logging, methodName, logToRoot)

私が管理しているユーティリティライブラリhaggisで、さらに詳細な実装を見つけることができます。この関数haggis.logs.add_logging_levelは、この回答のより本番環境に対応した実装です。

于 2016-03-04T19:54:20.290 に答える
68

私は「ラムダ」の答えが表示されないようにし、log_at_my_log_level追加された場所を変更する必要がありました。私もパウロがした問題を見ました–これはうまくいかないと思います。の最初の引数としてロガーは必要ありませんlog_at_my_log_levelか? これは私のために働いた

import logging
DEBUG_LEVELV_NUM = 9 
logging.addLevelName(DEBUG_LEVELV_NUM, "DEBUGV")
def debugv(self, message, *args, **kws):
    # Yes, logger takes its '*args' as 'args'.
    self._log(DEBUG_LEVELV_NUM, message, args, **kws) 
logging.Logger.debugv = debugv
于 2012-08-02T20:08:51.810 に答える
43

この質問はかなり古いですが、私は同じトピックを扱って、私には少しきれいに見えるすでに述べたものと同様の方法を見つけました。これは3.4でテストされたため、使用されたメソッドが古いバージョンに存在するかどうかはわかりません。

from logging import getLoggerClass, addLevelName, setLoggerClass, NOTSET

VERBOSE = 5

class MyLogger(getLoggerClass()):
    def __init__(self, name, level=NOTSET):
        super().__init__(name, level)

        addLevelName(VERBOSE, "VERBOSE")

    def verbose(self, msg, *args, **kwargs):
        if self.isEnabledFor(VERBOSE):
            self._log(VERBOSE, msg, args, **kwargs)

setLoggerClass(MyLogger)
于 2014-03-23T02:07:19.073 に答える
25

私たちはすでにたくさんの正解を持っていますが、私の意見では、よりパイソン的なものは次のとおりです。

import logging

from functools import partial, partialmethod

logging.TRACE = 5
logging.addLevelName(logging.TRACE, 'TRACE')
logging.Logger.trace = partialmethod(logging.Logger.log, logging.TRACE)
logging.trace = partial(logging.log, logging.TRACE)

コードで使用する場合は、警告が属性を追加しないmypyように追加することをお勧めします。# type: ignore

于 2019-03-21T08:57:26.157 に答える
20

誰が内部メソッド(self._log)を使用するという悪い習慣を始めましたか、そしてなぜそれぞれの答えはそれに基づいているのですか?!pythonicソリューションはself.log代わりに使用することになるので、内部のものをいじる必要はありません。

import logging

SUBDEBUG = 5
logging.addLevelName(SUBDEBUG, 'SUBDEBUG')

def subdebug(self, message, *args, **kws):
    self.log(SUBDEBUG, message, *args, **kws) 
logging.Logger.subdebug = subdebug

logging.basicConfig()
l = logging.getLogger()
l.setLevel(SUBDEBUG)
l.subdebug('test')
l.setLevel(logging.DEBUG)
l.subdebug('test')
于 2013-06-06T06:27:25.007 に答える
9

クラスをサブクラス化し、基本的に。より低いレベルで呼び出すLoggerというメソッドを追加する必要があると思います。私はこれを試していませんが、これはドキュメントが示していることです。traceLogger.logDEBUG

于 2010-02-02T10:27:50.613 に答える
8

log()関数を渡すロガーオブジェクトの新しい属性を作成する方が簡単だと思います。この理由から、ロガーモジュールはaddLevelName()とlog()を提供していると思います。したがって、サブクラスや新しいメソッドは必要ありません。

import logging

@property
def log(obj):
    logging.addLevelName(5, 'TRACE')
    myLogger = logging.getLogger(obj.__class__.__name__)
    setattr(myLogger, 'trace', lambda *args: myLogger.log(5, *args))
    return myLogger

mylogger.trace('This is a trace message')

期待どおりに動作するはずです。

于 2010-05-12T13:13:41.660 に答える
6

カスタムロガーを作成するためのヒント:

  1. 使用しないでください_log、使用logしてください(チェックする必要はありませんisEnabledFor
  2. ロギングモジュールは、で魔法をかけるため、カスタムロガーのインスタンスを作成するものであるgetLogger必要があります。そのため、次の方法でクラスを設定する必要があります。setLoggerClass
  3. __init__何も保存していない場合は、ロガー、クラスを定義する必要はありません。
# Lower than debug which is 10
TRACE = 5
class MyLogger(logging.Logger):
    def trace(self, msg, *args, **kwargs):
        self.log(TRACE, msg, *args, **kwargs)

このロガーを呼び出すときはsetLoggerClass(MyLogger)、これをデフォルトのロガーにするために使用します。getLogger

logging.setLoggerClass(MyLogger)
log = logging.getLogger(__name__)
# ...
log.trace("something specific")

setFormatterこの低レベルのトレースを実際に取得するには、、、、setHandlerおよびそれ自体を実行するsetLevel(TRACE)必要があります。handlerlog

于 2016-08-17T22:51:09.140 に答える
3

これは私のために働いた:

import logging
logging.basicConfig(
    format='  %(levelname)-8.8s %(funcName)s: %(message)s',
)
logging.NOTE = 32  # positive yet important
logging.addLevelName(logging.NOTE, 'NOTE')      # new level
logging.addLevelName(logging.CRITICAL, 'FATAL') # rename existing

log = logging.getLogger(__name__)
log.note = lambda msg, *args: log._log(logging.NOTE, msg, args)
log.note('school\'s out for summer! %s', 'dude')
log.fatal('file not found.')

lambda / funcNameの問題は、@marqueedが指摘したようにlogger._logで修正されています。ラムダを使用すると少しきれいに見えると思いますが、欠点はキーワード引数をとることができないことです。私はそれを自分で使ったことがないので、大したことはありません。

  注の設定:学校は夏に出かけます!お前
  致命的な設定:ファイルが見つかりません。
于 2012-08-21T06:24:39.877 に答える
2

私の経験では、これは操作の問題の完全な解決策です...メッセージが発行される関数として「ラムダ」が表示されないようにするには、さらに詳しく説明します。

MY_LEVEL_NUM = 25
logging.addLevelName(MY_LEVEL_NUM, "MY_LEVEL_NAME")
def log_at_my_log_level(self, message, *args, **kws):
    # Yes, logger takes its '*args' as 'args'.
    self._log(MY_LEVEL_NUM, message, args, **kws)
logger.log_at_my_log_level = log_at_my_log_level

スタンドアロンのロガークラスを使って作業したことはありませんが、基本的な考え方は同じだと思います(_logを使用)。

于 2011-09-22T05:55:14.350 に答える
2

ファイル名と行番号を正しく取得するためのMadPhysicistsの例への追加:

def logToRoot(message, *args, **kwargs):
    if logging.root.isEnabledFor(levelNum):
        logging.root._log(levelNum, message, args, **kwargs)
于 2016-11-21T12:17:40.703 に答える
1

固定された回答に基づいて、新しいログレベルを自動的に作成する小さなメソッドを作成しました

def set_custom_logging_levels(config={}):
    """
        Assign custom levels for logging
            config: is a dict, like
            {
                'EVENT_NAME': EVENT_LEVEL_NUM,
            }
        EVENT_LEVEL_NUM can't be like already has logging module
        logging.DEBUG       = 10
        logging.INFO        = 20
        logging.WARNING     = 30
        logging.ERROR       = 40
        logging.CRITICAL    = 50
    """
    assert isinstance(config, dict), "Configuration must be a dict"

    def get_level_func(level_name, level_num):
        def _blank(self, message, *args, **kws):
            if self.isEnabledFor(level_num):
                # Yes, logger takes its '*args' as 'args'.
                self._log(level_num, message, args, **kws) 
        _blank.__name__ = level_name.lower()
        return _blank

    for level_name, level_num in config.items():
        logging.addLevelName(level_num, level_name.upper())
        setattr(logging.Logger, level_name.lower(), get_level_func(level_name, level_num))

configは次のようになります。

new_log_levels = {
    # level_num is in logging.INFO section, that's why it 21, 22, etc..
    "FOO":      21,
    "BAR":      22,
}
于 2019-01-11T13:36:02.857 に答える
1

誰かがやりたいかもしれません、ルートレベルのカスタムロギング。そして、logging.get_logger('')の使用を避けてください:

import logging
from datetime import datetime
c_now=datetime.now()
logging.basicConfig(
    level=logging.INFO,
    format="%(asctime)s [%(levelname)s] :: %(message)s",
    handlers=[
        logging.StreamHandler(),
        logging.FileHandler("../logs/log_file_{}-{}-{}-{}.log".format(c_now.year,c_now.month,c_now.day,c_now.hour))
    ]
)
DEBUG_LEVELV_NUM = 99 
logging.addLevelName(DEBUG_LEVELV_NUM, "CUSTOM")
def custom_level(message, *args, **kws):
    logging.Logger._log(logging.root,DEBUG_LEVELV_NUM, message, args, **kws) 
logging.custom_level = custom_level
# --- --- --- --- 
logging.custom_level("Waka")
于 2021-08-31T16:41:53.970 に答える
0

Loggerクラスにメソッドを追加する代わりに、このLogger.log(level, msg)メソッドを使用することをお勧めします。

import logging

TRACE = 5
logging.addLevelName(TRACE, 'TRACE')
FORMAT = '%(levelname)s:%(name)s:%(lineno)d:%(message)s'


logging.basicConfig(format=FORMAT)
l = logging.getLogger()
l.setLevel(TRACE)
l.log(TRACE, 'trace message')
l.setLevel(logging.DEBUG)
l.log(TRACE, 'disabled trace message')
于 2013-10-30T13:40:33.977 に答える
0

よくわかりません; 少なくとも、Python 3.5では、次のように機能します。

import logging


TRACE = 5
"""more detail than debug"""

logging.basicConfig()
logging.addLevelName(TRACE,"TRACE")
logger = logging.getLogger('')
logger.debug("n")
logger.setLevel(logging.DEBUG)
logger.debug("y1")
logger.log(TRACE,"n")
logger.setLevel(TRACE)
logger.log(TRACE,"y2")
    

出力:

DEBUG:root:y1

TRACE:root:y2

于 2018-02-24T13:49:53.837 に答える
-3

誰かが新しいロギングレベルをロギングモジュール(またはそのコピー)に動的に追加する自動化された方法が必要な場合に備えて、私はこの関数を作成し、@pfaの答えを拡張しました。

def add_level(log_name,custom_log_module=None,log_num=None,
                log_call=None,
                   lower_than=None, higher_than=None, same_as=None,
              verbose=True):
    '''
    Function to dynamically add a new log level to a given custom logging module.
    <custom_log_module>: the logging module. If not provided, then a copy of
        <logging> module is used
    <log_name>: the logging level name
    <log_num>: the logging level num. If not provided, then function checks
        <lower_than>,<higher_than> and <same_as>, at the order mentioned.
        One of those three parameters must hold a string of an already existent
        logging level name.
    In case a level is overwritten and <verbose> is True, then a message in WARNING
        level of the custom logging module is established.
    '''
    if custom_log_module is None:
        import imp
        custom_log_module = imp.load_module('custom_log_module',
                                            *imp.find_module('logging'))
    log_name = log_name.upper()
    def cust_log(par, message, *args, **kws):
        # Yes, logger takes its '*args' as 'args'.
        if par.isEnabledFor(log_num):
            par._log(log_num, message, args, **kws)
    available_level_nums = [key for key in custom_log_module._levelNames
                            if isinstance(key,int)]

    available_levels = {key:custom_log_module._levelNames[key]
                             for key in custom_log_module._levelNames
                            if isinstance(key,str)}
    if log_num is None:
        try:
            if lower_than is not None:
                log_num = available_levels[lower_than]-1
            elif higher_than is not None:
                log_num = available_levels[higher_than]+1
            elif same_as is not None:
                log_num = available_levels[higher_than]
            else:
                raise Exception('Infomation about the '+
                                'log_num should be provided')
        except KeyError:
            raise Exception('Non existent logging level name')
    if log_num in available_level_nums and verbose:
        custom_log_module.warn('Changing ' +
                                  custom_log_module._levelNames[log_num] +
                                  ' to '+log_name)
    custom_log_module.addLevelName(log_num, log_name)

    if log_call is None:
        log_call = log_name.lower()

    setattr(custom_log_module.Logger, log_call, cust_log)
    return custom_log_module
于 2017-04-08T16:28:39.497 に答える