Diff for "JythonDeveloperGuide"

Differences between revisions 2 and 15 (spanning 13 versions)

BrianZimmer, incept: 2005-01-31

This is an introduction to developing Jython, just to get someone started. It doesn't 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 make it better!

CVS

ConcurrentVersionControl
available on most *nix systems or with cygwin on Windows
GUI clients are available on most platforms
Eclipse users, see /EclipseNotes

Login

      cvs -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/jython login

Checkout

NewStyleClasses:you'll want to checkout the newstyle classes branch:

       cvs -z3 -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/jython co -P -d jython.newstyle-branch -r newstyle-branch jython

2.1 Stable:

       cvs -z3 -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/jython co -P -d jython.Release_2_1 -r Release_2_1 jython

2.2 Alpha 0:

       cvs -z3 -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/jython co -P -d jython.Release_2_2alpha0 -r Release_2_2alpha0 jython

Python

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.

JavaCC

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).

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

Any Java IDE will work (IntelliJ, Eclipse, Vim, ...)

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'

Directory layout

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

-  ⇤ ← Revision 2 as of 2005-02-04 17:55:43 → 
  Size: 4453
  Editor: BillDehora
  Comment:
+   ← Revision 15 as of 2005-02-10 05:35:58 → ⇥
  Size: 4208
  Editor: ClarkUpdike
  Comment:
-Deletions are marked like this.
+Additions are marked like this.
 Line 11:
+BrianZimmer, incept: 2005-01-31
-Line 12:
+Line 13:
-    * BrianZimmer

    * 2005-01-31

      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.
+This is an introduction to developing Jython, just to get someone started. It doesn't 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 make it better!
-Line 19:
+Line 16:
-= CVS =
+''' CVS '''
-Line 21:
+Line 18:
-    * ConcurrentVersionControl
    * available on most *nix systems or with cygwin on Windows
    * GUI clients are available on most platforms
    *  Login
+  * Wiki:ConcurrentVersionControl
  * available on most *nix systems or with cygwin on Windows
  * GUI clients are available on most platforms
  * Eclipse users, see /EclipseNotes

  * '''Login'''
  {{{
 Line 26:
-      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
}}}
+  }}}
    
  * '''Checkout''' 
    * ''NewStyleClasses:''you'll want to checkout the newstyle classes branch:
     {{{   
       cvs -z3 -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/jython co -P -d jython.newstyle-branch -r newstyle-branch jython
     }}}

    * ''2.1 Stable:''
     {{{   
       cvs -z3 -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/jython co -P -d jython.Release_2_1 -r Release_2_1 jython 
     }}}

    * ''2.2 Alpha 0:''
     {{{   
       cvs -z3 -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/jython co -P -d jython.Release_2_2alpha0 -r Release_2_2alpha0 jython 
     }}}

'''  Python '''

  * 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.
-Line 34:
+Line 50:
-=  Python =
+''' JavaCC '''
-Line 36:
+Line 52:
-    * 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.
+  * 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).
-Line 40:
+Line 58:
-= JavaCC =
+''' Ant '''
-Line 42:
+Line 60:
-    * 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).
+  * 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=
    }}}
-Line 48:
+Line 87:
-JavaCC
+''' Jars '''
-Line 50:
+Line 89:
-    * 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).
+  * 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
-Line 55:
+Line 93:
+''' IDEs '''
-Line 56:
+Line 95:
-= Ant =
+  * Any Java IDE will work (IntelliJ, Eclipse, Vim, ...)
-Line 58:
+Line 97:
-    * 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
+''' Tests '''
-Line 68:
+Line 99:
-javaccHome=/Users/bzimmer/Library/Java/Extras/javacc-3.2
+  * 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'
-Line 70:
+Line 105:
-ht2html.dir=
#python.home=
python.lib=/sw/lib/python2.2
python.exe=/sw/bin/python2.2
+''' Directory layout '''
-Line 75:
+Line 107:
-### 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
+  * 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