有没有办法返回方法文档字符串?

时间:2018-06-03 06:42:15

标签: python methods documentation

由于python3中的dir()方法返回所有可用的可用方法, 是否有任何方法可以将方法的文档(解释)作为字符串返回?

如果是字典的pop()方法,则应返回以下内容:

  

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

     

@overload def pop可能的类型:
    •(self:MutableMapping,k:_KT) - > _VT

     

•(self:MutableMapping,k:_KT,默认:Union [_VT,_T]) - >联盟[_VT,_T]

     

外部文件:   http://docs.python.org/3.6/library/

2 个答案:

答案 0 :(得分:2)

您可以使用__doc__属性访问函数的docstring:

➜ 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

答案 1 :(得分:0)

[解决]

正如所提及的评论和答案,帮助()或 doc 工作正常!

print(help(dict.pop))

print(dict.pop.__doc__)