Thursday, December 1, 2005

Zope Development Tools

I just got a chance to view the automatically generated Plone API documentation site: As someone with a Java background, I was really happy to see such a familiar Javadoc style format. Of course, since Python is a dynamically typed language, the documentation cannot tell the data type of a method's arguments (one of the primary thing I use Javadoc for). In order for that to happen, the documentation generation tool would have to run the program and record what variable types are successfully used as method arguments. The main advantage that the API documentation has over looking at the actual code is that it shows a full inheritance tree and lists methods that are inherited from super-classes.

Another tool that might be useful for Java programmers looking for a friendly, familiar face is PyDev, a Python plugin for Eclipse. PyDev does source tree navigation, text completion, method definition lookup, auto-indent, parentheses matching, code search, and automatic, real-time error checking just like what you get when you use Eclipse for Java. I find the error checking especially useful because it shows you immediately if your indents are wrong.

For debugging a Zope application, I was recently introduced to the Python debugger PDB. It is not a visual tool integrated into the your IDE, but if you run Zope in the forground (zopectl fg), and you add the line import pdb;pdb.set_trace() into your code, you enter an interactive session where you can step through the code, write code statements, and check variable values. Here is some good documentation to help you out: