rbco.recipe.pyeclipse 0.0.4

Overview

This recipe creates a Pydev [1] project for Eclipse. The goal is to automate the following strategy:

1. Create a Pydev project. The project directory is separated from the source code directories. In other words, the source code will not reside inside the project directory.

2. Create links to the source code directories. This is done by right-clicking the project in the Pydev Package Explorer and selection New->Folder. Then click Advanced and choose “Link to folder in the filesystem.”

3. Add the linked directories to the PYTHONPATH of the project.

This approach works very well when working with Zope/Plone, specially if combined with collective.recipe.omelette [2], as pointed in this article [3] by Martin Aspeli.

However it should be flexible enough to allow other strategies.

After the recipe is run import the project into Eclipse going to: File -> Import… -> Existing projects into workspace.

Supported options

The recipe supports the following options:

project-name

The project name.

python-version

The Python version for syntatical analysis, such as 2.4 or 2.5.

python-interpreter

Optional. The path to the Python interpreter. Defaults to the default interpreter configured in Eclipse.

project-directory

The directory where the project configuration files will be stored.

source-resources

A set of paths separated by space or newline. These will be added as linked directories (or files) and will be in the PYTHONPATH.

extra-linked-resources

A set of paths separated by space or newline. These will be added as linked directories (or files) only.

extra-pythonpath-resources

A set of paths separated by space or newline. These will be added only to the PYTHONPATH.

Example usage

Setup:

>>> from os.path import join
>>> egg_zip_filename = 'some.egg.zip'
>>> src_dirname = 'my.python.package'
>>>
>>> test_dir = tmpdir('testdir')
>>>
>>> mkdir(test_dir, src_dirname)
>>> src_dir = join(test_dir, src_dirname)
>>>
>>> write(test_dir, egg_zip_filename, 'foo')
>>> egg_zip_file = join(test_dir, egg_zip_filename)

We’ll start by creating a typical buildout that uses the recipe:

>>> write('buildout.cfg',
... """
... [buildout]
... parts = eclipse_project
...
... [eclipse_project]
... recipe = rbco.recipe.pyeclipse
... project-name = TestProject
... python-version = 2.4
... project-directory = ${buildout:directory}/testproject
... source-resources =
...     %(src_dir)s
...     %(egg_zip_file)s
... """ % locals())

>>> #cat('buildout.cfg')

Note that we added two source resources: a directory and a zipped egg.

Running the buildout gives us:

>>> print 'start', system(buildout)
start...
Installing eclipse_project.
<BLANKLINE>

The project directory is created if it does not exist and so happens to the .project and .pydevproject files. The .project file will look like this:

>>> cat(join(sample_buildout, 'testproject', '.project'))
<?xml version='1.0' encoding='utf-8'?>
<projectDescription>
 <name>TestProject</name>
 ...
 <buildspec>
  <buildcommand>
   <name>org.python.pydev.PyDevBuilder</name>
   ...
  </buildcommand>
 </buildspec>
 <natures>
  <nature>org.python.pydev.pythonNature</nature>
 </natures>
 <linkedResources>
 ...
 </linkedResources>
</projectDescription>

Let’s look into the <linkedResources> tag. The paths listed in the source-resources section must be listed there:

>>> cat(join(sample_buildout, 'testproject', '.project'))
<?xml...
<linkedResources>...
  <link>
    <name>my.python.package</name>
    ...testdir/my.python.package</location>
    <type>2</type>
  </link>...
</linkedResources>...

The egg zip file is present too:

>>> cat(join(sample_buildout, 'testproject', '.project'))
<?xml...
<linkedResources>...
  <link>
    <name>some.egg.zip</name>
    ...testdir/some.egg.zip</location>
    <type>1</type>
  </link>...
</linkedResources>...

Known bugs, caveats ant tips

• If you get an error message saying, in the details, that Files cannot be linked to folders then try to rebuild your buildout running: bin/buildout -Nov.

  This is happening probably because the pyeclipse recipe ran before a directory referred in the recipe’s configuration was created. This often happens when using omelettes.

  Then you’ll probably need to rebuild your project in Eclipse. See the next items.

• If Pydev stopped analyzing or doing auto-complete on your code:

  • Try to fix any syntax errors on your project. It seems Pydev stops processing your files when any syntax error is found.

  • Check if all directories in the PYTHONPATH have a __init__.py file inside, including the root directory.

  • Check if the Python version is set up correctly. Check inside Project -> Properties -> “Pydev - project type” -> “Grammar Version”.

    The Python version can be configured using the python-version option of the recipe.

• After fixing the errors above, if Pydev is still not working correctly then try to rebuild your project. Do the following:

  • Check if “Project -> Build Automatically” is on. Then go to “Project -> Clean” and clean your project. The project will be rebuilt.

  • Go to “Project -> Properties -> Pydev - PYTHONPATH” and click on “Force restore internal info”.

References

0.0.1 (04-may-2009)

• First release.

0.0.2 (04-may-2009)

• Corrected XML formatting.

0.0.3 (04-may-2009)

• Corrected XML formatting again, fixing the Python Version Bug.

• Improved documentation.

0.0.4 (12-may-2009)

• Improved section “Known bugs, caveats ant tips” of README.txt.