Differences between revisions 2 and 78 (spanning 76 versions)
⇤ ← Revision 2 as of 2005-02-04 17:55:43 →
Size: 4453
Editor: BillDehora
Comment:
← Revision 78 as of 2008-08-15 23:28:36 → ⇥
Size: 4301
Editor: JimBaker
Comment:
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		 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!
Line 11: Line 3:
== Subversion ==
Line 12: Line 5:
    * BrianZimmer   * 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 ASM branch:
    {{{ svn co https://jython.svn.sourceforge.net/svnroot/jython/branches/asm/ }}}
Line 14: Line 12:
    * 2005-01-31   * Attach patches to issues in the [http://bugs.jython.org/ Jython bug tracker].
Line 16: Line 14:
      This is an introduction to Jython development just to get someone started. It does cover in any depth the source code or the design behind Jython. It's purely aimed at getting a development environment setup. It's definitely not complete so feel free to email me when you find something that's wrong or missing. == Ant ==
Line 18: Line 16:
  * [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 19: Line 22:
= CVS = == 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).
Line 21: Line 25:
    * ConcurrentVersionControl
    * available on most *nix systems or with cygwin on Windows
    * GUI clients are available on most platforms
    * Login
      cvs -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/jython login
      Checkout source code
    * Main/Tip/Trunk
{{{
 cvs -z3 -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/jython co -P jython Newstyle Branch
      cvs -z3 -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/jython co -P -d jython.newstyle -r newstyle-branch jython
}}}		 If you're using Windows without Cygwin, use the batch file `dist/bin/jython.bat` instead.
Line 33: Line 27:
Now you're ready to run tests...
Line 34: Line 29:
= Python =   * 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`.
Line 36: Line 34:
    * http://www.python.org/2.2.3/
    * Jython uses Python's standard library where possible. This means you will need a working copy of Python source files for the stdlib. We currently use Python 2.2 so you can grab the files from here if you don't already have 2.2 installed.		 See TestingJython for some more details.
Line 39: Line 36:
== 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.
Line 40: Line 39:
= JavaCC =   * `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
Line 42: Line 52:
    * https://javacc.dev.java.net/
    * Parser generator for Java. Generally needed only for working on parser.
    * It's not really required that you install this so I'd skip it.
    * The latest version is JDK 1.5 compatible (uses 'e' rather than 'enum' as variable name).		 == Coding guidance ==
Line 47: Line 54:
  * /PortingPythonModulesToJython : A good starting task for a Jython developer
  * CodingStandards : The standards for writing Java code for Jython
  * PatchGuidelines : How to make a patch for submission to the tracker
  * JythonModulesInJava : How to write a Jython module in Java
  * JythonClassesInJava : How to write a Jython class in Java
  * PythonTypesInJava : How to make a Python type in Java(2.5 and later)
Line 48: Line 61:
JavaCC == Other stuff ==
Line 50: Line 63:
    * https://javacc.dev.java.net/
    * Parser generator for Java. Generally needed only for working on parser.
    * It's not really required that you install this so I'd skip it.
    * The latest version is JDK 1.5 compatible (uses 'e' rather than 'enum' as variable name).		  * WebsiteBuilderSetup : How to get the pieces setup to edit and build the Jython website
 * VersionTransition : Why some tests are excluded in going to a new version and how to go about fixing them
 * /RegressionTestNotes : Some notes on the running the regression tests (on 2.3)
 * /PleaseAdoptMe : Tasks looking for volunteers
 * HowToReleaseJython : Checklist for building a release and updating the website
Line 55: Line 69:
== Porting external projects to Jython ==
Line 56: Line 71:
= Ant =

    * http://ant.apache.org/ A Java-based build tool.
    * The Makefiles in the repository are old and will be removed.
    * Download the latest version and install so the bin/ is somewhere in your path.
    * The build.xml is the file containing the compiler directives
    * It uses a file called ant.properties to override default paths; here's mine:
{{{
build.compiler=modern
debug=on
optimize=off

javaccHome=/Users/bzimmer/Library/Java/Extras/javacc-3.2

ht2html.dir=
#python.home=
python.lib=/sw/lib/python2.2
python.exe=/sw/bin/python2.2

### zxJDBC ###
oracle.jar=
mysql.jar=/Users/bzimmer/Library/Java/Extras/mysql-connector-java-3.1.6-bin.jar
informix.jar=
postgresql.jar=/Users/bzimmer/Library/Java/Extras/pg74.215.jdbc2.jar
jdbc.jar=
servlet.jar=
}}}


= Jars =

    * Jython uses many optional jars
    * These are not required for building locally but are for deployment with the installer
    * The ant script takes care of conditional compilation

= IDEs =

    * This is religious
    * I generally use IntelliJ and vim
    * Others don't
    * You'll have to set this up yourself
    * http://www.eclipse.org
    * http://www.jetbrains.com/idea


= Tests =

    * There are a couple different places to find test cases
            Jython's Lib/test
            Jython's bugtests repository
            Python2.2's Lib/test
    * Run the particular test or you can run the whole suite by running 'regrtest.py'

= Directories =

com : zxJDBC related sources"
Demo : demo sources for the website and such"
Doc : the website documentation"
installer : the current installer which apparently no longer works"
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
org : top level package for python and apache (used for regex)
Tools : JythonC and Freeze


----

Notes

    * This should be done in ReST and checked into Jython.
    * The directory structures need work.
    * The test suites need to be better consolidated.






----
CategoryJython

CategoryJythonHacking		  * DjangoOnJython
 * MercurialOnJython
 * SqlAlchemyOnJython
 * SetuptoolsOnJython
 * PylonsOnJython

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