Differences between revisions 111 and 113 (spanning 2 versions)
⇤ ← Revision 111 as of 2014-04-20 15:08:05 →
Size: 8815
Editor: AdamBurke
Comment: rv spam
← Revision 113 as of 2014-07-26 16:06:40 → ⇥
Size: 7718
Editor: HenningJacobs
Comment: add new GIT section and remove historical SVN section
Deletions are marked like this. Additions are marked like this.
Line 8: Line 8:
NOTE: The source code of Jython is now mirrored to [[http://github.com/jythontools/jython|Github]],
please see the next section "GIT" on how to contribute with pull requests.
Line 20: Line 22:
 * It's easy to create your own fork of the repo on [[BitBucket|BitBucket]], visit http://bitbucket.org/jython/jython and click on 'Fork'  * It's easy to create your own fork of the repo on [[BitBucket|BitBucket]], visit http://bitbucket.org/jython/jython and click on 'Fork' --- Please see the "GIT" section for our new GIT-based pull request process.
Line 23: Line 25:

== 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 [[http://git-scm.com/downloads/guis|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 [[http://hg.python.org/jython|upstream Mercurial repo]].
Line 34: Line 47:
== Subversion (Historical) ==


When Jython first followed CPython into use of Mercurial as the repository, it continued to reference a part of the CPython source at {{{ https://svn.python.org }}} as a "sub-repository". This meant you still needed [[http://subversion.apache.org|Subversion]] installed. As of 20 March 2012, the Jython Mercurial repository contains a snapshot of CPython libs in the 2.2, 2.5, and default branches.


You therefore only need the following advice if you are somehow working with an old repository.


The following advice is based on experience using Mercurial 1.9, [[http://sliksvn.com|Slik Subversion]] and Windows 7 (AMDx64). Other tools and operating systems exist. An installation that gives you the command 'svn' on your path is sufficient.


If you do not have Subversion installed (and on the PATH) the Mercurial {{{hg clone}}} command will terminate with the message:


{{{
abort: The system cannot find the file specified
}}}


at the point where it attempts to read the sub-repository, specified in the files {{{ .hgsub }}} and {{{ .hgsubstate }}}.


A second requirement is that Subversion should accept the SSL certificate from the site svn.python.org. If you have not used Subversion already to access the site, you may find that the {{{ hg clone }}} command hangs at the point where it attempts to read the sub-repository. A simple solution is to visit the site once from the command line as follows:


{{{
svn info https://svn.python.org/projects/python/branches/release26-maint/Lib/
}}}


Subversion will issue a warning about the certificate, and you will be able to "accept permanently" the site's certificate. The Mercurial clone operation should not now hang.


If you see the sub-directory {{{ CPythonLib }}} created in your local repository, then the call to Subversion by Mercurial was a success. (It can take a few minutes to complete.)
Line 72: Line 48:
Line 119: Line 94:
 * `CPythonLib` : Lib directory from the corresponding version of cpython, via svn:externals  * `lib-python/<version>` : Lib directory from the corresponding version of cpython

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!

Contents

  1. Mercurial
  2. GIT
  3. IDE Support
  4. Ant
  5. Tests
  6. Directory layout
  7. Coding guidance
  8. How things work
  9. Other stuff
  10. Tasks
    1. Porting external projects to Jython

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 directory is somewhere in your path.

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

  • The results of the build appear in the dist subdirectory.

Tests

The Jython build process generates an executable Bash script, dist/bin/jython, 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 instead.

Now you're ready to run tests...

  • There are a couple different places to find test cases

    • Jython's dist/Lib/test (populated by the build process)

    • Jython's bugtests subdirectory (included with the development sources)

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

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 : top level package for python

  • src/com : zxJDBC related sources

  • src/shell : launcher scripts

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

  • Demo : demo sources for the website and such

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

  • Lib : the python source files for Jython standard library implementations

  • Lib/test : test cases

  • Misc : random scripts which are not all used; some generate source

  • Tools : JythonC and Freeze

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

  • bugtests : additional test cases covering bug reports

Coding guidance

How things work

Other stuff

Tasks

Porting external projects to Jython

JythonDeveloperGuide (last edited 2014-07-26 16:06:40 by HenningJacobs)