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

Question

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

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

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.

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

Answer 1

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

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

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