如何在docstring中指定类型

2024-09-21 02:52:06 发布

您现在位置:Python中文网/ 问答频道 /正文

我使用PyCharm编写python3.6脚本,刚刚发现docstring的强大功能。我想知道更多关于类型的信息。你知道吗

如果我使用熊猫数据框作为参数,或者使用从Outlook获得的pywin32 object的参数,会怎么样?你知道吗

如果要填充参数的类型,是否必须键入完整的类名?
现在我要type(dataframe)获取类名。我将这些信息复制到我的docstring:<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

    """

那么写1.core.frame框架.DataFrame作为参数DataFramewin32的类型通用电气公司.00062FFF-0000-0000-C000-000000000046x0x9x6.\u MailItem是否作为邮件对象的类型?
此外,如果win32.com的文本是动态的,会发生什么?这次是win32com.gen_py.00062FFF-0000-0000-C000-000000000046x0x9x6._MailItem,但下次是win32com.gen_py.01245._MailItem


Tags: core信息类型dataframepandas参数objectmail

热门问题