|
Size: 4629
Comment: revised ant/script/testing info
|
Size: 4301
Comment:
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 3: | Line 3: |
| == Subversion == | |
| Line 4: | Line 5: |
| ''' SVN ''' | * 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 6: | Line 12: |
| * 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 }}} |
* Attach patches to issues in the [http://bugs.jython.org/ Jython bug tracker]. |
| Line 16: | Line 14: |
| * Patches should be posted to the [http://sourceforge.net/tracker/?group_id=12867&atid=312867 jython patch tracker] as explained in the PatchGuidelines. | == Ant == |
| Line 18: | Line 16: |
| ''' Ant ''' | * [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 20: | Line 22: |
| * 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 Ant's `bin` directory is somewhere in your path. * The `build.xml` is the file containing the compiler directives * After getting Ant set up, run `ant` in your Jython checkout directory. That should produce `dist/jython.jar` if everything is setup correctly. |
== 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 26: | Line 25: |
''' Tests ''' As part of building the project, Jython will generate an executable script, `dist/bin/jython`, to make it easy to launch your build of Jython. This works if you're on a Unix-like platform (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% }}} |
If you're using Windows without Cygwin, use the batch file `dist/bin/jython.bat` instead. |
| Line 57: | Line 32: |
| * Run a particular test, or you can run the whole Python test suite with `ant regrtest`. | * Run a particular test, or the whole Python test suite with `ant regrtest`. |
| Line 61: | Line 36: |
| ''' Directory layout ''' | == Directory layout == |
| Line 64: | Line 39: |
| * src/org : top level package for python * src/com : zxJDBC related sources * 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 * CPython``Lib : Lib directory from the corresponding version of cpython, via svn:externals * bugtests : additional test cases covering bug reports |
* `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 76: | Line 52: |
| ''' Coding Guidance ''' | == Coding guidance == |
| Line 85: | Line 61: |
| ''' Other Stuff ''' | == Other stuff == |
| Line 93: | Line 69: |
| ''' Porting external projects to Jython | == Porting external projects to Jython == |
| Line 96: | Line 72: |
| * MercurialOnJython |
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
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/
Attach patches to issues in the [http://bugs.jython.org/ Jython bug tracker].
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
/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)
Other stuff
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