Как документировать вложенные и неопределенные типы? - PullRequest
Новая
       6

Как документировать вложенные и неопределенные типы?

0 голосов
/ 21 января 2019

Я пытаюсь задокументировать тип возврата функции, которая запрашивает базу данных.Моя попытка выглядит так: 

"""
Execute the query, append a report to the file (start & end time, duration, n rows and result file) and copy results
next to the original file with the same file name but the extension being csv.

:param file_path: file containing a single SQL query
:type file_path: str
:return: data queried from the database
:rtype: {'headers': list<str>, 'rows': list<tuple<any>>}
"""

Однако я действительно не уверен насчет "rtype".Вот пример такого объекта: 

{
   "headers": ["id", "name"],
   "rows": [
     (1, "Adrien"),
     (2, "Simon")
   ]
}

Так что это диктуется ключом "заголовки", в котором размещен список строк, и ключом "строки", в котором находится список кортежей элементов неопределенного типа.Я думаю, у меня есть две проблемы здесь:

  1. Как документировать вложенные типы?GenericType<SubType> ок?
  2. Как документировать неопределенный тип?any ок?

Я ищу соглашение, если таковое существует.

...