Как указать тип строки документации - PullRequest
Новая
       31

Как указать тип строки документации

0 голосов
/ 19 декабря 2018

Я использую PyCharm для написания своих скриптов на Python 3.6 и только что обнаружил силу строк документации.Я хотел бы узнать больше о type .

Что если я использую pandas data frame в качестве аргумента или что если я использую аргумент pywin32-объект , который я получил из Outlook?

Если я хочу заполнить тип аргумента, нужно ли вводить полное имя класса?
Пока я делаю 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

...