内置函数-help-帮助文档

合集 - python(99)

1.python基础之注释2023-06-27 2.python语言学习路线（基础）2023-06-26 3.python源码结构2023-06-26 4.python发展史及python应用场景2023-06-26 5.变量2023-06-28 6.bug及debug2023-06-29 7.常见数据类型及其转换2023-06-30 8.字符串格式化2023-06-30 9.转义符2023-06-30 10.字符串在货币、日期、精度的处理2023-07-01 11.字符编解码2023-07-01 12.字符编解码及其相互转换2023-07-01

13.内置函数-help-帮助文档2023-07-01

14.内置函数print-输出2023-07-03 15.内置函数input2023-07-03 16.运算符2023-07-04 17.int的缓存策略（特别容易混）2023-07-04 18.判断语句2023-07-04 19.random模块2023-07-04 20.判断语句+ random的应用-剪刀石头布游戏2023-07-04 21.三元运算符（if else的简写）2023-07-04 22.循环语句-while2023-07-05 23.循环语句-while-练习题2023-07-05 24.循环语句for循环2023-07-05 25.循环语句 + else2023-07-05 26.字符串类str2023-07-06 27.正则在字符串中的简单应用2023-07-06 28.列表（List）2023-07-07 29.列表list的sort方法的坑2023-07-07 30.列表综合应用-8个教室随机分配到3个教室2023-07-08 31.元组2023-07-08 32.自动组包 & 自动解包2023-07-08 33.字典2023-07-08 34.集合2023-07-08 35.公共操作2023-07-08 36.公共操作-推导式（集合、列表、字典）2023-07-08 37.函数定义、调用、闭包2023-07-08 38.拆包和交换变量值2023-07-09 39.函数的变量作用域、返回值、参数2023-07-09 40.函数递归2023-07-09 41.匿名函数（lambda表达式）012023-07-09 42.内置函数abs2023-07-09 43.内置函数round2023-07-09 44.内置函数abs022023-07-09 45.高阶函数2023-07-09 46.内置高阶函数map2023-07-09 47.内置高阶函数reduce2023-07-09 48.内置函数reduce2023-07-09 49.学生管理系统-函数&循环&运算符综合练习2023-07-09 50.文件操作之语法2023-07-10 51.文件操作2-最佳实践2023-07-11 52.文件操作之seek2023-07-11 53.文件及文件夹操作2023-07-11 54.面向对象基本概念2023-07-12 55.面向对象之类、对象的定义2023-07-12 56.添加和获取对象属性2023-07-12 57.面向对象之魔法方法2023-07-12 58.魔法函数 __repr__() 和 __str__()的区别2023-07-12 59.魔法方法__len__2023-07-12 60.魔法方法之__getitem__(self, key)、__setitem__(self, key, value) 和 __delitem__(self, key) 2023-07-12 61.魔法方法之__iter__(self) && __next__(self)2023-07-17 62.TypeError: iter() returned non-iterator of type 'MyIterable'2023-07-17 63.魔法方法之__contains__()2023-07-17 64.魔法方法之__call__2023-07-17 65.魔法方法之__getattr__(), __setattr__(), 和 __delattr__2023-07-18 66.__eq__(), __lt__(), 和 __gt__() 2023-07-18 67.案例：烤地瓜2023-07-18 68.案例：给房子置办家具2023-07-19 69.继承2023-07-19 70.继承之子类复用父类的属性、方法2023-07-19 71.继承的分类2023-07-19 72.MRO2023-07-19 73.继承之子类重写父类同名属性和方法2023-07-19 74.⼦类调⽤⽗类的同名⽅法和属性2023-07-19 75.私有属性&&方法的定义&访问限制2023-07-19 76.setter&getter方法访问私有属性2023-07-20 77.__mro__属性2023-07-20 78.python 面向对象3大特征详解2023-07-20 79. 类属性和实例属性2023-07-21 80.类属性和实例属性最佳实践2023-07-21 81.类方法2023-07-21 82.静态方法2023-07-21 83.异常基础2023-07-21 84.多组异常处理基础2023-07-22 85.多组异常处理2023-07-22 86.使用Python内置的错误信息2023-07-22 87.捕获所有异常2023-07-22 88.手动抛异常（raise）2023-07-22 89.try-except-else-finally2023-07-22 90.断言assert在异常中应用2023-07-22 91.自定义异常类2023-07-22 92.模块2023-07-23 93.常见的5种模块导入2023-07-23 94.模块的定位顺序2023-07-23 95.__all__变量限制、明确导入范围2023-07-23 96.包2023-07-23 97.时间模块datetime2023-07-23 98.多任务编程之并发、并行概念2023-07-23 99.进程实现多任务（进程概念、单进程、多进程执行多任务）2023-07-23

help() 是一个内置函数，用于获取有关对象、模块、函数、类等的帮助信息。它能够提供对象的文档字符串(docstring)、方法、属性以及其他相关信息。

help() 函数提供的帮助信息是根据对象的文档字符串(docstring)生成的，因此，在编写代码时，为你自己的函数、类和模块提供清晰和详细的文档字符串是一个好习惯。这样可以使 help() 函数提供有用的信息，方便其他开发者使用和理解你的代码。

以下是关于 help() 的详解、最佳实践和示例：

help() 函数的使用方法：
- 使用 help() 函数时，你可以提供一个对象作为参数，以获取有关该对象的详细帮助信息。
- 也可以直接调用 help() 函数，然后在交互式解释器中输入要查询的对象。
最佳实践：
- 对于内置的 Python 对象、模块、函数、类等，使用 help() 函数可以获得官方的文档和用法说明。
- help() 函数对于第三方库和自定义的模块、函数和类也非常有用，因为它能帮助你理解和学习这些代码的功能和使用方法。
- 尽量多阅读并使用 help() 函数来学习和理解 Python 中的不同库和概念。

 1 '''
 2 help() 是一个内置函数（属于builtins.py模块），用于获取有关对象、模块、函数、类等的帮助信息。
 3 它能够提供对象的文档字符串(docstring)、方法、属性以及其他相关信息。
 4 
 5 以下是关于 help() 的详解、最佳实践和示例：
 6 1. help() 函数的使用方法：
 7 
 8     1. 使用 help() 函数时，你可以提供一个对象作为参数，以获取有关该对象的详细帮助信息。
 9     也可以直接调用 help() 函数，然后在交互式解释器中输入要查询的对象。
10 
11 2. 最佳实践：
12     1. 对于内置的 Python 对象、模块、函数、类等，使用 help() 函数可以获得官方的文档和用法说明。
13     2. help() 函数对于第三方库和自定义的模块、函数和类也非常有用，因为它能帮助你理解和学习这些代码的功能和使用方法。
14     3. 尽量多阅读并使用 help() 函数来学习和理解 Python 中的不同库和概念。
15 '''
16 
17 # 获取print函数的帮助信息
18 help(print)  # 默认就是输出到标准输出
19 # print(help(print))
20 '''
21 Help on built-in function print in module builtins:
22 
23 print(*args, sep=' ', end='\n', file=None, flush=False)
24     Prints the values to a stream, or to sys.stdout by default.
25     
26     sep
27       string inserted between values, default a space.
28     end
29       string appended after the last value, default a newline.
30     file
31       a file-like object (stream); defaults to the current sys.stdout.
32     flush
33       whether to forcibly flush the stream.
34 
35 None
36 '''
37 
38 # 获取帮助信息并输出结果到文件
39 import sys
40 with open('011-print.txt', 'w') as f:
41     sys.stdout = f
42     help(print)
43     sys.stdout = sys.__stdout__
44 
45 # 在交互式解释器中使用 help() 函数
46 help()
47 # 输入要查询的对象名称，例如 'print'，然后按下回车键
48 # 打印帮助信息

在交换解释器中的使用示例：

help> help

Welcome to Python 3.11'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.11/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".