파이썬 클래스 데코레이터 완벽 가이드: 모든 메서드에 한 번에 적용하는 방법

파이썬 클래스 데코레이터 완벽 가이드: 모든 메서드에 한 번에 적용하는 방법

안녕하세요. 파파대니입니다.

클래스 내 모든 함수에 데코레이터를 적용하는 방법은 크게 3가지로 나눌 수 있습니다.

각 방법은 목적과 상황에 맞게 선택할 수 있습니다.

 

1. 클래스 내부에서 동적으로 데코레이터 적용 (__init__ 또는 __new__ 메서드 이용)

이 방법은 클래스 정의 후 인스턴스를 생성할 때, __init__ 메서드 또는 __new__ 메서드를 사용하여 클래스 내 모든 메서드에 데코레이터를 적용하는 방식입니다.

 

예시

import logging
import functools

# 예외 로그 데코레이터
def exception_logger(func):
    @functools.wraps(func)
    def wrapper(self, *args, **kwargs):
        try:
            return func(self, *args, **kwargs)
        except Exception as e:
            logger.error(f"Exception occurred in method '{func.__name__}' of class '{self.__class__.__name__}': {str(e)}", exc_info=True)
            raise
    return wrapper

class Calculator:
    def __init__(self):
        # 클래스의 모든 메서드에 예외 로그 데코레이터 적용
        for name, method in self.__class__.__dict__.items():
            if callable(method):
                setattr(self, name, exception_logger(method))

    def divide(self, a, b):
        return a / b

    def multiply(self, a, b):
        return a * b

# 객체 생성 및 예외 발생
calc = Calculator()
try:
    calc.divide(10, 0)
except ZeroDivisionError:
    pass

---

2. 메타클래스를 이용한 데코레이터 적용

메타클래스를 활용하면 클래스가 생성될 때, 클래스 내 모든 메서드에 데코레이터를 자동으로 적용할 수 있습니다.

메타클래스는 클래스를 생성하는 클래스이므로 클래스 정의 시점에 데코레이터를 적용할 수 있습니다.

 

예시

import logging
import functools

# 예외 로그 데코레이터
def exception_logger(func):
    @functools.wraps(func)
    def wrapper(self, *args, **kwargs):
        try:
            return func(self, *args, **kwargs)
        except Exception as e:
            logger.error(f"Exception occurred in method '{func.__name__}' of class '{self.__class__.__name__}': {str(e)}", exc_info=True)
            raise
    return wrapper

class DecoratorMeta(type):
    def __new__(cls, name, bases, dct):
        # 모든 메서드에 데코레이터 적용
        for key, value in dct.items():
            if callable(value):
                dct[key] = exception_logger(value)
        return super().__new__(cls, name, bases, dct)

class Calculator(metaclass=DecoratorMeta):
    def divide(self, a, b):
        return a / b

    def multiply(self, a, b):
        return a * b

# 객체 생성 및 예외 발생
calc = Calculator()
try:
    calc.divide(10, 0)
except ZeroDivisionError:
    pass

---

 

3. 클래스 외부에서 메서드에 데코레이터 적용

클래스 정의 후, 외부에서 클래스의 메서드들을 순회하여 데코레이터를 적용하는 방법입니다.

이 방법은 클래스 코드에 직접적인 영향을 미치지 않고, 클래스 정의 후 외부에서 처리할 수 있습니다.

 

예시

import logging
import functools

# 예외 로그 데코레이터
def exception_logger(func):
    @functools.wraps(func)
    def wrapper(self, *args, **kwargs):
        try:
            return func(self, *args, **kwargs)
        except Exception as e:
            logger.error(f"Exception occurred in method '{func.__name__}' of class '{self.__class__.__name__}': {str(e)}", exc_info=True)
            raise
    return wrapper

class Calculator:
    def divide(self, a, b):
        return a / b

    def multiply(self, a, b):
        return a * b

# 클래스 외부에서 모든 메서드에 데코레이터 적용
def apply_decorator_to_class_methods(cls, decorator):
    for attr_name, attr_value in cls.__dict__.items():
        if callable(attr_value):  # 메서드인 경우에만 데코레이터 적용
            decorated_method = decorator(attr_value)
            setattr(cls, attr_name, decorated_method)

# 데코레이터를 클래스에 적용
apply_decorator_to_class_methods(Calculator, exception_logger)

# 객체 생성 및 예외 발생
calc = Calculator()
try:
    calc.divide(10, 0)
except ZeroDivisionError:
    pass

---

각 방법의 설명

1. 클래스 내부에서 동적으로 데코레이터 적용
   • 장점: 클래스 내에서 모든 메서드에 동적으로 데코레이터를 적용할 수 있어 코드가 간결하고, 클래스의 초기화 과정에서 모든 메서드에 일괄적으로 적용 가능합니다.
   • 단점: 클래스 정의가 길어지거나 복잡해지면, __init__ 메서드에서 메서드를 순회하는 코드가 복잡해질 수 있습니다.
2. 메타클래스를 이용한 데코레이터 적용
   • 장점: 메타클래스를 사용하면 클래스가 생성될 때 자동으로 모든 메서드에 데코레이터를 적용할 수 있어 코드의 분리와 재사용이 용이합니다.
   • 단점: 메타클래스는 파이썬에서 고급 개념에 속하며, 코드의 이해가 어려울 수 있습니다. 또한, 메타클래스에 의존하게 되면 다른 코드와의 호환성 문제가 발생할 수 있습니다.
3. 클래스 외부에서 메서드에 데코레이터 적용
   • 장점: 클래스 코드에 직접적인 영향을 미치지 않고, 클래스 정의 후 외부에서 데코레이터를 적용할 수 있어 유연합니다.
   • 단점: 클래스가 완전히 정의된 후 데코레이터를 적용해야 하므로, 클래스 설계 초기 단계에서 데코레이터를 적용하려면 추가적인 처리 과정이 필요할 수 있습니다.

---

 

각 방법은 상황에 따라 장단점이 있습니다.

하지만 메타클래스를 이용한 방법을 가장 추천합니다.

이유는 메타클래스를 사용하면 클래스가 정의될 때 자동으로 모든 메서드에 데코레이터를 적용할 수 있어, 코드가 간결하고 명확하게 관리할 수 있습니다.

또한, 클래스 정의와 데코레이터 적용이 분리되어 유지보수가 용이하고 확장성도 뛰어납니다.

 

클래스 내부에서 동적으로 데코레이터를 적용하는 방법은 코드가 간단할 때 유용합니다.

작은 프로젝트나 간단한 클래스에서는 이 방법이 효율적일 수 있습니다.

그러나 클래스가 커질수록 관리가 복잡해질 수 있습니다.

클래스 외부에서 메서드에 데코레이터 적용하는 방법은 매우 유연하지만, 클래스를 완전히 정의한 후에 데코레이터를 적용해야 하므로, 설계 초기 단계에서는 조금 번거로울 수 있습니다.

 

따라서, 복잡하고 확장 가능한 시스템을 구축하려면 메타클래스를 이용한 방법을 추천하며, 간단한 클래스나 특정 요구가 있는 경우에는 클래스 내부에서 동적으로 적용하거나 외부에서 적용하는 방법을 고려하는 것이 좋습니다.

 

 

⬇️ 참고하면 좋은 글 ⬇️

 

파이썬 고급 문법 완벽 가이드: 데코레이터, 제너레이터, 메타프로그래밍 등

파이썬 고급 문법 완벽 가이드: 데코레이터, 제너레이터, 메타프로그래밍 등

 

Python에서 self, this, me 차이 한 번에 정리하기

Python에서 self, this, me 차이 한 번에 정리하기

 

Python에서 한글 처리 시 인코딩 문제 해결하기 (UTF-8 vs ANSI)

Python에서 한글 처리 시 인코딩 문제 해결하기 (UTF-8 vs ANSI)