python 文档怎么看

调用help函数，可以看到一个函数或者方法的字符串文档。

In [1]: import requests

In [2]: help(requests.get)

Help on function get in module requests.api:

get(url, params=None, **kwargs)

Sends a GET request.

:param url: URL for the new :class:`Request` object.
:param params: (optional) Dictionary or bytes to be sent in the query string for the :class:`Request`.
:param \*\*kwargs: Optional arguments that ``request`` takes.
:return: :class:`Response <Response>` object
:rtype: requests.Response

使用dir可以查看模块或对象都有那些方法。

In [3]: dir(requests)
Out[3]:
['ConnectionError',
'HTTPError',
'compat',
'cookies',
'delete',
'exceptions',
'get',
'head',
'hooks',
...
使用ipython+?查看

In [4]: requests.get?
Type: function
String form:
File: /Library/Python/2.7/site-packages/requests/api.py
Definition: requests.get(url, params=None, **kwargs)
Docstring:
Sends a GET request.

:param url: URL for the new :class:Request object.
:param params: (optional) Dictionary or bytes to be sent in the query string for the :class:Request.
:param **kwargs: Optional arguments that request takes.
:return: :class:Response <Response> object
:rtype: requests.Response
使用pydoc查看字符串文档

☁ ~ python -m pydoc requests

Help on package requests:

NAME

requests

FILE

/Library/Python/2.7/site-packages/requests/__init__.py

DESCRIPTION

requests HTTP library

Requests is an HTTP library, written in Python, for human beings. Basic GET
usage:

   >>> import requests
   >>> r = requests.get('https://www.python.org')
   >>> r.status_code
   200
   >>> 'Python is a programming language' in r.content
   True