Skip to content
The Chat Archive
gemini-2.5-pro-preview-05-06· Google LMArena Human Preference 140K

[code] [code] discord.py側のログが二重になっていたり、なっていなかったりする。この一貫性のなさの原因は?

  1. User
    # main.py
    import os
    from logging import getLogger
    from logging.config import dictConfig
    
    import discord
    from discord.ext import commands
    
    # Logging
    
    logging_settings = {
        "version": 1,
        "disable_existing_loggers": False,
        "formatters": {
            "color": {
                "()": "colorlog.ColoredFormatter",
                "format": "%(log_color)s%(asctime)s %(name)s:%(lineno)d %(funcName)s [%(levelname)s]:%(reset)s %(message)s",
                "log_colors": {
                    "DEBUG": "white",
                    "INFO": "green",
                    "WARNING": "yellow",
                    "ERROR": "red",
                    "CRITICAL": "red,bg_white"
                },
                "style": "%"
            },
            "simple": {
                "format": "%(asctime)s %(name)s:%(lineno)d %(funcName)s [%(levelname)s]: %(message)s"
            }
        },
        "handlers": {
            "consoleHandler": {
                "class": "logging.StreamHandler",
                "level": "INFO",
                "formatter": "color",
                "stream": "ext://sys.stdout"
            },
            "fileHandler": {
                "class": "logging.handlers.RotatingFileHandler",
                "level": "DEBUG",
                "formatter": "simple",
                "filename": "application.log",
                "maxBytes": 10485760,
                "backupCount": 5,
                "encoding": "utf-8"
            }
        },
        "root": {
            "level": "DEBUG",
            "handlers": ["consoleHandler", "fileHandler"]
        }
    }
    dictConfig(logging_settings)
    logger = getLogger(__name__)
    
    "D:\LLM API\Nyabi\venv\Scripts\python.exe" "D:\LLM API\Nyabi\main.py" 
    2025-05-19 21:24:32,388 discord.client:318 __init__ [WARNING]: PyNaCl is not installed, voice will NOT be supported
    2025-05-19 21:24:32,391 discord.client:643 login [INFO]: logging in using static token
    [2025-05-19 21:24:32] [INFO    ] discord.client: logging in using static token
    2025-05-19 21:24:33,801 discord.gateway:562 received_message [INFO]: Shard ID None has connected to Gateway (Session ID: 061ea72f2210795798de7da89203a05b).
    [2025-05-19 21:24:33] [INFO    ] discord.gateway: Shard ID None has connected to Gateway (Session ID: 061ea72f2210795798de7da89203a05b).
    2025-05-19 21:24:35,809 src.cogs.commands:13 __init__ [INFO]: hi from CommandsCog!
    2025-05-19 21:24:36,191 __main__:77 on_ready [INFO]: Successfully logged in as Nyabi#3449
    

    discord.py側のログが二重になっていたり、なっていなかったりする。この一貫性のなさの原因は?

  2. Assistant

    discord.pyのログが二重に出力されたり、されなかったりする一貫性のなさの原因は、主に以下の2つの要因が組み合わさっているためと考えられます。

    1. discord.pyライブラリ自身のロギング設定: discord.pyのClientを初期化する際、デフォルトではライブラリが独自のロギングハンドラをセットアップします。このハンドラは通常、ルートロガーまたはdiscordロガーにアタッチされ、INFOレベル以上のログをコンソール (sys.stdout) に特定のフォーマットで出力します。 ログ出力例に見られる [2025-05-19 21:24:32] [INFO ] discord.client: logging in using static token のような形式のログが、これに該当する可能性が高いです。このフォーマットは discord.py のデフォルト ([{asctime}] [{levelname:<8}] {name}: {message}) です。

    2. ユーザー定義のロギング設定: 提供されたコードでは、dictConfigを使って独自のロギング設定を適用しています。

      • ルートロガーには consoleHandler(INFOレベル、colorフォーマッタ)と fileHandler(DEBUGレベル、simpleフォーマッタ)が設定されています。
      • disable_existing_loggers が False のため、discord.pyが設定した既存のハンドラは無効化されず、そのまま残ります。

    これにより、ルートロガー(またはdiscordロガーから伝播してきたログを受け取るルートロガー)には、少なくとも以下の2つのコンソール出力用ハンドラが存在することになります。

    • discord.pyが追加したハンドラ
    • ユーザーが定義したconsoleHandler

    ログの二重出力について

    discord.client や discord.gateway の INFO ログが二重に出力されているのは、上記の2つのハンドラが両方ともこれらのログを処理しているためです。

    • 1つ目のログ: 2025-05-19 21:24:32,391 discord.client:643 login [INFO]: logging in using static token これは、ユーザー定義の consoleHandler に設定された color フォーマッタ (%(log_color)s%(asctime)s %(name)s:%(lineno)d %(funcName)s [%(levelname)s]:%(reset)s %(message)s) による出力だと思われます(コンソールでは色が付いているはずです)。時刻がミリ秒まで表示され、ファイル名や行番号が含まれています。

    • 2つ目のログ: [2025-05-19 21:24:32] [INFO ] discord.client: logging in using static token これは、discord.pyがデフォルトで設定するハンドラによる出力だと思われます。時刻は秒までで、フォーマットも異なります。

    一貫性のなさ(一部ログのみ二重になる、またはそう見える理由)について

    これが問題の核心です。なぜ discord.client の WARNING ログや、src.cogs.commands、__main__ の INFO ログは二重に出力されていないように見えるのか、という点です。

    考えられる主な理由:

    1. discord.py のハンドラの選択的動作: 最も可能性が高いのは、discord.pyが内部的に追加するロギングハンドラが、特定の条件下や特定のロガー(例: discord.client, discord.gateway の INFO レベルのイベントなど)に対してのみ反応するように設定されているか、あるいはそのような挙動になっている可能性です。 標準的なPythonのロギングでは、ルートロガーに設定されたハンドラはレベルが合致すれば全てのログを処理しますが、ライブラリ側で特殊なフィルタリングや制御を行っている場合、このような選択的な動作が起こり得ます。

    2. ログレベルやフィルタリング: discord.py側のハンドラのログレベルが厳密にINFOで、WARNING以上は処理しないか、あるいは別のフィルタが設定されている可能性も考えられますが、通常はINFOレベルのハンドラはWARNINGも処理します。

    3. コンソール表示のタイミングやcolorlogの相互作用: 稀なケースですが、非常に短い時間間隔で複数のログが出力される場合や、colorlogが出力するエスケープシーケンスがターミナルの表示に影響を与え、片方のログが見えにくくなったり、実質的に上書きされたように見えたりする可能性も完全に否定はできません。しかし、提供されたログの順序からは、この可能性は低いと思われます。

    結論としての一貫性のなさの原因

    discord.pyがセットアップするデフォルトのロギングハンドラが、あなたのカスタムロギング設定と共存し、かつ、そのデフォルトハンドラが全てのログメッセージに対して一律に動作しているわけではなく、特定の条件下(例えば特定のdiscord.py内部モジュールのINFOレベルログ)でのみ顕著に出力を行うため、結果として一部のログのみが二重に出力されているように見える、というのが最も有力な説明です。

    対策

    この二重出力や一貫性のない挙動を避けるためには、discord.pyのデフォルトロギングを制御するのが一般的です。 discord.Client(または commands.Bot)をインスタンス化する際に、log_handler引数を指定することで、discord.pyによるロギング設定をカスタマイズできます。

    import logging
    # ... (他のimportや設定)
    
    # discord.pyに独自のロギング処理をさせないためにNullHandlerを指定する
    # これにより、discordライブラリ内のログは'discord'ロガーに送られ、
    # その後ルートロガーに伝播し、ユーザー定義のハンドラで処理される。
    intents = discord.Intents.default() # 適切なIntentsを設定してください
    # client = discord.Client(intents=intents, log_handler=logging.NullHandler())
    # または commands.Bot の場合
    # bot = commands.Bot(command_prefix='!', intents=intents, log_handler=logging.NullHandler())
    
    # logger = getLogger(__name__) # この行はdictConfigの後の方が一般的
    
    # main.pyの先頭の方(discord Client初期化前)でロギング設定を行う
    dictConfig(logging_settings)
    logger = getLogger(__name__) # __name__ロガーの取得
    
    # discord.pyのロガーを取得して、ユーザー設定のみ使うようにする
    # Client初期化後にdiscord.pyが設定したハンドラを削除する方法もある
    # discord_logger = logging.getLogger('discord')
    # discord_logger.handlers.clear()
    # discord_logger.addHandler(logging.NullHandler()) # 伝播はさせるがdiscordロガー自身は出力しない
    
    # Client/Botの初期化
    # ここでlog_handler=logging.NullHandler() を使うのが推奨
    client = discord.Client(intents=intents, log_handler=logging.NullHandler())
    # または
    # bot = commands.Bot(command_prefix='!', intents=intents, log_handler=logging.NullHandler())
    
    
    # ... (以降のコード)
    # 例:
    # TOKEN = os.getenv("DISCORD_TOKEN")
    #
    # @client.event
    # async def on_ready():
    #     logger.info(f"Successfully logged in as {client.user}")
    #
    # client.run(TOKEN)
    
    

    log_handler=logging.NullHandler() を指定すると、discord.pyはdiscordという名前のロガーにNullHandler(何もしないハンドラ)を設定します。これにより、discord.pyライブラリからのログメッセージはdiscordロガーを経由してルートロガーに伝播し、最終的にあなたがdictConfigで設定したハンドラによってのみ処理されるようになります。これにより、ログ出力が一元化され、二重出力やフォーマットの混在を防ぐことができます。

  3. User

    discord.pyは何かしら特殊な方法でログを出力している?

  4. Assistant

    はい、discord.pyがログを出力する方法には、標準的なPythonのloggingモジュールの使い方に加えて、ライブラリ特有の初期化処理が関わっています。これが「特殊な方法」と感じられるかもしれません。

    具体的には以下のようになっています。

    1. 標準のloggingモジュールを使用: discord.py自体は、Python標準のloggingモジュールを利用してログメッセージを生成・出力します。完全に独自のロギングシステムを持っているわけではありません。ライブラリ内の各モジュールは、logging.getLogger(__name__) のような形でロガーを取得し、logger.info(), logger.warning() などを使ってログを出力します。これらのロガー名は通常 discord.client, discord.gateway のように discord. で始まります。

    2. デフォルトでのハンドラ設定: discord.Client (または discord.ext.commands.Bot) をインスタンス化する際、引数 log_handler が指定されない場合 (デフォルトは None)、discord.pyは自動的にロギング設定を行います。 このとき、以下の処理が行われます(discord.py v2.x の場合):

      • logging.getLogger('discord') という名前のロガーを取得します。
      • この 'discord' ロガーに、標準出力 (sys.stdout) へ出力する logging.StreamHandler を追加します。
      • このハンドラには、特定のフォーマット ([{asctime}] [{levelname:<8}] {name}: {message}) が設定されます。
      • 'discord' ロガーのレベルは、Client の log_level 引数(デフォルトは logging.INFO)に設定されます。
    3. なぜ「特殊」に見えるか、そして問題の原因: あなたのコードでは、dictConfig を使って独自の詳細なロギング設定を行っています。

      • ルートロガーに consoleHandler と fileHandler を設定しています。
      • disable_existing_loggers が False のため、discord.pyが上記2で設定したハンドラはそのまま残ります。

      これにより、discord 名前空間(例: discord.client, discord.gateway)からログが出力されると:

      • まず、discord ロガーに追加されたdiscord.pyのデフォルトハンドラによって処理され、コンソールにdiscord.pyのフォーマットで出力されます。
      • 次に、ログイベントは親ロガー(最終的にはルートロガー)に伝播 (propagate) します。
      • ルートロガーに設定されたあなたの consoleHandler によっても処理され、コンソールにあなたの指定した color フォーマットで出力されます。
      • 同様に fileHandler によっても処理され、ファイルに記録されます。

      この結果、コンソールには同じログイベントが2つの異なるフォーマットで出力される(二重出力)ことになります。これが、discord.client や discord.gateway の INFO ログが二重になっていた理由です。

    4. PyNaCl の警告ログが二重にならなかった件について: これは興味深い点で、一貫性のなさの核心部分です。 2025-05-19 21:24:32,388 discord.client:318 __init__ [WARNING]: PyNaCl is not installed, voice will NOT be supported このログはあなたの color フォーマッタによるもので、discord.pyのデフォルトフォーマットによる警告ログは見当たりません。

      考えられる理由としては非常に微妙なものになりますが:

      • 初期化タイミング: PyNaCl のチェックと警告ログの出力は、discord.Client の __init__ メソッドの比較的早い段階で行われます。discord.pyが自身のデフォルトハンドラをセットアップする処理 (_setup_logging) も __init__ 内で行われますが、そのハンドラがこの特定の警告ログを捕捉するよりも前に警告が出力されてしまうか、あるいは何らかの理由でその時点ではまだそのハンドラが完全にアクティブになっていない可能性があります。標準の logging の仕組みからすると、ハンドラが追加されていればレベルが合致するログは処理されるはずなので、これは少し不可解な挙動です。
      • ライブラリ内部の特殊な制御: 明示的なコードは見当たらないものの、非常に初期の特定の警告については、デフォルトハンドラが異なる振る舞いをする可能性もゼロではありませんが、通常は考えにくいです。

      この PyNaCl の警告がdiscord.pyのデフォルトフォーマットで出力されない点は、discord.pyのロギング初期化のシーケンスと、ログイベント発生のタイミングに依存する、ややエッジケース的な挙動である可能性があります。

    結論として: discord.pyは標準のloggingを使用していますが、デフォルトで独自のハンドラを'discord'ロガーに追加します。これが、ユーザーが設定したルートロガーのハンドラと共存することで、特にINFOレベルのログで二重出力が発生しやすくなります。 PyNaClの警告が二重出力されなかったのは、おそらくログ出力のタイミングが非常に早く、discord.pyのデフォルトハンドラがそれを捉えきれなかったか、あるいは他の要因によるものと考えられますが、これが「一貫性のなさ」として現れています。

    この問題を解決し、ログ出力を一元管理するための推奨される方法は、Client (または Bot) の初期化時に log_handler=logging.NullHandler() を指定することです。これにより、discord.pyは独自のハンドラを追加せず、全てのログがあなたの dictConfig で設定したシステムに委ねられるようになります。

    import logging
    import discord
    
    # ... (your dictConfig and other imports) ...
    dictConfig(logging_settings) # これはdiscord.Clientより前に
    
    # ...
    intents = discord.Intents.default() # 適切なIntentsを設定
    # client = discord.Client(intents=intents, log_handler=logging.NullHandler())
    # またはBotの場合
    # bot = commands.Bot(command_prefix='!', intents=intents, log_handler=logging.NullHandler())
    

    このようにすることで、ログのフォーマットや出力先を完全に制御でき、二重出力やフォーマットの混在を防ぐことができます。

Responses were produced in different, uncontrolled contexts (system prompts, settings, prior turns). This is not a benchmark.