Quelle est la méthode de débogage en Python ?

La journalisation est un must

Si vous écrivez votre application sans une sorte de configuration de journalisation, vous finirez par le regretter. Sans aucun journal dans l'application, il est difficile de résoudre les erreurs. Heureusement, en Python, configurer un enregistreur de base est très simple :

import logging
logging.basicConfig(
    filename='application.log',
    level=logging.WARNING,
    format= '[%(asctime)s] {%(pathname)s:%(lineno)d} %(levelname)s - %(message)s',
    datefmt='%H:%M:%S'
)

logging.error("Some serious error occurred.")
logging.warning('Function you are using is deprecated.')

C'est tout ce dont vous avez besoin pour commencer à écrire des journaux dans un fichier, qui ressemblera à ceci (vous pouvez utiliser logging.getLoggerClass( ).root.handlers [0].baseFilenameRechercher le chemin du fichier) : logging.getLoggerClass().root.handlers[0].baseFilename查找文件路径）：

[12:52:35] {<stdin>:1} ERROR - Some serious error occurred.
[12:52:35] {<stdin>:1} WARNING - Function you are using is deprecated.

这种设置似乎已经足够好了（通常情况下也是如此），但配置良好、格式化良好、可读的日志可以让你的生活更轻松。改进和扩展配置的一种方法是使用日志记录器读取的.ini或.yaml文件。例如，你可以在配置中执行以下操作：

version: 1
disable_existing_loggers: true

formatters:
  standard:
    format: "[%(asctime)s] {%(pathname)s:%(lineno)d} %(levelname)s - %(message)s"
    datefmt: '%H:%M:%S'

handlers:
  console:  # handler which will log into stdout
    class: logging.StreamHandler
    level: DEBUG
    formatter: standard  # Use formatter defined above
    stream: ext://sys.stdout
  file:  # handler which will log into file
    class: logging.handlers.RotatingFileHandler
    level: WARNING
    formatter: standard  # Use formatter defined above
    filename: /tmp/warnings.log
    maxBytes: 10485760 # 10MB
    backupCount: 10
    encoding: utf8

root:  # Loggers are organized in hierarchy - this is the root logger config
  level: ERROR
  handlers: [console, file]  # Attaches both handler defined above

loggers:  # Defines descendants of root logger
  mymodule:  # Logger for "mymodule"
    level: INFO
    handlers: [file]  # Will only use "file" handler defined above
    propagate: no  # Will not propagate logs to "root" logger

在python代码中拥有这种广泛的配置将很难导航、编辑和维护。将内容保存在YAML文件中，可以更轻松地设置和调整多个日志记录程序，这些日志记录程序具有非常特定的设置，如上述设置。

如果你想知道所有这些配置字段的来源，这些都官方文档中记录，其中大多数只是关键字参数，如第一个示例所示。

因此，现在文件中有配置，意味着我们需要以某种方式加载。最简单的方法是使用YAML文件：

import yaml
from logging import config

with open("config.yaml", 'rt') as f:
    config_data = yaml.safe_load(f.read())
    config.dictConfig(config_data)

Python logger实际上并不直接支持YAML文件，但它支持字典配置，可以使用yaml.safe_load从YAML轻松创建字典配置。如果你倾向于使用旧的.ini文件，那么我只想指出，根据官方文档，使用字典配置是新应用程序的推荐方法。有关更多示例，请查看官方日志记录手册。

日志装饰器

继续前面的日志记录技巧，你可能会遇到需要记录一些错误函数调用的情况。你可以使用日志装饰器来代替修改所述函数的主体，该装饰器将使用特定的日志级别和可选消息记录每个函数调用。让我们看看装饰器：

from functools import wraps, partial
import logging

def attach_wrapper(obj, func=None):  # Helper function that attaches function as attribute of an object
    if func is None:
        return partial(attach_wrapper, obj)
    setattr(obj, func.__name__, func)
    return func

def log(level, message):  # Actual decorator
    def decorate(func):
        logger = logging.getLogger(func.__module__)  # Setup logger
        formatter = logging.Formatter(
            '%(asctime)s - %(name)s - %(levelname)s - %(message)s')
        handler = logging.StreamHandler()
        handler.setFormatter(formatter)
        logger.addHandler(handler)
        log_message = f"{func.__name__} - {message}"

        @wraps(func)
        def wrapper(*args, **kwargs):  # Logs the message and before executing the decorated function
            logger.log(level, log_message)
            return func(*args, **kwargs)

        @attach_wrapper(wrapper)  # Attaches "set_level" to "wrapper" as attribute
        def set_level(new_level):  # Function that allows us to set log level
            nonlocal level
            level = new_level

        @attach_wrapper(wrapper)  # Attaches "set_message" to "wrapper" as attribute
        def set_message(new_message):  # Function that allows us to set message
            nonlocal log_message
            log_message = f"{func.__name__} - {new_message}"

        return wrapper
    return decorate

# Example Usage
@log(logging.WARN, "example-param")
def somefunc(args):
    return args

somefunc("some args")

somefunc.set_level(logging.CRITICAL)  # Change log level by accessing internal decorator function
somefunc.set_message("new-message")  # Change log message by accessing internal decorator function
somefunc("some args")

毋庸置疑，这可能需要一点时间才能让你的头脑清醒（你可能只想复制粘贴并使用它）。这里的想法是，log函数接受参数，并将其提供给内部wrapper函数。然后，通过添加附加到装饰器的访问器函数，使这些参数可调整。至于functools.wraps装饰器——若我们在这里不使用它，函数的名称（ func.__name__）将被装饰器的名称覆盖。但这是个问题，因为我们想打印名字。这可以通过functools.wraps将函数名、文档字符串和参数列表复制到装饰器函数来解决。

无论如何，这是上面代码的输出。很整洁，对吧？

2020-05-01 14:42:10,289 - __main__ - WARNING - somefunc - example-param
2020-05-01 14:42:10,289 - __main__ - CRITICAL - somefunc - new-message

__repr__更多可读日志

对代码的简单改进使其更易于调试，就是在类中添加__repr__方法。若你不熟悉这个方法，它所做的只是返回类实例的字符串表示。使用__repr__方法的最佳实践是输出可用于重新创建实例的文本。例如：

class Circle:
    def __init__(self, x, y, radius):
        self.x = x
        self.y = y
        self.radius = radius

    def __repr__(self):
        return f"Rectangle({self.x}, {self.y}, {self.radius})"

...
c = Circle(100, 80, 30)
repr(c)
# Circle(100, 80, 30)

如果如上所示表示对象是不可取的或不可能的，那么好的替代方法是使用<...>表示，例如<_io.TextIOWrapper name=&#39;somefile.txt&#39; mode=&#39;w&#39; encoding=&#39;UTF-8&#39;>。

除了__repr__之外，实现__str__方法也是一个好主意，默认情况下，在调用print(instance)时使用该方法。使用这两种方法，只需打印变量即可获得大量信息。

__missing__字典的Dunder方法

如果你出于任何原因需要实现自定义字典类，那么当你尝试访问一些实际上不存在的键时，可能会因为KeyError而出现一些bug。为了避免不得不在代码中四处查看缺少的键，可以实现特殊的__missing__方法，每次引发KeyError

class MyDict(dict):
    def __missing__(self, key):
        message = f'{key} not present in the dictionary!'
        logging.warning(message)
        return message  # Or raise some error instead

Cette configuration semble être assez bonne (et c'est généralement le cas), mais bien configurée et bien formatée , des journaux lisibles peuvent vous faciliter la vie. Une façon d'améliorer et d'étendre votre configuration consiste à utiliser un fichier .ini ou .yaml lu par l'enregistreur. Par exemple, vous pouvez faire ce qui suit dans la configuration :

# crashing_app.py
SOME_VAR = 42

class SomeError(Exception):
    pass

def func():
    raise SomeError("Something went wrong...")

func()

Avoir ce type de configuration étendue en code python serait difficile à naviguer, à modifier et à maintenir. L'enregistrement du contenu dans un fichier YAML facilite la configuration et le réglage de plusieurs enregistreurs avec des paramètres très spécifiques comme celui ci-dessus.

Si vous vous demandez d'où viennent tous ces champs de configuration, ils sont documentés dans la documentation officielle, et la plupart d'entre eux ne sont que des arguments de mots clés, comme indiqué dans le premier exemple.

Nous avons donc maintenant la configuration dans le fichier, ce qui signifie que nous devons la charger d'une manière ou d'une autre. Le moyen le plus simple est d'utiliser un fichier YAML : 🎜

# Run crashing application
~ $ python3 -i crashing_app.py
Traceback (most recent call last):
  File "crashing_app.py", line 9, in <module>
    func()
  File "crashing_app.py", line 7, in func
    raise SomeError("Something went wrong...")
__main__.SomeError: Something went wrong...
>>> # We are interactive shell
>>> import pdb
>>> pdb.pm()  # start Post-Mortem debugger
> .../crashing_app.py(7)func()
-> raise SomeError("Something went wrong...")
(Pdb) # Now we are in debugger and can poke around and run some commands:
(Pdb) p SOME_VAR  # Print value of variable
42
(Pdb) l  # List surrounding code we are working with
  2
  3   class SomeError(Exception):
  4       pass
  5
  6   def func():
  7  ->     raise SomeError("Something went wrong...")
  8
  9   func()
[EOF]
(Pdb)  # Continue debugging... set breakpoints, step through the code, etc.

L'enregistreur Python ne prend pas réellement en charge les fichiers YAML directement, mais il prend en charge la configuration 🎜dictionnaire🎜, qui peut être configurée à l'aide de yaml.safe_load Créez facilement des configurations de dictionnaire à partir de YAML. Si vous préférez utiliser les anciens fichiers .ini, je tiens simplement à souligner que selon la documentation officielle, l'utilisation de la configuration par dictionnaire est l'approche recommandée pour les nouvelles applications. Pour plus d'exemples, consultez le manuel de journalisation officiel. 🎜

Décorateur de journaux 🎜

Continuez avec les conseils de journalisation précédents, vous pouvez rencontrer des erreurs qui doivent être enregistrées Situation d’appel de fonction. Au lieu de modifier le corps de ladite fonction, vous pouvez utiliser un décorateur de journalisation, qui enregistrera chaque appel de fonction avec un niveau de journalisation spécifique et un message facultatif. Regardons les décorateurs : 🎜

import traceback
import sys

def func():
    try:
        raise SomeError("Something went wrong...")
    except:
        traceback.print_exc(file=sys.stderr)

Inutile de dire que cela peut prendre un peu de temps à comprendre (vous pouvez simplement le copier-coller et l'utiliser). L'idée ici est que la fonction log accepte les arguments et les fournit à la fonction interne wrapper. Ensuite, rendez ces paramètres réglables en ajoutant des fonctions d'accesseurs attachées au décorateur. Quant au décorateur functools.wraps - si nous ne l'utilisons pas ici, le nom de la fonction ( func.__name__) sera écrasé par le nom du décorateur . Mais c'est un problème car nous voulons imprimer les noms. Cela peut être résolu en functools.wraps copiant le nom de la fonction, la docstring et la liste d'arguments dans la fonction décorateur. 🎜

Quoi qu'il en soit, voici le résultat du code ci-dessus. Plutôt sympa, non ? 🎜

>>> import func from module
>>> func()
"This is result..."

# Make some changes to "func"
>>> func()
"This is result..."  # Outdated result
>>> from importlib import reload; reload(module)  # Reload "module" after changes made to "func"
>>> func()
"New result..."

__repr__ Journaux plus lisibles 🎜

Améliorations simples du code À apporter pour faciliter le débogage, ajoutez une méthode __repr__ à la classe. Si vous n'êtes pas familier avec cette méthode, elle ne fait que renvoyer une représentation sous forme de chaîne de l'instance de classe. La meilleure pratique lors de l’utilisation de la méthode __repr__ consiste à générer du texte qui peut être utilisé pour recréer l’instance. Par exemple : 🎜rrreee

Si ce qui précède indique que l'objet est indésirable ou impossible, alors une bonne alternative consiste à utiliser <...> code> signifie, par exemple, <_io.TextIOWrapper name='somefile.txt' mode='w' encoding='UTF-8'>. 🎜

En plus de __repr__, c'est également une bonne idée d'implémenter la méthode __str__ par défaut, après avoir appelé <. code>print (instance)

Utilisez cette méthode. En utilisant ces deux méthodes, vous pouvez obtenir de nombreuses informations simplement en imprimant les variables. 🎜

__missing__ Méthode Dunder pour le dictionnaire 🎜

Si vous en avez besoin pour une raison quelconque Implémentez une classe de dictionnaire personnalisée, et lorsque vous essayez d'accéder à des clés qui n'existent pas réellement, des bugs peuvent survenir en raison de KeyError. Pour éviter d'avoir à chercher dans votre code une 🎜key🎜 manquante, vous pouvez implémenter une méthode spéciale __missing__ qui est appelée chaque fois qu'une KeyError est levée. 🎜rrreee🎜L'implémentation ci-dessus est très simple, il suffit de renvoyer et d'enregistrer les messages avec une 🎜clé🎜 manquante, mais vous pouvez également enregistrer d'autres informations précieuses pour vous donner plus de contexte sur les erreurs se produisant dans votre code. 🎜

调试崩溃的应用程序

如果你的应用程序在你有机会看到其中发生了什么之前崩溃，你可能会发现这个技巧非常有用。

-i使用参数-i ( python3 -i app.py)运行应用程序会导致它在程序退出后立即启动交互式 shell。此时你可以检查变量和函数。

如果这还不够好，可以使用更大的hammer-pdb-Python调试器。pdb有相当多的特性，可以保证文章的独立性。但这里是一个例子和最重要的部分概要。让我们先看看我们的小崩溃脚本：

# crashing_app.py
SOME_VAR = 42

class SomeError(Exception):
    pass

def func():
    raise SomeError("Something went wrong...")

func()

现在，如果我们使用-i参数运行它，我们就有机会调试它：

# Run crashing application
~ $ python3 -i crashing_app.py
Traceback (most recent call last):
  File "crashing_app.py", line 9, in <module>
    func()
  File "crashing_app.py", line 7, in func
    raise SomeError("Something went wrong...")
__main__.SomeError: Something went wrong...
>>> # We are interactive shell
>>> import pdb
>>> pdb.pm()  # start Post-Mortem debugger
> .../crashing_app.py(7)func()
-> raise SomeError("Something went wrong...")
(Pdb) # Now we are in debugger and can poke around and run some commands:
(Pdb) p SOME_VAR  # Print value of variable
42
(Pdb) l  # List surrounding code we are working with
  2
  3   class SomeError(Exception):
  4       pass
  5
  6   def func():
  7  ->     raise SomeError("Something went wrong...")
  8
  9   func()
[EOF]
(Pdb)  # Continue debugging... set breakpoints, step through the code, etc.

上面的调试会话非常简单地展示了如何使用pdb。程序终止后，我们进入交互式调试会话。首先，我们导入pdb并启动调试器。此时，我们可以使用所有pdb命令。作为上面的示例，我们使用p命令打印变量，使用l命令打印列表代码。大多数情况下，你可能希望设置断点，你可以使用b LINE_NO来设置断点，并运行程序，直到达到断点（c），然后继续使用s单步执行函数，也可以使用w打印堆栈轨迹。有关命令的完整列表，你可以转到官方pdb文档。

检查堆栈轨迹

例如，假设你的代码是在远程服务器上运行的Flask或Django应用程序，你无法在其中获得交互式调试会话。在这种情况下，你可以使用traceback和sys包来了解代码中的错误：

import traceback
import sys

def func():
    try:
        raise SomeError("Something went wrong...")
    except:
        traceback.print_exc(file=sys.stderr)

运行时，上面的代码将打印引发的最后一个异常。除了打印例外，你还可以使用traceback包打印堆栈轨迹（traceback.print_stack()）或提取原始堆栈帧，对其进行格式化并进一步检查（traceback.format_list(traceback.extract_stack())）。

在调试期间重新加载模块

有时，你可能正在调试或试验交互式shell中的某些函数，并对其进行频繁更改。为了使运行/测试和修改的循环更容易，你可以运行importlib.reload(module)以避免每次更改后重新启动交互会话：

>>> import func from module
>>> func()
"This is result..."

# Make some changes to "func"
>>> func()
"This is result..."  # Outdated result
>>> from importlib import reload; reload(module)  # Reload "module" after changes made to "func"
>>> func()
"New result..."

这个技巧更多的是关于效率而不是调试。能够跳过一些不必要的步骤，使你的工作流程更快、更高效，这总是很好的。通常，不时地重新加载模块是一个好主意，因为它可以帮助你避免调试同时已经修改过多次的代码。

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!