Epydoc выполняет файл Python

Question

У меня есть файл Python с несколькими классами в нем и хотел использовать epydoc для создания документации из моих комментариев. Так что я делаю на консоли в моей системе Debian wheezy:

epydoc --html storage_config_tool.py -o ~/

Он всегда выполняет приложение на Python, и генерация документов останавливается на 21%. Такое же поведение, когда я использую epydocgui.

Когда я тестирую его в простой программе hello world, все работает нормально. Файл имеет> 1000 строк, поэтому я не могу опубликовать его. Сама программа работает отлично.

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

Спасибо 4 помощь

Answer 1

Не видя ваш код, трудно сказать, в чем проблема. Тем не менее, звучит так, как будто код для запуска приложения не защищен if __name__ == '__main__': заявление, поэтому приложение запускается, когда epydoc импортирует файл Две вещи, которые могут помочь:

1. исправлять storage_config_tool.py так что только class, defи операторы присваивания выполняются при импорте модуля.

2. использование epydoc --html --parse-only storage_config_tool.py -o ~/ генерировать документацию. Это пропускает этап импорта модуля, который может или не может быть необходим для генерации полной документации.