Python에서 디버깅하는 방법은 무엇입니까?

로깅은 필수입니다

로깅 설정 없이 애플리케이션을 작성하면 결국 후회하게 될 것입니다. 애플리케이션에 로그가 없으면 오류를 해결하기가 어렵습니다. 운 좋게도 Python에서는 기본 로거 설정이 매우 간단합니다.

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.')

이것이 파일에 로그 쓰기를 시작하는 데 필요한 전부입니다. 이는 다음과 같습니다( logging.getLoggerClass( ).root.handlers를 사용할 수 있습니다) [0].baseFilename파일 경로 찾기): 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

이 설정은 충분해 보이지만(일반적으로 그렇습니다) 잘 구성되고 형식이 잘 지정되었습니다. , 읽을 수 있는 로그를 통해 생활이 더욱 편리해집니다. 구성을 개선하고 확장하는 한 가지 방법은 로거가 읽는 .ini 또는 .yaml 파일을 사용하는 것입니다. 예를 들어 구성에서 다음을 수행할 수 있습니다.

# crashing_app.py
SOME_VAR = 42

class SomeError(Exception):
    pass

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

func()

Python 코드에서 이러한 종류의 광범위한 구성을 사용하면 탐색, 편집 및 유지 관리가 어려울 수 있습니다. 콘텐츠를 YAML 파일에 저장하면 위와 같은 매우 구체적인 설정으로 여러 로거를 더 쉽게 설정하고 조정할 수 있습니다.

이러한 모든 구성 필드가 어디서 왔는지 궁금하다면 공식 문서에 문서화되어 있으며 첫 번째에 표시된 대로 대부분은 단지 키워드 인수일 뿐입니다. 예.

이제 파일에 구성이 있으므로 어떻게든 로드해야 합니다. 가장 쉬운 방법은 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.

Python 로거는 실제로 YAML 파일을 직접 지원하지 않지만 yaml.safe_load YAML에서 사전 구성을 쉽게 생성하세요. 이전 .ini 파일을 사용하려는 경우 공식 문서에 따르면 사전 구성을 사용하는 것이 새 애플리케이션에 권장되는 접근 방식이라는 점을 지적하고 싶습니다. 더 많은 예를 보려면 공식 로깅 매뉴얼을 확인하세요. 🎜

로그 데코레이터 🎜

이전 로깅 팁을 계속 진행하면 기록해야 하는 몇 가지 오류가 발생할 수 있습니다. 함수 호출 상황. 해당 함수의 본문을 수정하는 대신 특정 로그 수준 및 선택적 메시지로 각 함수 호출을 기록하는 로깅 데코레이터를 사용할 수 있습니다. 데코레이터를 살펴보겠습니다. 🎜

import traceback
import sys

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

말할 필요도 없이 이 작업을 이해하는 데 약간의 시간이 걸릴 수 있습니다(복사하여 붙여넣기만 하면 됩니다). 여기서의 아이디어는 log 함수가 인수를 받아들이고 이를 내부 wrapper 함수에 제공한다는 것입니다. 그런 다음 데코레이터에 연결된 접근자 함수를 추가하여 이러한 매개변수를 조정 가능하게 만듭니다. functools.wraps 데코레이터의 경우 - 여기서 사용하지 않으면 함수 이름( func.__name__)이 데코레이터 이름으로 덮어쓰여집니다. . 하지만 이름을 인쇄하고 싶기 때문에 이것이 문제가 됩니다. 이 문제는 functools.wraps에서 함수 이름, 독스트링, 인수 목록을 데코레이터 함수에 복사하여 해결할 수 있습니다. 🎜

어쨌든 위 코드의 출력은 다음과 같습니다. 꽤 깔끔하죠? 🎜

>>> 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__ 더 읽기 쉬운 로그 🎜

간단한 코드 개선 디버그하기가 더 쉬우면 클래스에 __repr__ 메서드를 추가하세요. 이 메서드에 익숙하지 않은 경우 클래스 인스턴스의 문자열 표현을 반환하는 것뿐입니다. __repr__ 메서드를 사용할 때 가장 좋은 방법은 인스턴스를 다시 만드는 데 사용할 수 있는 텍스트를 출력하는 것입니다. 예: 🎜rrreee

위의 결과가 객체가 바람직하지 않거나 불가능하다는 것을 나타내는 경우, 좋은 대안은 <...> code>를 사용하는 것입니다. 예를 들어 <_io.TextIOWrapper name='somefile.txt' mode='w' 인코딩='UTF-8'>을 의미합니다. 🎜

__repr__ 외에도 기본적으로 __str__ 메서드를 구현하는 것도 좋습니다. code>print(인스턴스)

이 방법을 사용하세요. 이 두 가지 방법을 사용하면 변수를 인쇄하는 것만으로도 많은 정보를 얻을 수 있습니다. 🎜

__missing__ 사전에 대한 Dunder 메서드 🎜

어떤 이유로든 필요한 경우 사용자 정의 사전 클래스를 구현하고 실제로 존재하지 않는 일부 키에 액세스하려고 하면 KeyError로 인해 일부 버그가 발생할 수 있습니다. 코드에서 누락된 🎜key🎜를 찾아볼 필요가 없도록 KeyError가 발생할 때마다 호출되는 특수 __missing__ 메서드를 구현할 수 있습니다. 🎜rrreee🎜위 구현은 매우 간단합니다. 🎜key🎜가 누락된 메시지를 반환하고 기록하기만 하면 됩니다. 하지만 다른 중요한 정보를 기록하여 코드에서 발생하는 오류에 대해 더 많은 컨텍스트를 제공할 수도 있습니다. 🎜

调试崩溃的应用程序

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

-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..."

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

위 내용은 Python에서 디버깅하는 방법은 무엇입니까?의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!