使用預設參數的可變參數
Python是支援可變參數的,最簡單的方法莫過於使用預設參數,例如:
def test_defargs(one, two = 2): print 'Required argument: ', one print 'Optional argument: ', two test_defargs(1) # result: # Required argument: 1 # Optional argument: 2 test_defargs(1, 3) # result: # Required argument: 1 # Optional argument: 3
在函數定義時使用*args和**kwargs
當然,本文主要講一個達到可變參數(Variable Argument) 的方法:使用*args和**kwargs語法。其中,*args是可變的positional arguments列表,**kwargs是可變的keyword arguments列表。並且,*args必須位於**kwargs之前,因為positional arguments必須位於keyword arguments之前。
首先介紹兩者的基本用法。
下面一個例子使用*args,同時包含一個必須的參數:
def test_args(first, *args): print 'Required argument: ', first for v in args: print 'Optional argument: ', v test_args(1, 2, 3, 4) # result: # Required argument: 1 # Optional argument: 2 # Optional argument: 3 # Optional argument: 4
下面一個例子使用*kwargs, 同時包含一個必須的參數和*args列表:
def test_kwargs(first, *args, **kwargs): print 'Required argument: ', first for v in args: print 'Optional argument (*args): ', v for k, v in kwargs.items(): print 'Optional argument %s (*kwargs): %s' % (k, v) test_kwargs(1, 2, 3, 4, k1=5, k2=6) # results: # Required argument: 1 # Optional argument (*args): 2 # Optional argument (*args): 3 # Optional argument (*args): 4 # Optional argument k2 (*kwargs): 6 # Optional argument k1 (*kwargs): 5
在函數調用時,使用*args和* *kwargs
*args和**kwargs語法不只可以在函式定義中使用,同樣可以在函式呼叫的時候使用。不同的是,如果說在函數定義的位置使用*args和**kwargs是一個將參數pack的過程,那麼在函數呼叫的時候就是一個將參數unpack的過程了。以下使用一個例子來加深理解:
def test_args(first, second, third, fourth, fifth): print 'First argument: ', first print 'Second argument: ', second print 'Third argument: ', third print 'Fourth argument: ', fourth print 'Fifth argument: ', fifth # Use *args args = [1, 2, 3, 4, 5] test_args(*args) # results: # First argument: 1 # Second argument: 2 # Third argument: 3 # Fourth argument: 4 # Fifth argument: 5 # Use **kwargs kwargs = { 'first': 1, 'second': 2, 'third': 3, 'fourth': 4, 'fifth': 5 } test_args(**kwargs) # results: # First argument: 1 # Second argument: 2 # Third argument: 3 # Fourth argument: 4 # Fifth argument: 5
使用*args和**kwargs可以非常方便的定義函數,同時可以加強擴展性,以便日後的程式碼維護。
示例
def foo(*args, **kwargs): print('args = ', args) print('kwargs = ', kwargs) print('---------------------------------------') if __name__ == '__main__': foo(1,2,3,4) foo(a=1,b=2,c=3) foo(1,2,3,4, a=1,b=2,c=3) foo('a', 1, None, a=1, b='2', c=3)
注意
注:在定義或調用這種函數時,要遵循以下規則:
可變參數一定在不可變參數之後
*args是可變的positional arguments列表,**kwargs是可變的keyword arguments列表。並且,*args必須位於**kwargs之前,因為positional arguments必須位於keyword arguments之前