** kwargs의 목적과 사용은 무엇입니까?


763

**kwargs파이썬에서 어떤 용도로 사용 됩니까?

나는 당신 objects.filter이 테이블에서 할 수 있고 **kwargs인수를 전달할 수 있다는 것을 알고 있습니다 .  

타임 델타를 지정하기 위해 이것을 할 수 있습니까 timedelta(hours = time1)?

정확히 어떻게 작동합니까? 클래스는 '포장 풀기'로되어 있습니까? 처럼 a,b=1,2?


27
나처럼이 질문에 부딪 치면 * args와 ** kwargs?
sumid 2019

3
두드러지게 간결한 설명은 여기 "튜플에 *를 수집하는 모든 위치 인수가", "** 사전에있는 모든 키워드 인수를 수집합니다." 핵심 단어는 수집합니다 .
osa

24
그냥 참고 : kwargs약자 KeyWord ARGumentS키를 설정, 즉 인수
리처드 드 위트

답변:


868

**kwargs함수가 임의의 수의 키워드 인수를 사용 하도록 할 수 있습니다 ( "kwargs"는 "키워드 인수"를 의미 함).

>>> def print_keyword_args(**kwargs):
...     # kwargs is a dict of the keyword args passed to the function
...     for key, value in kwargs.iteritems():
...         print "%s = %s" % (key, value)
... 
>>> print_keyword_args(first_name="John", last_name="Doe")
first_name = John
last_name = Doe

**kwargs키워드 인수 사전을 구성하여 함수에 전달하여 함수를 호출 할 때 구문 을 사용할 수도 있습니다 .

>>> kwargs = {'first_name': 'Bobby', 'last_name': 'Smith'}
>>> print_keyword_args(**kwargs)
first_name = Bobby
last_name = Smith

파이썬 자습서 는 몇 가지 좋은 예와 함께 작동하는 방법의 좋은 설명이 포함되어 있습니다.

<-업데이트->

iteritems () 대신 Python 3을 사용하는 사람들은 items ()


1
@ yashas123 아니요; 비어있는 것을 반복하면 아무 일도 일어나지 않으므로 다음에 올 코드는 정상적으로 실행됩니다.
JG

330

포장 풀기 사전

** 사전의 압축을 풉니 다.

func(a=1, b=2, c=3)

와 같다

args = {'a': 1, 'b': 2, 'c':3}
func(**args)

매개 변수를 구성해야하는 경우 유용합니다.

args = {'name': person.name}
if hasattr(person, "address"):
    args["address"] = person.address
func(**args)  # either expanded to func(name=person.name) or
              #                    func(name=person.name, address=person.address)

함수의 패킹 파라미터

def setstyle(**styles):
    for key, value in styles.iteritems():      # styles is a regular dictionary
        setattr(someobject, key, value)

이를 통해 다음과 같은 기능을 사용할 수 있습니다.

setstyle(color="red", bold=False)

13
kwarg는 변수 이름 일 뿐입니 까? 그래서 def func (** args)를 사용할 수 있습니다.
스리 람

11
@Sriram : 그렇습니다. 별표가 중요합니다. kwargs 는 더 나은 것이 없다면 이름입니다. (보통 있습니다.)
Georg Schölly

54
@Sriram : 가독성을 위해 kwargs를 고수해야 합니다.
johndodo

12
** do unpack dictionaries.>> 마음이 날 것입니다 / 물론! 그 비트를 설명하기 위해 +1.
Marc

13
참고 : 파이썬 3에서 .iteritems()이름이 바뀌 었습니다 .items().
fnkr

67

kwargs는 매개 변수에 추가 된 사전 일뿐입니다.

사전은 키, 값 쌍을 포함 할 수 있습니다. 그리고 그것은 kwargs입니다. 자, 이것이 방법입니다.

무엇을 위해 그렇게 간단하지 않습니다.

예를 들어 (매우 가정적인) 작업을 수행하기 위해 다른 루틴을 호출하는 인터페이스가 있습니다.

def myDo(what, where, why):
   if what == 'swim':
      doSwim(where, why)
   elif what == 'walk':
      doWalk(where, why)
   ...

이제 새로운 방법 "드라이브"를 얻습니다.

elif what == 'drive':
   doDrive(where, why, vehicle)

그러나 잠시만 기다려주십시오. 새로운 매개 변수 "차량"이 있습니다. 이전에는 몰랐습니다. 이제이를 myDo 함수의 서명에 추가해야합니다.

여기에서 크워 그를 던져 넣을 수 있습니다. 서명에 크워 그를 추가하기 만하면됩니다.

def myDo(what, where, why, **kwargs):
   if what == 'drive':
      doDrive(where, why, **kwargs)
   elif what == 'swim':
      doSwim(where, why, **kwargs)

이렇게하면 호출 된 루틴 중 일부가 변경 될 때마다 인터페이스 기능의 서명을 변경할 필요가 없습니다.

이것은 kwargs가 도움이 될만한 좋은 예입니다.


46

좋은 샘플이 때로는 긴 담화보다 낫다는 것을 기초로 모든 파이썬 변수 인수 전달 기능 (위치 및 명명 된 인수 모두)을 사용하여 두 개의 함수를 작성합니다. 자신이하는 일을 쉽게 볼 수 있어야합니다.

def f(a = 0, *args, **kwargs):
    print("Received by f(a, *args, **kwargs)")
    print("=> f(a=%s, args=%s, kwargs=%s" % (a, args, kwargs))
    print("Calling g(10, 11, 12, *args, d = 13, e = 14, **kwargs)")
    g(10, 11, 12, *args, d = 13, e = 14, **kwargs)

def g(f, g = 0, *args, **kwargs):
    print("Received by g(f, g = 0, *args, **kwargs)")
    print("=> g(f=%s, g=%s, args=%s, kwargs=%s)" % (f, g, args, kwargs))

print("Calling f(1, 2, 3, 4, b = 5, c = 6)")
f(1, 2, 3, 4, b = 5, c = 6)

그리고 출력은 다음과 같습니다.

Calling f(1, 2, 3, 4, b = 5, c = 6)
Received by f(a, *args, **kwargs) 
=> f(a=1, args=(2, 3, 4), kwargs={'c': 6, 'b': 5}
Calling g(10, 11, 12, *args, d = 13, e = 14, **kwargs)
Received by g(f, g = 0, *args, **kwargs)
=> g(f=10, g=11, args=(12, 2, 3, 4), kwargs={'c': 6, 'b': 5, 'e': 14, 'd': 13})

28

주제는 : *args**kwargs필요 함수 호출에 전달 될 수있는 인수에 대한 자리 표시 자 역할을

함수를 사용 *args하고 **kwargs호출하기

def args_kwargs_test(arg1, arg2, arg3):
    print "arg1:", arg1
    print "arg2:", arg2
    print "arg3:", arg3

이제 *args위에서 정의한 함수를 호출하는 데 사용할 것입니다

#args can either be a "list" or "tuple"
>>> args = ("two", 3, 5)  
>>> args_kwargs_test(*args)

결과:

arg1 : 2 개의
arg2 : 3
arg3 : 5


이제 **kwargs같은 함수를 호출하는 데 사용

#keyword argument "kwargs" has to be a dictionary
>>> kwargs = {"arg3":3, "arg2":'two', "arg1":5}
>>> args_kwargs_test(**kwargs)

결과:

arg1 : 5
arg2 : 2 개의
arg3 : 3

결론 : *args지능이 없으며, 전달 된 인수를 매개 변수 (왼쪽에서 오른쪽 순서로)에 보간하면서 **kwargs필요한 위치에서 적절한 값을 배치하여 지능적으로 동작합니다.


24
  • kwargsin **kwargs은 변수 이름입니다. 당신은 아주 잘 할 수 있습니다**anyVariableName
  • kwargs"키워드 인수"를 나타냅니다. 그러나 나는 그것들이 단순히 이름과 함께 전달되는 인수이기 때문에 "명명 된 인수"로 불리워 져야한다고 느낍니다. 프로그래밍 언어로 예약 된 단어이므로 프로그래머가 변수 이름으로 사용하지 않아야합니다. 따라서 값만 전달하는 대신 다음과 같이 함수에 전달 된 이름 param1param2두 개의 매개 변수 값을 제공합니다 . 따라서, 나는 그들이 적절하게 호출 할 수 있어야한다고 생각한다 "명명 된 인수의 임의의 숫자" 우리는 이러한 매개 변수의 수를 (지정할 수있는,func(param1="val1",param2="val2")func(val1,val2)funcfunc(**kwargs)

"명명 된 인수"를 먼저 설명한 다음 "임의의 수의 명명 된 인수"를 설명하겠습니다 kwargs.

명명 된 인수

  • 명명 된 인수는 위치 인수를 따라야합니다.
  • 명명 된 인수의 순서는 중요하지 않습니다
  • def function1(param1,param2="arg2",param3="arg3"):
        print("\n"+str(param1)+" "+str(param2)+" "+str(param3)+"\n")
    
    function1(1)                      #1 arg2 arg3   #1 positional arg
    function1(param1=1)               #1 arg2 arg3   #1 named arg
    function1(1,param2=2)             #1 2 arg3      #1 positional arg, 1 named arg
    function1(param1=1,param2=2)      #1 2 arg3      #2 named args       
    function1(param2=2, param1=1)     #1 2 arg3      #2 named args out of order
    function1(1, param3=3, param2=2)  #1 2 3         #
    
    #function1()                      #invalid: required argument missing
    #function1(param2=2,1)            #invalid: SyntaxError: non-keyword arg after keyword arg
    #function1(1,param1=11)           #invalid: TypeError: function1() got multiple values for argument 'param1'
    #function1(param4=4)              #invalid: TypeError: function1() got an unexpected keyword argument 'param4'

임의의 명명 된 인수 kwargs

  • 기능 매개 변수 순서 :
    1. 위치 매개 변수
    2. 임의의 수의 인수를 캡처하는 공식 매개 변수 (*로 시작)
    3. 명명 된 공식 매개 변수
    4. 임의의 수의 명명 된 매개 변수를 캡처하는 공식 매개 변수 (접두사 **)
  • def function2(param1, *tupleParams, param2, param3, **dictionaryParams):
        print("param1: "+ param1)
        print("param2: "+ param2)
        print("param3: "+ param3)
        print("custom tuple params","-"*10)
        for p in tupleParams:
            print(str(p) + ",")
        print("custom named params","-"*10)
        for k,v in dictionaryParams.items():
            print(str(k)+":"+str(v))
    
    function2("arg1",
              "custom param1",
              "custom param2",
              "custom param3",
              param3="arg3",
              param2="arg2", 
              customNamedParam1 = "val1",
              customNamedParam2 = "val2"
              )
    
    # Output
    #
    #param1: arg1
    #param2: arg2
    #param3: arg3
    #custom tuple params ----------
    #custom param1,
    #custom param2,
    #custom param3,
    #custom named params ----------
    #customNamedParam2:val2
    #customNamedParam1:val1

사용자 정의 인수에 대한 튜플 및 dict 변수 전달

그것을 끝내기 위해, 우리는 또한 통과 할 수 있음에 유의하십시오.

  • 튜플 변수로 "임의의 수의 인수를 캡처하는 공식 매개 변수"
  • dict 변수로 "명명 된 매개 변수의 임의 수를 캡처하는 공식 매개 변수"

따라서 위와 동일한 호출이 다음과 같이 이루어질 수 있습니다.

tupleCustomArgs = ("custom param1", "custom param2", "custom param3")
dictCustomNamedArgs = {"customNamedParam1":"val1", "customNamedParam2":"val2"}

function2("arg1",
      *tupleCustomArgs,    #note *
      param3="arg3",
      param2="arg2", 
      **dictCustomNamedArgs     #note **
      )

마지막으로주의 *** 위의 함수를 호출한다. 생략하면 결과가 나빠질 수 있습니다.

*튜플 인수 생략 :

function2("arg1",
      tupleCustomArgs,   #omitting *
      param3="arg3",
      param2="arg2", 
      **dictCustomNamedArgs
      )

인쇄물

param1: arg1
param2: arg2
param3: arg3
custom tuple params ----------
('custom param1', 'custom param2', 'custom param3'),
custom named params ----------
customNamedParam2:val2
customNamedParam1:val1

튜플 위 ('custom param1', 'custom param2', 'custom param3') 은 그대로 인쇄됩니다.

dict인수 생략 :

function2("arg1",
      *tupleCustomArgs,   
      param3="arg3",
      param2="arg2", 
      dictCustomNamedArgs   #omitting **
      )

준다

dictCustomNamedArgs
         ^
SyntaxError: non-keyword arg after keyword arg

3
keyword용어가 키-값 쌍의 데이터베이스 인 dict을 전달한다는 사실에서 비롯된 용어 라고 생각합니다 .
crobar

"키"-값 쌍의 "키"단어를 의미합니까? 또한 일반적으로 데이터베이스라고하는 것이 아니라 사전입니다. 그러나 여전히 "키워드"라는 단어의 사용법에 대한 의미를 찾을 수 없습니다.
Mahesha999

9

또한 kwargs 함수를 호출 할 때 다양한 사용 방법을 혼합 할 수도 있습니다.

def test(**kwargs):
    print kwargs['a']
    print kwargs['b']
    print kwargs['c']


args = { 'b': 2, 'c': 3}

test( a=1, **args )

이 출력을 제공합니다.

1
2
3

** kwargs는 마지막 인수 여야합니다.


5

kwargs는 이름 인수를 사전 (func)으로 또는 사전을 명명 된 인수 (func)로 전달하는 구문 설탕입니다.


5

사용법을 설명하는 간단한 기능은 다음과 같습니다.

def print_wrap(arg1, *args, **kwargs):
    print(arg1)
    print(args)
    print(kwargs)
    print(arg1, *args, **kwargs)

않은 모든 인수 하지 함수 정의에 지정된는에 넣어 될 것입니다 args목록, 또는 kwargs그들이 키워드 인자인지 여부에 따라 목록 :

>>> print_wrap('one', 'two', 'three', end='blah', sep='--')
one
('two', 'three')
{'end': 'blah', 'sep': '--'}
one--two--threeblah

함수에 전달되지 않는 키워드 인수를 추가하면 오류가 발생합니다.

>>> print_wrap('blah', dead_arg='anything')
TypeError: 'dead_arg' is an invalid keyword argument for this function

1

도움이 되길 바랍니다.

#! /usr/bin/env python
#
def g( **kwargs) :
  print ( "In g ready to print kwargs" )
  print kwargs
  print ( "in g, calling f")
  f ( **kwargs )
  print ( "In g, after returning from f")

def f( **kwargs ) :
  print ( "in f, printing kwargs")
  print ( kwargs )
  print ( "In f, after printing kwargs")


g( a="red", b=5, c="Nassau")

g( q="purple", w="W", c="Charlie", d=[4, 3, 6] )

프로그램을 실행하면 다음과 같은 이점이 있습니다.

$ python kwargs_demo.py 
In g ready to print kwargs
{'a': 'red', 'c': 'Nassau', 'b': 5}
in g, calling f
in f, printing kwargs
{'a': 'red', 'c': 'Nassau', 'b': 5}
In f, after printing kwargs
In g, after returning from f
In g ready to print kwargs
{'q': 'purple', 'c': 'Charlie', 'd': [4, 3, 6], 'w': 'W'}
in g, calling f
in f, printing kwargs
{'q': 'purple', 'c': 'Charlie', 'd': [4, 3, 6], 'w': 'W'}
In f, after printing kwargs
In g, after returning from f

여기서 중요한 것은 호출에서 명명 된 인수의 변수 수가 함수의 사전으로 변환된다는 것입니다.


0

python unpacking 에 대해 이해하기위한 간단한 예제입니다 .

>>> def f(*args, **kwargs):
...    print 'args', args, 'kwargs', kwargs

eg1 :

>>>f(1, 2)
>>> args (1,2) kwargs {} #args return parameter without reference as a tuple
>>>f(a = 1, b = 2)
>>> args () kwargs {'a': 1, 'b': 2} #args is empty tuple and kwargs return parameter with reference as a dictionary

0

Java에서는 생성자를 사용하여 클래스를 오버로드하고 여러 입력 매개 변수를 허용합니다. 파이썬에서는 kwargs를 사용하여 유사한 동작을 제공 할 수 있습니다.

자바 예 : https://beginnersbook.com/2013/05/constructor-overloading/

파이썬 예제 :

class Robot():
    # name is an arg and color is a kwarg
    def __init__(self,name, color='red'):
        self.name = name
        self.color = color

red_robot = Robot('Bob')
blue_robot = Robot('Bob', color='blue')

print("I am a {color} robot named {name}.".format(color=red_robot.color, name=red_robot.name))
print("I am a {color} robot named {name}.".format(color=blue_robot.color, name=blue_robot.name))

>>> I am a red robot named Bob.
>>> I am a blue robot named Bob.

그것에 대해 생각하는 또 다른 방법.


0

키워드 인수는 종종 파이썬 에서 kwargs 로 단축됩니다 . 에서 컴퓨터 프로그래밍 ,

키워드 인수는 함수 호출 내에서 각 매개 변수의 이름을 명확하게 나타내는 함수 호출에 대한 컴퓨터 언어의 지원을 나타냅니다.

매개 변수 이름 앞에 두 개의 별표를 사용한 경우 ** kwargs 하면 함수에 몇 개의 키워드 인수가 전달되는지 알 수 없습니다. 이 경우 임의 / 와일드 카드 키워드 인수라고합니다.

이것의 한 예는 Django의 리시버 함수 입니다.

def my_callback(sender, **kwargs):
    print("Request finished!")

이 함수는 와일드 카드 키워드 인수 (** kwargs)와 함께 발신자 인수를 사용합니다. 모든 신호 핸들러는이 인수를 사용해야합니다. 모든 신호는 키워드 인수를 전송하며 언제든지 키워드 인수를 변경할 수 있습니다. request_finished 의 경우 인수를 보내지 않는 것으로 문서화되어 신호 처리를 my_callback (sender)로 작성하려고 할 수 있습니다.

이것은 틀렸을 것입니다. 실제로 장고는 그렇게하면 오류를 던질 것입니다. 어떤 시점에서든 인수가 신호에 추가 될 수 있고 수신자가 새로운 인수를 처리 할 수 ​​있어야하기 때문입니다.

kwargs 라고 할 필요는 없지만 **가 있어야합니다 (이름 kwargs 는 규칙 임).

당사 사이트를 사용함과 동시에 당사의 쿠키 정책개인정보 보호정책을 읽고 이해하였음을 인정하는 것으로 간주합니다.
Licensed under cc by-sa 3.0 with attribution required.