5

我目前正在尝试为使用 ArcGIS arcpy 库的脚本生成 sphinx 文档。

当 sphinx 在生成文档时尝试运行脚本时，我遇到了一个问题，因为 arcpy 脚本从 arcgis gui 获取输入参数。由于 sphinx 在没有 gui 的情况下调用脚本，因此这些参数为空并导致 Tracebacks，例如：

C:\VersionControl\PythonScripts\Source\src\_build\script_export_pdf.rst:4: WARNING:     autodoc: failed to import module u'gis.scripts.script_export_pdf'; the following exception was raised:
Traceback (most recent call last):
  File "C:\VersionControl\PythonScripts\Source\src\lib\Python27\ArcGIS10.1\lib\site-packages\sphinx\ext\autodoc.py", line 335, in import_object
    __import__(self.modname)
  File "C:\VersionControl\PythonScripts\Source\src\gis\scripts\script_export_pdf.py", line 76, in <module>
    mxd.ExportToPDF(in_mxds, out_folder, overwrite, current)
  File "C:\VersionControl\PythonScripts\Source\src\gis\mapping\mxd.py", line 315, in ExportToPDF
    _ExportToPDF(arcpy.mapping.MapDocument(m), out_folder, overwrite)
  File "C:\Program Files (x86)\ArcGIS\Desktop10.1\arcpy\arcpy\arcobjects\mixins.py", line 609, in __init__
    assert (os.path.isfile(mxd) or (mxd.lower() == "current")), gp.getIDMessage(89004, "Invalid MXD filename")
AssertionError: Invalid MXD filename.

我通过在测试开始时设置一个变量来解决单元测试中的这个问题，脚本检查并在参数中设置测试值，我想知道狮身人面像是否有类似的解决方法？

4

4 回答 4

4

我想出的解决方案虽然可能远非理想，但只需检查

if 'sphinx' in sys.modules:
    in_mxds = [r"C:/test.mxd"]
else:
    in_mxds = arcpy.GetParameterAsText(1)

这将确保脚本不会尝试从生成 sphinx 文档时未设置的 GUI 获取参数。

于 2014-01-06T22:59:43.967 回答
3

我做这样的事情。在我conf.py的模块中，我添加了一个新变量，builtins例如：

# anywhere in conf.py before any of your modules are imported
import builtins
builtins.__sphinx_build__ = True

然后在我的模块代码中，我可以编写如下检查：

try:
    from some_dependency import SomeClass
except ImportError:
    try:
        if __sphinx_build__:
            class SomeClass:
                """Mock the class"""
    except NameError:
        raise ImportError('some_dependency')
于 2020-12-04T17:03:49.897 回答
1

如果您的项目正在导入sphinx（在我的情况下是 sphinx 扩展），以下内容也可能对您有用

import os
import sys
if os.path.basename(sys.argv[0]) == "sphinx-build":
    # code for when sphinx is running
else:
    # code for regular application

我不确定这是否适用于 Windows，或者是否应该类似于

if os.path.basename(sys.argv[0]) in ["sphinx-build", "sphinx-build.exe"]:
于 2018-04-12T05:04:45.800 回答
1

从 Sphinx 1.3 开始，这个问题有一个简单的解决方案。只需添加

autodoc_mock_imports = ['arcpy']

到你的conf.py。这可以在构建时不满足某些外部依赖项并破坏构建过程时使用。请参阅Sphinx：如何在自动模块中排除导入？.

不幸的是，Esri 的 arcpy 文档非常差，而且大多忽略了 Python 标准。

于 2020-07-17T10:41:20.307 回答