Python関数のドキュメントを読む方法

Question

Pythonの関数の説明を理解する上で問題があります。 私は単にos.putenv(varname, value)のような機能を理解していますが、私はこれをどのように使用するのかわかりません：os.getenv(varname[, value])。その関数に引数を渡すには、角かっこはどういう意味ですか？

Answer 1

通常、角括弧は値がオプションであることを意味します。ここでは、varnameは取得する環境変数を指し、valueは環境変数が存在しない場合の戻り値のオプション値です。

Answer 2

角括弧は、引数がの場合は、オプションでであることを示します。 the descriptionを読む：

戻り、環境の値が存在する場合varnameが、または値変数そうでない場合。 値のデフォルトはNoneです。

だから、このようにそれを呼び出すことができます。

os.getenv('NONEXISTANTVAR') 

またはこのような：

os.getenv('NONEXISTANTVAR', u'my default') 

この最初はos.getenv('NONEXISTANTVAR', None)と同等です。 getenvという特定のケースでは、環境変数が存在しない場合は2番目の引数が返されます。

通常、説明に明示的に指定するか、または=somevalueを署名に直接入れることによって、ドキュメントにはデフォルト値が記載されます。それが特定の値を示していない場合は、少なくとも行動の違いを記述します。

unicodeは私達に署名で=の例を与える：

unicodeは（オブジェクト= ''）Pythonで、引数は任意であることが唯一の方法であること

注それがデフォルト値を持つためです。