Как добавить строку документации Python для возвращаемого вложенного словаря - PullRequest
Новая
       24

Как добавить строку документации Python для возвращаемого вложенного словаря

3 голосов
/ 17 июня 2019

Я пытаюсь создать строку документации для словаря возвращаемого типа. В словаре есть пары Дата-> Словарь-значение. Вложенный словарь имеет 2 пары ключ-значение строка-> int и пару ключ-значение словарь-> строка

Текущая строка документации выглядит следующим образом: 

def func():
  """
  Some explanation of what my function does and explaining the return types

    Returns:
      a_dict(Dictionary)
        Key: date (Date)
        Value: another_dict(Dictionary)
          Key: 'foo' (str)
          Value: value (int) 
          Key: 'bar' (str)
          Value: value (int) 
          Key: 'qaz' (str)
          Value: third_dict (Dictionary of str:int)


 """

Тем не менее, это выглядит намного сложнее и сложнее, чем хотелось бы.

Как выглядит мое возвращение 

{
  datetime.date(2045, 12, 01): {
    'foo': 10,
    'bar': 20,
    'qaz': {'qaz_foo': 30,
            'quz_bar': 40
           }
  },
  datetime.date(2067, 12, 01): {
    'foo': 50,
    'bar': 60,
    'qaz': {'qaz_foo': 70,
            'quz_bar': 80
           }
  }
}
...