python - 为什么 Python 函数文档在可选参数的括号后包含逗号?

标签 python documentation notation

Python 文档中函数签名的格式有点困惑。将逗号放在开括号之后而不是之前有什么意义?嵌套括号有什么意义?

他们是怎样的:

RegexObject.match(string[, pos[, endpos]])

我希望出现以下情况之一:

RegexObject.match(string, [pos], [endpos])
RegexObject.match(string[, pos][, endpos])

最佳答案

方括号表示内容是可选的,方括号外的内容是必填的。

用你的符号:

RegexObject.match(string, [pos], [endpos])

我希望必须写:

r.match("foo",,)

嵌套是必需的,因为如果您提供第三个参数,那么您还必须提供第二个参数,即使它是一个可选参数。以下非嵌套替代方案会产生歧义:

RegexObject.match(string[, pos][, endpos])

关于python - 为什么 Python 函数文档在可选参数的括号后包含逗号?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/2120507/

相关文章:

documentation - 您的团队使用哪些工具来编写用户手册?

python - 心理学/Postgres : Connections hang out randomly

python - 如何修复错误消息 : 'chromedriver.exe' executable may have wrong permissions

documentation - 如何发送版本控制文档更新?

php - reSTLer 资源管理器提示查看器与 REQUEST_BODY json

matlab - matlab输出中 "e"的含义

python - 从空列表中弹出

python - pysvn 基于日期导出

Ruby 试图掌握一种新的表示法。 (注入(inject)(: ) vs select(&:even?);为什么有&?)

java - 为什么反向 DNS 表示法用于包命名?