|
Size: 6469
Comment: Grammar edit
|
← Revision 113 as of 2014-07-26 16:06:40 ⇥
Size: 7718
Comment: add new GIT section and remove historical SVN section
|
| 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 ''' | <<TableOfContents>> |
| 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 current source archive at http://svn.sourceforge.net/viewcvs.cgi/jython/ * to obtain the a copy of the ''current development'' source, checkout from trunk: {{{ svn co https://svn.sourceforge.net/svnroot/jython/trunk/jython }}} |
== Mercurial == |
| Line 29: | Line 8: |
| For ''2.1 Stable'', the last stable release: {{{ svn co https://svn.sourceforge.net/svnroot/jython/tags/Release_2_1/jython }}} |
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 34: | Line 11: |
| For ''2.2 Alpha 1'', the last alpha release: {{{ svn co https://svn.sourceforge.net/svnroot/jython/tags/Release_2_2alpha1/jython }}} For ''2.3'', the development branch the next version: {{{ svn co https://svn.sourceforge.net/svnroot/jython/branches/2.3 }}} * Patches should be posted to the [http://sourceforge.net/tracker/?group_id=12867&atid=312867 jython patch tracker] as forward unified diffs. This can be done for example using ''svn diff'' from the command line, just plain ''diff -u'', or using the eclipse ''Team->Create Patch feature''. [TODO: write better patch submission guidelines, similar to http://www.python.org/dev/patches/). ''' 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. |
* Check out a copy of the Jython source with [[http://mercurial.selenic.com/|Mercurial]], available on most *nix systems or with Cygwin on Windows. * You can use the command line tool `hg`, or [[http://mercurial.selenic.com/wiki/OtherTools#Graphical_user_interfaces|GUI clients are available]] on most platforms. * NetBeans, Eclipse and other Java IDEs also integrate Mercurial support. Eclipse users should see [[JythonDeveloperGuide/EclipseNotes|JythonDeveloperGuide/EclipseNotes]]. * Browse the source code on the Web at http://hg.python.org/jython or at the official mirror on [[BitBucket|BitBucket]], at http://bitbucket.org/jython/jython. * To obtain the a copy of the ''current development'' source, clone the repo via: . {{{ hg clone http://hg.python.org/jython }}} |
| Line 52: | Line 22: |
| ''' JavaCC ''' | * 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. * Attach patches to issues in the [[http://bugs.jython.org/|Jython bug tracker]]. * Also, you can upload them to http://codereview.appspot.com (the Jython repository is already registered). |
| Line 54: | Line 26: |
| * 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). |
== 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]]. == 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: * [[JythonDeveloperGuide/EclipseNotes|JythonDeveloperGuide/EclipseNotes]] * [[JythonDeveloperGuide/IntellijNotes|JythonDeveloperGuide/IntellijNotes]] * [[JythonDeveloperGuide/IntellijTricks|JythonDeveloperGuide/IntellijTricks]] == Ant == * [[http://ant.apache.org/|Ant]] is a Java-based tool used to build Jython from source. * Eclipse users, see [[JythonDeveloperGuide/EclipseNotes#ANT|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. |
| Line 60: | Line 56: |
| ''' Ant ''' | == Tests == |
| Line 62: | Line 58: |
| * http://ant.apache.org/ A Java-based build tool. * Eclipse users, see [wiki:Self:/JythonDeveloperGuide/EclipseNotes#ANT Eclipse ANT notes] * 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 |
|
| Line 73: | Line 59: |
| javaccHome=/Users/bzimmer/Library/Java/Extras/javacc-3.2 | 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 75: | Line 61: |
| ht2html.dir= #python.home= python.lib=/sw/lib/python2.2 python.exe=/sw/bin/python2.2 |
|
| Line 80: | Line 62: |
| ### 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= }}} |
If you're using Windows without Cygwin, use the batch file `dist/bin/jython.bat` instead. |
| Line 89: | Line 64: |
| * ant.properties for Gentoo users: {{{ build.compiler=modern debug=on optimize=off |
|
| Line 95: | Line 65: |
| python.lib=/usr/lib/python2.2/lib-old }}} ''' 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 see /EclipseNotes * NetBeans see /NetbeansGuide * Vim * ... ''' Tests ''' 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)]] {{{ :: 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% }}} |
|
| Line 139: | Line 67: |
| * 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` with the `-a` option |
|
| Line 145: | Line 68: |
| ''' Directory layout ''' Note the following describes the current trunk. If you are working from an older tag, src doesn't exist and src/com and src/org are moved up a level. |
* 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) |
| Line 148: | Line 72: |
| * src/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 * src/org : top level package for python and apache (used for regex) * Tools : JythonC and Freeze ''' Coding Guidance ''' * CodingStandards : The standards for writing Java code for Jython * JythonModulesInJava : How to write a Jython module in Java * JythonClassesInJava : How to write a Jython class in Java ''' Other Stuff ''' * /WebsiteBuilderSetup : How to get the pieces setup to edit and build the Jython website |
* Run a particular test, or the whole Python test suite with `ant regrtest`. |
| Line 169: | Line 75: |
| See [[TestingJython|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 == * [[JythonDeveloperGuide/PortingPythonModulesToJython]] : A good starting task for a Jython developer * [[CodingStandards|CodingStandards]] : The standards for writing Java code for Jython * [[PatchGuidelines|PatchGuidelines]] : How to make a patch for submission to the tracker == How things work == * [[ImplementNewType|ImplementNewType]] : Implementing a new type (a beginner's notes) * [[ImplementSequenceType|ImplementSequenceType]] : Implementing a new sequence type * [[JythonModulesInJava|JythonModulesInJava]] : How to write a Jython module in Java * [[PythonTypesInJava|PythonTypesInJava]] : How to make a Jython type in Java (2.5 and later), mostly about the type exposer * [[JythonClassesInJava|JythonClassesInJava]] : How to make a Jython class in Java (pre-2.2, deprecated) * [[JythonDeveloperGuide/AttributeLookupMethods]] : Some explanation for the different methods to lookup attributes on [[PyObject|PyObject]]. * [[JythonDeveloperGuide/ImplementingStrAndRepr]] : Tips for implementation of `__str__` and `__unicode__` in Java. * [[IntegerConversion|IntegerConversion]] : Basics of converting [[PyObject|PyObject]] numbers to Java primitives * [[JythonDeveloperGuide/UsingPyNewStringFromPythonCode]] : On the corner case of converting a Java String to a Python String. * [[GeneratedDerivedClasses|GeneratedDerivedClasses]] : {{{gderived.py}}}, a tool used when implementing new types * [[BufferProtocol|BufferProtocol]] : Design of a Jython equivalent to the CPython buffer protocol (buffer API) * [[MethodDispatch|MethodDispatch]] : An explanation of Jython method dispatch mechanism. == Other stuff == * [[WebsiteBuilderSetup|WebsiteBuilderSetup]] : How to get the pieces setup to edit and build the Jython website * [[VersionTransition|VersionTransition]] : Why some tests are excluded in going to a new version and how to go about fixing them * [[JythonDeveloperGuide/RegressionTestNotes]] : Some notes the regression tests * [[JythonDeveloperGuide/PleaseAdoptMe]] : Tasks looking for volunteers * [[HowToReleaseJython|HowToReleaseJython]] : Checklist for building a release and updating the website * [[SvnToHgMigration|SvnToHgMigration]] : Notes on the migration to Mercurial == Tasks == * [[PerformanceEnhancements|PerformanceEnhancements]] : Ideas on how to speedup Jython * [[CodebaseCleanup|CodebaseCleanup]] : Tasks/general guidelines on keeping the codebase clean === Porting external projects to Jython === * [[DjangoOnJython|DjangoOnJython]] * [[MercurialOnJython|MercurialOnJython]] * [[SqlAlchemyOnJython|SqlAlchemyOnJython]] * [[SetuptoolsOnJython|SetuptoolsOnJython]] * [[PylonsOnJython|PylonsOnJython]] * [[TwistedOnJython|TwistedOnJython]] |
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
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.
Check out a copy of the Jython source with Mercurial, available on most *nix systems or with Cygwin on Windows.
You can use the command line tool hg, or GUI clients are available on most platforms.
NetBeans, Eclipse and other Java IDEs also integrate Mercurial support. Eclipse users should see JythonDeveloperGuide/EclipseNotes.
Browse the source code on the Web at http://hg.python.org/jython or at the official mirror on BitBucket, at http://bitbucket.org/jython/jython.
To obtain the a copy of the current development source, clone the repo via:
hg clone http://hg.python.org/jython
It's easy to create your own fork of the repo on BitBucket, visit http://bitbucket.org/jython/jython and click on 'Fork' --- Please see the "GIT" section for our new GIT-based pull request process.
Attach patches to issues in the Jython bug tracker.
Also, you can upload them to http://codereview.appspot.com (the Jython repository is already registered).
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
JythonDeveloperGuide/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
How things work
ImplementNewType : Implementing a new type (a beginner's notes)
ImplementSequenceType : Implementing a new sequence type
JythonModulesInJava : How to write a Jython module in Java
PythonTypesInJava : How to make a Jython type in Java (2.5 and later), mostly about the type exposer
JythonClassesInJava : How to make a Jython class in Java (pre-2.2, deprecated)
JythonDeveloperGuide/AttributeLookupMethods : Some explanation for the different methods to lookup attributes on PyObject.
JythonDeveloperGuide/ImplementingStrAndRepr : Tips for implementation of __str__ and __unicode__ in Java.
IntegerConversion : Basics of converting PyObject numbers to Java primitives
JythonDeveloperGuide/UsingPyNewStringFromPythonCode : On the corner case of converting a Java String to a Python String.
GeneratedDerivedClasses : gderived.py, a tool used when implementing new types
BufferProtocol : Design of a Jython equivalent to the CPython buffer protocol (buffer API)
MethodDispatch : An explanation of Jython method dispatch mechanism.
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
JythonDeveloperGuide/RegressionTestNotes : Some notes the regression tests
JythonDeveloperGuide/PleaseAdoptMe : Tasks looking for volunteers
HowToReleaseJython : Checklist for building a release and updating the website
SvnToHgMigration : Notes on the migration to Mercurial
Tasks
PerformanceEnhancements : Ideas on how to speedup Jython
CodebaseCleanup : Tasks/general guidelines on keeping the codebase clean