函数/类文档中的方括号“[]”是什么意思？

问题描述：

我无法弄清楚 csv.dictreader 的参数，并且意识到我不知道方括号代表什么。

来自文档：

class csv.DictReader(csvfile[, fieldnames=None[, restkey=None[, restval=None[, dialect='excel'[, *args, **kwds]]]]])

我很感激有关类实例化参数的总结。

谢谢

解决方案 1：

方括号表示这些参数是可选的。你可以省略它们。

因此，在这种情况下，您只需将参数传递csvfile给csv.DictReader。如果您传递第二个参数，它将被解释为fieldnames参数。第三个参数将是restkey，等等。

如果您只想指定例如cvsfile和dialect，那么您必须明确命名关键字参数，如下所示：

csv.DictReader(file('test.csv'), dialect='excel_tab')

有关关键字参数的更多信息，请参阅python.org 上的教程第 4.7.2 节。

解决方案 2：

通常在 api 文档中方括号表示可选。我认为它们在这里的意思是一样的。

解决方案 3：

这实际上是广泛使用的用于明确描述语言语法的符号的一个子集，称为巴科斯范式（详情请参阅维基百科文章）。

解决方案 4：

重申其他人所说的话，论点是可选的。

如果省略可选部分，剩余的、fieldnames=或关键字将告诉函数缺少哪些部分。restval=`restkey=`dialect=

语法并没有建议这样做，但是如果关键字允许以任何顺序指定参数，我不会感到惊讶，只是最后两个参数必须同时指定，或者同时省略。