Archive:Debug Python Scripts with Eclipse - Revision history

Karellen at 03:30, 12 September 2020

2020-09-12T03:30:03Z

← Older revision		Revision as of 03:30, 12 September 2020
Line 1:		Line 1:
	Here is a method you can adopt in order to use the Eclipse (multi-platforms) remote debugger with your Python scripts/plugin.		Here is a method you can adopt in order to use the Eclipse (multi-platforms) remote debugger with your Python scripts/plugin.

	~~Note: Follow this link [[HOW-TO:Debug_python_scripts\|Debugging Python Scripts on Linux with WinPDB]] for more information if you prefer to use WinPDB instead.~~

	Note: The information provided herein is also applicable to user with [http://www.aptana.com/ Aptana Studio 3] installation which come pre-installed with pydev. For this case, you can skip to [[#Configure Pydev and Eclipse\|Configure Pydev and Eclipse]] after the Aptana Studio 3 installation.		Note: The information provided herein is also applicable to user with [http://www.aptana.com/ Aptana Studio 3] installation which come pre-installed with pydev. For this case, you can skip to [[#Configure Pydev and Eclipse\|Configure Pydev and Eclipse]] after the Aptana Studio 3 installation.
Line 140:		Line 138:
	{{Collapse top}}		{{Collapse top}}
	In new Eclipse versions on Linux, the standard eclipse installation (/usr/share/eclipse/plugins) does not contain the pydev files any more.		In new Eclipse versions on Linux, the standard eclipse installation (/usr/share/eclipse/plugins) does not contain the pydev files any more.
	The easiest solution is to install the ~~[[Add-on:Pydevd\|~~pydevd-addon]].<br />		The easiest solution is to install the pydevd-addon.<br />
	To access this from your addon, your addon.xml has to contain <code><import addon="script.module.pydevd" version="3.4.1"/></code>.		To access this from your addon, your addon.xml has to contain <code><import addon="script.module.pydevd" version="3.4.1"/></code>.
	{{Collapse bottom}}		{{Collapse bottom}}
Line 173:		Line 171:
	* Option 2 - Copy pysrc in our script directory and refer it from our script		* Option 2 - Copy pysrc in our script directory and refer it from our script
	* Option 3 - Copy pysrc in XBMC Python install		* Option 3 - Copy pysrc in XBMC Python install
	* Option 4 - Use the pydev from the ~~[[Add-on:Pydevd\|~~pydevd-addon]]		* Option 4 - Use the pydev from the pydevd-addon

	I am only going to show you the steps for ''Option 3'':		I am only going to show you the steps for ''Option 3'':
Line 184:		Line 182:

	===== Option 4: (Suggested for Linux users) =====		===== Option 4: (Suggested for Linux users) =====
	Use the ~~[[Add-on:Pydevd\|~~pydevd-addon]] as described above. No action necessary. Option 3 does not work on Linux, because /usr/share/kodi/system/python/Lib is ignored.		Use the pydevd-addon as described above. No action necessary. Option 3 does not work on Linux, because /usr/share/kodi/system/python/Lib is ignored.

	=== Add to your python script the code for remote debug ===		=== Add to your python script the code for remote debug ===

Karellen at 01:59, 26 July 2020

2020-07-26T01:59:48Z

← Older revision		Revision as of 01:59, 26 July 2020
Line 1:		Line 1:
	~~{{mininav\|[[Development]]\|[[Add-on development]]}}~~

	Here is a method you can adopt in order to use the Eclipse (multi-platforms) remote debugger with your Python scripts/plugin.		Here is a method you can adopt in order to use the Eclipse (multi-platforms) remote debugger with your Python scripts/plugin.

Line 251:		Line 249:
	[[File:EclipsePydevDebugger.png]]		[[File:EclipsePydevDebugger.png]]

	~~== See also ==~~
	* [[Add-ons]]
	~~'''Development:'''~~
	* [[Add-on_settings\|Addon Settings]]
	* [[Add-on repositories]]
	* [[Official add-on repository]]

	[[Category:~~Python]]~~		[[Category:Development-Archived]]
	~~[[Category:Add~~-~~on development~~]]

Karellen: Karellen moved page HOW-TO:Debug Python Scripts with Eclipse to Archive:Debug Python Scripts with Eclipse without leaving a redirect: Outdated

2020-07-26T01:57:33Z

Karellen moved page HOW-TO:Debug Python Scripts with Eclipse to Archive:Debug Python Scripts with Eclipse without leaving a redirect: Outdated

← Older revision	Revision as of 01:57, 26 July 2020
(No difference)

Karellen at 22:50, 20 July 2020

2020-07-20T22:50:54Z

← Older revision		Revision as of 22:50, 20 July 2020
Line 1:		Line 1:
	{{mininav\|[[Development]]\|[[Add-on ~~development]]\|[[Python~~ development]]}}		{{mininav\|[[Development]]\|[[Add-on development]]}}

	Here is a method you can adopt in order to use the Eclipse (multi-platforms) remote debugger with your Python scripts/plugin.		Here is a method you can adopt in order to use the Eclipse (multi-platforms) remote debugger with your Python scripts/plugin.

	Note: Follow this link [[HOW-TO ~~debug Python Scripts~~\|Debugging Python Scripts on Linux with WinPDB]] for more information if you prefer to use WinPDB instead.		Note: Follow this link [[HOW-TO:Debug_python_scripts\|Debugging Python Scripts on Linux with WinPDB]] for more information if you prefer to use WinPDB instead.

	Note: The information provided herein is also applicable to user with [http://www.aptana.com/ Aptana Studio 3] installation which come pre-installed with pydev. For this case, you can skip to [[#Configure Pydev and Eclipse\|Configure Pydev and Eclipse]] after the Aptana Studio 3 installation.		Note: The information provided herein is also applicable to user with [http://www.aptana.com/ Aptana Studio 3] installation which come pre-installed with pydev. For this case, you can skip to [[#Configure Pydev and Eclipse\|Configure Pydev and Eclipse]] after the Aptana Studio 3 installation.
Line 253:		Line 253:
	== See also ==		== See also ==
	* [[Add-ons]]		* [[Add-ons]]
	* [[:Category:All add-ons]]
	* [[3rd party add-on repositories]]
	'''Development:'''		'''Development:'''
	* [[Add-~~on development]]~~		* [[Add-on_settings\|Addon Settings]]
	* [[Addon Settings]]
	* [[Python development]]
	* [[Add-on repositories]]		* [[Add-on repositories]]
	* [[Official add-on repository]]		* [[Official add-on repository]]

	[[Category:Python]]		[[Category:Python]]
	~~[[Category:How-to]]~~
	[[Category:Add-on development]]		[[Category:Add-on development]]

Calebzor: /* Identify where PyDev remote debugger Python files are */

2015-12-29T10:04:36Z

Identify where PyDev remote debugger Python files are

← Older revision		Revision as of 10:04, 29 December 2015
Line 130:		Line 130:

	==== Identify where PyDev remote debugger Python files are ====		==== Identify where PyDev remote debugger Python files are ====
			In later versions, you need to have started the debug server from Eclipse at least once for the following folder to show up.

	Python source files should be in you Eclipse installation directory:		Python source files should be in you Eclipse installation directory:
	<pre>C:\...\eclipse\plugins\org.python.pydev.debug_1.5.5.2010030420\pysrc\</pre>		<pre>C:\...\eclipse\plugins\org.python.pydev.debug_1.5.5.2010030420\pysrc\</pre>

Calebzor: /* Add to your python script the code for remote debug */

2015-12-29T09:59:51Z

Add to your python script the code for remote debug

← Older revision		Revision as of 09:59, 29 December 2015
Line 189:		Line 189:
	At the beginning of you Python script/plugin (usually Default.py) add the following code:		At the beginning of you Python script/plugin (usually Default.py) add the following code:
	<pre>		<pre>
	REMOTE_DBG = True		REMOTE_DBG = True

	# append pydev remote debugger		# append pydev remote debugger
Line 197:		Line 197:
	try:		try:
	import pysrc.pydevd as pydevd # with the addon script.module.pydevd, only use `import pydevd`		import pysrc.pydevd as pydevd # with the addon script.module.pydevd, only use `import pydevd`
	# stdoutToServer and stderrToServer redirect stdout and stderr to eclipse console		# stdoutToServer and stderrToServer redirect stdout and stderr to eclipse console
	pydevd.settrace('localhost', stdoutToServer=True, stderrToServer=True)		pydevd.settrace('localhost', stdoutToServer=True, stderrToServer=True)
	except ImportError:		except ImportError:
Line 205:		Line 205:
	</pre>		</pre>

	In the case you have ~~change~~ the default port you can replace the line with pydevd.settrace by this one:		If this doesn't work and you are still getting the PYTHONPATH error you can try to:

			Replace:

			<pre>
			import pysrc.pydevd as pydevd
			</pre>

			in the code snippet above with:

			<pre>
			import sys
			sys.path.append('full_path_to_pysrc')
			import pydevd
			</pre>

			In the case you have changed the default port you can replace the line with pydevd.settrace by this one:
	<pre>		<pre>
	pydevd.settrace('localhost', port=5678, stdoutToServer=True, stderrToServer=True)		pydevd.settrace('localhost', port=5678, stdoutToServer=True, stderrToServer=True)

NedBot: web link corrections for xbmc.org -> kodi.tv; cosmetic changes

2015-05-13T01:14:39Z

web link corrections for xbmc.org -> kodi.tv; cosmetic changes

← Older revision		Revision as of 01:14, 13 May 2015
Line 69:		Line 69:
	Many developers are accustom to using predefined completions when writing their code (eg. type-ahead). The standard Python completions are enabled by default when using these instructions, but the standard XBMC components will not be recognized appropriately (xbmc, xbmcgui, xbmcplugin, etc).		Many developers are accustom to using predefined completions when writing their code (eg. type-ahead). The standard Python completions are enabled by default when using these instructions, but the standard XBMC components will not be recognized appropriately (xbmc, xbmcgui, xbmcplugin, etc).

	In order to overcome this, you can run the [http://forum.~~xbmc~~.~~org~~/showthread.php?t=79070 PyDev Predefined Completions Creator addon] and [http://pydev.org/manual_101_interpreter.html#PyDevInterpreterConfiguration-PredefinedCompletions setup Eclipse] to reference this file:		In order to overcome this, you can run the [http://forum.kodi.tv/showthread.php?t=79070 PyDev Predefined Completions Creator addon] and [http://pydev.org/manual_101_interpreter.html#PyDevInterpreterConfiguration-PredefinedCompletions setup Eclipse] to reference this file:
	# Download the 'PyDev Predefined Completions Creator' Addon (eg. System > Settings > Addons > XBMC.org > Program Add-Ons)		# Download the 'PyDev Predefined Completions Creator' Addon (eg. System > Settings > Addons > XBMC.org > Program Add-Ons)
	# Navigate to the newly installed Addon (eg. Programs from the home screen)		# Navigate to the newly installed Addon (eg. Programs from the home screen)
Line 233:		Line 233:
	[[File:EclipsePydevDebugger.png]]		[[File:EclipsePydevDebugger.png]]

	==See also==		== See also ==
	* [[Add-ons]]		* [[Add-ons]]
	* [[:Category:All add-ons]]		* [[:Category:All add-ons]]

Schapplm: /* Add to your python script the code for remote debug */

2015-01-11T15:31:29Z

Add to your python script the code for remote debug

← Older revision		Revision as of 15:31, 11 January 2015
Line 196:		Line 196:
	# Note pydevd module need to be copied in XBMC\system\python\Lib\pysrc		# Note pydevd module need to be copied in XBMC\system\python\Lib\pysrc
	try:		try:
	import pysrc.pydevd as pydevd		import pysrc.pydevd as pydevd # with the addon script.module.pydevd, only use `import pydevd`
	# stdoutToServer and stderrToServer redirect stdout and stderr to eclipse console		# stdoutToServer and stderrToServer redirect stdout and stderr to eclipse console
	pydevd.settrace('localhost', stdoutToServer=True, stderrToServer=True)		pydevd.settrace('localhost', stdoutToServer=True, stderrToServer=True)
Line 214:		Line 214:
	* Replace localhost by an IP address if XBMC and Eclipse are on 2 different machines		* Replace localhost by an IP address if XBMC and Eclipse are on 2 different machines
	* stdoutToServer and stderrToServer redirect stdout and stderr to eclipse console, you won't have to open xbmc.log file		* stdoutToServer and stderrToServer redirect stdout and stderr to eclipse console, you won't have to open xbmc.log file



	=== Run ===		=== Run ===

Schapplm: /* Copy pysrc in XBMC Python install */

2015-01-11T15:29:26Z

Copy pysrc in XBMC Python install

← Older revision		Revision as of 15:29, 11 January 2015
Line 178:		Line 178:

	==== Copy pysrc in XBMC Python install ====		==== Copy pysrc in XBMC Python install ====
			===== Option 3: (Suggested for Windows users) =====
	* Copy the content of pysrc to:		* Copy the content of pysrc to:
	<pre>XBMC\system\python\Lib\pysrc\</pre>		<pre>XBMC\system\python\Lib\pysrc\</pre>
	* Add an empty __init__.py file in it		* Add an empty __init__.py file in it

			===== Option 4: (Suggested for Linux users) =====
			Use the [[Add-on:Pydevd\|pydevd-addon]] as described above. No action necessary. Option 3 does not work on Linux, because /usr/share/kodi/system/python/Lib is ignored.

	=== Add to your python script the code for remote debug ===		=== Add to your python script the code for remote debug ===

Schapplm: /* Choose how XBMC will refer to Pydev debugging module */

2015-01-11T15:13:27Z

Choose how XBMC will refer to Pydev debugging module

← Older revision		Revision as of 15:13, 11 January 2015
Line 173:		Line 173:
	* Option 2 - Copy pysrc in our script directory and refer it from our script		* Option 2 - Copy pysrc in our script directory and refer it from our script
	* Option 3 - Copy pysrc in XBMC Python install		* Option 3 - Copy pysrc in XBMC Python install
			* Option 4 - Use the pydev from the [[Add-on:Pydevd\|pydevd-addon]]

	I am only going to show you the steps for ''Option 3'':		I am only going to show you the steps for ''Option 3'':