Differences between revisions 71 and 75 (spanning 4 versions)
⇤ ← Revision 71 as of 2007-12-24 06:14:52 →
Size: 5377
Editor: CharlieGroves
Comment:
← Revision 75 as of 2008-06-09 21:05:10 → ⇥
Size: 4790
Editor: NicholasRiley
Comment: more cleanups
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
## Please edit system and help pages ONLY in the moinmaster wiki! For more
## information, please see MoinMaster:MoinPagesEditorGroup.
## Please edit (or translate) system/help pages on the moinmaster wiki ONLY.
## For more information, please see MoinMaster:MoinPagesEditorGroup.
##master-page:Unknown-Page
##master-date:Unknown-Date
#acl MoinPagesEditorGroup:read,write,delete,revert All:read
#format wiki
#language en

BrianZimmer, incept: 2005-01-31
Line 16: Line 4:
''' SVN ''' ''' Subversion '''
Line 18: Line 6:
  * http://subversion.tigris.org/
  * available on most *nix systems or with cygwin on Windows
  * GUI clients are available on most platforms
  * Eclipse users, see JythonDeveloperGuide/EclipseNotes
  * can browse the source at http://fisheye3.cenqua.com/browse/jython
  * to obtain the a copy of the ''current development'' source, checkout from trunk:
    {{{        svn co https://jython.svn.sourceforge.net/svnroot/jython/trunk/jython
     }}}		   * Check out a copy of the Jython source with [http://subversion.tigris.org/ Subversion], available on most *nix systems or with Cygwin on Windows.
  * You can use the command line tool `svn`, or [http://subversion.tigris.org/links.html#clients GUI clients are available] on most platforms.
  * !NetBeans, Eclipse and other Java IDEs also integrate Subversion support. Eclipse users should see JythonDeveloperGuide/EclipseNotes.
  * Browse the source code on the Web at http://fisheye3.cenqua.com/browse/jython.
  * To obtain the a copy of the ''current development'' source, check out the Jython trunk:
    {{{ svn co https://jython.svn.sourceforge.net/svnroot/jython/trunk/jython }}}
Line 28: Line 13:
  * Patches should be posted to the [http://sourceforge.net/tracker/?group_id=12867&atid=312867 jython patch tracker] as explained in the PatchGuidelines.   * Attach patches to issues in the [http://bugs.jython.org/ Jython bug tracker].
Line 32: Line 17:
  * http://ant.apache.org/ A Java-based build tool.
  * Eclipse users, see [wiki:Self:/EclipseNotes#ANT Eclipse ANT notes]
  * Download the latest version and install so the bin/ is somewhere in your path.
  * The build.xml is the file containing the compiler directives
  * After getting Ant setup, run ''ant'' in your Jython checkout directory. That should produce ''dist/jython.jar'' if everything is setup correctly.
  * [http://ant.apache.org/ Ant] is a Java-based tool used to build Jython from source.
  * Eclipse users, see [wiki:Self:/EclipseNotes#ANT Eclipse Ant notes]
  * Download the latest version 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.
Line 40: Line 24:
 After you've built the project, you may want to set up an excutable file on your path to make it easy to launch your build of jython. This file will need to:
 *Set the python home property to the `dist` directory of your build (otherwise, you'll get import errors on the standard lib stuff).
 *Execute the `jython.jar` in the `dist` produced by the build.
Here's a batch file that runs the built jython.jar (for windows): [[Anchor(sampleBatch)]]		 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, here's a batch file that runs the built `jython.jar`:
[[Anchor(sampleBatch)]]
Line 64: Line 48:
On Unix you can use a shell script: {{{
#!/bin/sh

exec java -Dpython.home=<path>/dist/ -jar <path>/dist/jython.jar $*
}}}
Line 74: Line 51:
    * Jython's dist/Lib/test (populated by the build process)
    * Jython's bugtests subdirectory (included with the development sources)
  * Run a particular test or you can run the whole Python test suite by running the following:
{{{
jython dist/Lib/test/regrtest.py -e
}}}		     * 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`.
Line 88: Line 62:
  * src/shell : launcher scripts
Line 109: Line 84:
 * /WebsiteBuilderSetup : How to get the pieces setup to edit and build the Jython website  * WebsiteBuilderSetup : How to get the pieces setup to edit and build the Jython website
Line 113: Line 88:
 * /HowToReleaseJython : Checklist for building a release and updating the website  * HowToReleaseJython : Checklist for building a release and updating the website

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!

Subversion

Ant

  • [http://ant.apache.org/ Ant] is a Java-based tool used to build Jython from source.

  • Eclipse users, see [wiki:/EclipseNotes Eclipse Ant notes]

  • Download the latest version 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, here's a batch file that runs the built jython.jar: Anchor(sampleBatch) 

:: jytip.bat
@echo off
set ARGS=

:: concatenate all the command line args into one
:loop
if [%1] == [] goto end
        set ARGS=%ARGS% %1
        shift
        goto loop
:end

:: this is mine...
:: java -Dpython.home=C:\\workspace\\JythonTip\\jython\\dist -jar 
::<cont> c:\workspace\JythonTip\jython\dist\jython.jar %ARGS%
:: fill in <placeholders> below:
java -Dpython.home=<path to dist directory>\\dist -jar <path to dist directory>\dist\jython.jar %ARGS%

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 /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

  • CPythonLib : Lib directory from the corresponding version of cpython, via svn:externals

  • bugtests : additional test cases covering bug reports

Coding Guidance

Other Stuff

Porting external projects to Jython

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