[python] 데코레이터(Decorator, 장식자)

장식자(Decorator)

함수는 일급 객체이므로 다른 함수에 인수로 전달될 수 있습니다. 이 방식으로 인수로 전달된 함수의 결과는 더 자세한 정보를 첨가시키는 등의 수정을 일으킬 수 있습니다. 다음 함수 dol2won은 달러를 원화로 전환하는 것으로 달러와 환율을 인수로 받습니다. 다음의 결과와 같이 결과는 단순히 숫자로 반화됩니다.

def dol2won(dol, wpd):
    return dol*wpd

dol2won(3, 1200)

3600

다음 deco()는 중첩함수를 포함하는 함수로 클로저(closure)입니다. 이 함수의 인수는 다른 함수이며 중첩함수는 인수로 전달된 함수를 사용합니다.

def deco(fn):
    def wrapper(*args, **kwargs):
        result=fn(*args, **kwargs)
        return f'{result} 원'
    return wrapper

그림 1은 함수 deco()의 실행 순서를 나타낸 것입니다. 함수 deco() 실행과 동시에 중첩함수를 호출합니다. 이 함수의 인수는 내부에 정의되지 않으므로 외부에서 전달해야 합니다. 즉, 클로저 입니다. 실행된 중첩함수는 인수로 전달된 함수를 적용하여 결과를 반환합니다.

그림 1. 함수 deco()의 실행 순서.

dwon=deco(dol2won)
dwon(3, 1200)

 '3600 원'

위 결과는 함수 dol2won() 함수의 결과와 같지만 단위를 표시하는 것으로 수정되었습니다. 파이썬에서는 다음과 같이 코딩하여 같은 결과를 반환할 수 있습니다.

@deco
def dol2won(dol, wpd):
    return dol*wpd

dol2won(1000, 1200)

 '1200000 원'

위 코딩은 함수 위에 @함수를 첨가합니다. 이것은 함수가 @함수의 인수로 전달된다는 것을 의미합니다. @과 함께 첨가된 함수는 아래에 있는 함수의 결과를 수정할 수 있는 함수로 장식자(Decorator)라고 합니다. 장식자를 사용하는 기본구조는 식 1과 같습니다.

@decorator def  name(argument): 본 문

(식 1)

위 형식에서 @decorator 아래 입력된 함수가 장식자에 인수로 전달됩니다. 장식자를 변화시키는 것으로 인수로 전달되는 함수의 결과를 수정할 있습니다.

def deco2(fn):
    def wrapper(*args, **kwargs):
        result=fn(*args, **kwargs)
        return f'{result} 원입니다.'
    return wrapper 

@deco2
def dol2won(dol, wpd):
    return dol*wpd

dol2won(2, 1200)

'2400 원입니다.'

위 결과와 같이 하나의 함수를 여러 장식자와 연결하여 사용하여 다양한 결과를 반환할 수 있습니다. 장식자를 선언한 다음부터 수정된 결과를 반환합니다. 그러므로 장식자를 제거하고 원래의 함수를 사용하기 위해서는 그 함수를 다시 실행시켜야 됩니다. 다음은 원래의 함수를 재실행 한 후의 결과 입니다.

#dol2won()함수 재실행
dol2won(1000, 1200)

1200000

HTML에서 표 생성을 파이썬 함수를 사용하여 자동화하는 예입니다. 먼저 HTML의 테이블 작성을 알아봅니다. 테이블 작성에 필요한 필수 HTML 태그는 <table>, <tr>, <th>, <td>로 작성자는 주로 <th>, <td>를 수정한다고 가정합니다. 그러나 이 두 태그는 다음의 형식과 같이 <tr> ~ </tr> 사이에 위치해야 하며 테이블의 모든 내용은 <table> ~ </table> 태그 내부에 위치해 합니다. 식 2는 테이블 작성을 위한 기본적인 구조입니다.

<table>

(식 2)

<thead>

<tr> <th>내용</th><th>내용 ~ </th></tr>

</thead><tbody>

<tr> <td>내용</td><td>내용 ~ </td></tr>

</tbody></table>

위에서 소개한 HTML 테이블에 관계된 태그와 내용을 자동으로 정렬하내는 파이썬 함수를 작성합시다. 이 과정에서 장식자의 방법을 적용할 수 있습니다.

아래 함수 tableMake()는 인수를 <table> ~ </table> 태그 내부에 위치시키며 lineMake() 함수는 인수를 <tr> ~ </tr> 사이에 위치하도록 합니다.

def tableMake(a, b):
    re=f'<table><thead> {a} </thead><tbody>{b}</tbody></table>'
    return(re)

def lineMake(f):
    def wrap(x, sty):
        return f'<tr>{f(x, sty)}</tr>'
    return wrap

<th>, <td> 태그 내에 작성된 내용을 <tr> ~ </tr>에 위치시키기 위해 lineMake()를 장식자로 지정합니다. 다음 코드의 x.join(y) 메소드는 문자열인 x에 문자열인 y를 연결한 결과를 반환합니다.

@lineMake
def thMake(x, sty=None):
    return ''.join([f'<th style={sty}>{i}</th>' for i in x])

@lineMake
def tdMake(x, sty):
    return ''.join([f'<td style={sty}>{i}</td>' for i in x])

다음은 위 함수들을 사용하여 배열 객체를 HTML 테이블 구조로 전환하기 위해 적용한 것입니다. 먼저 <th> 태그 내에 위치하는 각 열의 제목을 먼저 작성합니다. thMake()함수는 lineMake()함수를 장식자로 받기 때문에 결과로 <tr> 태그가 함께 반환됩니다.

th=thMake(['제목1','제목2'],'""'); th

 '<tr><th style="">제목1</th><th style="">제목2</th></tr>'

다음 객체 a을 표의 내용으로 입력하기 위해 tdMake() 함수를 적용합니다. 또한 최종으로 표를 작성하기 위해 작성된 th와 td를 tableMake() 함수에 인수로 전달합니다.

a=["A","B","C","D"]
td=''
for i in a:
    td=td+tdMake(i, 'text-align:center')
td

 '<tr><td style=text-align:center>A</td><td style=text-align:center>B</td></tr>
  <tr><td style=text-align:center>C</td><td style=text-align:center>D</td></tr>' 

tableMake(th, td)

 '<table><thead> <tr><th style="">제목1</th><th style="">제목2</th></tr> 
  </thead><tbody><tr><td style=text-align:center>A</td><td <style=text-align:center
  >B</td></tr><tr><td style=text-align:center>C</td><td style=text-align:center>
  D</td></tr></tbody></table>' 

위 결과는 다음과 같습니다.

제목1	제목2
A	B
C	D

위 과정을 시각화하면 그림 2와 같습니다.

그림. 2. 함수와 장식자.

장식자를 적용한 함수는 결국 하나의 함수 결과로 간주할 수 있습니다. 이것은 그 결과에 다른 장식자를 적용할 수 있다는 의미입니다. 다음 예는 문장열을 HTML의 'b'태그와 'u'태그를 적용하기 위한 것입니다.

def underline(func):
    def wrap():
        return f'<u>{func()}</u>'
    return wrap

def bold(func):
    def wrap():
        return f'<b>{func()}</b>'
    return wrap

@underline
@bold
def strings2():
    return 'hello, world!'

strings2()

'<u><b>hello, world!</b></u>'

이것은 장식자가 적용된 순서를 아래에서 위로 명확하게 보여줍니다. 먼저 입력 함수가 @bold에 의해 래핑된 다음 결과(데코레이트된) 함수가 @underline 에 의해 다시 래핑되었습니다. 그 순서에 따른 결과를 다음과 같이 나타내면 더욱 명확해 집니다.

def strings3():
    return 'hello, world!'

underline(bold(strings3))()

'<u><b>hello, world!</b></u>'

장식자에 전달되는 인수는 내장 메소드 __call__()를 가지고 있는 호출가능한(callable) 객체입니다. 즉 인수가 전달되어야 하는 일급객체이어야 합니다.

'__call__' in dir(bold)

True

'__call__' in dir(underline)

True

'__call__' in dir(strings2)

True

필요한 모든 인수가 전달되어 평가된 결과이면 인수를 더 이상 전달할 수 없게 되므로 단순 객체입니다. 그러므로 다음은 예외를 발생합니다.

bold(strings3)()

'<b>hello, world!</b>'

callable(bold(strings3)())

False

underline(bold(strings3)())()

TypeError: 'str' object is not callable

장식자에서 최종으로 실행되는 함수는 중첩함수입니다. 이 부분은 내장 메소드인 callable 객체의 이름을 반환하는 __name__에 의해 확인할 수 있습니다.

underline(bold(strings3)).__name__

'wrap'