Python如何进入帮助模式

要进入那帮助模式, 可在解释器里头使用内置的help()函数来达成。首先, 打开终端或者命令提示符, 接着输入进入解释器, 随后再度输入help()从而进入帮助模式。这帮助模式能够准许你 query 模块、关键字、符号等相关的帮助文档, 这对于学习以及查找某些函数或者模块的用法而言是极为有用的。要是你想要退出此帮助模式, 那就输入quit或者按下Ctrl + D。

在进入帮助模式以后, 借着输入关键字、模块名、函数名或者类名的方式, 能够获取与之相关的信息。举例来说, 输入了help('print'), 便可以获取到关于print函数所具备的详细信息；帮助模式是其中一个特别强大且实用的工具, 尤其是在针对初学者以及那些需要快速查找文档的开发者而言。

下面这些内容, 会极为细致地讲述怎样去运用帮助模式, 还有帮助模式确切的功能以及应用情况。

一、进入解释器

1、打开终端或命令提示符

无论是macOS也好, 还是Linux也罢, 将打开终端或者命令提示符作为第一步行动。于系统里, 借助“开始”菜单寻觅“cmd”或者“命令提示符”进而实现打开操作。在macOS以及Linux系统环境下, 能够直接把终端开启。

2、启动解释器

于终端里, 或者是命令提示符内, 输入, 或者（这具体得看你的版本以及系统配置情况）, 之后按下回车键, 如此便会启动解释器, 并且显示出一个提示符（一般情况下是>>>）, 这意味着你已然进入了交互模式。

$ python

Python 3.9.7 (default, Sep 10 2021, 00:00:00)

[GCC 8.3.0] on linux

Type "help", "copyright", "credits" or "license" for more information.

>>>

二、使用help()函数

1、输入help()进入帮助模式

于提示符那里输入help(), 然后按下回车键, 如此便可进入帮助模式。在这样子的时刻, 你将会瞧见帮助系统的欢迎信息, 以及提示符help>, 这表明你已然进入了帮助模式。

>>> help()

Welcome to Python 3.9'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.9/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".

help>

2、查询帮助信息

于帮助模式当中, 你能够键入任何你期望去查询的模块、关键字、函数或者类的名称, 举例而言, 输入print之后再按下回车键, 便能够查看print函数的帮助信息。

help> print

Help on built-in function print in module builtins:

print(...)

print(value, ..., sep=' ', end='\n', file=sys.stdout, flush=False)

Prints the values to a stream, or to sys.stdout by default.

Optional keyword arguments:

file: a file-like object (stream); defaults to the current sys.stdout.

sep: string inserted between values, default a space.

end: string appended after the last value, default a newline.

flush: whether to forcibly flush the stream.

3、退出帮助模式

要想退出帮助模式, 进而返回解释器, 能够输入quit, 或者按Ctrl+D:

help> quit

>>>

三、查询模块、关键字和符号

1、查询模块

在帮助模式中, 去查询任意一个标准库模块或者第三方模块的帮助信息, 你是能够这样做到的, 这是可行的。比如说, 把math输入进去, 随后按下回车键, 如此一来, 就能查看数学模块math的帮助信息了:

help> math

Help on module math:

NAME

math

DESCRIPTION

This module provides access to the mathematical functions

defined by the C standard.

FUNCTIONS

acos(x, /)

Return the arc cosine (measured in radians) of x.

...

DATA

e = 2.718281828459045

pi = 3.141592653589793

2、查询关键字

于帮助模式之中, 还能够进行查询的, 皆是保留关键字。比如说, 当输入if之后, 并按下回车键, 便能够查看关键字if的帮助信息:

help> if

The "if" statement

The "if" statement is used for conditional execution:

if_stmt ::= "if" expression ":" suite

("elif" 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 Expressions 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 the

expressions are false, the suite of the "else" clause, if present, is

executed.

3、查询符号

帮助模式能够进行特殊符号或者操作符的查询, 举例说来, 把+输入进去, 随后按回车键, 这样就能够查看到加号操作符+所对应的帮助信息。

help> +

The "+" operator

The binary "+" operator yields the sum of its arguments. The numeric arguments are first converted to a common type. The result has the same type as the operands after coercion.

四、使用dir()函数和属性

1、dir()函数

撇开help()函数不谈, dir()函数同样是个相当实用的工具, 它能够将模块、类、实例之类的属性以及方法给罗列出来, 在运用dir()函数之际, 你只要在解释器里键入dir(对象)就行, 比如说用于查看math模块的属性跟方法便是如此:

>>> import math

>>> dir(math)

['__doc__', '__loader__', '__name__', '__package__', '__spec__', 'acos', 'acosh', 'asin', 'asinh', 'atan', 'atan2', 'atanh', 'ceil', 'comb', 'copysign', 'cos', 'cosh', 'degrees', 'dist', 'e', 'exp', 'expm1', 'fabs', 'factorial', 'floor', 'fmod', 'frexp', 'fsum', 'gamma', 'gcd', 'hypot', 'inf', 'isclose', 'isfinite', 'isinf', 'isnan', 'isqrt', 'ldexp', 'lgamma', 'log', 'log10', 'log1p', 'log2', 'modf', 'nan', 'perm', 'pi', 'pow', 'prod', 'radians', 'remAInder', 'sin', 'sinh', 'sqrt', 'tan', 'tanh', 'tau', 'trunc']

2、属性

每一个函数, 每一个类, 还有每一个模块, 都存在着一个特殊的属性, 这个属性之中包含着该对象的文档字符串。你能够通过访问这个属性, 进而查看该对象的文档。比如说, 去查看print函数的文档字符串:

>>> print(print.__doc__)

print(value, ..., sep=' ', end='\n', file=sys.stdout, flush=False)

Prints the values to a stream, or to sys.stdout by default.

Optional keyword arguments:

file: a file-like object (stream); defaults to the current sys.stdout.

sep: string inserted between values, default a space.

end: string appended after the last value, default a newline.

flush: whether to forcibly flush the stream.

五、结合使用help()和dir()函数

先运用dir()函数将对象所含的全部属性以及方法给罗列出来, 接着凭借help()函数去查询特定属性或者方法的详尽信息, help()与dir()函数能够联合起来使用进而获取更为全面的帮助信息, 比如说去查看math模块的sqrt函数。

>>> import math

>>> dir(math)

['__doc__', '__loader__', '__name__', '__package__', '__spec__', 'acos', 'acosh', 'asin', 'asinh', 'atan', 'atan2', 'atanh', 'ceil', 'comb', 'copysign', 'cos', 'cosh', 'degrees', 'dist', 'e', 'exp', 'expm1', 'fabs', 'factorial', 'floor', 'fmod', 'frexp', 'fsum', 'gamma', 'gcd', 'hypot', 'inf', 'isclose', 'isfinite', 'isinf', 'isnan', 'isqrt', 'ldexp', 'lgamma', 'log', 'log10', 'log1p', 'log2', 'modf', 'nan', 'perm', 'pi', 'pow', 'prod', 'radians', 'remainder', 'sin', 'sinh', 'sqrt', 'tan', 'tanh', 'tau', 'trunc']

>>> help(math.sqrt)

Help on built-in function sqrt in module math:

sqrt(x, /)

Return the square root of x.

六、在线文档和资源

除去内置的帮助系统之外, 你能够去访问的官方文档以及其他的在线资源, 借此来获取更为详细的信息与教程。举例来说, 相关的官方文档网站, 提供了有关语言、标准库以及各个模块的详细文档。

1、官方文档

学习以及查找信息之时用来当作最佳资源去选用的是官方文档, 在文档当中你能够查找标准库模块、语言参考、教程以及各种各样的指南, 官方文档并且还提供了搜索功能, 从而能够方便你异常快速地找到所需要的信息。

2、在线教程和社区

有许多联机教程以及社区资源存在, 并非官方文档, 像Tutor、Real、Stack这些, 提供了丰富的范例编码、各类问答互动, 还有诸多的教学课程, 助力你应对实实在在的编程难题, 提升技能水平。

3、使用第三方工具

另外存在一些第三方工具, 能够协助你更高效地去查找以及使用文档。比如说, Dash以及Zeal是两款流行的文档浏览器, 它们支持离线查看涵盖多种编程语言以及框架的文档。你能够下载并安装这些工具, 从而在没有网络连接的状况下也能够查阅文档。

七、深入学习帮助系统

1、阅读源码和文档字符串

能深入学习帮助系统的一个不错方法乃是去阅读标准库的源码以及文档字符串经由阅读源码能知道模块、类以及函数的具现细节还有文档字符串的编写规则对此不仅有益于明白帮助系统的运作原理还能够提升你的代码阅读以及编写能力。

2、编写自己的文档字符串

编写代码之际, 养成去编写清晰且详细的文档字符串的习惯是极为重要的, 那文档字符串不但能够助力你自己还有他人去理解代码, 还能够借由help()函数以及其他工具自动地生成文档, 比如, 为一个简单的函数编写文档字符串:

def add(a, b):

"""

Add two numbers and return the result.

Parameters:

a (int or float): The first number.

b (int or float): The second number.

Returns:

int or float: The sum of the two numbers.

"""

return a + b

3、使用自动文档生成工具

除了凭借手动去编写文档字符串之外, 还能够运用自动文档生成工具, 像是pydoc这样的。这些工具是能够依据代码内部的文档字符串以此去生成HTML、PDF等格式的文档的, 便于你去发布以及分享代码文档。比如说, 运用生成文档的基本步骤, 究竟是怎样的呢:

安装: 通过pip进行, 创建项目: 要进行相关操作, 配置项目: 需编辑conf.py文件, 设置项目名称、作者等信息, 编写文档: 于index.rst和其他.rst文件中编写文档内容, 生成文档: 运行make html命令生成HTML格式的文档。

八、总结

有一个工具, 它是强大且易于使用的帮助模式, 能帮你快速查找以及理解模块、函数、类和关键字的用法。你通过进入解释器, 并且使用help()函数, 就能够轻松进入帮助模式, 进而获取所需的信息。将dir()函数同属性结合使用, 能够更加全面地去了解对象的属性和方法。除此之外，借助在线文档、教程以及第三方工具, 能够进一步提升你的学习效率以及编程技能。养成编写清晰文档字符串的习惯, 还要使用自动文档生成工具, 这可以帮你更好地组织以及分享代码文档。经由持续不断地学习以及实践, 你会具备能够更高效运用之情势下的这个帮助系统, 进而使得编程水平得以提升, 有帮助系统，会提升编程水平。

相关问答FAQs：

如何在中查看可用的帮助文档？

于交互环境里, 您能够借由help()函数去查看任一模块、函数亦或是类的帮助文档, 比如说, 输入help(str)会展现字符串对象的相关讯息, 另外, 您还能够在命令行借助 -m pydoc来获取特定模块的文档。

在 中怎样获取的帮助信息？

在其中, 您能够借助?或者??去获取对象的帮助资讯。举例来说, 输入str?的话会弹出字符串对象的帮助文档, 然而str??会给出更详尽的内容, 涵盖源代码（要是存在的话）。这般方式极为便利, 适宜于在开展数据分析与探索性编程之际运用。

帮助模式是否支持自定义模块的帮助文档？

没错, 您能够针对自定义模块撰写帮助文档。借助于在函数或者类的定义里头增添文档字符串（）, 当运用help()函数之际, 您就能够去查看这些文档字符串。比如说, 在定义一个函数之时, 可以于其定义的后面添加上在三重引号里面的描述, 调用help(您所定义的函数名)便能查看对应的帮助信息。如此一来, 您不但能够助力自己, 还能够助力其他开发者去理解您所编写的代码。