Python怎么查看帮助信息

Posted 2023-05-10

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了Python怎么查看帮助信息相关的知识，希望对你有一定的参考价值。

Python获取帮助的3种方式

help()

help函数是Python的一个内置函数。

函数原型：help([object])。

可以帮助我们了解该对象的更多信息。

dir()

dir函数是Python的一个内置函数。

函数原型：dir([object])

可以帮助我们获取该对象的大部分相关属性。

_ doc_

在Python中有一个奇妙的特性，文档字符串，又称为DocStrings。

用它可以为我们的模块、类、函数等添加说明性的文字，使程序易读易懂，更重要的是可以通过Python自带的标准方法将这些描述性文字信息输出。

上面提到的自带的标准方法就是_ doc _。前后各两个下划线。

注：当不是函数、方法、模块等调用doc时，而是具体对象调用时，会显示此对象从属的类型的构造函数的文档字符串。

参考技术A 在前面打个问号就行了。比如我要看rename怎么用
？df.rename() 就这样

Python内置了很多有用的函数，我们可以直接调用。

要调用一个函数，需要知道函数的名称和参数，比如求绝对值的函数abs，只有一个参数。可以直接从Python的官方网站查看文档：

也可以在交互式命令行通过help(abs)查看abs函数的帮助信息。

调用abs函数：

>>> abs(100)
100
>>> abs(-20)
20
>>> abs(12.34)
12.34

调用函数的时候，如果传入的参数数量不对，会报TypeError的错误，并且Python会明确地告诉你：abs()有且仅有1个参数，但给出了两个：

>>> abs(1, 2)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: abs() takes exactly one argument (2 given)

如果传入的参数数量是对的，但参数类型不能被函数所接受，也会报TypeError的错误，并且给出错误信息：str是错误的参数类型：

>>> abs(‘a‘)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: bad operand type for abs(): ‘str‘

而比较函数cmp(x, y)就需要两个参数，如果x<y，返回-1，如果x==y，返回0，如果x>y，返回1：

>>> cmp(1, 2)
-1
>>> cmp(2, 1)
1
>>> cmp(3, 3)
0

Python内置的常用函数还包括数据类型转换函数，比如int()函数可以把其他数据类型转换为整数：

>>> int(‘123‘)
123
>>> int(12.34)
12
>>> float(‘12.34‘)
12.34
>>> str(1.23)
‘1.23‘
>>> unicode(100)
u‘100‘
>>> bool(1)
True
>>> bool(‘‘)
False

函数名其实就是指向一个函数对象的引用，完全可以把函数名赋给一个变量，相当于给这个函数起了一个“别名”：

>>> a = abs # 变量a指向abs函数
>>> a(-1) # 所以也可以通过a调用abs函数
1

调用Python的函数，需要根据函数定义，传入正确的参数。如果函数调用出错，一定要学会看错误信息，所以英文很重要！

以上是关于Python怎么查看帮助信息的主要内容，如果未能解决你的问题，请参考以下文章