如何为嵌套字典返回类型添加python docstring

时间:2019-06-17 14:28:25

标签: python dictionary docstring

我正在尝试为返回类型Dictionary创建一个文档字符串。字典具有日期->字典键值对。嵌套的Dictionary具有2个string-> int键值对和一个string-> Dictionary键值对

当前文档字符串如下所示:

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
           }
  }
}

0 个答案:

没有答案