本系列将会陆续整理分享一些的Python内置函数。
-
通过百度网盘获取：
链接：https://pan.baidu.com/s/11x9_wCZ3yiYOe5nVcRk2CQ?pwd=mnsj提取码：mnsj
-
前往GitHub获取：
https://github.com/returu/Python_built-in_functionshelp()help(request)
-
无参数调用：如果直接调用 help()，会启动一个交互式的帮助系统，用户可以在其中输入模块名、函数名、类名等，获取详细帮助，可以通过输入 quit 或按 Ctrl+D（Unix 系统）或 Ctrl+Z（Windows系统）退出。 -
带参数调用：如果给 help() 传递一个对象（如模块、函数、类、变量等），它会直接显示该对象的帮助信息。如果直接传递字符串，help() 会尝试查找该名称对应的对象。
-
对象的文档字符串（docstring）：即对象定义中用三引号 “””…””” 编写的说明。 -
函数/方法的参数列表和用法：对于函数，会显示参数名称和调用格式。 -
类的继承关系和属性方法列表：对于类，会列出其父类和所有方法。
下面是一些使用 help() 函数的示例：
-
示例 1：获取内置函数的帮助
可以直接对内置对象（如函数、类、模块等）使用 help()。
help(len)
-
示例 2：获取模块的帮助
可以对一个模块使用 help() 来查看该模块的文档字符串以及它所包含的函数和类的简要说明。
# 如果直接传递字符串，help()会尝试查找该名称对应的对象而无需导入
help('math')
# 模块中函数
# 传递字符串参数
help('math.sin')
-
示例 3：获取类或方法的帮助
可以对一个类或类的方法使用 help()。
# 查看 list 类的帮助
help(list)
# 查看 list 类 append 方法的帮助
help(list.append)
-
示例 4：获取自定义对象的帮助
也可以使用 help() 来查看自定义类或函数的文档字符串，需编写 docstring。
class MyClass:
"""这是一个自定义类的文档"""
def my_method(self):
pass
help(MyClass) # 显示类的文档和方法说明
在 Python 中，帮助信息通常是通过对象的 __doc__ 属性来定义的。__doc__ 是一个特殊的属性，用于存储对象的文档字符串（docstring），它是一个字符串，描述了对象的功能、参数、返回值等信息。
# 通过对象的 __doc__ 属性来定义帮助信息
MyClass.my_method.__doc__ = """这是一个方法的文档"""
help(MyClass.my_method)
-
示例 5：查看关键字的帮助
还可以使用 help() 来查看 Python 关键字的帮助。
help("if")
本篇文章来源于微信公众号: 码农设计师
