天天看点

python文档帮助help()和dir()

python内置了很多内置函数、类方法属性及各种模块。当我们想要当我们想要了解某种类型有哪些属性方法以及每种方法该怎么使用时,我们可以使用dir()函数和help()函数在python idle交互式模式下获得我们想要的信息。

1、dir()函数获得对象中可用属性的列表

>>>dir(list)

['__add__', '__class__', '__contains__', '__delattr__', '__delitem__', '__dir__', '__doc__', '__eq__', '__format__', '__ge__', '__getattribute__', '__getitem__', '__gt__', '__hash__', '__iadd__', '__imul__', '__init__', '__init_subclass__', '__iter__', '__le__', '__len__', '__lt__', '__mul__', '__ne__', '__new__', '__reduce__', '__reduce_ex__', '__repr__', '__reversed__', '__rmul__', '__setattr__', '__setitem__', '__sizeof__', '__str__', '__subclasshook__', 'append', 'clear', 'copy', 'count', 'extend', 'index', 'insert', 'pop', 'remove', 'reverse', 'sort']

其中以双下划线开头的表述列表类型的内置方法(私有方法),没有以下划线开头的表示列表类型的一般方法(公有方法)。

当我们想要了解每种类型、对象或方法、属性的使用方式时我们可以使用help()函数

2、help()函数帮助我们了解模块、类型、对象、方法、属性的详细信息

2.1help()帮助查看类型详细信息,包含类的创建方式、属性、方法。

>>> help(list)

Help on class list in module builtins:

class list(object)

 |  list() -> new empty list

 |  list(iterable) -> new list initialized from iterable's items

 |  

 |  Methods defined here:

 |  

 |  __add__(self, value, /)

 |      Return self+value.

......

 |  sort(...)

 |      L.sort(key=None, reverse=False) -> None -- stable sort *IN PLACE*

 |  

 |  ----------------------------------------------------------------------

 |  Data and other attributes defined here:

 |  

 |  __hash__ = None

2.2 help() 帮助查看方法的详细使用信息

>>> help(list.index)

Help on method_descriptor:

index(...)

    L.index(value, [start, [stop]]) -> integer -- return first index of value.

    Raises ValueError if the value is not present.

使用时要注意输入完整路径,使用模块帮助时,需要先导入模块

>>> import turtle

>>> dir(turtle)

['Canvas', 'Pen', 'RawPen', 'RawTurtle', 'Screen', 'ScrolledCanvas', 'Shape', 'TK', 'TNavigator', 'TPen', 'Tbuffer', 'Terminator', 'Turtle', 'TurtleGraphicsError', 'TurtleScreen',...... 'time', 'title', 'towards', 'tracer', 'turtles', 'turtlesize', 'types', 'undo', 'undobufferentries', 'up', 'update', 'width', 'window_height', 'window_width', 'write', 'write_docstringdict', 'xcor', 'ycor']

>>> help(turtle.bgcolor)

Help on function bgcolor in module turtle:

bgcolor(*args)

    Set or return backgroundcolor of the TurtleScreen.

    Arguments (if given): a color string or three numbers

    in the range 0..colormode or a 3-tuple of such numbers.

    Example:

    >>> bgcolor("orange")

    >>> bgcolor()

    'orange'

    >>> bgcolor(0.5,0,0.5)

    >>> bgcolor()

    '#800080'

使用 星号导入时会导入模块中的所有类、属性、方法,此时可不用加模块名

>>> from turtle import *

>>> help(bgcolor)

Help on function bgcolor in module turtle:

bgcolor(*args)

    Set or return backgroundcolor of the TurtleScreen.

    Arguments (if given): a color string or three numbers

    in the range 0..colormode or a 3-tuple of such numbers.

    Example:

    >>> bgcolor("orange")

    >>> bgcolor()

    'orange'

    >>> bgcolor(0.5,0,0.5)

    >>> bgcolor()

    '#800080'

参考python学习手册