Docstring - python中参数名称和类型的用法

时间:2018-01-09 09:34:12

标签: python docstring

我用Python编写了一些类,我为他们编写了文档字符串:

class DB:
    def execute_and_return(self, sql):
        """Execute the query and returns the result as a list of list
        Parameters
        ----------
        sql: str
            Your query
        Returns
        -------
        list""

如果我想访问另一个类中的docstring,我可以简单地调用DB.execute_and_return.__doc__并获取字符串。

但是,如果我有兴趣知道参数的名称(在这种情况下是sql)和数据的类型(在这种情况下是str),那么有任何内置函数可以访问?

1 个答案:

答案 0 :(得分:0)

python没有严格的类型,因此除非在文档中明确说明,否则您永远无法确定变量应该是什么类型。但是有一种方法可以在python中找到变量名:

import inspect
args = inspect.getargspec(DB.execute_and_return)[0]