检查Sphinx文档是否调用了该脚本

问题描述

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

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

C:VersionControlPythonScriptsSourcesrc\_buildscript_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:VersionControlPythonScriptsSourcesrclibPython27ArcGIS10.1libsite-packagessphinxextautodoc.py", line 335, in import_object
    __import__(self.modname)
  File "C:VersionControlPythonScriptsSourcesrcgisscriptsscript_export_pdf.py", line 76, in <module>
    mxd.ExportToPDF(in_mxds, out_folder, overwrite, current)
  File "C:VersionControlPythonScriptsSourcesrcgismappingmxd.py", line 315, in ExportToPDF
    _ExportToPDF(arcpy.mapping.MapDocument(m), out_folder, overwrite)
  File "C:Program Files (x86)ArcGISDesktop10.1arcpyarcpyarcobjectsmixins.py", line 609, in __init__
    assert (os.path.isfile(mxd) or (mxd.lower() == "current")), gp.getIDMessage(89004, "Invalid MXD filename")
AssertionError: Invalid MXD filename.

我在单元测试中绕过了这个问题，方法是在测试开始时设置一个变量，脚本将检查该变量并在参数中设置测试值，我想知道Shinx是否有类似的解决方法？

---

解决方案

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

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

这将确保脚本不会尝试从图形用户界面获取参数，而该参数在生成sphinx文档时并未设置。