5

我正在尝试在扩展外部类的类上运行 autodoc。

我使用了模拟以便接受导入。

为此，我使用了此博客http://blog.rtwilson.com/how-to-make-your-sphinx-documentation-compile-with-readthedocs-when-youre-using-numpy-and-scipy/中描述的内容 

import mock

MOCK_MODULES = ['de', 'de.xyz', 'de.xyz.class_that_is_extended']
for mod_name in MOCK_MODULES:
  sys.modules[mod_name] = mock.Mock()

我尝试记录的 python 文件如下所示： from de.xyz import class_that_is_extended

class extending_class (class_that_is_extended):
'''
  docstring
'''

运行 sphinx 后，结果是只显示类名和源链接。

当我将“类扩展类（class_that_is_extended）：”行更改为“类扩展类（对象）：”时，sphinx/autodoc 生成带有文档字符串的文档。

我怎样才能让课程保持原样并仍然在文档中获取文档字符串？

4

2 回答 2

2

使用此处发布的方法： Sphinx-doc :automodule: with Mock imports

我刚刚更改了这一行：

sys.modules[mod_name] = mock.Mock()

到：

sys.modules[mod_name] = mock.Mock(class_that_is_extended=object)

并从 MOCK_MODULES 中删除了 'de.xyz.class_that_is_extended'

于 2014-09-23T15:25:22.913 回答
0

我遇到了同样的问题，我的解决方案是object直接从Mock属性访问返回。

from unittest.mock import MagicMock

MOCK_MODULES = [
    # modules to mock
    'kivy.uix.floatlayout',
]

MOCK_CLASSES = [
    # classes you are inheriting from
    "FloatLayout",
]


class Mock(MagicMock):
    @classmethod
    def __getattr__(cls, name):
        if name in MOCK_CLASSES:
            return object
        return MagicMock()


sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)
于 2018-03-30T08:08:19.003 回答