|
Size: 4453
Comment:
|
Size: 7226
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! == Mercurial == * 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. * 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' * 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). == Subversion == Although development has moved to a Mercurial repository, at the time of this writing (July 2011), you still need [[http://subversion.apache.org | Subversion]] installed. This is because the Mercurial repository named above continues to reference a part of the CPython source at {{{ https://svn.python.org }}} as a "sub-repository". The following advice is based on experience using Mercurial 1.9, [[http://sliksvn.com| Slik Subversion]] and Windows 7 (AMDx64). Other tools and operating systems exist. An installation that gives you the command 'svn' on your path is sufficient. If you do not have Subversion installed (and on the PATH) the Mercurial {{{hg clone}}} command will terminate with the message: {{{ abort: The system cannot find the file specified }}} at the point where it attempts to read the sub-repository, specified in the files {{{ .hgsub }}} and {{{ .hgsubstate }}}. A second requirement is that Subversion should accept the SSL certificate from the site svn.python.org. If you have not used Subversion already to access the site, you may find that the {{{ hg clone }}} command hangs at the point where it attempts to read the sub-repository. A simple solution is to visit the site once from the command line as follows: {{{ svn info https://svn.python.org/projects/python/branches/release26-maint/Lib/ }}} Subversion will issue a warning about the certificate, and you will be able to "accept permanently" the site's certificate. The Mercurial clone operation should not now hang. If you see the sub-directory {{{ CPythonLib }}} created in your local repository, then the call to Subversion by Mercurial was a success. (It can take a few minutes to complete.) |
| Line 12: | Line 37: |
| * BrianZimmer | == Ant == |
| Line 14: | Line 39: |
| * 2005-01-31 | * [[http://ant.apache.org/|Ant]] is a Java-based tool used to build Jython from source. * Eclipse users, see [[/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 16: | Line 45: |
| 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. | == 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 18: | Line 48: |
| If you're using Windows without Cygwin, use the batch file `dist/bin/jython.bat` instead. | |
| Line 19: | Line 50: |
| = CVS = | Now you're ready to run tests... |
| Line 21: | Line 52: |
| * 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 }}} |
* 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 33: | Line 57: |
| See TestingJython for some more details. | |
| Line 34: | Line 59: |
| = Python = | == 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 36: | Line 62: |
| * 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. |
* `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 39: | Line 75: |
| == Coding guidance == | |
| Line 40: | Line 77: |
| = JavaCC = | * /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 * 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) * /AttributeLookupMethods : Some explanation for the different methods to lookup attributes on PyObject. * /ImplementingStrAndRepr : Tips for implementation of `__str__` and `__unicode__` in Java. * IntegerConversion : Basics of converting PyObject numbers to Java primitives * /UsingPyNewStringFromPythonCode : On the corner case of converting a Java String to a Python String. * GeneratedDerivedClasses : {{{gderived.py}}}, a tool used when implementing new types |
| Line 42: | Line 91: |
| * 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). |
== Other stuff == |
| Line 47: | Line 93: |
| * 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 the regression tests * /PleaseAdoptMe : Tasks looking for volunteers * HowToReleaseJython : Checklist for building a release and updating the website * SvnToHgMigration : Notes on the migration to Mercurial |
|
| Line 48: | Line 100: |
| JavaCC | == Tasks == |
| Line 50: | Line 102: |
| * 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). |
* PerformanceEnhancements : Ideas on how to speedup Jython * CodebaseCleanup : Tasks/general guidelines on keeping the codebase clean |
| Line 55: | Line 105: |
| === Porting external projects to Jython === | |
| Line 56: | Line 107: |
| = 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 * 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!
Mercurial
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'
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).
Subversion
Although development has moved to a Mercurial repository, at the time of this writing (July 2011), you still need Subversion installed. This is because the Mercurial repository named above continues to reference a part of the CPython source at https://svn.python.org as a "sub-repository".
The following advice is based on experience using Mercurial 1.9, Slik Subversion and Windows 7 (AMDx64). Other tools and operating systems exist. An installation that gives you the command 'svn' on your path is sufficient.
If you do not have Subversion installed (and on the PATH) the Mercurial hg clone command will terminate with the message:
abort: The system cannot find the file specified
at the point where it attempts to read the sub-repository, specified in the files .hgsub and .hgsubstate .
A second requirement is that Subversion should accept the SSL certificate from the site svn.python.org. If you have not used Subversion already to access the site, you may find that the hg clone command hangs at the point where it attempts to read the sub-repository. A simple solution is to visit the site once from the command line as follows:
svn info https://svn.python.org/projects/python/branches/release26-maint/Lib/
Subversion will issue a warning about the certificate, and you will be able to "accept permanently" the site's certificate. The Mercurial clone operation should not now hang.
If you see the sub-directory CPythonLib created in your local repository, then the call to Subversion by Mercurial was a success. (It can take a few minutes to complete.)
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 /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
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)
/AttributeLookupMethods : Some explanation for the different methods to lookup attributes on PyObject.
/ImplementingStrAndRepr : Tips for implementation of __str__ and __unicode__ in Java.
IntegerConversion : Basics of converting PyObject numbers to Java primitives
/UsingPyNewStringFromPythonCode : On the corner case of converting a Java String to a Python String.
GeneratedDerivedClasses : gderived.py, a tool used when implementing new types
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 the regression tests
/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