23. 키워드 인자로 선택적인 기능을 제공하라¶

함수를 호출할때 위치에 따라 인자를 넘길 수 있다

In [1]:

def remainder(number, divisor):
    return number % divisor

In [2]:

assert remainder(20, 7) == 6

In [3]:

remainder(20, 7)

Out[3]:

In [4]:

remainder(20, divisor=7)

Out[4]:

In [5]:

remainder(number=20, divisor=7)

Out[5]:

In [6]:

remainder(divisor=7, number=20)

Out[6]:

In [7]:

remainder(number=20, 7)

  File "<ipython-input-7-9265fd4030d2>", line 1
    remainder(number=20, 7)
                         ^
SyntaxError: positional argument follows keyword argument

In [8]:

remainder(20, number=7)

---------------------------------------------------------------------------
TypeError                                 Traceback (most recent call last)
<ipython-input-8-f2d03bd9e009> in <module>
----> 1 remainder(20, number=7)

TypeError: remainder() got multiple values for argument 'number'

딕셔너리의 내용물을 사용해 remainder와 같은 함수를 호출하고 싶다면 **연산자를 사용할 수 있다.

In [9]:

my_kwargs = {
    'number': 20,
    'divisor': 7
}

In [10]:

assert remainder(**my_kwargs) == 6

** 연산자를 위치 인자나 키워드 인자와 섞어서 함수를 호출할 수 있다. 다만 중복되는 인자가 없어야 한다.

In [11]:

my_kwargs = {
    'divisor': 7,
}

In [12]:

assert remainder(number=20, **my_kwargs) == 6

** 연산자를 여러 번 사용할 수도 있다. 다만 여러 딕셔너리에 겹치는 키가 없어야 한다.

In [16]:

my_kwargs = {
    'number': 20,
}

In [17]:

other_kwargs = {
    'divisor': 7,
}

In [18]:

assert remainder(**my_kwagrs, **other_kwargs) == 6

아무 키워드 인자나 받는 함수를 만들고 싶다면, 모든 키워드 인자를 dict에 모아주는 **kwargs 라는 파라미터를 사용한다.

In [21]:

def print_parameters(**kwargs):
    for key, value in kwargs.items():
        print(f'{key} = {value}')

In [22]:

print_parameters(alpha=1.5, beta=9, 감마=4)

alpha = 1.5
beta = 9
감마 = 4

키워드 인자가 제공하는 세가지 이점

코드를 처음 보는 사람들에게 함수 호출의 의미를 명확히 알려줄 수 있다.
함수 정의에서 디폴트 값을 지정할 수 있다.

In [23]:

def flow_rate(weight_Diff, time_diff):
    return weight_diff / time_diff

In [25]:

weight_diff = 0.5
time_diff = 3
flow = flow_rate(weight_diff, time_diff)

In [26]:

print(f'{flow:.3} kg/s')

0.167 kg/s

In [27]:

def flow_rate(weight_Diff, time_diff, period):
    return (weight_diff / time_diff) * period

In [28]:

flow_per_second = flow_rate(weight_diff, time_diff, 1)

In [29]:

flow_per_second

Out[29]:

0.16666666666666666

In [30]:

def flow_rate(weight_Diff, time_diff, period=1):
    return (weight_diff / time_diff) * period

In [31]:

flow_per_second = flow_rate(weight_diff, time_diff)

In [32]:

flow_per_hour = flow_rate(weight_diff, time_diff, period=3600)

어떤 함수를 사용하던 기존 호출자에게는 하위 호환성을 제공하면서 함수 파라미터를 확장할 수 있는 방법을 제공한다는 것이다.

In [33]:

def flow_rate(weight_Diff, time_diff, period=1, units_per_kg=1):
    return ((weight_diff / units_per_kg) / time_diff) * period

In [35]:

flow_per_hour = flow_rate(weight_diff, time_diff, period=3600, units_per_kg=2.2)

In [37]:

flow_per_hour

Out[37]:

272.72727272727275

선택적 인자를 위치인자로 지정하면 혼동을 야기할 수 있다.

따라서 항상 키워드 인자를 사용하고 위치 인자를 절대 사용하지 않는 것

기억해야 할 내용¶

함수 인자를 위치에 따라 지정할 수도 있고, 키워드를 사용해 지정할 수도 있다.
키워드를 사용하면 위치 인자만 사용할 떄는 혼동할 수 있는 여러 인자의 목적을 명확히 할 수 있다.
키워드 인자와 디폴트 값을 함께 사용하면 기본 호출 코드를 마이그레이션하지 않고도 함수에 새로운 기능을 쉽게 추가할 수 있다.
선택적 키워드 인자는 항상 위치가 아니라 키워드를 사용해 전달돼야 한다.