HOW-TO:Debug Python Scripts with Eclipse

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 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 Aptana Studio 3 installation which come pre-installed with pydev. For this case, you can skip to Configure Pydev and Eclipse after the Aptana Studio 3 installation.

Prerequisite

 * Any platform able to run Eclipse IDE (Windows 32bit-64bit, Mac Carbon 32bit-64bit, Mac Cocoa 32bit-64bit, Linux 32bit-64bit): it is the platform from where you will run the debugger IDE
 * Python interpreter 2.4 (use the same version as XBMC or version <= 2.7 ) install on the machine running Eclipse
 * Any platform running XBMC (Xbox, Linux, MACOSX, Windows): it is the platform running Python scripts/plugin connecting with the remote debugger.
 * XBMC installed on Ubuntu (should work just fine on Windows and Mac too)


 * Pydev plugin for Eclipse IDE: Pydev is a Python IDE for Eclipse, which may be used in Python, Jython and IronPython development.

Install Eclipse
Note: in our example Eclipse Galileo (3.5.1) is used
 * Download Eclipse IDE and install it

Install Pydev in Eclipse
Note: in our example PyDev 1.5.5
 * In Eclipse go in: Help -> Install New Software...
 * Click on the Add button and add Pydev website as a source: http://pydev.org/updates
 * You will see the window below:
 * Check PyDev box and follow the steps in order to install PyDev

Add Python Interpreter Path
This will help in order to have Python code completion (except for XBMC modules)
 * Go in Window -> Preferences
 * Pydev then Interpreter - Python
 * Click on button New...
 * In the new prompt, enter the Interpreter Name: Python, and Browse for your Python Interpreter 2.4 python.exe file and select it. After that you should see something like this:

Add Pydev view to Eclipse
Use this view for your developments in Python for XBMC
 * On the top right corner click on the View button on select Others
 * Select Pydev then OK, a PyDev View Button should be now available on the top right corner

Add Pydev Start/Stop debug server buttons

 * In the menu bar select Window -> Customize perspective..., a window Customize Perspective - PyDev will open
 * Select Command Groups Availability Tab
 * Check Pydev Debug box and OK
 * You should see 2 new buttons in your toolbar:

Setting the remote debugger port (optional)
If you do not want to use the default port (usually 5678) you can set it up:
 * Go to Window -> Preferences
 * Pydev then Debug you can define here the port and the timeout you want

Setting up Predefined Completions (optional)
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 PyDev Predefined Completions Creator addon and setup Eclipse to reference this file:
 * 1) Download the 'PyDev Predefined Completions Creator' Addon (eg. System > Settings > Addons > XBMC.org > Program Add-Ons)
 * 2) Navigate to the newly installed Addon (eg. Programs from the home screen)
 * 3) Open the context menu for newly installed addon and select 'Add-on Settings'
 * 4) Set the location to save the help docs to and save the new settings (This can be anywhere on your system - we'll configure it in Eclipse later)
 * 5) Select the add-on to run it (the addon should run and close quickly)
 * 6) Open Eclipse and select Window > Preferences > PyDev > Interpreter - Python
 * 7) From the 'Predefined' tab, click the new button and select the folder you created in the step above
 * 8) Press Apply / OK to ensure the changes are saved

Create a new PyDev Project
Most of the time when you are doing development, likely that you are running XBMC and Eclipse on the same platform; (The installed debugger described in this article actually can also work with a remote XBMC). Let's say you already have scripts installed in XBMC script folder that you want to create a new PyDev project e.g. C:\XBMC\addons\myscript1 C:\XBMC\addons\myscript2

With myscript1 & myscript2 being sub-directories of C:\XBMC\addons each containing the Default.py scripts. First you need to define the Python project workspace: Then proceed to create the Python project:
 * File -> Switch Workspace -> Other...
 * Browse to the parent directory of your script module i.e. C:\XBMC\addons in this example, select and OK
 * File -> New -> PyDev Project
 * OR select below in case PyDev Project is not displayed


 * File -> New -> Others; and Select Pydev then PyDev Project; Click Next
 * Enter the name of your project e.g. xbmc_addons
 * Uncheck option Use Default
 * Browse to the directory of your scripts and select i.e. C:\XBMC\addons.
 * Set ''Python' as Project Type
 * Select 2.4 (XBMC Python version) for the grammar
 * Select Don't configure PYTHONPATH (to be done manually later on)
 * Click on Finish button

Set the Python Path

 * Right click on your new project and select Properties
 * Select PyDev - PYTHONPATH and click on Add source folder
 * Select the source directory of your script, /xbmc_addons in our example

Import File System
Assuming you want to add in all the directories under C:\XBMC\addons Your source code is now recognized by Eclipse and you will have access to neat functionality such as code completion, link between source files, etc.
 * Right click on your new project and select Import...
 * Select General and click on File System; then Next
 * Browse to the source directory of your script (or plugin) e.g. C:\XBMC\addons
 * Check the directory and files to be added
 * Select Into folder: xbmc_addons
 * Select Options | <<Advanced | Create links in workspace
 * Uncheck both the options i.e. Create virtual folders & Create link locations relative to;...
 * Click on Finish button

Add Pydev Python source code (pysrc) to XBMC
XBMC needs to know where to find the PyDev remote python source file in order to communicate with the remote debugger of Eclipse.

Identify where PyDev remote debugger Python files are
Python source files should be in you Eclipse installation directory: C:\...\eclipse\plugins\org.python.pydev.debug_1.5.5.2010030420\pysrc\ In our case we use PyDev 1.5.5. With newer versions of PyDev, the directory structure changed. C:\...\eclipse\plugins\org.python.pydev_3.6.0.201406232321\pysrc\ Look for org.python.pydev.debug (not core)

Instructions for Linux users:

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 pydevd-addon.

To access this from your addon, your addon.xml has to contain.

Modify PyDev source in order to support XBMC paths
The pysrc code that came with Eclipse-pydev does not support XBMC paths (special://... or Q:/...) and the module would not find them making it impossible to insert breakpoints in such files.

In order to add the support of XBMC paths, you will need to do a simple modification to the file pydevd_file_utils.py consisting on adding a line to each procedure that had a filename parameter (4 procedures in total). Add a line like

def _NormFile(filename): filename = xbmc.translatePath(filename) try: ...

The other three procedures are:
 * def _NormFile(filename):
 * def NormFileToServer(filename):
 * def NormFileToClient(filename):

of course you need the import directive at the top of the file:

import xbmc

at the beginning of the module...

Choose how XBMC will refer to Pydev debugging module
You have 3 options as below:
 * Option 1 - Refer from our python script directly the directory where pysrc is installed
 * Option 2 - Copy pysrc in our script directory and refer it from our script
 * Option 3 - Copy pysrc in XBMC Python install
 * Option 4 - Use the pydev from the pydevd-addon

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

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

Option 4: (Suggested for Linux users)
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
At the beginning of you Python script/plugin (usually Default.py) add the following code: REMOTE_DBG = True

if REMOTE_DBG: # Make pydev debugger works for auto reload. # Note pydevd module need to be copied in XBMC\system\python\Lib\pysrc try: 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 pydevd.settrace('localhost', stdoutToServer=True, stderrToServer=True) except ImportError: sys.stderr.write("Error: " +           "You must add org.python.pydev.debug.pysrc to your PYTHONPATH.") sys.exit(1)
 * 1) append pydev remote debugger

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


 * Use REMOTE_DBG in order to activate or not the remote debugging
 * port specifies the listening port number use between the client and the server
 * 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

Run

 * Go in Debug view (Eclipse: [[File:changeperspective.png]] / Debug ) and press on the start server button: [[File:EclipsePydevDebugSrvButtons.png]]

Debug Server at port: 5678
 * You will see in the console logs like:


 * Start XBMC and run your script/plugin, you will see it as "Running" but paused


 * In Eclipse (Debug View) click on the Resume button (or F8), then you will see the program running in XBMC


 * You are now fully set up: You can set break-point, watch on variables, run step by step etc


 * Enjoy!