说明
《Python 教程》 持续更新中,提供建议、纠错、催更等加作者微信: gairuo123(备注:pandas教程)和关注公众号「盖若」ID: gairuo。跟作者学习,请进入 Python学习课程。欢迎关注作者出版的书籍:《深入浅出Pandas》 和 《Python之光》。
除了 Python 的官网网站,Python 还有一个内置的帮助系统,通过内置函数 help() 可以查看相应的帮助信息。在交互模式下熟练使用 help() 可以帮助我们快速查询函数和方法的使用方法,提高编程效率。
一些常见的使用场景:
help(max)
'''
Help on built-in function max in module builtins:
max(...)
max(iterable, *[, default=obj, key=func]) -> value
max(arg1, arg2, *args, *[, key=func]) -> value
With a single iterable argument, return its biggest item. The
default keyword-only argument specifies an object to return if
the provided iterable is empty.
With two or more arguments, return the largest argument.
'''
help('if')
'''
The "if" statement
******************
The "if" statement is used for conditional execution:
if_stmt ::= "if" assignment_expression ":" suite
("elif" assignment_expression ":" suite)*
["else" ":" suite]
It selects exactly one of the suites by evaluating the expressions one
by one until one is found to be true (see section Boolean operations
for the definition of true and false); then that suite is executed
(and no other part of the "if" statement is executed or evaluated).
If all expressions are false, the suite of the "else" clause, if
present, is executed.
Related help topics: TRUTHVALUE
'''
import math
help(math.sin)
'''
Help on built-in function sin in module math:
sin(x, /)
Return the sine of x (measured in radians).
'''
它的语法为 help([object])
,传入的是一个对象,特别是类、函数的名称,返回对应的说明文档字符串供我们查看学习。
help() 启动内置的帮助系统(此函数主要在交互式中使用)。如果没有实参,解释器控制台里会启动交互式帮助系统。如果实参是一个字符串,则在模块、函数、类、方法、关键字或文档主题中搜索该字符串,并在控制台上打印帮助信息。如果实参是其他任意对象,则会生成该对象的帮助页。
请注意,如果在调用 help() 时,目标函数的形参列表中存在斜杠(/),则意味着斜杠之前的参数只能是位置参数。
该函数通过 site 模块加入到内置命名空间。
在 3.4 版更改: pydoc 和 inspect 的变更使得可调用对象的签名信息更加全面和一致。
在交互场景下,如果参数传入为空,则输出帮助功能的引导语,并进入帮助模式。如笔者执行的效果:
help()
'''
Welcome to Python 3.10's help utility!
If this is your first time using Python, you should definitely check out
the tutorial on the internet at https://docs.python.org/3.10/tutorial/.
Enter the name of any module, keyword, or topic to get help on writing
Python programs and using Python modules. To quit this help utility and
return to the interpreter, just type "quit".
To get a list of available modules, keywords, symbols, or topics, type
"modules", "keywords", "symbols", or "topics". Each module also comes
with a one-line summary of what it does; to list the modules whose name
or summary contain a given string such as "spam", type "modules spam".
'''
help>
大意是:
欢迎使用Python 3.10的帮助实用程序!
如果这是你第一次使用Python,你一定要在网上查看教程 https://docs.python.org/3.10/tutorial/.
输入任何模块、关键字或主题的名称,以获取有关编写Python程序和使用Python模块的帮助。要退出此帮助实用程序并返回解释器,只需键入“退出”。
要获取可用模块、关键字、符号或主题的列表,请键入“模块”、“关键词”、“符号”或“主题”。每个模块还附带一行内容摘要;要列出其名称或摘要包含给定字符串(如“spam”)的模块,请键入“modules spam”。
会有 help>
批示符号等待输入要帮助的内容,输入 quit/按 Q 或者直接回车,便退出此模式。
以下是一些常见的议题帮助关键词,可以以字符形式传入 help() 查看相关主题的帮助。
字符 | 主题内容 |
---|---|
topics | 查看所有主题关键词 |
ASSERTION | 断言 asert 语句说明 |
ASSIGNMENT | 赋值 |
ATTRIBUTEMETHODS | 属性方法 |
ATTRIBUTES | 属性 |
AUGMENTEDASSIGNMENT | 增量赋值 |
BASICMETHODS | 类的基本方法,特殊方法 SPECIALMETHODS |
BINARY | 二进制数据 |
BITWISE | 位运算 |
BOOLEAN | 布尔类型 |
CALLABLEMETHODS | 可调用方法 |
CALLS | 调用 |
CLASSES | 标准类型层次 |
CODEOBJECTS | 代码对象 |
COMPARISON | 比较 |
COMPLEX | 复数 |
CONDITIONAL | if 条件语句 |
CONTEXTMANAGERS | 上下文管理器 |
CONVERSIONS | 数值间转换 |
DEBUGGING | pdb Python调试器 |
DELETION | 删除 del 关键词的说明 |
DICTIONARIES | 字典类型 |
DICTIONARYLITERALS | 字典字面量 |
DYNAMICFEATURES | 动态特征 |
ELLIPSIS | 省略对象 |
EXCEPTIONS | 异常 |
EXECUTION | 执行模型 |
EXPRESSIONS | 运算符优先级,同 OPERATORS |
FLOAT | 浮点类型 |
FORMATTING | 格式化 |
FRAMEOBJECTS | 框架对象 |
FRAMES | 名字与绑定,同 SCOPING |
FUNCTIONS | 函数对象 |
IDENTIFIERS | 标识符和关键字 |
IMPORTING | import 语句,同 PACKAGES |
INTEGER | 整型 |
LISTLITERALS | 列表字面量 |
LISTS | 列表 |
LITERALS | 字面量 |
LOOPING | 控制流结构,if、while、for 等 |
MAPPINGMETHODS | 实现容器对象 |
MAPPINGS | 映射类型 dict |
METHODS | 方法 |
MODULES | 模块 |
NAMESPACES | 命名空间 |
NONE | NONE |
NUMBERMETHODS | 实现数值类型 |
NUMBERS | 数字 |
OBJECTS | 对象, 值和类型 |
OPERATORS | 操作符优先级,同 EXPRESSIONS |
PACKAGES | 同 IMPORTING |
POWER | 幂运算 |
PRECEDENCE | 同 OPERATORS |
PRIVATENAMES | 标识符(名称) |
RETURNING | return 声明 |
SCOPING | 名字与绑定,同 FRAMES |
SEQUENCEMETHODS | 实现序列对象 |
SEQUENCES | 序列类型 |
SHIFTING | 移位运算 |
SLICINGS | 切片选择 |
SPECIALATTRIBUTES | 附加属性,特殊属性 |
SPECIALIDENTIFIERS | 保留的标识符类型 |
SPECIALMETHODS | 特殊方法 |
STRINGMETHODS | 字符串方法 |
STRINGS | 字符串 |
SUBSCRIPTS | 下标 |
TRACEBACKS | 回溯 |
TRUTHVALUE | 真值检验 |
TUPLELITERALS | 元组字面量 |
TUPLES | 元组 |
TYPEOBJECTS | 类型对象 |
TYPES | 类型系统 |
UNARY | 一元算术和位运算 |
UNICODE | 字符串与字节的字面值 |
更新时间:March 30, 2022, 10:20 p.m. 标签:python help 帮助