Is there any way of returning method documentation strings?

Question

As dir() method in python3 returns all the available usable methods, is there any methods for returning documentation(explanation) of the method as string?

In case of pop() method of dictionary it should be returning the following:

class MutableMapping(Mapping[_KT, _VT], Generic[_KT, _VT])

@overload def pop Possible types:
• (self: MutableMapping, k: _KT) -> _VT

• (self: MutableMapping, k: _KT, default: Union[_VT, _T]) -> Union[_VT, _T]

External documentation: http://docs.python.org/3.6/library/

That's not what `help(dict.pop)` outputs. What is that output? — Aran-Fey, Jun 03 '18 at 06:45
So... do you want pycharm's documentation as output or the official one? — Aran-Fey, Jun 03 '18 at 06:47
Uhm Actually I think help(), (__doc__) built-in methods work! — , Jun 03 '18 at 06:49

score 2 · Accepted Answer · answered Jun 03 '18 at 06:47

You can access the docstring of a function using the __doc__ attribute:

➜ python
Python 3.6.4 (default, May 23 2018, 17:30:17)
Type "help", "copyright", "credits" or "license" for more information.
>>> print(dict.pop.__doc__)
D.pop(k[,d]) -> v, remove specified key and return the corresponding value.
If key is not found, d is returned if given, otherwise KeyError is raised

score 0 · Answer 2 · answered Jun 03 '18 at 07:01

0

[Solved]

As the comments and the answers mentioned, either help() or doc works fine!

print(help(dict.pop))

print(dict.pop.__doc__)

answered Jun 03 '18 at 07:01

Is there any way of returning method documentation strings?

2 Answers2