Проверьте, вызвал ли скрипт Sphinx doc

В настоящее время я пытаюсь создать документацию sphinx для сценариев, использующих библиотеку arcpy ArcGIS.

Я столкнулся с проблемой, когда sphinx пытается запустить сценарии при создании документации, поскольку сценарии arcpy берут входные параметры из графического интерфейса arcgis. Поскольку sphinx вызывает скрипты без графического интерфейса, эти параметры пусты и вызывают такие трассировки, как:

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.

Я обхожу эту проблему в юнит-тестах, устанавливая переменную, когда начинается тест, который проверяет скрипт, и устанавливает тестовые значения в параметрах. Мне интересно, есть ли аналогичный обходной путь со сфинксом?


python python-sphinx arcpy
person navigator_    schedule 30.12.2013    source источник

Ответы (4)


arrow_upward
4
arrow_downward

Решение, которое я придумал, хотя, вероятно, далеко не идеальное, состоит в том, чтобы просто проверить

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

Это гарантирует, что сценарий не будет пытаться получить параметр из графического интерфейса, который не установлен при создании документов sphinx.

person navigator_    schedule 06.01.2014
comment
Отличный хак для большинства проектов! К сожалению, если вы документируете расширение sphinx, оно не сработает :/ - person svenevs; 11.04.2018

arrow_upward
2
arrow_downward

Если ваш проект импортирует 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"]:
person svenevs    schedule 12.04.2018

arrow_upward
1
arrow_downward

Я делаю что-то вроде этого. В моем 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')
person Iguananaut    schedule 04.12.2020

arrow_upward
0
arrow_downward

Начиная со Sphinx 1.3 для этой проблемы есть простое решение. Просто добавь

autodoc_mock_imports = ['arcpy']

в ваш conf.py. Это можно использовать, когда некоторые внешние зависимости не выполняются во время сборки и прерывают процесс сборки. См. раздел Sphinx: как исключить импорт в автомодуле?.

К сожалению, Esri имеет очень плохую документацию по arcpy и в основном игнорирует стандарты Python.

person Georg Haefele    schedule 17.07.2020