Python - Help / Function Documentation

> Procedural Languages > Python

1 - How to

1.1 - Get all methods

From the python shell, use the dir function.

For instance for a list

>>> myList = []
>>> dir(myList)
['__add__', '__class__', '__contains__', '__delattr__', '__delitem__', '__delslice__', '__doc__', '__eq__', '__format__',
 '__ge__', '__getat
tribute__', '__getitem__', '__getslice__', '__gt__', '__hash__', '__iadd__', '__imul__', '__init__', '__iter__', 
'__le__', '__len__', '__lt_
_', '__mul__', '__ne__', '__new__', '__reduce__', '__reduce_ex__', '__repr__', '__reversed__', '__rmul__', '__setattr__', 
'__setitem__', '__
setslice__', '__sizeof__', '__str__', '__subclasshook__', 'append', 'count', 'extend', 'index', 'insert', 'pop', 
'remove', 'reverse', 'sort'
]
Advertising

1.2 - Get the documentation of a function

>>> help(myList.insert)
Help on built-in function insert:
 
insert(...)
    L.insert(index, object) -- insert object before index

1.3 - Get a global help

help()