Отладка QGIS расширения в PyCharm - История изменений

Yellow-sky: /* Ссылки по теме */

2014-11-27T14:02:43Z

Ссылки по теме

← Предыдущая версия		Версия от 16:02, 27 ноября 2014
Строка 97:		Строка 97:

	[http://linfiniti.com/2012/09/remote-debugging-qgis-plugins-using-pycharm/ Remote debugging QGIS plugins using PyCharm]		[http://linfiniti.com/2012/09/remote-debugging-qgis-plugins-using-pycharm/ Remote debugging QGIS plugins using PyCharm]

			[https://www.jetbrains.com/pycharm/webhelp/remote-debugging.html PyCharm Onlin Help. Remote Debugging]

Yellow-sky: /* Предварительные настройки */

2014-11-27T13:59:53Z

Предварительные настройки

← Предыдущая версия		Версия от 15:59, 27 ноября 2014
Строка 16:		Строка 16:
	Так же, для удобства отладки желательно установить QGIS расширение [http://plugins.qgis.org/plugins/plugin_reloader/ Plugin Reloader]. Этот модуль позволяет перезагружать разрабатываемое расширение, например в следствии изменения кода, без перезапуска самого QGIS.		Так же, для удобства отладки желательно установить QGIS расширение [http://plugins.qgis.org/plugins/plugin_reloader/ Plugin Reloader]. Этот модуль позволяет перезагружать разрабатываемое расширение, например в следствии изменения кода, без перезапуска самого QGIS.

	Для возможности использовать удаленную отладку необходимо установить пакет pydevd в тот PYTHONPATH, с которым запускается QGIS. В общем случае это директория site-package системного Python. В случае использования ~~OSGEO4W~~ или нестандартной установки необходимо выбирать соответствующий интерпретатор\директорию установки.		Для возможности использовать удаленную отладку необходимо установить пакет pydevd в тот PYTHONPATH, с которым запускается QGIS. В общем случае это директория site-package системного Python. В случае использования OSGeo4W или нестандартной установки необходимо выбирать соответствующий интерпретатор\директорию установки.

	Пакет pydevd распространяется вместе с PyCharm. Обычно файл pycharm-debug.egg (pycharm-debug-py3k.egg если использвется Python 3) находится в корневой директории установки PyCharm. Установить пакет можно различными способами. Наиболее простой - с помощью easy_install или pip:		Пакет pydevd распространяется вместе с PyCharm. Обычно файл pycharm-debug.egg (pycharm-debug-py3k.egg если использвется Python 3) находится в корневой директории установки PyCharm. Установить пакет можно различными способами. Наиболее простой - с помощью easy_install или pip:

Yellow-sky: /* Предварительные настройки */

2014-11-27T13:59:38Z

Предварительные настройки

← Предыдущая версия		Версия от 15:59, 27 ноября 2014
Строка 27:		Строка 27:
	'''Для Windows'''		'''Для Windows'''
	<syntaxhighlight lang="bash">		<syntaxhighlight lang="bash">
	~~python~~ c:\Python27\Scripts\easy_install.py c:\Soft\pycharm-3.4.1\pycharm-debug.egg		c:\Python27\Scripts\easy_install.exe c:\Soft\pycharm-3.4.1\pycharm-debug.egg
	</syntaxhighlight>		</syntaxhighlight>

Yellow-sky: /* Описание проблемы */

2014-11-27T13:58:56Z

Описание проблемы

← Предыдущая версия		Версия от 15:58, 27 ноября 2014
Строка 7:		Строка 7:
	Для того, что бы иметь возможность отлаживать части кода в IDE можно воспользоваться механизмом Remote Debug (удаленная отладка). В этом случае, код, выполняемый в другом процессе, может сам инициировать остановку исполнения и передать управление другому процессу, например нашей IDE.		Для того, что бы иметь возможность отлаживать части кода в IDE можно воспользоваться механизмом Remote Debug (удаленная отладка). В этом случае, код, выполняемый в другом процессе, может сам инициировать остановку исполнения и передать управление другому процессу, например нашей IDE.

	Этим способом можно воспользоваться в различных IDE. В заметке описывается вариант для PyCharm версии 3.4 или выше.		Этим способом можно воспользоваться в различных IDE. В заметке описывается вариант для [https://www.jetbrains.com/pycharm/ PyCharm] версии 3.4 или выше.

			Данная IDE имеет удобные функции автодополнения, проверки синтаксиса, проверки на соответствие кода требованиям pep8 и pylint и запуска юнит-тестов, что делает её удобной для разработки расширений для QGIS.

	== Предварительные настройки ==		== Предварительные настройки ==

Yellow-sky в 13:50, 27 ноября 2014

2014-11-27T13:50:53Z

← Предыдущая версия		Версия от 15:50, 27 ноября 2014
Строка 3:		Строка 3:

	== Описание проблемы ==		== Описание проблемы ==
	При разработке расширений QGIS на ~~python~~ не редко встает проблема отладки кода. К сожалению, для отладки модуля в "родном окружении" необходимо запустить QGIS, который и загрузит разрабатываемое расширение в своем процессе. При этом режим интерактивной отладки из среды разработки(IDE) становится недоступным, так как код расширения запущен не в режиме отладки (pdb), а в стандартном процессе-интерпретаторе Python.		При разработке расширений QGIS на Python не редко встает проблема отладки кода. К сожалению, для отладки модуля в "родном окружении" необходимо запустить QGIS, который и загрузит разрабатываемое расширение в своем процессе. При этом режим интерактивной отладки из среды разработки(IDE) становится недоступным, так как код расширения запущен не в режиме отладки (pdb), а в стандартном процессе-интерпретаторе Python.

	Для того, что бы иметь возможность отлаживать части кода в IDE можно воспользоваться механизмом Remote Debug (удаленная отладка). В этом случае, код, выполняемый в другом процессе, может сам инициировать остановку исполнения и передать управление другому процессу, например нашей IDE.		Для того, что бы иметь возможность отлаживать части кода в IDE можно воспользоваться механизмом Remote Debug (удаленная отладка). В этом случае, код, выполняемый в другом процессе, может сам инициировать остановку исполнения и передать управление другому процессу, например нашей IDE.

Yellow-sky в 13:48, 27 ноября 2014

2014-11-27T13:48:17Z

← Предыдущая версия		Версия от 15:48, 27 ноября 2014
Строка 70:		Строка 70:
	Запуск отладки происходит в два этапа.		Запуск отладки происходит в два этапа.

	1) Запуск сервера отладки в IDE. Для этого необходимо нажать комбинацию Shift-F9 или нажать кнопку Debug на панели инструментов. При этом в нижней панели отобразится окно отладки и станет активна вкладка Console, в которую будут выводится сообщения.		1. Запуск сервера отладки в IDE. Для этого необходимо нажать комбинацию Shift-F9 или нажать кнопку Debug на панели инструментов. При этом в нижней панели отобразится окно отладки и станет активна вкладка Console, в которую будут выводится сообщения.
	При успешном запуске в консоли должны появится строки:		При успешном запуске в консоли должны появится строки:

Строка 79:		Строка 79:


	2~~) Запустить~~ QGIS, либо ~~перезагрузить разрабатываемый модуль~~ с помощью Plugin Reloader, если QGIS уже был запущен. При этом, когда выполнение дойдет до указанной точки, в консоли отладки PyCharm появится строка:		2. Запуск QGIS, либо перезагрузка разрабатываемого модуля с помощью Plugin Reloader, если QGIS уже был запущен. При этом, когда выполнение дойдет до указанной точки, в консоли отладки PyCharm появится строка:

	<pre>		<pre>
Строка 86:		Строка 86:

	и стать активной вкладка Debbuger:		и стать активной вкладка Debbuger:
	[[Файл:Remote debug pycharm5.png\|~~448px~~]]
			[[Файл:Remote debug pycharm5.png\|550px]]

	Теперь можно работать с отладчиком в интерактивном режиме как при обычной отладке.		Теперь можно работать с отладчиком в интерактивном режиме как при обычной отладке.

Yellow-sky: /* Запуск отладки */

2014-11-27T13:46:20Z

Запуск отладки

← Предыдущая версия		Версия от 15:46, 27 ноября 2014
Строка 68:		Строка 68:

	== Запуск отладки ==		== Запуск отладки ==
			Запуск отладки происходит в два этапа.

			1) Запуск сервера отладки в IDE. Для этого необходимо нажать комбинацию Shift-F9 или нажать кнопку Debug на панели инструментов. При этом в нижней панели отобразится окно отладки и станет активна вкладка Console, в которую будут выводится сообщения.
			При успешном запуске в консоли должны появится строки:

			<pre>
			Starting debug server at port 5566
			Waiting for process connection...
			</pre>


			2) Запустить QGIS, либо перезагрузить разрабатываемый модуль с помощью Plugin Reloader, если QGIS уже был запущен. При этом, когда выполнение дойдет до указанной точки, в консоли отладки PyCharm появится строка:

			<pre>
			Connected to pydev debugger (build 139.487)
			</pre>

			и стать активной вкладка Debbuger:
			[[Файл:Remote debug pycharm5.png\|448px]]

			Теперь можно работать с отладчиком в интерактивном режиме как при обычной отладке.

	== Ссылки по теме ==		== Ссылки по теме ==

Yellow-sky: /* Выбор места установки точки останова */

2014-11-27T13:32:45Z

Выбор места установки точки останова

← Предыдущая версия		Версия от 15:32, 27 ноября 2014
Строка 62:		Строка 62:

	'''Важно!'''		'''Важно!'''
	В PyCharm 3.X вставка этого вызова в функции __init__ или initGui класса расширения иногда могут приводить к зависаниям QGIS при старте или при перезагрузке модуля. В PyCharm 4.0 такого зависания не наблюдается.
			При использовании PyCharm 3.X вставка этого вызова в функции __init__ или initGui класса расширения иногда могут приводить к зависаниям QGIS при старте или при перезагрузке модуля. С PyCharm 4.0 такого зависания не наблюдается.

	После вставки данного вызова можно как и при обычной отладке расставлять в коде точки останова.		После вставки данного вызова можно как и при обычной отладке расставлять в коде точки останова.

Yellow-sky: /* Выбор места установки точки останова */

2014-11-27T13:31:58Z

Выбор места установки точки останова

← Предыдущая версия		Версия от 15:31, 27 ноября 2014
Строка 57:		Строка 57:
	<syntaxhighlight lang="python">		<syntaxhighlight lang="python">
	import pydevd		import pydevd
	pydevd.settrace('localhost', port=5566, stdoutToServer=True, stderrToServer=True)		pydevd.settrace('localhost', port=5566, stdoutToServer=True, stderrToServer=True, suspend=False)
	</syntaxhighlight>		</syntaxhighlight>
	Вставлять данный код необходимо в том месте, где предполагается начинать саму отладку. Чаще всего это начало функции или обработчика некого события.		Вставлять данный код необходимо в том месте, где предполагается начинать саму отладку. Чаще всего это начало функции или обработчика некого события.

	'''Важно!'''		'''Важно!'''
			В PyCharm 3.X вставка этого вызова в функции __init__ или initGui класса расширения иногда могут приводить к зависаниям QGIS при старте или при перезагрузке модуля. В PyCharm 4.0 такого зависания не наблюдается.

			После вставки данного вызова можно как и при обычной отладке расставлять в коде точки останова.

	== Запуск отладки ==		== Запуск отладки ==

Yellow-sky: /* Выбор места установки точки останова */

2014-11-27T13:14:40Z

Выбор места установки точки останова

← Предыдущая версия		Версия от 15:14, 27 ноября 2014
Строка 59:		Строка 59:
	pydevd.settrace('localhost', port=5566, stdoutToServer=True, stderrToServer=True)		pydevd.settrace('localhost', port=5566, stdoutToServer=True, stderrToServer=True)
	</syntaxhighlight>		</syntaxhighlight>
			Вставлять данный код необходимо в том месте, где предполагается начинать саму отладку. Чаще всего это начало функции или обработчика некого события.

			'''Важно!'''

	== Запуск отладки ==		== Запуск отладки ==