[python] 🎀 Decorator : @ 의 미학

✨ 안녕하세요, 오늘은 Decorator 사용법을 간단히 정리해보려 합니다.

Decorator? Callable?

😋 말 그대로 '꾸며주는' 기능을 하는 python callable입니다 :)
🤷‍♂️ 엥? 근데 callable은 또 뭐야?

callable은 말 그대로 'call 할 수 있는' python 객체를 말합니다.
그리고, 'call'이란 : "()"을 사용하는 것 입니다. :)
😊 함수, 혹은 class가 여기에 속하죠!

😃 함수같은 경우는, 함수 정의와 동시에 간단하게 call 할 수 있죠.

def func_call():
	print('call!')

# "()"을 사용해 call 하였습니다!
func_call()
>>> call!

😎 반면에, class는 __call__() 함수를 정의해주면 call 할 수 있습니다.

class ClassCall(object):
	def __init__(self):
    	pass
   	def __call__(self):
    	print('call class!')
        
instance_call = ClassCall()
instance_call()
>>> call class!

😉 OK! callable이 무엇인지 알았으니, Decorator로 넘어가도록 하지요 :)

Decorator : 꾸민다!

😎 Decorator는 '꾸며주는 자'라는 의미 그대로, callable(함수 or class)가 call될 때 앞뒤로 꾸며줄 수 있는 기능을 더해주는 것을 말합니다.
😁 주로 반복하여 사용하는 기능(시간 체크)들을 구현하여 사용합니다!
😋 백문이 불여일견! 한번 간단한 예시를 보시죠 :)

import time

# 데코레이터 함수
def time_check(func):                            
    def deco_wrapper():                           
        print(func.__name__, 'function start')
        st = time.time()
        func()
        et = time.time()
        print("Function Spent TIME : {}".format(et-st))
        print(func.__name__, 'function end')
    return deco_wrapper   
    
@time_check
def print_yaho():
	print('yaho!')
    
print_yaho()
>>> print_yaho function start
    yaho!
    Function Spent TIME : 4.291534423828125e-06
    print_yaho function end

def print_yaho():
	print('yaho!')
    
print_yaho()
>>> yaho!

😉 위와 같은 방식으로 데코레이터를 만들어, 함수 선언시 "@"로 꾸며주면
✌ deco_wrapper안의 로직이 앞뒤로 수행된 후 func, 즉 printyaho가 수행되는 것을 보실 수 있습니다 :)
📏 함수 수행시간 체크시 아주 유용하겠죠? 😊

Fancy Decorator : with Args

😃 좀 더 나아가 Decorator에 인자도 줄 수 있고, 실제 프로덕션에서 사용하려면 몇가지 조치를 좀 더 취해주어야 합니다.
🤔 여러개의 Decorator가 하나의 함수에 적용된다면, 함수명이 제대로 출력되지 않기 때문이지요!

자세한 내용은 https://dojang.io/mod/page/view.php?id=2429 를 참고하였습니다 :)

😎 즉, Decorator에 인자를 주고, 가변인자까지 사용한 최종 템플릿은 대략 아래와 같습니다.

import functools

def time_check(decimal):
    def decorator_time_check(func):
        @functools.wraps(func)
        def wrapper_time_check(*args, **kwargs):
            st = time.perf_counter()
            print('HERE IS {}`s TIME CHECK START!'.format(func.__name__))
            value = func(*args, **kwargs)
            et = time.perf_counter()
            print('HERE IS {}`s TIME! : {}'.format(func.__name__, round(et-st, decimal)))
            return value
        return wrapper_time_check
    return decorator_time_check

@time_check(decimal=12)
def calc_repeat(rep=10**6):
    sum = 0
    for i in range(rep):
        sum += i
    return sum

calc_repeat()

😎 수행 시간을 소숫점 몇자리까지 넣을 것인지에 대한 decorator 변수 'decimal'을 추가했으며,
😁 func의 인자를 가변 인자 처리하여, 어떤 함수가 오더라도 처리가 가능하게 구현하였습니다.
😀 어찌되었건, Decorator는 일종의 템플릿 같은 느낌이기에, 요렇게 구현해놀고 저도 그냥 가져다 쓰는 편입니다 :)

정리하며

😊 오늘은 간략히 Decorator에 대해 정리해 보았습니다.
😎 단순히 수행 시간 측정 이외에도 다양하게 사용될 수 있는 Decorator!
😉 잘 알아두면 복잡해보이는 오픈소스 코드를 뒤적거릴때도 큰 도움이 됩니다 :)
🤞 그럼, 읽어주셔서 감사합니다. 좋은 하루 되세요!