wiki:DeveloperGuidelines/Eclipse

Context Navigation

Version 49 (modified by Fran Boon, 13 years ago) ( diff )
--

Developer Guidelines - Eclipse

Eclipse is a full IDE supporting Debugging & Code Completion.

PyDev is an Eclipse module which supports Python.

Installation

An Eclipse install with PyDev included is available in the 75Mb zip file which also includes Web2Py & Eden:

http://eden.sahanafoundation.org/Sahana-Eden.zip

or install manually:

Install Java JDK
Install Eclipse (setup for 3.6 is documented below):
- Look for "Latest release" on the downloads page.
- (For Linux, and also apt-get install eclipse-platform but may get old version.)
If using JDK 6u21: modify eclipse.ini
Install PyDev through Eclipse:
1. Help menu > Install New Software
2. Work with: http://pydev.org/updates
3. Add, OK
4. tick PyDev (can exclude the optional PyDev Mylyn Integration), Next, Next, Accept, Finish
5. tick to trust certificate, Restart now
Recommend installing Psyco to speed-up Python in Eclipse:

Linux: http://psyco.sourceforge.net/
Windows: http://www.voidspace.org.uk/python/modules.shtml#psyco

Configuration

Set up the Python Interpreter:
1. Window > Preferences > PyDev > Interpreter - Python. Click New
  1. On Windows: Browse to python26/python.exe (or python27/python.exe if using 2.7), OK, OK
  2. On Linux: "python" is the name of the interpreter, the location is "/usr/bin/python", OK, OK
Add a new PyDev Project:
1. File > New > Project...
2. Open the PyDev folder, and choose PyDev Project
3. Give the project a name "web2py"
4. Un-tick "Use Default"
5. Grammar Version (should be 2.6 in the Linux VM)
6. Browse to the web2py directory (on the Linux VM, this is in /home/web2py)
7. Un-tick "Create default 'src' folder and add it to the pythonpath"
8. Click Finish
9. Click "No" when asked to open the perspective
Debug Configuration:
1. From the Run menu, choose Debug Configurations...
2. Double-click Python Run
3. On the Main tab: Name: Enter (e.g.) web2py
4. Project: Select web2py (should be the only option)
5. On the Main tab: Browse to web2py.py (on the Linux VM, this is /home/web2py/web2py.py)
6. On the Arguments tab: Type in the program arguments: "-a password" (Choose a password for web2py and substitute it for "password".)
7. Click Apply. Close the configuration window.
8. In the PyDev Package Explorer tab, click web2py to select it. (Without this, you will get an error saying $project_loc is empty. This is an Eclipse issue.)
9. In the toolbar below the main Eclipse menu bar, find the bug icon and click the down-arrow next to it. Click the option that has a "P" superscript, which executes the Python command line we just set. (The option with a "U" runs unittests, which are not what we want now.)
10. On Windows: If asked, unblock in Windows Firewall (not necessary on the Linux VM).

Miscellaneous suggestions for comfort and convenience:
1. Right-click on Java perspective in top-right & select Close
2. Window > Open Perspective > Other > Debug
3. Window > Show View > Expressions
4. Window > Show View > Expressions > Other > PyDev > PyDev Package Explorer
  (This is where you will need to select web2py before trying Run or Debug to avoid the empty $project_loc error.)
5. Drag the Expressions, Console, Tasks tabs to the upper right, where the Variables tab is. Drag PyDev Package Explorer to the upper left where Debug is. (This leaves more space for the editor view.)
6. Window > Customize Perspective > Tool bar visibility > untick PyDev Debug. Click OK
7. Set your default HTML editor
  1. Window > Preferences > General > Editors > File Associations
  2. Click .htm
  3. In the Associated editors section below, click "Add..."
  4. Choose "Text Editor"
  5. Click OK
  6. Text Editor will be added to the editors list. If not selected, click it.
  7. Click Default.
  8. Repeat the process with .html
  9. Click OK
8. Window > Preferences > General > Editors > Text Editors 8 TICK 'insert spaces for Tabs'
  - tick Show line numbers
  - tick Show Print Margin and set the margin to 80 (to assist in our attempt to keep within that width)
9. Window > Preferences > General > Workspace
  - tick 'Refresh on access'
  - untick 'Build automatically'
10. You may want to change the layout of the window by dragging sections to convenient regions of the window and resizing them. Combine less-used sections as tabs in the same region.

Debugging with Eclipse

Set and remove breakpoints by double clicking in the margin of the code file.
To start running with the debugger: In the toolbar below the main Eclipse menu bar, find the bug icon and click the down-arrow next to it. Click the option that has a "P" superscript. After this, you can just click the bug. (If you get an error that indicates Eclipse tried to run unittests instead, go through the down-arrow menu again.)

F5 Step into functions
F6 Step over lines
F7 Step out of functions
Use expressions (drag and drop from code) or right-click > watch
Examine values of variables in the Variables tab.

Accessing private data

Some data is marked as private to let other developers know they shouldn't access this directly

e.g. in s3xrc.py we have S3Resource.__set & S3Resource.__query

This then means that Eclipse can't see these attributes as self.__set, etc.

Instead need to use:

xxx._ClassName__AttributeName

e.g.:

resource._S3Resource__query
resource._S3Resource__set

Bzr integration (optional)

http://wiki.bazaar.canonical.com/BzrEclipse

bzr checkout --lightweight lp:bzr-xmloutput
cd bzr-xmloutput
python setup.py install
cd ..