オプションのパラメーターを関数に渡す方法はありますか?


133

関数を呼び出すときに関数にオプションのパラメーターを渡すPythonの方法はありますか?関数の定義には、「オプションのパラメーターが渡された場合のみ」に基づくコードがあります

回答:


115

Pythonの2のドキュメント、7.6。関数定義は、呼び出し元がオプションのパラメーターを提供したかどうかを検出するいくつかの方法を提供します。

まず、特別な仮パラメーター構文を使用できます*。関数定義の前に単一のが続く仮パラメーターがある場合、*Pythonはそのパラメーターに、先行する仮パラメーター(タプルとして)と一致しない位置パラメーターを入力します。関数定義の前にが付いている仮パラメーターがある場合、**Pythonはそのパラメーターに、先行する仮パラメーター(dictとして)と一致しないキーワードパラメーターを入力します。関数の実装では、これらのパラメーターの内容を確認して、必要な種類の「オプションのパラメーター」を確認できます。

たとえば、次の関数opt_funは、2つの位置パラメータx1とを取りx2、「optional」という名前の別のキーワードパラメータを探します。

>>> def opt_fun(x1, x2, *positional_parameters, **keyword_parameters):
...     if ('optional' in keyword_parameters):
...         print 'optional parameter found, it is ', keyword_parameters['optional']
...     else:
...         print 'no optional parameter, sorry'
... 
>>> opt_fun(1, 2)
no optional parameter, sorry
>>> opt_fun(1,2, optional="yes")
optional parameter found, it is  yes
>>> opt_fun(1,2, another="yes")
no optional parameter, sorry

第2に、None呼び出し元が使用しないようなデフォルトのパラメーター値を提供できます。パラメータにこのデフォルト値がある場合、呼び出し元がパラメータを指定しなかったことがわかります。パラメータにデフォルト以外の値が含まれている場合は、呼び出し元からのパラメータであることがわかります。


7
positional_parametersタプルでありkeyword_parameters、辞書です。
Cees Timmerman、2016年

Pythonはどのようにformal parameters preceded by * (これは何と呼ばれますか)をと区別しkeyword parameterますか?私が理解しているように、キーワードパラメータは=、関数呼び出しで演算子を使用して指定されます(したがってopt_fun(1,2, optional="yes")、パラメータを予期しますが、必ずしも必要ではない関数にキーワード引数「yes」を提供しますoption
Minh Tran

一方、私formal parameters preceded by * は単に「キーワード引数の前にある位置引数に対応しない、呼び出し元が提供する引数」として理解しました。例えば、中opt_fun(1,2, "blah", 3.14, mykey="yes", myyear="2018")"blah"そして3.14あるforma arguments preceded by *、2つの位置引数と引数の間に使用中ですので、=看板を。結果のタプルpositional_parameterはdupleです("blah", 3.14)。これは正しいです?
Minh Tran

@MinhTran、コメント内の質問は、スタックオーバーフローで回答を得るための最良の方法ではありません。大きな青色の[質問する]ボタンをクリックして、他の人が "答える"ことができる "質問"としてリクエストを書く方がはるかに良いです。しかし、あなたを助けるために、a)parameterparameters」に対して「preceded by *」ではなく「」と書いたことに注意してください。言語*identifierは、パラメーターリストで1つだけを許可します。b)の読み取りdocs.python.org/2/reference/...、C)読みdocs.python.org/2/reference/expressions.html#callsを。このコメントで許可されている文字が不足しています。
ジムデラハント2018

81
def my_func(mandatory_arg, optional_arg=100):
    print(mandatory_arg, optional_arg)

http://docs.python.org/2/tutorial/controlflow.html#default-argument-values

これはを使用するよりも読みやすいと思います**kwargs

引数がまったく渡されたかどうかを判断するために、カスタムユーティリティオブジェクトをデフォルト値として使用します。

MISSING = object()

def func(arg=MISSING):
    if arg is MISSING:
        ...

-ありがとうございます。このパラメーターのデフォルト値をコード内の別の変数として指定する方法はありますか?
user1795998

はい。default_value=100; def my_func(mandatory_argument, optional_argument_with_default_value=default_value): ...
warvariuc

これは、オプションのパラメーターの使用方法を示しているように見えますが、パラメーターが渡されたかどうかをテストする方法ではなく、OPが求めていることです。
Mawgはモニカを2016

4
ほとんどの場合、これはJimのソリューションよりも単純でまっすぐなソリューションです。デフォルト値をNoneに設定すると、パラメーターが渡されたかどうかを確認できます。ジムの解決策がより良い唯一のケースは、引数としてNoneを渡すことと引数をまったく渡さないことを区別することが重要である場合です。
Arnon Axelrod

19
def op(a=4,b=6):
    add = a+b
    print add

i)op() [o/p: will be (4+6)=10]
ii)op(99) [o/p: will be (99+6)=105]
iii)op(1,1) [o/p: will be (1+1)=2]
Note:
 If none or one parameter is passed the default passed parameter will be considered for the function. 

1
最初のパラメーター(a)ではなく、2番目のパラメーター(b)のみを渡す方法はありますか?
ジジウフ2017

4
@Djidioufはい、あります–JürgMerlin op(b=2)
Spaak

7

パラメータにデフォルト値を指定する場合は、()に値を割り当てます。(x = 10)のように。しかし、重要なことは、最初に強制的な引数、次にデフォルト値であるべきです。

例えば。

(y、x = 10)

だが

(x = 10、y)は間違っています


ありがとう、このパラメーターのデフォルト値をコード内の別の変数として指定する方法はありますか?
user1795998

はい*arg **karg、関数の引数として呼び出されるものを使用できます。グーグルで検索。
要約

これは、オプションのパラメーターの使用方法を示しているように見えますが、パラメーターが渡されたかどうかをテストする方法ではなく、OPが求めていることです。
Mawgはモニカを2016

2

オプションの引数のデフォルト値を指定して、関数に渡されないものを指定して、is演算子で確認することができます。

class _NO_DEFAULT:
    def __repr__(self):return "<no default>"
_NO_DEFAULT = _NO_DEFAULT()

def func(optional= _NO_DEFAULT):
    if optional is _NO_DEFAULT:
        print("the optional argument was not passed")
    else:
        print("the optional argument was:",optional)

そうしない限りfunc(_NO_DEFAULT)、引数が渡されたかどうかを正確に検出でき、受け入れられた回答とは異なり、**表記の副作用について心配する必要はありません。

# these two work the same as using **
func()
func(optional=1)

# the optional argument can be positional or keyword unlike using **
func(1) 

#this correctly raises an error where as it would need to be explicitly checked when using **
func(invalid_arg=7)

ただしてください_NO_DEFAULT = object()
Aran-Fey

イントロスペクションを向上させるための2行の追加は、その価値があります。これを実行help(func)すると、明示的に渡されない場合に引数がどのように解釈されるかがより明確になります。
Tadhg McDonald-Jensen
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.