Формат строки Python с несколькими типами ввода - PullRequest
0 голосов
/ 20 ноября 2018

Я использую формат документации Python в стиле Google.Есть одна функция, и входным параметром может быть dict, list или string.Каков формат нескольких типов данных в строке документации?

Как

Args:
    input (str, list, dict): input of this function

1 Ответ

0 голосов
/ 20 ноября 2018

Как указано в документации Sphinx 1.5 , описывающей этот стиль форматирования, поддерживаются аннотации типа PEP 484.

PEP 484 определяет тип объединения какподходит для ситуации, когда у вас есть ограниченный набор принятых типов для аргумента.В вашем примере это будет:

Args:
    input (Union[str, list, dict]): input of this function
...