如何阅读Python文档

我试图理解我应该如何阅读python文档，例如：

string.lstrip（s[，chars]）

---

我该怎么读呢？我知道括号的意思是可选的，但那是什么意思？是否有一个页面可以解释文档是如何编写的？

文档中没有明确定义，但

string.lstrip(s[, chars])

string

是一个Python模块，它不是任何字符串（例如，它不能是

“abc”

）

参数

s

是要剥离的字符串（例如，它可以是

“abc”

）。这是强制性的，不是选择性的

括号内的参数是可选的，它将是一个字符串，其字符将从字符串中删除

有关如何调用此函数的一些示例如下：

import string

print string.lstrip("abc", "a") # "bc"
print string.lstrip(" abc") # "abc"

注意：不要与

“abc.lstrip（）

混淆。它们是具有相同结果的不同函数。另外，请阅读@user2357112的评论

编辑：在我的IDE上，我刚刚测试了它，它实际上显示了文档上的

s

（按F2键）：

---

s

是函数的第一个参数。字母

s

的选择没有什么意义；它只是一个名称。是的，但它可以是可选的，那么为什么没有

[s]

？我可以写

“aaa”.lstrip（）

这不是可选的；这是强制性的。请注意，

str.lstrip

方法是另一种方法。该方法只接受一个可选参数。此处的“string”一词表示

string

模块，而不是字符串变量。字面意思是“string”。@antox您看到的是string模块的文档，而不是string类型。请注意，文档明确说明不要使用以下内容：“以下函数列表也定义为字符串和Unicode对象的方法；有关这些方法的更多信息，请参见“字符串方法”一节。您应该将这些函数视为弃权，尽管它们不会在Python 3中被删除。

def lstrip Found at: string

def lstrip(s, chars=None):
    """lstrip(s [,chars]) -> string

    Return a copy of the string s with leading whitespace removed.
    If chars is given and not None, remove characters in chars instead.

    """
    return s.lstrip(chars)

# Strip trailing tabs and spaces