Python の関数パラメーター受け渡しメソッド *args、**kwargs など

この記事では、Python の関数パラメータについて説明します。 args と **kwargs、/ と とは何かについて学びます。この質問は Python の基本的な質問ですが、コードを書くときによく遭遇します。たとえば、timm で広く使用されています。この方法でパラメータを渡します。

パラメータの定義と受け渡し

パラメータと引数の違いは何ですか?

多くの人がこれらの用語を同じ意味で使用していますが、は違いです:

• パラメータは関数定義で定義された名前です
• 引数は関数に渡される値です

#赤いものはパラメータ、緑のものは引数です。

パラメータを渡す 2 つの方法

パラメータは位置とキーワードによって渡すことができます。次の例では、値 hello を位置パラメータとして渡します。値ワールドはキーワードを使用して渡されます。

 def the_func(greeting, thing):
 print(greeting + ' ' + thing)
 
 the_func('hello', thing='world')

位置パラメータと kwargs (キーワード パラメータ) の違いは、位置パラメータを渡す順序が重要であるということです。 the_func('world', 'hello') を呼び出すと、world hello が出力されます。 kwarg が渡される順序は重要ではありません:

the_func('hello', 'world')# -> 'hello world'
the_func('world', 'hello')# -> 'world hello'
the_func(greeting='hello', thing='world') # -> 'hello world'
the_func(thing='world', greeting='hello') # -> 'hello world'
the_func('hello', thing='world')# -> 'hello world'

kwarg が位置パラメータの後に来る限り、位置引数とキーワード引数を組み合わせて一致させることができます。 Python チュートリアルでよく見かける内容ですが、以下に進みましょう。

関数パラメータ

すべての問題をカバーできる、関数パラメータを渡す 6 つの方法を示します。

1. 捕捉されなかった位置パラメータをすべて取得する方法

*args を使用して、不特定数の仮パラメータを受信できるようにします。

def multiply(a, b, args):
result = a * b
for arg in args:
result = result * arg
return result

この関数では、通常、最初の 2 つのパラメータ (a と b) を定義します。次に、args を使用して、残りの引数をすべてタプルにパックします。 * は、他の未処理パラメータを取得し、それらを「args」という名前のタプル変数に収集すると考えることができます。

multiply(1, 2)# returns 2
multiply(1, 2, 3, 4)# returns 24

最後の呼び出しの値は 1 になります。パラメータ a に割り当て、2 を割り当てます。パラメータ b に代入し、arg 変数に (3,4) を代入します。これはタプルなので、関数内でループして乗算に値を使用できます!

2. キャッチされていないすべてのキーワード引数を取得する方法

*args と同様に、これはその後に 2 つのアスタリスクが続きます **kwargs

def introduce(firstname, lastname, **kwargs):
introduction = f"I am {firstname} {lastname}"
for key, value in kwargs.items():
introduction += f" my {key} is {value} "
return introduction

**kwargs キーワードは、一致しないすべてのキーワード引数を kwargs という辞書に保存します。この辞書には、上記の関数と同様にアクセスできます。

 print(introduce(firstname='mike', lastname='huls'))
 # returns "I am mike huls"
 
 print(introduce(firstname='mike', lastname='huls', age=33, website='mikehuls.com'))
 # I am mike huls my age is 33 my website is overfit.cn

3. キーワード パラメーターのみを受け入れたい場合、

の設計方法により、関数がキーワード パラメーターのみを受け入れるように強制できます。

 def transfer_money(*, from_account:str, to_account:str, amount:int):
 print(f'Transfering ${amount} FORM {from_account} to {to_account}')
 
 transfer_money(from_account='1234', to_account='6578', amount=9999)
 # won't work: TypeError: transfer_money() takes 0 positional arguments but 1 positional argument (and 2 keyword-only arguments) were given
 transfer_money('1234', to_account='6578', amount=9999)
 # won't work: TypeError: transfer_money() takes 0 positional arguments but 3 were given
 transfer_money('1234', '6578', 9999)

上記の関数では、* アスタリスクは一致しない位置パラメータをすべて取得しますが、それを受け入れる変数がないため、無視されます。

4. 位置パラメーターのみを受け入れる関数の設計方法

次は、位置パラメーターのみを受け入れる関数の例です: 関数定義内の

 def the_func(arg1:str, arg2:str, /):
 print(f'provided {arg1=}, {arg2=}')
 
 # These work:
 the_func('num1', 'num2')
 the_func('num2', 'num1')
 
 # won't work: TypeError: the_func() got some positional-only arguments passed as keyword arguments: 'arg1, arg2'
 the_func(arg1='num1', arg2='num2')
 # won't work: TypeError: the_func() got some positional-only arguments passed as keyword arguments: 'arg2'
 the_func('num1', arg2='num2')

/その前にあるものをすべて強制します。パラメータはすべて位置パラメータです。これは、/ に続くすべての引数が kwarg のみである必要があるという意味ではなく、これらは位置およびキーワードである可能性があります。

これを見たら、きっとこう思うでしょう、なぜこれが必要なのでしょうか? コードの可読性が低下するのではありませんか? 私もあなたの意見は非常に正しいと思います。非常に明確な関数を定義する場合、キーワードは必要ありません機能を指定するには引数が必要です。例:

def exceeds_100_bytes(x, /) -> bool:
 return x.__sizeof__() > 100
 
 exceeds_100_bytes('a')
 exceeds_100_bytes({'a'})

この例では、「a」のメモリ サイズが 100 バイトを超えているかどうかを確認しています。この x の名前は私たちにとって重要ではないため、関数を呼び出すときに x='a' を指定する必要はありません。たとえば、最も一般的に使用される len は、len(__obj=[]) を呼び出した場合、少しばかげているように見えますか。なぜなら、len は次のように定義されているからです。 def len(__obj: Sized) -> int:

5. 混合とマッチング

例として、前に説明した len 関数を見てみましょう。この関数は位置引数のみを許可します。この関数を拡張して、開発者が重複をカウントするかどうかを選択できるようにします。たとえば、このキーワードを kwargs で渡すようにします。

 def len_new(x, /, *, no_duplicates=False):
 if (no_duplicates):
 return len(list(set([a for a in x])))
 return len(x)

変数 x の len を計算したい場合は、パラメータの前に / が付いているためです。 no_duplicate パラメータは の後に続くため、キーワードと一緒に渡す必要があります。この関数をどのように呼び出すことができるかを見てみましょう:

print(len_new('aabbcc'))# returns 6
 print(len_new('aabbcc', no_duplicates=True))# returns 3
 print(len_new([1, 1, 2, 2, 3, 3], no_duplicates=False)) # returns 6
 print(len_new([1, 1, 2, 2, 3, 3], no_duplicates=True))# returns 3
 
 # Won't work: TypeError: len_() got some positional-only arguments passed as keyword arguments: 'x'
 print(len_new(x=[1, 1, 2, 2, 3, 3]))
 # Won't work: TypeError: len_new() takes 1 positional argument but 2 were given
 print(len_new([1, 1, 2, 2, 3, 3], True))

6. 最後にそれらをまとめます

次の関数は、これまでに説明したテクニックをすべて組み合わせる方法の非常に極端な例です。位置的に渡される 2 つのパラメータ、次の 2 つのパラメータは位置およびキーワードとともに渡すことができ、次に 2 つのキーワードのみのパラメータ、そして残りを **kwargs でキャプチャします。 キャッチされないパラメータ。

 def the_func(pos_only1, pos_only2, /, pos_or_kw1, pos_or_kw2, *, kw1, kw2, **extra_kw):
 # cannot be passed kwarg <-- | --> can be passed 2 ways | --> can only be passed by kwarg
 print(f"{pos_only1=}, {pos_only2=}, {pos_or_kw1=}, {pos_or_kw2=}, {kw1=}, {kw2=}, {extra_kw=}")

呼び出しメソッドは次のとおりです:

# works (pos_or_kw1 & pow_or_k2 can be passed positionally and by kwarg)
 pos_only1='pos1', pos_only2='pos2', pos_or_kw1='pk1', pos_or_kw2='pk2', kw1='kw1', kw2='kw2', extra_kw={}
 pos_only1='pos1', pos_only2='pos2', pos_or_kw1='pk1', pos_or_kw2='pk2', kw1='kw1', kw2='kw2', extra_kw={}
 pos_only1='pos1', pos_only2='pos2', pos_or_kw1='pk1', pos_or_kw2='pk2', kw1='kw1', kw2='kw2', extra_kw={'kw_extra1': 'extra_kw1'}
 
 # doesnt work, (pos1 and pos2 cannot be passed with kwarg)
 # the_func(pos_only1='pos1', pos_only2='pos2', pos_or_kw1='pk1', pos_or_kw2='pk2', kw1='kw1', kw2='kw2')
 
 # doesnt work, (kw1 and kw2 cannot be passed positionally)
 # the_func('pos1', 'pos2', 'pk1', 'pk2', 'kw1', 'kw2')

概要

ごちゃごちゃしてますね?そうです。 Python は設計時に非常に緩い言語なので、仕様はそれほど多くなく、多くの人が使うほど使用するメソッドが増え、このようになります。

それでは、最初の写真に戻ります:

def func(x,/,y,,z,**k):

(x,/,y,,z,**k):是函数的参数。总共有四个参数:

• x: 是一个常规参数，这意味着它可以按位置传递，也可以按关键字传递。
• /,: 是一个参数分隔符，将仅限位置的参数与其他参数分开。与前面的x结合，意味着x只能按位置传递。
• y: 时另一个常规参数。
• *: 是一个参数分隔符，用于分隔仅限位置参数和仅限关键字参数。它意味着后面的z只能通过关键字传递。
• z: 是一个仅限关键字的参数。
• **k: 这是一个参数，将所有剩余的关键字参数收集到一个名为' k '的字典中。

这样解释是不是就很明白了。

我们今天介绍的这个例子虽然在看源代码时没有遇到这么复杂的情况，但是在 面试 的时候还真有人问（虽然我觉得没啥用），所以最好还是知道一些，以免尴尬。

如果你忘记了，这里可以教你一个变通的办法，可以使用类似的回答：

上面的参数传递在开发时并不常用，因为对于开发规范来说，应该保证代码的可读性，我们这边遵循的开发规范是：

1、尽量不要在函数定义中将可变位置参数 *args 和可变关键字参数 **kwargs 放在一起，因为这样会让函数的调用方式变得不太直观。

2、在使用可变参数时，要保证函数的行为是可预测的。上面函数中的进行了太多的python语法糖，对于理解该函数的参数会造成很大的困惑，也就是可读性太差，我们在进行codereview（如果你了解什么是codereview就说，不了解就说组长检查）/组长merge代码 时会直接要求返工，所以我们在实际开发时是不会用这个的。

对于我阅读的开源代码，也都基本上使用的是 **kwargs这种情况（这里可以举两个例子），还没有看到有人写这么乱的代码，我想要是写这样的代码估计开源的人也会被人吐糟（这里自己可以自行延伸），所以这些参数传递的规则我在学习的时候看到过，但是实际中没见过真正使用，就不太记住了。

回到本文，我们介绍了设计函数参数的所有方法，并了解了如何混合和匹配它们，虽然后面几个内容可能你一辈子也不会用到，但是了解一下也是好的，因为万一呢。

以上がPython の関数パラメーター受け渡しメソッド *args、**kwargs などの詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。