如何为dict的dict添加python docstring

Question

我有一个对象是字典的字典。我想告诉我的编辑这个对象是这样的，我该怎么做呢？目前我有：

def do_somthing(dict_of_dicts):
    """
    :type dict_of_dicts: dict of dict
    """

    for key, value in dict_of_dicts.items():
            for key2, value2 in value.items():
                print('Key')

但是，我的编辑器（Pycharm）似乎没有注册这个。

Answer 1

您可以使用Dict 的类型提示来实现此目的：

from typing import Dict, Any

def do_somthing(dict_of_dicts: Dict[Any, Dict]):
    """
    :type dict_of_dicts: Dict[Any, Dict]
    """

    for key, value in dict_of_dicts.items():
            for key2, value2 in value.items():
                print('Key')

Answer 2

我不使用 PyCharm，但是……它理解类型注释，对吗？因此，将其指定为注释：

from typing import Dict, Any

def do_something(dict_of_dicts: Dict[Any, Dict[Any, Any]]):
    # ...

或者你甚至可以定义一个通用的DictOfDict 类型（通用的外键、内键和内值）：

from typing import Dict, Any, TypeVar, Generic:

K1, K2, V = TypeVar('K1'), TypeVar('K2'), TypeVar('V')
class DictOfDicts(Dict[K1, Dict[K2, V]]): ...

def do_something(dict_of_dicts: DictOfDicts[Any, Any, Any]):
    # ...

Answer 3

您可能已经找到了答案，但对于偶然发现此主题的其他人：

试试这个，不用导入typing：

dict[dict]

它将在文档字符串中显示为：

 Dict[dict]

在你的例子中：

def do_somthing(dict_of_dicts):
    """
    :type dict_of_dicts: dict[Any, dict]
    """

    for key, value in dict_of_dicts.items():
            for key2, value2 in value.items():
                print('Key')

Answer 4

你也可以加param:

def do_somthing(dict_of_dicts):
    """
    :param dict_of_dicts: A dictionary of dictionaries.
    :type dict_of_dicts: dict of dict
    """

for key, value in dict_of_dicts.items():
        for key2, value2 in value.items():
            print('Key')

我建议阅读这篇文章：https://thomas-cokelaer.info/tutorials/sphinx/docstring_python.html