commit 444b9d33dc1effb91400cc5db87da6b3ed6bdd16 Author: Cédric Krier Date: Sat Jun 12 16:55:24 2010 +0200 Initial commit diff --git a/COPYRIGHT b/COPYRIGHT new file mode 100644 index 0000000000..34a6d18b42 --- /dev/null +++ b/COPYRIGHT @@ -0,0 +1,15 @@ +Copyright (C) 2010 Cédric Krier. +Copyright (C) 2010 B2CK SPRL. + +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 . diff --git a/INSTALL b/INSTALL new file mode 100644 index 0000000000..04691ddbe3 --- /dev/null +++ b/INSTALL @@ -0,0 +1,26 @@ +Installing proteus +================== + +Prerequisites +------------- + + * Python 2.4 or later (http://www.python.org/) + * trytond (http://www.tryton.org/) + +Installation +------------ + +Once you've downloaded and unpacked the proteus source release, enter the +directory where the archive was unpacked, and run: + + python setup.py install + +Note that you may need administrator/root privileges for this step, as +this command will by default attempt to install module to the Python +site-packages directory on your system. + +For advanced options, please refer to the easy_install and/or the distutils +documentation: + + http://peak.telecommunity.com/DevCenter/EasyInstall + http://docs.python.org/inst/inst.html diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000000..94a9ed024d --- /dev/null +++ b/LICENSE @@ -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/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000000..b88b5e975d --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,9 @@ +include LICENSE +include COPYRIGHT +include README +include INSTALL +include CHANGELOG +include doc/* +recursive-include doc *.rst +recursive-include doc *.po +recursive-include doc *.pot diff --git a/README b/README new file mode 100644 index 0000000000..c337a861ce --- /dev/null +++ b/README @@ -0,0 +1,35 @@ +proteus +======= + +A library to access Tryton's models like a client. + +Installing +---------- + +See INSTALL + +Support +------- + +If you encounter any problems with Tryton, please don't hesitate to ask +questions on the Tryton bug tracker, mailing list, wiki or IRC channel: + + http://bugs.tryton.org/ + http://groups.tryton.org/ + http://wiki.tryton.org/ + irc://irc.freenode.net/tryton + +License +------- + +See LICENSE + +Copyright +--------- + +See COPYRIGHT + + +For more information please visit the Tryton web site: + + http://www.tryton.org/ diff --git a/proteus/__init__.py b/proteus/__init__.py new file mode 100644 index 0000000000..ebed1bb268 --- /dev/null +++ b/proteus/__init__.py @@ -0,0 +1,555 @@ +#This file is part of Tryton. The COPYRIGHT file at the top level of +#this repository contains the full copyright notices and license terms. +''' +A library to access Tryton's models like a client. +''' +__version__ = "0.0.1" +from types import NoneType +import threading +import datetime +from decimal import Decimal +import proteus.config +from proteus.pyson import PYSONDecoder + +_MODELS = threading.local() + +class _EvalEnvironment(dict): + 'Dictionary for evaluation' + def __init__(self, parent): + super(_EvalEnvironment, self).__init__() + self.parent = parent + + def __getitem__(self, item): + if item == '_parent_' + self.parent.parent_field_name \ + and self.parent.parent: + return _EvalEnvironment(self.parent.parent) + return self.parent._get_eval()[item] + + def __getattr__(self, item): + return self.__getitem__(item) + + def get(self, item, default=None): + try: + return self.__getattr__(item) + except: + pass + return super(_EvalEnvironment, self).get(item, default) + + def __nonzero__(self): + return True + + def __str__(self): + return str(self.parent) + + __repr__ = __str__ + + def __contains__(self, item): + return item in self.parent._fields + +def _getmethod(name, definition): + def getmethod(self): + if self.id > 0 and name not in self._values: + self._read(name) + if definition['type'] == 'many2one': + if isinstance(self._values.get(name), (int, long)) \ + and self._values.get(name) is not False: + relation = Model.get(definition['relation'], self._config) + self._values[name] = relation(self._values.get(name)) + elif not self._values.get(name): + self._values[name] = None + elif definition['type'] in ('one2many', 'many2many'): + relation = Model.get(definition['relation'], self._config) + if not isinstance(self._values.get(name), ModelList): + self._values[name] = ModelList((relation(id) for id + in self._values.get(name) or []), self, name) + for record in self._values[name]: + record._parent = self + record._parent_field_name = name + elif definition['type'] == 'date': + if isinstance(self._values.get(name), datetime.datetime): + self._values[name] = self._values.get(name).date() + elif definition['type'] == 'reference': + if isinstance(self._values.get(name), basestring): + ref_model, ref_id = self._values[name].split(',', 1) + if ref_model: + relation = Model.get(ref_model, self._config) + self._values[name] = relation(int(ref_id)) + elif not self._values.get(name): + self._values[name] = None + return self._values.get(name) + return getmethod + +def _setmethod(name, definition): + def set_method(self, value): + assert definition['type'] not in ('one2many', 'many2many') + + if definition['type'] in ('many2one'): + assert isinstance(value, (Model, NoneType)) + if value: + assert value.id > 0 and not value._changed + assert value._config == self._config + elif definition['type'] == 'datetime': + assert isinstance(value, datetime.datetime) + elif definition['type'] == 'date': + assert isinstance(value, datetime.date) + elif definition['type'] == 'reference': + assert isinstance(value, (Model, NoneType, basestring)) + if isinstance(value, basestring): + assert value.startswith(',') + elif isinstance(value, Model): + assert value.id > 0 and not value._changed + assert value._config == self._config + elif definition['type'] in ('char', 'sha', 'selection'): + assert isinstance(value, basestring) + elif definition['type'] in ('float_time', 'float'): + assert isinstance(value, float) + elif definition['type'] in ('integer', 'biginteger'): + assert isinstance(value, (int, long)) + elif definition['type'] == 'numeric': + assert isinstance(value, Decimal) + elif definition['type'] == 'boolean': + assert isinstance(value, bool) + + if self.id > 0 and name not in self._values: + self._read(name) + previous = getattr(self, name) + self._values[name] = value + if previous != getattr(self, name): + self._changed.add(name) + self._on_change(name) + if self._parent: + self._parent._changed.add(self._parent_field_name) + self._parent._on_change(self._parent_field_name) + return set_method + +class MetaModelFactory(object): + def __init__(self, model_name, config=None): + super(MetaModelFactory, self).__init__() + self.model_name = model_name + self.config = config or proteus.config.get_config() + + def __call__(self): + models_key = 'c%s' % id(self.config) + if not hasattr(_MODELS, models_key): + setattr(_MODELS, models_key, {}) + class MetaModel(type): + 'Meta class for Model' + def __new__(mcs, name, bases, dict): + if self.model_name in getattr(_MODELS, models_key): + return getattr(_MODELS, models_key)[self.model_name] + proxy = self.config.get_proxy(self.model_name) + context = self.config.context + name = self.model_name + dict['_proxy'] = proxy + dict['_config'] = self.config + dict['_fields'] = proxy.fields_get(None, context) + for field_name, definition in dict['_fields'].iteritems(): + if field_name == 'id': + continue + dict[field_name] = property(_getmethod(field_name, + definition), _setmethod(field_name, definition)) + for method in self.config.get_proxy_methods(self.model_name): + setattr(mcs, method, getattr(proxy, method)) + res = type.__new__(mcs, name, bases, dict) + getattr(_MODELS, models_key)[self.model_name] = res + return res + __new__.__doc__ = type.__new__.__doc__ + return MetaModel + + +class ModelList(list): + 'List for Model' + + def __init__(self, sequence=None, parent=None, parent_field_name=None): + if sequence is None: + sequence = [] + self.parent = parent + self.parent_field_name = parent_field_name + if parent: + assert parent_field_name + self.record_removed = set() + self.record_deleted = set() + return super(ModelList, self).__init__(sequence) + __init__.__doc__ = list.__init__.__doc__ + + def _changed(self): + 'Signal change to parent' + if self.parent: + self.parent._changed.add(self.parent_field_name) + self.parent._on_change(self.parent_field_name) + + def append(self, record): + assert isinstance(record, Model) + if self.parent: + assert record._config == self.parent._config + elif self: + assert record._config == self[0]._config + assert record._parent is None + assert record._parent_field_name is None + record._parent = self.parent + record._parent_field_name = self.parent_field_name + res = super(ModelList, self).append(record) + self._changed() + return res + append.__doc__ = list.append.__doc__ + + def extend(self, iterable): + iterable = list(iterable) + config = None + for record in iterable: + assert isinstance(record, Model) + if self.parent: + assert record._config == self.parent._config + elif self: + assert record._config == self[0]._config + elif config: + assert record._config == config + else: + config = record._config + for record in iterable: + assert record._parent is None + assert record._parent_field_name is None + record._parent = self.parent + record._parent_field_name = self.parent_field_name + res = super(ModelList, self).extend(iterable) + self._changed() + return res + extend.__doc__ = list.extend.__doc__ + + def insert(self, index, record): + raise NotImplementedError + insert.__doc__ = list.insert.__doc__ + + def pop(self, index=-1): + self.record_removed.add(self[index]) + self[index]._parent = None + self[index]._parent_field_name = None + res = super(ModelList, self).pop(index) + self._changed() + return res + pop.__doc__ = list.pop.__doc__ + + def remove(self, record): + self.record_deleted.add(record) + record._parent = None + record._parent_field_name = None + res = super(ModelList, self).remove(record) + self._changed() + return res + remove.__doc__ = list.remove.__doc__ + + def reverse(self): + raise NotImplementedError + reverse.__doc__ = list.reverse.__doc__ + + def sort(self): + raise NotImplementedError + sort.__doc__ = list.sort.__doc__ + + +class Model(object): + 'Model class for Tryton records' + + __counter = -1 + _proxy = None + _config = None + _fields = None + + def __init__(self, id=None, **kwargs): + super(Model, self).__init__() + self.__id = id or Model.__counter + if self.__id < 0: + Model.__counter -= 1 + self._values = {} # store the values of fields + self._changed = set() # store the changed fields + self._parent = None # store the parent record + self._parent_field_name = None # store the field name in parent record + if self.id < 0: + self._default_get() + + for field_name, value in kwargs.iteritems(): + definition = self._fields[field_name] + if definition['type'] in ('one2many', 'many2many'): + getattr(self, field_name).extend(value) + else: + setattr(self, field_name, value) + __init__.__doc__ = object.__init__.__doc__ + + @classmethod + def get(cls, name, config=None): + 'Get a class for the named Model' + class Spam(Model): + __metaclass__ = MetaModelFactory(name, config=config)() + return Spam + + def __str__(self): + return '<%s(%d)>' % (self.__class__.__name__, self.id) + __str__.__doc__ = object.__str__.__doc__ + + def __repr__(self): + if self._config == proteus.config.get_config(): + return "proteus.Model.get('%s')(%d)" % (self.__class__.__name__, + self.id) + return "proteus.Model.get('%s', %s)(%d)" % (self.__class__.__name__, + repr(self._config), self.id) + __repr__.__doc__ = object.__repr__.__doc__ + + def __cmp__(self, other): + 'Compare with other' + if isinstance(other, Model): + return cmp(self.id, other.id) + if isinstance(other, (bool, NoneType)): + return 1 + raise NotImplementedError + + @property + def id(self): + 'The unique ID' + return self.__id + + @classmethod + def find(cls, condition=None): + 'Return records matching condition' + if condition is None: + condition = [] + ids = cls._proxy.search(condition, 0, None, None, + cls._config.context) + return [cls(id) for id in ids] + + def reload(self): + 'Reload record' + self._values = {} + self._changed = set() + + def save(self): + 'Save the record' + context = self._config.context + if self.id < 0: + values = self._get_values() + self.__id = self._proxy.create(values, context) + else: + if not self._changed: + return + values = self._get_values(fields=self._changed) + context['_timestamp'] = self._get_timestamp() + self._proxy.write(self.id, values, context) + self.reload() + + def delete(self): + 'Delete the record' + if self.id > 0: + context = self._config.context + context['_timestamp'] = self._get_timestamp() + return self._proxy.delete(self.id, context) + self.reload() + return True + + def _get_values(self, fields=None): + 'Return dictionary values' + if fields is None: + fields = self._values.keys() + values = {} + for field_name in fields: + if field_name == '_timestamp': + continue + definition = self._fields[field_name] + if definition['type'] == 'many2one': + if getattr(self, field_name): + values[field_name] = getattr(self, field_name).id + else: + values[field_name] = False + elif definition['type'] in ('one2many', 'many2many'): + values[field_name] = [('add', [])] + for record in getattr(self, field_name): + if record.id > 0: + if record._changed: + values[field_name].append(('write', record.id, + record._get_values())) + else: + values[field_name][0][1].append(record.id) + else: + values[field_name].append(('create', + record._get_values())) + if getattr(self, field_name).record_removed: + values[field_name].append(('unlink', [x.id for x + in getattr(self, field_name).record_removed])) + if getattr(self, field_name).record_deleted: + values[field_name].append(('delete', [x.id for x + in getattr(self, field_name).record_deleted])) + elif definition['type'] == 'reference' \ + and isinstance(getattr(self, field_name), Model): + record = getattr(self, field_name) + values[field_name] = '%s,%s' % (record.__class__.__name__, + record.id) + else: + values[field_name] = getattr(self, field_name) + return values + + @property + def _timestamp(self): + 'Get _timestamp' + return self._values.get('_timestamp') + + def _get_timestamp(self): + 'Return dictionary with timestamps' + result = {'%s,%s' % (self.__class__.__name__, self.id): + self._timestamp} + for field, definition in self._fields.iteritems(): + if field not in self._values: + continue + if definition['type'] in ('one2many', 'many2many'): + for record in getattr(self, field): + result.update(record._get_timestamp()) + return result + + def _read(self, name): + 'Read field' + fields = [] + if not self._values: + fields = [x for x, y in self._fields.iteritems() + if y['type'] not in ('one2many', 'many2many', 'binary')] + fields.append('_timestamp') + fields.append(name) + self._values.update(self._proxy.read(self.id, fields, + self._config.context)) + + def _default_get(self): + 'Set default values' + fields = self._fields.keys() + self._default_set(self._proxy.default_get(fields, self._config.context, + False)) + + def _default_set(self, values): + for field, value in values.iteritems(): + definition = self._fields[field] + if definition['type'] in ('one2many', 'many2many'): + if value and len(value) and isinstance(value[0], (int, long)): + self._values[field] = value + continue + relation = Model.get(definition['relation'], self._config) + records = [] + for vals in (value or []): + record = relation() + record._default_set(vals) + record._parent = self + record._parent_field_name = field + records.append(record) + self._values[field] = ModelList(records, self, field) + else: + self._values[field] = value + + def _get_eval(self): + values = {} + for field, definition in self._fields.iteritems(): + if definition['type'] in ('one2many', 'many2many'): + values[field] = [x.id for x in getattr(self, field) or []] + else: + values[field] = getattr(self, field) + values['id'] = self.id + return values + + def _on_change_args(self, args): + res = {} + values = {} + for field, definition in self._fields.iteritems(): + if definition['type'] in ('one2many', 'many2many'): + values[field] = [x._get_eval() for x in getattr(self, field)] + elif definition['type'] == 'many2one': + if getattr(self, field): + values[field] = getattr(self, field).id + else: + values[field] = False + elif definition['type'] == 'reference': + if isinstance(getattr(self, field), Model): + record = getattr(self, field) + values[field] = '%s,%s' % (record.__class__.__name__, + record.id) + else: + values[field] = getattr(self, field) or False + else: + values[field] = getattr(self, field) + if self._parent: + values['_parent_%s' % self._parent_field_name] = \ + _EvalEnvironment(self._parent) + for arg in args: + scope = values + for i in arg.split('.'): + if i not in scope: + scope = False + break + scope = scope[i] + res[arg] = scope + return res + + def _set_on_change(self, field, value): + if self._fields[field]['type'] in ('one2many', 'many2many'): + if isinstance(value, (list, tuple)): + self._values[field] = value + self._changed.add(field) + return + to_remove = [] + if value and value.get('remove'): + for record_id in value['remove']: + for record in getattr(self, field): + if record.id == record_id: + to_remove.append(record) + for record in to_remove: + # remove without signal + list.remove(getattr(self, field), record) + if value and value.get('add') or value.get('update'): + for vals in value.get('add', []): + relation = Model.get(self._fields[field]['relation'], + self._config) + # append without signal + list.append(getattr(self, field), relation(*vals)) + for vals in value.get('update', []): + if 'id' not in vals: + continue + for record in getattr(self, field): + if record.id == vals['id']: + for i, j in vals.iteritems: + record._values[i] = j + record._changed.add(i) + else: + self._values[field] = value + self._changed.add(field) + + def _on_change(self, name): + 'Call on_change for field' + definition = self._fields[name] + if definition.get('on_change'): + if isinstance(definition['on_change'], basestring): + definition['on_change'] = PYSONDecoder().decode( + definition['on_change']) + args = self._on_change_args(definition['on_change']) + context = self._config.context + res = getattr(self._proxy, 'on_change_%s' % name)(args, context) + later = {} + for field, value in res.iteritems(): + if field not in self._fields: + continue + if self._fields[field]['type'] in ('one2many', 'many2many'): + later[field] = value + continue + self._set_on_change(field, value) + for field, value in later.iteritems(): + self._set_on_change(field, value) + if self._parent: + self._parent._changed.add(self._parent_field_name) + if definition.get('change_default'): + context = self._config.context + default = Model.get('ir.default', config=self._config) + self._default_set(default.get_default(self.__class__.__name__, + '%s=%s' % (name, self._get_values([name])[name]), context)) + for field, definition in self._fields.iteritems(): + if not definition.get('on_change_with'): + continue + if name not in definition['on_change_with']: + continue + if field == name: + continue + args = self._on_change_args(definition['on_change_with']) + context = self._config.context + res = getattr(self._proxy, 'on_change_with_%s' % field)(args, + context) + self._set_on_change(field, res) diff --git a/proteus/config.py b/proteus/config.py new file mode 100644 index 0000000000..5b5a31b12b --- /dev/null +++ b/proteus/config.py @@ -0,0 +1,194 @@ +#This file is part of Tryton. The COPYRIGHT file at the top level of +#this repository contains the full copyright notices and license terms. +""" +Configuration functions for the proteus package for Tryton. +""" +import xmlrpclib +import threading +from decimal import Decimal +from types import NoneType +import datetime + +xmlrpclib.Marshaller.dispatch[Decimal] = \ + lambda self, value, write: self.dump_double(float(value), write) +xmlrpclib.Marshaller.dispatch[datetime.date] = \ + lambda self, value, write: self.dump_datetime( + datetime.datetime.combine(value, datetime.time()), write) + +_CONFIG = threading.local() + + +class Config(object): + 'Config interface' + + def __init__(self): + super(Config, self).__init__() + self._context = {} + + @property + def context(self): + return self._context.copy() + + def get_proxy(self, name): + raise NotImplementedError + + def get_proxy_methods(self, name): + raise NotImplementedError + +class _TrytondMethod(object): + + def __init__(self, name, model, config): + super(_TrytondMethod, self).__init__() + self._name = name + self._model = model + self._config = config + + def __call__(self, *args): + from trytond.tools import Cache + + assert self._name in self._model._rpc + + Cache.clean(self._config.database.database_name) + cursor = self._config.database.cursor() + try: + res = getattr(self._model, self._name)(cursor, self._config.user, + *args) + if self._model._rpc[self._name]: + cursor.commit() + return res + finally: + cursor.close() + Cache.resets(self._config.database.database_name) + +class TrytondProxy(object): + 'Proxy for function call for trytond' + + def __init__(self, name, config): + super(TrytondProxy, self).__init__() + self._config = config + self._model = config.pool.get(name) + __init__.__doc__ = object.__init__.__doc__ + + def __getattr__(self, name): + 'Return attribute value' + return _TrytondMethod(name, self._model, self._config) + + +class TrytondConfig(Config): + 'Configuration for trytond' + + def __init__(self, database_name, user, database_type, language='en_US', + password=''): + super(TrytondConfig, self).__init__() + from trytond.config import CONFIG + CONFIG['db_type'] = database_type + CONFIG.parse() + from trytond.modules import register_classes + from trytond.pool import Pool + from trytond.backend import Database + from trytond.protocols.dispatcher import create + from trytond.tools import Cache + self.database_name = database_name + self._user = user + self.database_type = database_type + + register_classes() + + database = Database().connect() + cursor = database.cursor() + try: + databases = database.list(cursor) + finally: + cursor.close() + if database_name not in databases: + create(database_name, CONFIG['admin_passwd'], language, password) + + self.database = Database(database_name).connect() + database_list = Pool.database_list() + self.pool = Pool(database_name) + if database_name not in database_list: + self.pool.init() + + Cache.clean(database_name) + user_obj = self.pool.get('res.user') + cursor = self.database.cursor() + try: + self.user = user_obj.search(cursor, 0, [ + ('login', '=', user), + ], context=self.context, limit=1)[0] + self._context = user_obj.get_preferences(cursor, self.user, + context_only=True, context=self.context) + finally: + cursor.close() + Cache.resets(database_name) + __init__.__doc__ = object.__init__.__doc__ + + def __repr__(self): + return "proteus.config.TrytondConfig('%s', '%s', '%s')" % ( + self.database_name, self._user, self.database_type) + __repr__.__doc__ = object.__repr__.__doc__ + + def get_proxy(self, name): + 'Return Proxy class' + return TrytondProxy(name, self) + + def get_proxy_methods(self, name): + 'Return list of methods' + proxy = self.get_proxy(name) + return [x for x in proxy._model._rpc] + +def set_trytond(database_name, user='admin', database_type='postgresql', + language='en_US', password=''): + 'Set trytond package as backend' + _CONFIG.current = TrytondConfig(database_name, user, database_type, + language=language, password=password) + return _CONFIG.current + + +class XmlrpcProxy(object): + 'Proxy for function call for XML-RPC' + + def __init__(self, name, config): + super(XmlrpcProxy, self).__init__() + self._config = config + self._model = getattr(config.server, 'model.%s' % name) + __init__.__doc__ = object.__init__.__doc__ + + def __getattr__(self, name): + 'Return attribute value' + return getattr(self._model, name) + +class XmlrpcConfig(Config): + 'Configuration for XML-RPC' + + def __init__(self, url): + super(XmlrpcConfig, self).__init__() + self.url = url + self.server = xmlrpclib.ServerProxy(url, allow_none=1, use_datetime=1) + # TODO add user + self._context = self.server.model.res.user.get_preferences(True, {}) + __init__.__doc__ = object.__init__.__doc__ + + def __repr__(self): + return "proteus.config.XmlrpcConfig('%s')" % self.url + __repr__.__doc__ = object.__repr__.__doc__ + + def get_proxy(self, name): + 'Return Proxy class' + return XmlrpcProxy(name, self) + + def get_proxy_methods(self, name): + 'Return list of methods' + return [x[len('model.%s' % name) + 1:] + for x in self.server.system.listMethods() + if x.startswith('model.%s' % name) + and '.' not in x[len('model.%s' % name) + 1:]] + +def set_xmlrpc(url): + 'Set XML-RPC as backend' + _CONFIG.current = XmlrpcConfig(url) + return _CONFIG.current + +def get_config(): + # TODO raise exception if not set + return _CONFIG.current diff --git a/proteus/pyson.py b/proteus/pyson.py new file mode 100644 index 0000000000..b3d375bb30 --- /dev/null +++ b/proteus/pyson.py @@ -0,0 +1,492 @@ +#This file is part of Tryton. The COPYRIGHT file at the top level of +#this repository contains the full copyright notices and license terms. +import sys +if sys.version_info < (2, 6): + import simplejson as json +else: + import json +import datetime + + +class PYSON(object): + + def pyson(self): + raise NotImplementedError + + def types(self): + raise NotImplementedError + + @staticmethod + def eval(dct, context): + raise NotImplementedError + + +class PYSONEncoder(json.JSONEncoder): + + def default(self, obj): + if isinstance(obj, PYSON): + return obj.pyson() + elif isinstance(obj, datetime.date): + if isinstance(obj, datetime.datetime): + return DateTime(obj.year, obj.month, obj.day, + obj.hour, obj.minute, obj.second, obj.microsecond + ).pyson() + else: + return Date(obj.year, obj.month, obj.day).pyson() + return super(PYSONEncoder, self).default(obj) + + +class PYSONDecoder(json.JSONDecoder): + + def __init__(self, context=None): + self.__context = context or {} + super(PYSONDecoder, self).__init__(object_hook=self._object_hook) + + def _object_hook(self, dct): + if '__class__' in dct: + klass = globals().get(dct['__class__']) + if klass and hasattr(klass, 'eval'): + return klass.eval(dct, self.__context) + return dct + + +class Eval(PYSON): + + def __init__(self, value, default=''): + super(Eval, self).__init__() + self._value = value + self._default = default + + def pyson(self): + return { + '__class__': 'Eval', + 'v': self._value, + 'd': self._default, + } + + def types(self): + if isinstance(self._default, PYSON): + return self._default.types() + else: + return set([type(self._default)]) + + @staticmethod + def eval(dct, context): + return context.get(dct['v'], dct['d']) + + +class Not(PYSON): + + def __init__(self, value): + super(Not, self).__init__() + if isinstance(value, PYSON): + assert value.types() == set([bool]), 'value must be boolean' + else: + assert isinstance(value, bool), 'value must be boolean' + self._value = value + + def pyson(self): + return { + '__class__': 'Not', + 'v': self._value, + } + + def types(self): + return set([bool]) + + @staticmethod + def eval(dct, context): + return not dct['v'] + + +class Bool(PYSON): + + def __init__(self, value): + super(Bool, self).__init__() + self._value = value + + def pyson(self): + return { + '__class__': 'Bool', + 'v': self._value, + } + + def types(self): + return set([bool]) + + @staticmethod + def eval(dct, context): + return bool(dct['v']) + + +class And(PYSON): + + def __init__(self, *statements): + super(And, self).__init__() + for statement in statements: + if isinstance(statement, PYSON): + assert statement.types() == set([bool]), \ + 'statement must be boolean' + else: + assert isinstance(statement, bool), \ + 'statement must be boolean' + assert len(statements) >= 2, 'must have at least 2 statements' + self._statements = statements + + def pyson(self): + return { + '__class__': 'And', + 's': self._statements, + } + + def types(self): + return set([bool]) + + @staticmethod + def eval(dct, context): + return bool(reduce(lambda x, y: x and y, dct['s'])) + + +class Or(And): + + def pyson(self): + res = super(Or, self).pyson() + res['__class__'] = 'Or' + return res + + @staticmethod + def eval(dct, context): + return bool(reduce(lambda x, y: x or y, dct['s'])) + + +class Equal(PYSON): + + def __init__(self, statement1, statement2): + super(Equal, self).__init__() + if isinstance(statement1, PYSON): + types1 = statement1.types() + else: + types1 = set([type(statement1)]) + if isinstance(statement2, PYSON): + types2 = statement2.types() + else: + types2 = set([type(statement2)]) + assert types1 == types2, 'statements must have the same type' + self._statement1 = statement1 + self._statement2 = statement2 + + def pyson(self): + return { + '__class__': 'Equal', + 's1': self._statement1, + 's2': self._statement2, + } + + def types(self): + return set([bool]) + + @staticmethod + def eval(dct, context): + return dct['s1'] == dct['s2'] + + +class Greater(PYSON): + + def __init__(self, statement1, statement2, equal=False): + super(Greater, self).__init__() + for i in (statement1, statement2): + if isinstance(i, PYSON): + assert i.types().issubset(set([int, long, float])), \ + 'statement must be an integer or a float' + else: + assert isinstance(i, (int, long, float)), \ + 'statement must be an integer or a float' + if isinstance(equal, PYSON): + assert equal.types() == set([bool]) + else: + assert isinstance(equal, bool) + self._statement1 = statement1 + self._statement2 = statement2 + self._equal = equal + + def pyson(self): + return { + '__class__': 'Greater', + 's1': self._statement1, + 's2': self._statement2, + 'e': self._equal, + } + + def types(self): + return set([bool]) + + @staticmethod + def eval(dct, context): + if dct['e']: + return dct['s1'] >= dct['s2'] + else: + return dct['s1'] > dct['s2'] + + +class Less(Greater): + + def pyson(self): + res = super(Less, self).pyson() + res['__class__'] = 'Less' + return res + + @staticmethod + def eval(dct, context): + if dct['e']: + return dct['s1'] <= dct['s2'] + else: + return dct['s1'] < dct['s2'] + + +class If(PYSON): + + def __init__(self, condition, then_statement, else_statement=None): + super(If, self).__init__() + if isinstance(condition, PYSON): + assert condition.types() == set([bool]), 'condition must be boolean' + else: + assert isinstance(condition, bool), 'condition must be boolean' + if isinstance(then_statement, PYSON): + then_types = then_statement.types() + else: + then_types = set([type(then_statement)]) + if isinstance(else_statement, PYSON): + assert then_types == else_statement.types(), \ + 'then and else statements must be the same type' + else: + assert then_types == set([type(else_statement)]), \ + 'then and else statements must be the same type' + self._condition = condition + self._then_statement = then_statement + self._else_statement = else_statement + + def pyson(self): + return { + '__class__': 'If', + 'c': self._condition, + 't': self._then_statement, + 'e': self._else_statement, + } + + def types(self): + if isinstance(self._then_statement, PYSON): + return self._then_statement.types() + else: + return set([type(self._then_statement)]) + + @staticmethod + def eval(dct, context): + if dct['c']: + return dct['t'] + else: + return dct['e'] + + +class Get(PYSON): + + def __init__(self, obj, key, default=''): + super(Get, self).__init__() + if isinstance(obj, PYSON): + assert obj.types() == set([dict]), 'obj must be a dict' + else: + assert isinstance(obj, dict), 'obj must be a dict' + self._obj = obj + if isinstance(key, PYSON): + assert key.types() == set([str]), 'key must be a string' + else: + assert type(key) == str, 'key must be a string' + self._key = key + self._default = default + + def pyson(self): + return { + '__class__': 'Get', + 'v': self._obj, + 'k': self._key, + 'd': self._default, + } + + def types(self): + if isinstance(self._default, PYSON): + return self._default.types() + else: + return set([type(self._default)]) + + @staticmethod + def eval(dct, context): + return dct['v'].get(dct['k'], dct['d']) + + +class In(PYSON): + + def __init__(self, key, obj): + super(In, self).__init__() + if isinstance(key, PYSON): + assert key.types().issubset(set([str, int, long])), \ + 'key must be a string or an integer or a long' + else: + assert type(key) in [str, int, long], \ + 'key must be a string or an integer or a long' + if isinstance(obj, PYSON): + assert obj.types().issubset(set([dict, list])), \ + 'obj must be a dict or a list' + if obj.types() == set([dict]): + assert type(key) == str, 'key must be a string' + else: + assert type(obj) in [dict, list] + if type(obj) == dict: + assert type(key) == str, 'key must be a string' + self._key = key + self._obj = obj + + def pyson(self): + return { + '__class__': 'In', + 'k': self._key, + 'v': self._obj, + } + + def types(self): + return set([bool]) + + @staticmethod + def eval(dct, context): + return dct['k'] in dct['v'] + + +class Date(PYSON): + + def __init__(self, year=None, month=None, day=None, + delta_years=0, delta_months=0, delta_days=0): + super(Date, self).__init__() + for i in (year, month, day, delta_years, delta_months, delta_days): + if isinstance(i, PYSON): + assert i.types().issubset(set([int, long, type(None)])), \ + '%s must be an integer or None' % (i,) + else: + assert isinstance(i, (int, long, type(None))), \ + '%s must be an integer or None' % (i,) + self._year = year + self._month = month + self._day = day + self._delta_years = delta_years + self._delta_months = delta_months + self._delta_days = delta_days + + def pyson(self): + return { + '__class__': 'Date', + 'y': self._year, + 'M': self._month, + 'd': self._day, + 'dy': self._delta_years, + 'dM': self._delta_months, + 'dd': self._delta_days, + } + + def types(self): + return set([datetime.date]) + + @staticmethod + def eval(dct, context): + date = datetime.date.today() + replace = {} + for i, j in (('y', 'year'), ('M', 'month'), ('d', 'day')): + if dct[i] is not None: + replace[j] = dct[i] + date = date.replace(**replace) + if dct['dy']: + year = date.year + dct['dy'] + date = date.replace(year=year) + if dct['dM']: + month = date.month + dct['dM'] + year = date.year + month / 12 + month = month % 12 + date = date.replace(year=year, month=month) + if dct['dd']: + date += datetime.timedelta(days=dct['dd']) + return date + + +class DateTime(Date): + + def __init__(self, year=None, month=None, day=None, + hour=None, minute=None, second=None, microsecond=None, + delta_years=0, delta_months=0, delta_days=0, + delta_hours=0, delta_minutes=0, delta_seconds=0, + delta_microseconds=0): + super(DateTime, self).__init__(year=year, month=month, day=day, + delta_years=delta_years, delta_months=delta_months, + delta_days=delta_days) + for i in (hour, minute, second, microsecond, + delta_hours, delta_minutes, delta_seconds, delta_microseconds): + if isinstance(i, PYSON): + assert i.types() == set([int, long, type(None)]), \ + '%s must be an integer or None' % (i,) + else: + assert isinstance(i, (int, long, type(None))), \ + '%s must be an integer or None' % (i,) + self._hour = hour + self._minute = minute + self._second = second + self._microsecond = microsecond + self._delta_hours = delta_hours + self._delta_minutes = delta_minutes + self._delta_seconds = delta_seconds + self._delta_microseconds = delta_microseconds + + def pyson(self): + res = super(DateTime, self).pyson() + res['__class__'] = 'DateTime' + res['h'] = self._hour + res['m'] = self._minute + res['s'] = self._second + res['ms'] = self._microsecond + res['dh'] = self._delta_hours + res['dm'] = self._delta_minutes + res['ds'] = self._delta_seconds + res['dms'] = self._delta_microseconds + return res + + def types(self): + return set([datetime.datetime]) + + @staticmethod + def eval(dct, context): + date = Date.eval(dct, context) + datetime_ = datetime.datetime.combine(date, + datetime.datetime.now().time()) + replace = {} + for i, j in (('h', 'hour'), ('m', 'minute'), ('s', 'second'), + ('ms', 'microsecond')): + if dct[i] is not None: + replace[j] = dct[i] + datetime_ = datetime_.replace(**replace) + delta = {} + for i, j in (('dh', 'hours'), ('dm', 'minutes'), ('ds', 'seconds'), + ('dms', 'microseconds')): + if dct[i]: + delta[j] = dct[i] + datetime_ += datetime.timedelta(**delta) + return datetime_ + +CONTEXT = { + 'Eval': Eval, + 'Not': Not, + 'Bool': Bool, + 'And': And, + 'Or': Or, + 'Equal': Equal, + 'Greater': Greater, + 'Less': Less, + 'If': If, + 'Get': Get, + 'In': In, + 'Date': Date, + 'DateTime': DateTime, +} diff --git a/proteus/tests/__init__.py b/proteus/tests/__init__.py new file mode 100644 index 0000000000..fe882b978e --- /dev/null +++ b/proteus/tests/__init__.py @@ -0,0 +1,26 @@ +#This file is part of Tryton. The COPYRIGHT file at the top level of +#this repository contains the full copyright notices and license terms. +import os +import sys +import unittest + +def test_suite(): + suite = unittest.TestSuite() + loader = unittest.TestLoader() + for filename in os.listdir(os.path.dirname(__file__)): + if filename.startswith("test") and filename.endswith(".py"): + modname = "proteus.tests." + filename[:-3] + __import__(modname) + module = sys.modules[modname] + suite.addTests(loader.loadTestsFromModule(module)) + return suite + +def main(): + suite = test_suite() + runner = unittest.TextTestRunner() + runner.run(suite) + +if __name__ == '__main__': + sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.dirname( + os.path.abspath(__file__))))) + main() diff --git a/proteus/tests/test_config.py b/proteus/tests/test_config.py new file mode 100644 index 0000000000..403696b861 --- /dev/null +++ b/proteus/tests/test_config.py @@ -0,0 +1,21 @@ +#This file is part of Tryton. The COPYRIGHT file at the top level of +#this repository contains the full copyright notices and license terms. +from unittest import TestCase +import proteus.config + + +class TestConfig(TestCase): + + def setUp(self): + proteus.config.set_trytond(':memory:', database_type='sqlite') + + def test_proxy(self): + config = proteus.config.get_config() + user_proxy = config.get_proxy('res.user') + user_id = user_proxy.search([('login', '=', 'admin')], 0, 1, None, + config.context)[0] + self.assert_(user_id == config.user) + + def test_proxy_methods(self): + config = proteus.config.get_config() + self.assert_('search' in config.get_proxy_methods('res.user')) diff --git a/proteus/tests/test_model.py b/proteus/tests/test_model.py new file mode 100644 index 0000000000..033a7dddb7 --- /dev/null +++ b/proteus/tests/test_model.py @@ -0,0 +1,259 @@ +#This file is part of Tryton. The COPYRIGHT file at the top level of +#this repository contains the full copyright notices and license terms. +from unittest import TestCase +from proteus import config, Model + + +class TestModel(TestCase): + + def setUp(self): + config.set_trytond(':memory:', database_type='sqlite') + + def test_class_cache(self): + User1 = Model.get('res.user') + User2 = Model.get('res.user') + self.assertEqual(id(User1), id(User2)) + + def test_class_method(self): + User = Model.get('res.user') + self.assert_(len(User.search([('login', '=', 'admin')]))) + + def test_find(self): + User = Model.get('res.user') + admin = User.find([('login', '=', 'admin')])[0] + self.assertEqual(admin.login, 'admin') + + def test_many2one(self): + User = Model.get('res.user') + admin = User.find([('login', '=', 'admin')])[0] + self.assert_(isinstance(admin.create_uid, User)) + try: + admin.create_uid = 'test' + self.fail() + except AssertionError: + pass + admin.create_uid = admin + admin.create_uid = None + + def test_one2many(self): + Group = Model.get('res.group') + administration = Group.find([('name', '=', 'Administration')])[0] + self.assert_(isinstance(administration.model_access, list)) + self.assert_(isinstance(administration.model_access[0], + Model.get('ir.model.access'))) + try: + administration.model_access = [] + self.fail() + except AssertionError: + pass + + def test_many2many(self): + User = Model.get('res.user') + admin = User.find([('login', '=', 'admin')])[0] + self.assert_(isinstance(admin.groups, list)) + self.assert_(isinstance(admin.groups[0], + Model.get('res.group'))) + try: + admin.groups = [] + self.fail() + except AssertionError: + pass + + # TODO test date + + def test_reference(self): + Attachment = Model.get('ir.attachment') + User = Model.get('res.user') + admin = User.find([('login', '=', 'admin')])[0] + attachment = Attachment() + attachment.name = 'Test' + attachment.resource = admin + attachment.save() + self.assertEqual(attachment.resource, admin) + + def test_id_counter(self): + User = Model.get('res.user') + test1 = User() + self.assert_(test1.id < 0) + test2 = User() + self.assert_(test2.id < 0) + self.assertNotEqual(test1.id, test2.id) + + def test_save(self): + User = Model.get('res.user') + test = User() + test.name = 'Test' + test.login = 'test' + test.save() + self.assert_(test.id > 0) + + test = User(test.id) + self.assertEqual(test.name, 'Test') + self.assertEqual(test.login, 'test') + self.assert_(test.active) + + test.signature = 'Test signature' + self.assertEqual(test.signature, 'Test signature') + test.save() + self.assertEqual(test.signature, 'Test signature') + test = User(test.id) + self.assertEqual(test.signature, 'Test signature') + + Group = Model.get('res.group') + test2 = User(name='Test 2', login='test2', + groups=[Group(name='Test 2')]) + test2.save() + self.assert_(test2.id > 0) + self.assertEqual(test2.name, 'Test 2') + self.assertEqual(test2.login, 'test2') + + def test_save_many2one(self): + User = Model.get('res.user') + test = User() + test.name = 'Test save many2one' + test.login = 'test_save_many2one' + test.save() + + Lang = Model.get('ir.lang') + en_US = Lang.find([('code', '=', 'en_US')])[0] + test.language = en_US + test.save() + self.assertEqual(test.language, en_US) + + test.language = None + test.save() + self.assertFalse(test.language) + + def test_save_one2many(self): + Group = Model.get('res.group') + group = Group() + group.name = 'Test save one2many' + group.save() + + ModelAccess = Model.get('ir.model.access') + Model_ = Model.get('ir.model') + model_access = ModelAccess() + model_access.model = Model_.find([('model', '=', 'res.group')])[0] + model_access.perm_read = True + model_access.perm_write = True + model_access.perm_create = True + model_access.perm_delete = True + + group.model_access.append(model_access) + group.save() + self.assertEqual(len(group.model_access), 1) + + model_access_id = group.model_access[0].id + + group.name = 'Test save one2many bis' + group.model_access[0].description = 'Test save one2many' + group.save() + self.assertEqual(group.model_access[0].description, + 'Test save one2many') + + group.model_access.pop() + group.save() + self.assertEqual(group.model_access, []) + self.assertEqual(len(ModelAccess.find([('id', '=', model_access_id)])), + 1) + + group.model_access.append(ModelAccess(model_access_id)) + group.save() + self.assertEqual(len(group.model_access), 1) + + group.model_access.remove(group.model_access[0]) + group.save() + self.assertEqual(group.model_access, []) + self.assertEqual(len(ModelAccess.find([('id', '=', model_access_id)])), + 0) + + def test_save_many2many(self): + User = Model.get('res.user') + test = User() + test.name = 'Test save many2many' + test.login = 'test_save_many2many' + test.save() + + Group = Model.get('res.group') + group = Group() + group.name = 'Test save many2many' + group.save() + + test.groups.append(group) + test.save() + self.assertEqual(len(test.groups), 1) + + group_id = test.groups[0].id + + test.name = 'Test save many2many bis' + test.groups[0].name = 'Test save many2many bis' + test.save() + self.assertEqual(test.groups[0].name, + 'Test save many2many bis') + + test.groups.pop() + test.save() + self.assertEqual(test.groups, []) + self.assertEqual(len(Group.find([('id', '=', group_id)])), 1) + + test.groups.append(Group(group_id)) + test.save() + self.assertEqual(len(test.groups), 1) + + test.groups.remove(test.groups[0]) + test.save() + self.assertEqual(test.groups, []) + self.assertEqual(len(Group.find([('id', '=', group_id)])), 0) + + def test_cmp(self): + User = Model.get('res.user') + test = User() + test.name = 'Test cmp' + test.login = 'test_cmp' + test.save() + admin1 = User.find([('login', '=', 'admin')])[0] + admin2 = User.find([('login', '=', 'admin')])[0] + + self.assertEqual(admin1, admin2) + self.assertNotEqual(admin1, test) + self.assertNotEqual(admin1, None) + self.assertNotEqual(admin1, False) + + self.failUnlessRaises(NotImplementedError, lambda: admin1 == 1) + + def test_default_set(self): + User = Model.get('res.user') + Group = Model.get('res.group') + group_ids = [x.id for x in Group.find()] + test = User() + test._default_set({ + 'name': 'Test', + 'groups': group_ids, + }) + self.assertEqual(test.name, 'Test') + self.assertEqual([x.id for x in test.groups], group_ids) + + test = User() + test._default_set({ + 'name': 'Test', + 'groups': [ + { + 'name': 'Group 1', + }, + { + 'name': 'Group 2', + }, + ], + }) + self.assertEqual(test.name, 'Test') + self.assertEqual([x.name for x in test.groups], ['Group 1', 'Group 2']) + + def test_delete(self): + User = Model.get('res.user') + test = User() + test.name = 'Test delete' + test.login = 'test delete' + test.save() + self.assert_(test.delete()) + + # TODO test on_change diff --git a/setup.py b/setup.py new file mode 100644 index 0000000000..6392718407 --- /dev/null +++ b/setup.py @@ -0,0 +1,43 @@ +#!/usr/bin/env python +#This file is part of Tryton. The COPYRIGHT file at the top level of +#this repository contains the full copyright notices and license terms. +from setuptools import setup, find_packages +import sys +import proteus + +major_version, minor_version, _ = proteus.__version__.split('.', 2) +major_version = int(major_version) +minor_version = int(minor_version) + +SIMPLEJSON = [] +if sys.version_info < (2, 6): + SIMPLEJSON = ['simplejson'] + +setup(name='proteus', + version=proteus.__version__, + description='Library to access Tryton server as a client', + author='B2CK', + author_email='info@b2ck.com', + url='http://www.tryton.org/', + download_url="http://downloads.tryton.org/" + \ + proteus.__version__.rsplit('.', 1)[0] + '/', + packages=find_packages(), + classifiers=[ + 'Development Status :: 5 - Production/Stable', + 'Environment :: Plugins', + 'Intended Audience :: Developers', + 'Intended Audience :: Financial and Insurance Industry', + 'Intended Audience :: Legal Industry', + 'License :: OSI Approved :: GNU General Public License (GPL)', + 'Operating System :: OS Independent', + 'Programming Language :: Python', + 'Topic :: Office/Business', + ], + license='GPL-3', + install_requires=SIMPLEJSON, + extras_require={ + 'trytond': ['trytond >= %s.%s, < %s.%s' % + (major_version, minor_version, major_version, minor_version + 1)], + }, + test_suite='proteus.tests', +)