commit 61a40112afc3fd3ac77b52591cc56e34e4338951 Author: baztian Date: Tue Aug 10 17:41:17 2010 +0200 Initial import diff --git a/.bzrignore b/.bzrignore new file mode 100644 index 0000000..82d481d --- /dev/null +++ b/.bzrignore @@ -0,0 +1,9 @@ +./*.class +./build +./dist +./src/**/*.class +./src/.ropeproject/globalnames +./src/.ropeproject/history +./src/.ropeproject/objectdb +**/*.bak +**/mem.* diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/COPYING @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/COPYING.LESSER b/COPYING.LESSER new file mode 100644 index 0000000..65c5ca8 --- /dev/null +++ b/COPYING.LESSER @@ -0,0 +1,165 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + + This version of the GNU Lesser General Public License incorporates +the terms and conditions of version 3 of the GNU General Public +License, supplemented by the additional permissions listed below. + + 0. Additional Definitions. + + As used herein, "this License" refers to version 3 of the GNU Lesser +General Public License, and the "GNU GPL" refers to version 3 of the GNU +General Public License. + + "The Library" refers to a covered work governed by this License, +other than an Application or a Combined Work as defined below. + + An "Application" is any work that makes use of an interface provided +by the Library, but which is not otherwise based on the Library. +Defining a subclass of a class defined by the Library is deemed a mode +of using an interface provided by the Library. + + A "Combined Work" is a work produced by combining or linking an +Application with the Library. The particular version of the Library +with which the Combined Work was made is also called the "Linked +Version". + + The "Minimal Corresponding Source" for a Combined Work means the +Corresponding Source for the Combined Work, excluding any source code +for portions of the Combined Work that, considered in isolation, are +based on the Application, and not on the Linked Version. + + The "Corresponding Application Code" for a Combined Work means the +object code and/or source code for the Application, including any data +and utility programs needed for reproducing the Combined Work from the +Application, but excluding the System Libraries of the Combined Work. + + 1. Exception to Section 3 of the GNU GPL. + + You may convey a covered work under sections 3 and 4 of this License +without being bound by section 3 of the GNU GPL. + + 2. Conveying Modified Versions. + + If you modify a copy of the Library, and, in your modifications, a +facility refers to a function or data to be supplied by an Application +that uses the facility (other than as an argument passed when the +facility is invoked), then you may convey a copy of the modified +version: + + a) under this License, provided that you make a good faith effort to + ensure that, in the event an Application does not supply the + function or data, the facility still operates, and performs + whatever part of its purpose remains meaningful, or + + b) under the GNU GPL, with none of the additional permissions of + this License applicable to that copy. + + 3. Object Code Incorporating Material from Library Header Files. + + The object code form of an Application may incorporate material from +a header file that is part of the Library. You may convey such object +code under terms of your choice, provided that, if the incorporated +material is not limited to numerical parameters, data structure +layouts and accessors, or small macros, inline functions and templates +(ten or fewer lines in length), you do both of the following: + + a) Give prominent notice with each copy of the object code that the + Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the object code with a copy of the GNU GPL and this license + document. + + 4. Combined Works. + + You may convey a Combined Work under terms of your choice that, +taken together, effectively do not restrict modification of the +portions of the Library contained in the Combined Work and reverse +engineering for debugging such modifications, if you also do each of +the following: + + a) Give prominent notice with each copy of the Combined Work that + the Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the Combined Work with a copy of the GNU GPL and this license + document. + + c) For a Combined Work that displays copyright notices during + execution, include the copyright notice for the Library among + these notices, as well as a reference directing the user to the + copies of the GNU GPL and this license document. + + d) Do one of the following: + + 0) Convey the Minimal Corresponding Source under the terms of this + License, and the Corresponding Application Code in a form + suitable for, and under terms that permit, the user to + recombine or relink the Application with a modified version of + the Linked Version to produce a modified Combined Work, in the + manner specified by section 6 of the GNU GPL for conveying + Corresponding Source. + + 1) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (a) uses at run time + a copy of the Library already present on the user's computer + system, and (b) will operate properly with a modified version + of the Library that is interface-compatible with the Linked + Version. + + e) Provide Installation Information, but only if you would otherwise + be required to provide such information under section 6 of the + GNU GPL, and only to the extent that such information is + necessary to install and execute a modified version of the + Combined Work produced by recombining or relinking the + Application with a modified version of the Linked Version. (If + you use option 4d0, the Installation Information must accompany + the Minimal Corresponding Source and Corresponding Application + Code. If you use option 4d1, you must provide the Installation + Information in the manner specified by section 6 of the GNU GPL + for conveying Corresponding Source.) + + 5. Combined Libraries. + + You may place library facilities that are a work based on the +Library side by side in a single library together with other library +facilities that are not Applications and are not covered by this +License, and convey such a combined library under terms of your +choice, if you do both of the following: + + a) Accompany the combined library with a copy of the same work based + on the Library, uncombined with any other library facilities, + conveyed under the terms of this License. + + b) Give prominent notice with the combined library that part of it + is a work based on the Library, and explaining where to find the + accompanying uncombined form of the same work. + + 6. Revised Versions of the GNU Lesser General Public License. + + The Free Software Foundation may publish revised and/or new versions +of the GNU Lesser General Public License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. + + Each version is given a distinguishing version number. If the +Library as you received it specifies that a certain numbered version +of the GNU Lesser General Public License "or any later version" +applies to it, you have the option of following the terms and +conditions either of that published version or of any later version +published by the Free Software Foundation. If the Library as you +received it does not specify a version number of the GNU Lesser +General Public License, you may choose any version of the GNU Lesser +General Public License ever published by the Free Software Foundation. + + If the Library as you received it specifies that a proxy can decide +whether future versions of the GNU Lesser General Public License shall +apply, that proxy's public statement of acceptance of any version is +permanent authorization for you to choose that version for the +Library. diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..ce75d0b --- /dev/null +++ b/README.rst @@ -0,0 +1,134 @@ +===================================================================== + JayDeBeApi - bridge from JDBC database drivers to Python DB-API +===================================================================== + +The JayDeBeApi library allows you to connect from Python code to +databases using Java `JDBC +`_. It provides a +Python DB-API_ v2.0 to that database. + +It works on ordinary Python (cPython) using the JPype_ Java +integration or on `Jython `_ to make use of +the Java JDBC driver. + +It has been tested with `Hypersonic SQL (HSQLDB) +`_ and `IBM DB2 +`_ for z/OS. + +In contrast to zxJDBC from the Jython project JayDeBeApi let's you +access a database with Jython AND Python with only minor code +modifications. JayDeBeApi's future goal is to provide a unique and +fast interface to different types of JDBC-Drivers through a flexible +plug-in mechanism. + +.. contents:: + +Install +======= + +You can get and install JayDeBeApi with `easy_install +`_ :: + + $ easy_install JayDeBeApi + +If you want to install JayDeBeApi in Jython make sure to have +EasyInstall available for it. + +Or you can get a copy of the source branch using `bzr +`_ by running :: + + $ bzr branch lp:jaydebeapi + +and install it with :: + + $ python setup.py install + +or if you are using Jython use :: + + $ jython setup.py install + +It has been tested with Jython 2.5.2. + +If you are using cPython ensure that you have installed JPype_ +properly. It has been tested with JPype 0.5.4. + +Usage +===== + +Basically you just import the ``jaydebeapi`` Python module and execute +the ``connect`` method. This gives you a DB-API_ conform connection to +the database. + +The first argument to ``connect`` is the name of the Java driver +class. The rest of the arguments are internally passed to the Java +``DriverManager.getConnection`` method. See the Javadoc of +``DriverManager`` class for details. + +Here is an example: + +>>> import jaydebeapi +>>> conn = jaydebeapi.connect('org.hsqldb.jdbcDriver', +... 'jdbc:hsqldb:mem', 'SA', '') +>>> curs = conn.cursor() +>>> curs.execute('create table CUSTOMER' +... '("CUST_ID" INTEGER not null,' +... ' "NAME" VARCHAR not null,' +... ' primary key ("CUST_ID"))' +... ) +>>> curs.execute("insert into CUSTOMER values (1, 'John')") +>>> curs.execute("select * from CUSTOMER") +>>> curs.fetchall() +[(1, u'John')] + +You probably have to configure Jython or JPype to actually be able to +access the database driver's jar files. If I want to connect to a HSQL +in memory database on my Ubuntu machine I'm starting Python by running :: + + $ JAVA_HOME=/usr/lib/jvm/java-6-openjdk python + +Now I have to configure JPype + +>>> jar = '/path/to/my/driver/hsqldb.jar' +>>> args='-Djava.class.path=%s' % jar +>>> jpype.startJVM(jvm_path, args) + +or in Jython I have to + +>>> jar = '/path/to/my/driver/hsqldb.jar' +>>> import sys +>>> sys.path.append(jar) + +Contributing +============ + +Please submit `bugs and patches +`_. All contributors will be +acknowledged. Thanks! + +License +======= + +JayDeBeApi is released under the GNU Lesser General Public license +(LGPL). See the file ``COPYING`` and ``COPYING.LESSER`` in the +distribution for details. + + +Changelog +========= + +- 0.1 + + - Initial release + +To do +===== + +- Extract Java calls to seperate Java methods to increase performance. +- Check if https://code.launchpad.net/dbapi-compliance can help making + JayDeBeApi more DB-API complient. +- Test it on different databases and provide a flexible db specific + pluign mechanism. +- SQLAlchemy modules (seperate project) + +.. _DB-API: http://www.python.org/dev/peps/pep-0249/ +.. _JPype: http://jpype.sourceforge.net/ diff --git a/ez_setup.py b/ez_setup.py new file mode 100644 index 0000000..d24e845 --- /dev/null +++ b/ez_setup.py @@ -0,0 +1,276 @@ +#!python +"""Bootstrap setuptools installation + +If you want to use setuptools in your package's setup.py, just include this +file in the same directory with it, and add this to the top of your setup.py:: + + from ez_setup import use_setuptools + use_setuptools() + +If you want to require a specific version of setuptools, set a download +mirror, or use an alternate download directory, you can do so by supplying +the appropriate options to ``use_setuptools()``. + +This file can also be run as a script to install or upgrade setuptools. +""" +import sys +DEFAULT_VERSION = "0.6c9" +DEFAULT_URL = "http://pypi.python.org/packages/%s/s/setuptools/" % sys.version[:3] + +md5_data = { + 'setuptools-0.6b1-py2.3.egg': '8822caf901250d848b996b7f25c6e6ca', + 'setuptools-0.6b1-py2.4.egg': 'b79a8a403e4502fbb85ee3f1941735cb', + 'setuptools-0.6b2-py2.3.egg': '5657759d8a6d8fc44070a9d07272d99b', + 'setuptools-0.6b2-py2.4.egg': '4996a8d169d2be661fa32a6e52e4f82a', + 'setuptools-0.6b3-py2.3.egg': 'bb31c0fc7399a63579975cad9f5a0618', + 'setuptools-0.6b3-py2.4.egg': '38a8c6b3d6ecd22247f179f7da669fac', + 'setuptools-0.6b4-py2.3.egg': '62045a24ed4e1ebc77fe039aa4e6f7e5', + 'setuptools-0.6b4-py2.4.egg': '4cb2a185d228dacffb2d17f103b3b1c4', + 'setuptools-0.6c1-py2.3.egg': 'b3f2b5539d65cb7f74ad79127f1a908c', + 'setuptools-0.6c1-py2.4.egg': 'b45adeda0667d2d2ffe14009364f2a4b', + 'setuptools-0.6c2-py2.3.egg': 'f0064bf6aa2b7d0f3ba0b43f20817c27', + 'setuptools-0.6c2-py2.4.egg': '616192eec35f47e8ea16cd6a122b7277', + 'setuptools-0.6c3-py2.3.egg': 'f181fa125dfe85a259c9cd6f1d7b78fa', + 'setuptools-0.6c3-py2.4.egg': 'e0ed74682c998bfb73bf803a50e7b71e', + 'setuptools-0.6c3-py2.5.egg': 'abef16fdd61955514841c7c6bd98965e', + 'setuptools-0.6c4-py2.3.egg': 'b0b9131acab32022bfac7f44c5d7971f', + 'setuptools-0.6c4-py2.4.egg': '2a1f9656d4fbf3c97bf946c0a124e6e2', + 'setuptools-0.6c4-py2.5.egg': '8f5a052e32cdb9c72bcf4b5526f28afc', + 'setuptools-0.6c5-py2.3.egg': 'ee9fd80965da04f2f3e6b3576e9d8167', + 'setuptools-0.6c5-py2.4.egg': 'afe2adf1c01701ee841761f5bcd8aa64', + 'setuptools-0.6c5-py2.5.egg': 'a8d3f61494ccaa8714dfed37bccd3d5d', + 'setuptools-0.6c6-py2.3.egg': '35686b78116a668847237b69d549ec20', + 'setuptools-0.6c6-py2.4.egg': '3c56af57be3225019260a644430065ab', + 'setuptools-0.6c6-py2.5.egg': 'b2f8a7520709a5b34f80946de5f02f53', + 'setuptools-0.6c7-py2.3.egg': '209fdf9adc3a615e5115b725658e13e2', + 'setuptools-0.6c7-py2.4.egg': '5a8f954807d46a0fb67cf1f26c55a82e', + 'setuptools-0.6c7-py2.5.egg': '45d2ad28f9750e7434111fde831e8372', + 'setuptools-0.6c8-py2.3.egg': '50759d29b349db8cfd807ba8303f1902', + 'setuptools-0.6c8-py2.4.egg': 'cba38d74f7d483c06e9daa6070cce6de', + 'setuptools-0.6c8-py2.5.egg': '1721747ee329dc150590a58b3e1ac95b', + 'setuptools-0.6c9-py2.3.egg': 'a83c4020414807b496e4cfbe08507c03', + 'setuptools-0.6c9-py2.4.egg': '260a2be2e5388d66bdaee06abec6342a', + 'setuptools-0.6c9-py2.5.egg': 'fe67c3e5a17b12c0e7c541b7ea43a8e6', + 'setuptools-0.6c9-py2.6.egg': 'ca37b1ff16fa2ede6e19383e7b59245a', +} + +import sys, os +try: from hashlib import md5 +except ImportError: from md5 import md5 + +def _validate_md5(egg_name, data): + if egg_name in md5_data: + digest = md5(data).hexdigest() + if digest != md5_data[egg_name]: + print >>sys.stderr, ( + "md5 validation of %s failed! (Possible download problem?)" + % egg_name + ) + sys.exit(2) + return data + +def use_setuptools( + version=DEFAULT_VERSION, download_base=DEFAULT_URL, to_dir=os.curdir, + download_delay=15 +): + """Automatically find/download setuptools and make it available on sys.path + + `version` should be a valid setuptools version number that is available + as an egg for download under the `download_base` URL (which should end with + a '/'). `to_dir` is the directory where setuptools will be downloaded, if + it is not already available. If `download_delay` is specified, it should + be the number of seconds that will be paused before initiating a download, + should one be required. If an older version of setuptools is installed, + this routine will print a message to ``sys.stderr`` and raise SystemExit in + an attempt to abort the calling script. + """ + was_imported = 'pkg_resources' in sys.modules or 'setuptools' in sys.modules + def do_download(): + egg = download_setuptools(version, download_base, to_dir, download_delay) + sys.path.insert(0, egg) + import setuptools; setuptools.bootstrap_install_from = egg + try: + import pkg_resources + except ImportError: + return do_download() + try: + pkg_resources.require("setuptools>="+version); return + except pkg_resources.VersionConflict, e: + if was_imported: + print >>sys.stderr, ( + "The required version of setuptools (>=%s) is not available, and\n" + "can't be installed while this script is running. Please install\n" + " a more recent version first, using 'easy_install -U setuptools'." + "\n\n(Currently using %r)" + ) % (version, e.args[0]) + sys.exit(2) + else: + del pkg_resources, sys.modules['pkg_resources'] # reload ok + return do_download() + except pkg_resources.DistributionNotFound: + return do_download() + +def download_setuptools( + version=DEFAULT_VERSION, download_base=DEFAULT_URL, to_dir=os.curdir, + delay = 15 +): + """Download setuptools from a specified location and return its filename + + `version` should be a valid setuptools version number that is available + as an egg for download under the `download_base` URL (which should end + with a '/'). `to_dir` is the directory where the egg will be downloaded. + `delay` is the number of seconds to pause before an actual download attempt. + """ + import urllib2, shutil + egg_name = "setuptools-%s-py%s.egg" % (version,sys.version[:3]) + url = download_base + egg_name + saveto = os.path.join(to_dir, egg_name) + src = dst = None + if not os.path.exists(saveto): # Avoid repeated downloads + try: + from distutils import log + if delay: + log.warn(""" +--------------------------------------------------------------------------- +This script requires setuptools version %s to run (even to display +help). I will attempt to download it for you (from +%s), but +you may need to enable firewall access for this script first. +I will start the download in %d seconds. + +(Note: if this machine does not have network access, please obtain the file + + %s + +and place it in this directory before rerunning this script.) +---------------------------------------------------------------------------""", + version, download_base, delay, url + ); from time import sleep; sleep(delay) + log.warn("Downloading %s", url) + src = urllib2.urlopen(url) + # Read/write all in one block, so we don't create a corrupt file + # if the download is interrupted. + data = _validate_md5(egg_name, src.read()) + dst = open(saveto,"wb"); dst.write(data) + finally: + if src: src.close() + if dst: dst.close() + return os.path.realpath(saveto) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +def main(argv, version=DEFAULT_VERSION): + """Install or upgrade setuptools and EasyInstall""" + try: + import setuptools + except ImportError: + egg = None + try: + egg = download_setuptools(version, delay=0) + sys.path.insert(0,egg) + from setuptools.command.easy_install import main + return main(list(argv)+[egg]) # we're done here + finally: + if egg and os.path.exists(egg): + os.unlink(egg) + else: + if setuptools.__version__ == '0.0.1': + print >>sys.stderr, ( + "You have an obsolete version of setuptools installed. Please\n" + "remove it from your system entirely before rerunning this script." + ) + sys.exit(2) + + req = "setuptools>="+version + import pkg_resources + try: + pkg_resources.require(req) + except pkg_resources.VersionConflict: + try: + from setuptools.command.easy_install import main + except ImportError: + from easy_install import main + main(list(argv)+[download_setuptools(delay=0)]) + sys.exit(0) # try to force an exit + else: + if argv: + from setuptools.command.easy_install import main + main(argv) + else: + print "Setuptools version",version,"or greater has been installed." + print '(Run "ez_setup.py -U setuptools" to reinstall or upgrade.)' + +def update_md5(filenames): + """Update our built-in md5 registry""" + + import re + + for name in filenames: + base = os.path.basename(name) + f = open(name,'rb') + md5_data[base] = md5(f.read()).hexdigest() + f.close() + + data = [" %r: %r,\n" % it for it in md5_data.items()] + data.sort() + repl = "".join(data) + + import inspect + srcfile = inspect.getsourcefile(sys.modules[__name__]) + f = open(srcfile, 'rb'); src = f.read(); f.close() + + match = re.search("\nmd5_data = {\n([^}]+)}", src) + if not match: + print >>sys.stderr, "Internal error!" + sys.exit(2) + + src = src[:match.start(1)] + repl + src[match.end(1):] + f = open(srcfile,'w') + f.write(src) + f.close() + + +if __name__=='__main__': + if len(sys.argv)>2 and sys.argv[1]=='--md5update': + update_md5(sys.argv[2:]) + else: + main(sys.argv[1:]) + + + + + + diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..d108ef6 --- /dev/null +++ b/setup.py @@ -0,0 +1,49 @@ +# Copyright 2010 Bastian Bowe +# +# This file is part of JayDeBeApi. +# JayDeBeApi is free software: you can redistribute it and/or modify +# it under the terms of the GNU Lesser General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. +# +# JayDeBeApi is distributed in the hope that it will be useful, but +# WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public +# License along with JayDeBeApi. If not, see +# . +# + +import ez_setup +ez_setup.use_setuptools() +from setuptools import setup, find_packages + +print find_packages('src') +setup( + #basic package data + name = 'JayDeBeApi', + version = '0.1', + author = 'Bastian Bowe', + author_email = 'bastian.bowe@gmail.com', + license = 'GNU LGPL', + url='https://code.launchpad.net/jaydebeapi', + description=('A bridge from JDBC database drivers to Python DB-API.'), + long_description=file('README.rst').read(), + keywords = ('db api java jdbc bridge connect sql jpype jython'), + classifiers = [ + 'Development Status :: 3 - Alpha', + 'Intended Audience :: Developers', + 'License :: OSI Approved :: GNU Library or Lesser General Public License (LGPL)', + 'Programming Language :: Java', + 'Programming Language :: Python', + 'Programming Language :: Python :: 2', + 'Topic :: Database', + 'Topic :: Software Development :: Libraries :: Java Libraries', + 'Topic :: Software Development :: Libraries :: Python Modules', + ], + + packages=find_packages('src'), + package_dir={ '': 'src' }, + ) diff --git a/src/.ropeproject/config.py b/src/.ropeproject/config.py new file mode 100644 index 0000000..ffebcd4 --- /dev/null +++ b/src/.ropeproject/config.py @@ -0,0 +1,85 @@ +# The default ``config.py`` + + +def set_prefs(prefs): + """This function is called before opening the project""" + + # Specify which files and folders to ignore in the project. + # Changes to ignored resources are not added to the history and + # VCSs. Also they are not returned in `Project.get_files()`. + # Note that ``?`` and ``*`` match all characters but slashes. + # '*.pyc': matches 'test.pyc' and 'pkg/test.pyc' + # 'mod*.pyc': matches 'test/mod1.pyc' but not 'mod/1.pyc' + # '.svn': matches 'pkg/.svn' and all of its children + # 'build/*.o': matches 'build/lib.o' but not 'build/sub/lib.o' + # 'build//*.o': matches 'build/lib.o' and 'build/sub/lib.o' + prefs['ignored_resources'] = ['*.pyc', '*~', '.ropeproject', + '.hg', '.svn', '_svn', '.git'] + + # Specifies which files should be considered python files. It is + # useful when you have scripts inside your project. Only files + # ending with ``.py`` are considered to be python files by + # default. + #prefs['python_files'] = ['*.py'] + + # Custom source folders: By default rope searches the project + # for finding source folders (folders that should be searched + # for finding modules). You can add paths to that list. Note + # that rope guesses project source folders correctly most of the + # time; use this if you have any problems. + # The folders should be relative to project root and use '/' for + # separating folders regardless of the platform rope is running on. + # 'src/my_source_folder' for instance. + #prefs.add('source_folders', 'src') + + # You can extend python path for looking up modules + #prefs.add('python_path', '~/python/') + + # Should rope save object information or not. + prefs['save_objectdb'] = True + prefs['compress_objectdb'] = False + + # If `True`, rope analyzes each module when it is being saved. + prefs['automatic_soa'] = True + # The depth of calls to follow in static object analysis + prefs['soa_followed_calls'] = 0 + + # If `False` when running modules or unit tests "dynamic object + # analysis" is turned off. This makes them much faster. + prefs['perform_doa'] = True + + # Rope can check the validity of its object DB when running. + prefs['validate_objectdb'] = True + + # How many undos to hold? + prefs['max_history_items'] = 32 + + # Shows whether to save history across sessions. + prefs['save_history'] = True + prefs['compress_history'] = False + + # Set the number spaces used for indenting. According to + # :PEP:`8`, it is best to use 4 spaces. Since most of rope's + # unit-tests use 4 spaces it is more reliable, too. + prefs['indent_size'] = 4 + + # Builtin and c-extension modules that are allowed to be imported + # and inspected by rope. + prefs['extension_modules'] = [] + + # Add all standard c-extensions to extension_modules list. + prefs['import_dynload_stdmods'] = True + + # If `True` modules with syntax errors are considered to be empty. + # The default value is `False`; When `False` syntax errors raise + # `rope.base.exceptions.ModuleSyntaxError` exception. + prefs['ignore_syntax_errors'] = False + + # If `True`, rope ignores unresolvable imports. Otherwise, they + # appear in the importing namespace. + prefs['ignore_bad_imports'] = False + + +def project_opened(project): + """This function is called after opening the project""" + # Do whatever you like here! diff --git a/src/JayDeBeApi.egg-info/PKG-INFO b/src/JayDeBeApi.egg-info/PKG-INFO new file mode 100644 index 0000000..bdb1ad9 --- /dev/null +++ b/src/JayDeBeApi.egg-info/PKG-INFO @@ -0,0 +1,154 @@ +Metadata-Version: 1.0 +Name: JayDeBeApi +Version: 0.1 +Summary: A bridge from JDBC database drivers to Python DB-API. +Home-page: https://code.launchpad.net/jaydebeapi +Author: Bastian Bowe +Author-email: bastian.bowe@gmail.com +License: GNU LGPL +Description: ===================================================================== + JayDeBeApi - bridge from JDBC Database drivers to Python DB-API + ===================================================================== + + The JayDeBeApi library allows you to connect from Python code to + databases using Java `JDBC + `_. It provides a + Python DB-API_ v2.0 to that database. + + It works on ordinary Python (cPython) using the JPype_ Java + integration or on `Jython `_ to make use of + the Java JDBC driver. + + It has been tested with `Hypersonic SQL (HSQLDB) + `_ and `IBM DB2 + `_ for z/OS. + + In contrast to zxJDBC from the Jython project JayDeBeApi let's you + access a database with Jython AND Python with only minor code + modifications. JayDeBeApi's future goal is to provide a unique and + fast interface to different types of JDBC-Drivers through a flexible + plug-in mechanism. + + .. contents:: + + Install + ======= + + You can get and install JayDeBeApi with `easy_install + `_ :: + + $ easy_install JayDeBeApi + + If you want to install JayDeBeApi in Jython make sure to have + EasyInstall available for it. + + Or you can get a copy of the source branch using `bzr + `_ by running :: + + $ bzr branch lp:jaydebeapi + + and install it with :: + + $ python setup.py install + + or if you are using Jython use :: + + $ jython setup.py install + + It has been tested with Jython 2.5.2. + + If you are using cPython ensure that you have installed JPype_ + properly. It has been tested with JPype 0.5.4. + + Usage + ===== + + Basically you just import the ``jaydebeapi`` Python module and execute + the ``connect`` method. This gives you a DB-API_ conform connection to + the database. + + The first argument to ``connect`` is the name of the Java driver + class. The rest of the arguments are internally passed to the Java + ``DriverManager.getConnection`` method. See the Javadoc of + ``DriverManager`` class for details. + + Here is an example: + + >>> import jaydebeapi + >>> conn = jaydebeapi.connect('org.hsqldb.jdbcDriver', + ... 'jdbc:hsqldb:mem', 'SA', '') + >>> curs = conn.cursor() + >>> curs.execute('create table CUSTOMER' + ... '("CUST_ID" INTEGER not null,' + ... ' "NAME" VARCHAR not null,' + ... ' primary key ("CUST_ID"))' + ... ) + >>> curs.execute("insert into CUSTOMER values (1, 'John')") + >>> curs.execute("select * from CUSTOMER") + >>> curs.fetchall() + [(1, u'John')] + + You probably have to configure Jython or JPype to actually be able to + access the database driver's jar files. If I want to connect to a HSQL + in memory database on my Ubuntu machine I'm starting Python by running :: + + $ JAVA_HOME=/usr/lib/jvm/java-6-openjdk python + + Now I have to configure JPype + + >>> jar = '/path/to/my/driver/hsqldb.jar' + >>> args='-Djava.class.path=%s' % jar + >>> jpype.startJVM(jvm_path, args) + + or in Jython I have to + + >>> jar = '/path/to/my/driver/hsqldb.jar' + >>> import sys + >>> sys.path.append(jar) + + Contributing + ============ + + Please submit `bugs and patches + `_. All contributors will be + acknowledged. Thanks! + + License + ======= + + JayDeBeApi is released under the GNU Lesser General Public license + (LGPL). See the file ``COPYING`` and ``COPYING.LESSER`` in the + distribution for details. + + + Changelog + ========= + + - 0.1 + + - Initial release + + To do + ===== + + - Extract Java calls to seperate Java methods to increase performance. + - Check if https://code.launchpad.net/dbapi-compliance can help making + JayDeBeApi more DB-API complient. + - Test it on different databases and provide a flexible db specific + pluign mechanism. + - SQLAlchemy modules (seperate project) + + .. _DB-API: http://www.python.org/dev/peps/pep-0249/ + .. _JPype: http://jpype.sourceforge.net/ + +Keywords: db api java jdbc bridge connect sql jpype jython +Platform: UNKNOWN +Classifier: Development Status :: 3 - Alpha +Classifier: Intended Audience :: Developers +Classifier: License :: OSI Approved :: GNU Library or Lesser General Public License (LGPL) +Classifier: Programming Language :: Java +Classifier: Programming Language :: Python +Classifier: Programming Language :: Python :: 2 +Classifier: Topic :: Database +Classifier: Topic :: Software Development :: Libraries :: Java Libraries +Classifier: Topic :: Software Development :: Libraries :: Python Modules diff --git a/src/JayDeBeApi.egg-info/SOURCES.txt b/src/JayDeBeApi.egg-info/SOURCES.txt new file mode 100644 index 0000000..1704513 --- /dev/null +++ b/src/JayDeBeApi.egg-info/SOURCES.txt @@ -0,0 +1,7 @@ +setup.py +src/JayDeBeApi.egg-info/PKG-INFO +src/JayDeBeApi.egg-info/SOURCES.txt +src/JayDeBeApi.egg-info/dependency_links.txt +src/JayDeBeApi.egg-info/top_level.txt +src/jaydebeapi/__init__.py +src/jaydebeapi/dbapi2.py \ No newline at end of file diff --git a/src/JayDeBeApi.egg-info/dependency_links.txt b/src/JayDeBeApi.egg-info/dependency_links.txt new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/src/JayDeBeApi.egg-info/dependency_links.txt @@ -0,0 +1 @@ + diff --git a/src/JayDeBeApi.egg-info/top_level.txt b/src/JayDeBeApi.egg-info/top_level.txt new file mode 100644 index 0000000..78d1c7f --- /dev/null +++ b/src/JayDeBeApi.egg-info/top_level.txt @@ -0,0 +1 @@ +jaydebeapi diff --git a/src/jaydebeapi/__init__.py b/src/jaydebeapi/__init__.py new file mode 100644 index 0000000..2e4ba3a --- /dev/null +++ b/src/jaydebeapi/__init__.py @@ -0,0 +1 @@ +from dbapi2 import * diff --git a/src/jaydebeapi/dbapi2.py b/src/jaydebeapi/dbapi2.py new file mode 100644 index 0000000..4b84075 --- /dev/null +++ b/src/jaydebeapi/dbapi2.py @@ -0,0 +1,385 @@ +#-*- coding: utf-8 -*- + +# Copyright 2010 Bastian Bowe +# +# This file is part of JayDeBeApi. +# JayDeBeApi is free software: you can redistribute it and/or modify +# it under the terms of the GNU Lesser General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. +# +# JayDeBeApi is distributed in the hope that it will be useful, but +# WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public +# License along with JayDeBeApi. If not, see +# . + +import datetime +import exceptions +import time +import sys + +_jdbc_connect = None + +def _jdbc_connect_jython(jclassname, *args): + # register driver for DriverManager + __import__(jclassname) + from java.sql import DriverManager + return DriverManager.getConnection(*args) + +def _prepare_jython(): + global _jdbc_connect + _jdbc_connect = _jdbc_connect_jython + # TODO: find solution for jython + # Binary = buffer + +def _jdbc_connect_jpype(jclassname, *args): + import jpype + if not jpype.isJVMStarted(): + jpype.startJVM(jpype.getDefaultJVMPath()) + if not jpype.isThreadAttachedToJVM(): + jpype.attachThreadToJVM() + # register driver for DriverManager + jpype.JClass(jclassname) + return jpype.java.sql.DriverManager.getConnection(*args) + +def _prepare_jpype(): + global _jdbc_connect + _jdbc_connect = _jdbc_connect_jpype + # TODO: doesn't work for Jython +# global Binary +# Binary = buffer + +if sys.platform.lower().startswith('java'): + _prepare_jython() +else: + _prepare_jpype() + +apilevel = '2.0' +threadsafety = 1 +paramstyle = 'qmark' + +class DBAPITypeObject(object): + def __init__(self,*values): + self.values = values + def __cmp__(self,other): + if other in self.values: + return 0 + if other < self.values: + return 1 + else: + return -1 + +STRING = DBAPITypeObject("CHARACTER", "CHAR", "VARCHAR", + "CHARACTER VARYING", "CHAR VARYING", "STRING",) + +TEXT = DBAPITypeObject("CLOB", "CHARACTER LARGE OBJECT", + "CHAR LARGE OBJECT", "XML",) + +BINARY = DBAPITypeObject("BLOB", "BINARY LARGE OBJECT",) + +NUMBER = DBAPITypeObject("INTEGER", "INT", "SMALLINT", "BIGINT",) + +FLOAT = DBAPITypeObject("FLOAT", "REAL", "DOUBLE", "DECFLOAT") + +DECIMAL = DBAPITypeObject("DECIMAL", "DEC", "NUMERIC", "NUM",) + +DATE = DBAPITypeObject("DATE",) + +TIME = DBAPITypeObject("TIME",) + +DATETIME = DBAPITypeObject("TIMESTAMP",) + +ROWID = DBAPITypeObject(()) + +# DB-API 2.0 Module Interface Exceptions +class Error(exceptions.StandardError): + pass + +class Warning(exceptions.StandardError): + pass + +class InterfaceError(Error): + pass + +class DatabaseError(Error): + pass + +class InternalError(DatabaseError): + pass + +class OperationalError(DatabaseError): + pass + +class ProgrammingError(DatabaseError): + pass + +class IntegrityError(DatabaseError): + pass + +class DataError(DatabaseError): + pass + +class NotSupportedError(DatabaseError): + pass + +# DB-API 2.0 Type Objects and Constructors +Date = datetime.date + +Time = datetime.time + +Timestamp = datetime.datetime + +def DateFromTicks(ticks): + return apply(Date, time.localtime(ticks)[:3]) + +def TimeFromTicks(ticks): + return apply(Time, time.localtime(ticks)[3:6]) + +def TimestampFromTicks(ticks): + return apply(Timestamp, time.localtime(ticks)[:6]) + +# DB-API 2.0 Module Interface connect constructor +def connect(jclassname, *args): + jconn = _jdbc_connect(jclassname, *args) + return Connection(jconn) + +# DB-API 2.0 Connection Object +class Connection(object): + + jconn = None + + def __init__(self, jconn): + self.jconn = jconn + + def close(self): + self.jconn.close() + + def commit(self): + return self.jconn.commit() + + def rollback(self): + return self.jconn.rollback() + + def cursor(self): + return Cursor(self) + +# DB-API 2.0 Cursor Object +class Cursor(object): + + rowcount = -1 + _meta = None + _prep = None + _rs = None + _description = None + + def __init__(self, connection): + self._connection = connection + + @property + def description(self): + if self._description: + return self._description + m = self._meta + if m: + count = m.getColumnCount() + self._description = [] + for col in range(1, count + 1): + size = m.getColumnDisplaySize(col) + col_desc = ( m.getColumnName(col), + m.getColumnTypeName(col), + size, + size, + m.getPrecision(col), + m.getScale(col), + m.isNullable(col), + ) + self._description.append(col_desc) + return self._description + +# optional callproc(self, procname, *parameters) unsupported + + def close(self): + self._close_last() + self.connection = None + + def _close_last(self): + """Close the resultset and reset collected meta data. + """ + if self._rs: + self._rs.close() + if self._prep: + self._prep.close() + self._rs = None + self._meta = None + self._description = None + + def _set_stmt_parms(self, prep_stmt, *parameters): + for i in range(len(parameters)): + sqltype = TYPE_MAP[type(parameters[i])] + setter = getattr(prep_stmt, 'set%s' % METHOD_MAP[sqltype]) + setter(i + 1, parameters[i]) + + def execute(self, operation, *parameters): + self._close_last() + self._prep = self._connection.jconn.prepareStatement(operation) + self._set_stmt_parms(self._prep, *parameters) + is_rs = self._prep.execute() + self.update_count = self._prep.getUpdateCount() + if is_rs: + self._rs = self._prep.getResultSet() + self._meta = self._rs.getMetaData() + # self._prep.getWarnings() ??? + + def executemany(self, operation, seq_of_parameters): + self._close_last() + self._prep = self._connection.jconn.prepareStatement(operation) + for parameters in seq_of_parameters: + self._set_stmt_parms(self._prep, *parameters) + self._prep.addBatch() + update_counts = self._prep.executeBatch() + # self._prep.getWarnings() ??? + self.rowcount = sum(update_counts) + + def fetchone(self): + #raise if not rs + if not self._rs.next(): + return None + row = [] + for col in range(1, self._meta.getColumnCount() + 1): + sqltype = self._meta.getColumnType(col) + getter = getattr(self._rs, 'get%s' % METHOD_MAP[sqltype]) + v = getter(col) + converter = TO_PY_MAP.get(sqltype) + if converter: + v = converter(v) + row.append(v) + return tuple(row) + + def fetchmany(self, size=None): + if size is None: + size = self.arraysize + self._rs.setFetchSize(size) + rows = [] + row = None + for i in xrange(size): + row = self.fetchone() + if row is None: + break + else: + rows.append(row) + # reset fetch size + if row: + self._rs.setFetchSize(0) + return rows + + def fetchall(self): + rows = [] + while True: + row = self.fetchone() + if row is None: + break + else: + rows.append(row) + return rows + + # optional nextset() unsupported + + arraysize = 1 + + def setinputsizes(self, sizes): + pass + + def setoutputsize(self, size, column): + pass + +class JavaSqlTypes(object): + # from java.sql.Types + ARRAY=2003 + BIGINT=-5 + BINARY=-2 + BIT=-7 + BLOB=2004 + BOOLEAN=16 + CHAR=1 + CLOB=2005 + DATALINK=70 + DATE=91 + DECIMAL=3 + DISTINCT=2001 + DOUBLE=8 + FLOAT=6 + INTEGER=4 + JAVA_OBJECT=2000 + LONGVARBINARY=-4 + LONGVARCHAR=-1 + NULL=0 + NUMERIC=2 + OTHER=1111 + REAL=7 + REF=2006 + SMALLINT=5 + STRUCT=2002 + TIME=92 + TIMESTAMP=93 + TINYINT=-6 + VARBINARY=-3 + VARCHAR=12 + +METHOD_MAP = { + JavaSqlTypes.ARRAY: 'Array', + #AsciiStream + JavaSqlTypes.NUMERIC: 'BigDecimal', + JavaSqlTypes.DECIMAL: 'BigDecimal', + #BinaryStream + JavaSqlTypes.BLOB: 'Blob', + JavaSqlTypes.BOOLEAN: 'Boolean', + JavaSqlTypes.CHAR: 'String', + JavaSqlTypes.BINARY: 'Bytes', + #CharacterStream + JavaSqlTypes.CLOB: 'Clob', + JavaSqlTypes.DOUBLE: 'Double', + JavaSqlTypes.DATE: 'Date', + JavaSqlTypes.FLOAT: 'Float', + JavaSqlTypes.INTEGER: 'Int', + JavaSqlTypes.BIGINT: 'Long', + JavaSqlTypes.SMALLINT: 'Short', + JavaSqlTypes.VARCHAR: 'String', + JavaSqlTypes.TIME: 'Time', + JavaSqlTypes.TIMESTAMP: 'Timestamp', + JavaSqlTypes.NULL: 'Null', +} + +TYPE_MAP = { + int: JavaSqlTypes.INTEGER, + long: JavaSqlTypes.BIGINT, + float: JavaSqlTypes.DOUBLE, + type(None): JavaSqlTypes.NULL, + str: JavaSqlTypes.VARCHAR, + bool: JavaSqlTypes.BOOLEAN, +# buffer: JavaSqlTypes.BINARY, + unicode: JavaSqlTypes.VARCHAR, + } + +def to_datetime(java_val): +# d=datetime.datetime.strptime(timestmp.toString()[:-7], "%Y-%m-%d %H:%M:%S") +# return d.replace(microsecond=int(str(timestmp.getNanos())[:6])) + return java_val.toString() + +def to_date(java_val): +# d=datetime.datetime.strptime(timestmp.toString()[:-7], "%Y-%m-%d %H:%M:%S") +# return d.replace(microsecond=int(str(timestmp.getNanos())[:6])) + return java_val.toString() + +def to_float(java_val): + return java_val.doubleValue() + +TO_PY_MAP = { + JavaSqlTypes.TIMESTAMP: to_datetime, + JavaSqlTypes.DATE: to_date, + JavaSqlTypes.DECIMAL: to_float, + JavaSqlTypes.NUMERIC: to_float, +} diff --git a/src/test/data/create.sql b/src/test/data/create.sql new file mode 100644 index 0000000..14b5e50 --- /dev/null +++ b/src/test/data/create.sql @@ -0,0 +1,7 @@ +create table konto ( +"KONTO_ID" TIMESTAMP default CURRENT_TIMESTAMP not null, +"KONTO_NR" INTEGER not null, +"SALDO" DECIMAL default 0.0 not null, +primary key ("KONTO_ID") +); + diff --git a/src/test/data/insert.sql b/src/test/data/insert.sql new file mode 100644 index 0000000..6d3a945 --- /dev/null +++ b/src/test/data/insert.sql @@ -0,0 +1,2 @@ +insert into Konto values ('2009-09-10 14:15:22.123456', 18, 12.4); +insert into Konto values ('2009-09-11 14:15:22.123456', 19, 12.9); diff --git a/src/test/integration_test.py b/src/test/integration_test.py new file mode 100644 index 0000000..b600b87 --- /dev/null +++ b/src/test/integration_test.py @@ -0,0 +1,145 @@ +#-*- coding: utf-8 -*- + +# Copyright 2010 Bastian Bowe +# +# This file is part of JayDeBeApi. +# JayDeBeApi is free software: you can redistribute it and/or modify +# it under the terms of the GNU Lesser General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. +# +# JayDeBeApi is distributed in the hope that it will be useful, but +# WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public +# License along with JayDeBeApi. If not, see +# . + +import os +from unittest import TestCase +import jaydebeapi +import sys + +this_dir = os.path.dirname(os.path.abspath(__file__)) +jar_dir = os.path.abspath(os.path.join(this_dir, '..', '..', + 'build', 'lib')) +create_sql = os.path.join(this_dir, 'data', 'create.sql') +insert_sql = os.path.join(this_dir, 'data', 'insert.sql') + +def is_jython(): + return sys.platform.lower().startswith('java') + +class IntegrationTest(TestCase): + + def sql_file(self, filename): + f = open(filename, 'r') + try: + lines = f.readlines() + finally: + f.close() + stmt = [] + stmts = [] + for i in lines: + stmt.append(i) + if ";" in i: + stmts.append(" ".join(stmt)) + stmt = [] + cursor = self.conn.cursor() + for i in stmts: + cursor.execute(i) + + def setup_jpype(self, jars): + import jpype + if not jpype.isJVMStarted(): + jvm_path = jpype.getDefaultJVMPath() + #jvm_path = ('/usr/lib/jvm/java-6-openjdk' + # '/jre/lib/i386/client/libjvm.so') + args='-Djava.class.path=%s' % jars + jpype.startJVM(jvm_path, args) + if not jpype.isThreadAttachedToJVM(): + jpype.attachThreadToJVM() + + def setUp(self): + # TODO support more than one jar + #jars='/usr/share/java/hsqldb.jar' + jars=os.path.join(jar_dir, 'hsqldb.jar') + #jars=jars_path(r'C:\Programme\DbVisualizer-4.3.5\jdbc') + if is_jython(): + sys.path.append(jars) + else: + self.setup_jpype(jars) + self.conn = jaydebeapi.connect('org.hsqldb.jdbcDriver', + 'jdbc:hsqldb:mem', 'SA', '') + #conn = jaydebeapi.connect('com.ibm.db2.jcc.DB2Driver', + # 'jdbc:db2://4.100.73.81:50000/db2t', + # getpass.getuser(), getpass.getpass()) + self.sql_file(create_sql) + self.sql_file(insert_sql) + + def tearDown(self): + cursor = self.conn.cursor() + cursor.execute("drop table konto"); + self.conn.close() + + def test_execute_and_fetch_no_data(self): + cursor = self.conn.cursor() + stmt = "select * from konto where konto_id is null" + cursor.execute(stmt) + assert [] == cursor.fetchall() + + def test_execute_and_fetch(self): + cursor = self.conn.cursor() + cursor.execute("select * from konto") + result = cursor.fetchall() + assert [(u'2009-09-10 14:15:22.123456', 18, 12.4), + (u'2009-09-11 14:15:22.123456', 19, 12.9)] == result + + def test_execute_and_fetch_parameter(self): + cursor = self.conn.cursor() + cursor.execute("select * from konto where konto_nr = ?", 18) + result = cursor.fetchall() + assert [(u'2009-09-10 14:15:22.123456', 18, 12.4)] == result + + def test_execute_and_fetchone(self): + cursor = self.conn.cursor() + cursor.execute("select * from konto order by konto_nr") + result = cursor.fetchone() + assert (u'2009-09-10 14:15:22.123456', 18, 12.4) == result + + def test_execute_reset_description_without_execute_result(self): + """Excpect the descriptions property being reset when no query + has been made via execute method. + """ + cursor = self.conn.cursor() + cursor.execute("select * from konto") + assert None != cursor.description + cursor.fetchone() + cursor.execute("delete from konto") + assert None == cursor.description + + def test_execute_and_fetchone_after_end(self): + cursor = self.conn.cursor() + cursor.execute("select * from konto where konto_nr = ?", 18) + cursor.fetchone() + result = cursor.fetchone() + assert None is result + + def test_execute_and_fetchmany(self): + cursor = self.conn.cursor() + cursor.execute("select * from konto order by konto_nr") + result = cursor.fetchmany() + assert [(u'2009-09-10 14:15:22.123456', 18, 12.4)] == result + + def test_executemany(self): + cursor = self.conn.cursor() + stmt = "insert into Konto (KONTO_ID, KONTO_NR, SALDO) values (?, ?, ?)" + parms = ( + ( '2009-09-11 14:15:22.123450', 20, 13.1 ), + ( '2009-09-11 14:15:22.123451', 21, 13.2 ), + ( '2009-09-11 14:15:22.123452', 22, 13.3 ), + ) + cursor.executemany(stmt, parms) + assert cursor.rowcount == 3 +