Question

我使用PyCharm编写我的Python 3.6脚本，并且刚刚发现了文档字符串的功能。我想了解更多有关类型的信息。

如果我使用 pandas数据框作为参数，或者如果我使用从Outlook获得的 pywin32-object 作为参数怎么办？

如果我要填充参数的类型，是否必须键入完整的类名？
现在我要type(dataframe)来获取类名。我将该信息复制到我的文档字符串中：<class 'pandas.core.frame.DataFrame'>是 pandas.core.frame.DataFrame在我的文档字符串中。

结果：

def my_fun(dataframe, mail_object):
    """
    Some informative text
    Parameters
    ----------
    dataframe : pandas.core.frame.DataFrame
        This is my dataframe to start with
    mail_object : win32com.gen_py.00062FFF-0000-0000-C000-000000000046x0x9x6._MailItem
        My mail object of Outlook
    Returns
    -------
    arguments_dict : dict

    """

所以将 pandas.core.frame.DataFrame 用作参数 dataframe 和 win32com.gen_py.00062FFF-0000-0000-C000的类型是否正确-000000000046x0x9x6._MailItem 作为mail_object的类型？
此外，如果win32.com的文本是动态的，会发生什么？这次是win32com.gen_py.00062FFF-0000-0000-C000-000000000046x0x9x6._MailItem，但是下次是win32com.gen_py.01245._MailItem

如何在文档字符串中指定类型

0 个答案: