JythonDeveloperGuide

Legacy Wiki Page

This page was migrated from the old MoinMoin-based wiki. Information may be outdated or no longer applicable. For current documentation, see python.org.

This is an introduction to developing Jython, just to get someone started. It doesn’t cover the source code in any depth or discuss the design behind Jython. It’s purely aimed at getting a development environment set up. It’s definitely not complete so feel free to make it better!

Mercurial

NOTE: The source code of Jython is now mirrored to Github, please see the next section “GIT” on how to contribute with pull requests.

GIT

  • Jython’s source code is mirrored to https://github.com/jythontools/jython (a background sync runs every 5 minutes from hg.python.org)

  • You can use your favorite GIT client to clone the GIT repo, on the command line:

    • git clone https://github.com/jythontools/jython.git

  • To submit patches, you should fork the github repo, create a special feature branch and submit a pull request on github.

  • The Jython developers will review and merge your pull request into the upstream Mercurial repo.

IDE Support

Because Jython is an Ant project, it’s a bit tricky to configure an Integrated Development Environment (IDE) for it.

These notes should help:

Ant

  • Ant is a Java-based tool used to build Jython from source.

  • Eclipse users, see Eclipse Ant notes

  • Download the latest version (Jython requires Ant 1.7 or later to build) and install it so Ant’s bin{.backtick} directory is somewhere in your path.

  • To build Jython, run ant{.backtick} in the top-level Jython directory (which contains the Ant file build.xml{.backtick}).

  • The results of the build appear in the dist{.backtick} subdirectory.

Tests

The Jython build process generates an executable Bash script, dist/bin/jython{.backtick}, to make it easy to launch your build of Jython. It works on Unix-like platforms (including Mac OS X and Cygwin).

If you’re using Windows without Cygwin, use the batch file dist/bin/jython.bat{.backtick} instead.

Now you’re ready to run tests…

  • There are a couple different places to find test cases

    • Jython’s dist/Lib/test{.backtick} (populated by the build process)

    • Jython’s bugtests{.backtick} subdirectory (included with the development sources)

  • Run a particular test, or the whole Python test suite with ant regrtest{.backtick}.

See TestingJython for some more details.

Directory layout

Note the following describes the current trunk/jython. If you are working from an older tag, src doesn’t exist and src/com and src/org are moved up a level.

  • src/org{.backtick} : top level package for python

  • src/com{.backtick} : zxJDBC related sources

  • src/shell{.backtick} : launcher scripts

  • src/templates{.backtick}: java source generator & related templates, used to update portions of java classes elsewhere in the source tree

  • Demo{.backtick} : demo sources for the website and such

  • Doc{.backtick} : the website documentation (see JythonDeveloperGuide/WebsiteBuilderSetup to build the http://jython.org website)

  • Lib{.backtick} : the python source files for Jython standard library implementations

  • Lib/test{.backtick} : test cases

  • Misc{.backtick} : random scripts which are not all used; some generate source

  • Tools{.backtick} : JythonC and Freeze

  • lib-python/<version>{.backtick} : Lib directory from the corresponding version of cpython

  • bugtests{.backtick} : additional test cases covering bug reports

Coding guidance

How things work

Other stuff

Tasks

Porting external projects to Jython