commit 30c55cc2aae17c958de96c86b2f5811295cf521e Author: Cédric Krier Date: Sun Sep 11 15:16:08 2022 +0200 Add account_consolidation module issue10346 review346041008 diff --git a/.drone.yml b/.drone.yml new file mode 100644 index 0000000000..b45ef267ef --- /dev/null +++ b/.drone.yml @@ -0,0 +1,78 @@ +clone: + hg: + image: plugins/hg + environment: + - HG_SHARE_POOL=/root/.cache/hg + volumes: + - cache:/root/.cache + +pipeline: + tox: + image: ${IMAGE} + environment: + - CFLAGS=-O0 + - DB_CACHE=/cache + - TOX_TESTENV_PASSENV=CFLAGS DB_CACHE CI_BUILD_NUMBER CI_JOB_NUMBER CI_JOB_ID + - POSTGRESQL_URI=postgresql://postgres@postgresql:5432/ + commands: + - echo "[extensions]" >> /root/.hgrc + - echo "hgext.share =" >> /root/.hgrc + - echo "[share]" >> /root/.hgrc + - echo "pool = /root/.cache/hg" >> /root/.hgrc + - pip install tox + - tox -e "${TOXENV}-${DATABASE}" + volumes: + - cache:/root/.cache + check_dist: + image: ${IMAGE} + commands: + - pip install twine + - python setup.py sdist + - twine check dist/* + volumes: + - cache:/root/.cache + check_doc: + image: ${IMAGE} + commands: + - pip install sphinx + - python -m sphinx -T -E -W -n -b html doc _build/html + - python -m sphinx -T -E -W -n -b linkcheck doc _build + volumes: + - cache:/root/.cache + +services: + postgresql: + image: postgres + environment: + - POSTGRES_HOST_AUTH_METHOD=trust + command: "-c fsync=off -c synchronous_commit=off -c full_page_writes=off" + when: + matrix: + DATABASE: postgresql + +matrix: + include: + - IMAGE: python:3.7 + TOXENV: py37 + DATABASE: sqlite + - IMAGE: python:3.7 + TOXENV: py37 + DATABASE: postgresql + - IMAGE: python:3.8 + TOXENV: py38 + DATABASE: sqlite + - IMAGE: python:3.8 + TOXENV: py38 + DATABASE: postgresql + - IMAGE: python:3.9 + TOXENV: py39 + DATABASE: sqlite + - IMAGE: python:3.9 + TOXENV: py39 + DATABASE: postgresql + - IMAGE: python:3.10 + TOXENV: py310 + DATABASE: sqlite + - IMAGE: python:3.10 + TOXENV: py310 + DATABASE: postgresql diff --git a/.flake8 b/.flake8 new file mode 100644 index 0000000000..fa6b4f66d1 --- /dev/null +++ b/.flake8 @@ -0,0 +1,2 @@ +[flake8] +ignore=E123,E124,E126,E128,E741,W503 diff --git a/.isort.cfg b/.isort.cfg new file mode 100644 index 0000000000..e1c6495da9 --- /dev/null +++ b/.isort.cfg @@ -0,0 +1,3 @@ +[settings] +multi_line_output=4 +known_first_party=trytond diff --git a/COPYRIGHT b/COPYRIGHT new file mode 100644 index 0000000000..146bf20d4c --- /dev/null +++ b/COPYRIGHT @@ -0,0 +1,16 @@ +Copyright (C) 2021 NaN-tic +Copyright (C) 2022 B2CK +Copyright (C) 2022 Cédric Krier + +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/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..005b0af076 --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,5 @@ +include CHANGELOG +include COPYRIGHT +include LICENSE +include README.rst +graft doc diff --git a/README.rst b/README.rst new file mode 100644 index 0000000000..176d9c2695 --- /dev/null +++ b/README.rst @@ -0,0 +1 @@ +doc/index.rst \ No newline at end of file diff --git a/__init__.py b/__init__.py new file mode 100644 index 0000000000..232e31cbe3 --- /dev/null +++ b/__init__.py @@ -0,0 +1,24 @@ +# 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 trytond.pool import Pool + +from . import account + + +def register(): + Pool.register( + account.Type, + account.Move, + account.MoveLine, + account.Consolidation, + account.ConsolidationBalanceSheetContext, + account.ConsolidationIncomeStatementContext, + module='account_consolidation', type_='model') + Pool.register( + account.ConsolidationStatement, + module='account_consolidation', type_='report') + Pool.register( + account.Invoice, + module='account_consolidation', type_='model', + depends=['account_invoice']) diff --git a/account.py b/account.py new file mode 100644 index 0000000000..9a624a81d0 --- /dev/null +++ b/account.py @@ -0,0 +1,459 @@ +from collections import defaultdict +from decimal import Decimal +from functools import wraps +from itertools import groupby, zip_longest +from operator import attrgetter + +from dateutil.relativedelta import relativedelta +from sql.conditionals import Coalesce + +from trytond.i18n import gettext +from trytond.model import ModelSQL, ModelView, fields, sequence_ordered, tree +from trytond.modules.currency.fields import Monetary +from trytond.pool import Pool, PoolMeta +from trytond.pyson import Bool, Eval, If +from trytond.report import Report +from trytond.transaction import Transaction + +from .exceptions import InvoiceConsolidationCompanyError + + +def with_currency_date(func): + @wraps(func) + def wrapper(*args, **kwargs): + pool = Pool() + Date = pool.get('ir.date') + today = Date.today() + transaction = Transaction() + context = transaction.context + with transaction.set_context( + date=context.get('date', context.get('to_date', today))): + return func(*args, **kwargs) + return wrapper + + +class Type(metaclass=PoolMeta): + __name__ = 'account.account.type' + consolidation = fields.Many2One( + 'account.consolidation', "Consolidation", select=True, + domain=[ + ('statement', '=', Eval('statement')), + If(Eval('statement') == 'balance', + ('assets', '=', Eval('assets', False)), + ()), + ]) + + +class Move(metaclass=PoolMeta): + __name__ = 'account.move' + + consolidation_company = fields.Many2One( + 'company.company', "Consolidation Company", + domain=[ + ('id', '!=', Eval('company', -1)), + ]) + + @classmethod + def __setup__(cls): + super().__setup__() + cls._check_modify_exclude.append('consolidation_company') + + +class MoveLine(metaclass=PoolMeta): + __name__ = 'account.move.line' + + consolidation_company = fields.Function(fields.Many2One( + 'company.company', "Consolidation Company"), + 'get_move_field', + setter='set_move_field', + searcher='search_move_field') + + @classmethod + def __setup__(cls): + super().__setup__() + cls._check_modify_exclude.add('consolidation_company') + + @classmethod + def query_get(cls, table): + pool = Pool() + Move = pool.get('account.move') + move = Move.__table__() + context = Transaction().context + query, fiscalyear_id = super().query_get(table) + if context.get('consolidated') and context.get('companies'): + query &= table.move.in_(move.select(move.id, where=~Coalesce( + move.consolidation_company, -1).in_(context['companies']))) + return query, fiscalyear_id + + +class Invoice(metaclass=PoolMeta): + __name__ = 'account.invoice' + + consolidation_company = fields.Many2One( + 'company.company', "Consolidation Company", + domain=[ + ('party', '=', Eval('party')), + ], + states={ + 'readonly': Eval('state') != 'draft', + }) + + @fields.depends('party', 'consolidation_company') + def on_change_party(self): + pool = Pool() + Company = pool.get('company.company') + super().on_change_party() + if self.party: + companies = Company.search([ + ('party', '=', self.party.id), + ]) + if len(companies) == 1: + self.consolidation_company, = companies + + @classmethod + def set_number(cls, invoices): + pool = Pool() + Company = pool.get('company.company') + + super().set_number(invoices) + + companies = Company.search([], order=[('party', None)]) + party2company = { + party: list(companies) + for party, companies in groupby(companies, attrgetter('party'))} + for invoice in invoices: + if not invoice.consolidation_company: + companies = party2company.get(invoice.party, []) + if len(companies) == 1: + invoice.consolidation_company, = companies + elif companies: + raise InvoiceConsolidationCompanyError( + gettext('account_consolidation.' + 'msg_invoice_consolidation_company_ambiguous', + invoice=invoice.rec_name, + party=invoice.party.rec_name)) + cls.save(invoices) + + def get_move(self): + previous_move = self.move + move = super().get_move() + if move != previous_move: + move.consolidation_company = self.consolidation_company + return move + + +class Consolidation( + sequence_ordered(), tree(separator='\\'), ModelSQL, ModelView): + "Account Consolidation" + __name__ = 'account.consolidation' + + parent = fields.Many2One( + 'account.consolidation', "Parent", ondelete="RESTRICT", + domain=['OR', + If(Eval('statement') == 'off-balance', + ('statement', '=', 'off-balance'), + If(Eval('statement') == 'balance', + ('statement', '=', 'balance'), + ('statement', '!=', 'off-balance')), + ), + ('statement', '=', None), + ]) + name = fields.Char("Name", required=True) + statement = fields.Selection([ + (None, ""), + ('balance', "Balance"), + ('income', "Income"), + ('off-balance', "Off-Balance"), + ], "Statement", + states={ + 'required': Bool(Eval('parent')), + }) + assets = fields.Boolean( + "Assets", + states={ + 'invisible': Eval('statement') != 'balance', + }) + types = fields.One2Many( + 'account.account.type', 'consolidation', "Types", + domain=[ + ('statement', '=', Eval('statement')), + If(Eval('statement') == 'balance', + ('assets', '=', Eval('assets', False)), + ()), + ], + add_remove=[ + ('consolidation', '=', None), + ]) + children = fields.One2Many('account.consolidation', 'parent', "Children") + amount = fields.Function(Monetary( + "Amount", currency='currency', digits='currency'), + 'get_amount') + currency = fields.Function(fields.Many2One( + 'currency.currency', 'Currency'), 'get_currency') + amount_cmp = fields.Function(Monetary( + "Amount", currency='currency', digits='currency'), + 'get_amount_cmp') + + @classmethod + def default_assets(cls): + return False + + @fields.depends('parent', '_parent_parent.statement') + def on_change_parent(self): + if self.parent: + self.statement = self.parent.statement + + def get_currency(self, name): + return Transaction().context.get('currency') + + @classmethod + @with_currency_date + def get_amount(cls, consolidations, name): + pool = Pool() + AccountType = pool.get('account.account.type') + Currency = pool.get('currency.currency') + User = pool.get('res.user') + transaction = Transaction() + context = transaction.context + user = User(transaction.user) + + result = defaultdict(Decimal) + children = cls.search([ + ('parent', 'child_of', [c.id for c in consolidations]), + ]) + + types = sum((c.types for c in children), ()) + key = attrgetter('company') + companies = set(context.get('companies', [])).intersection( + map(int, user.companies)) + id2types = {} + for company, types in groupby(sorted(types, key=key), key): + if company.id not in companies: + company = None + else: + company = company.id + with transaction.set_context(company=company, consolidated=True): + types = AccountType.browse(types) + id2types.update((t.id, t) for t in types) + + consolidation_sum = defaultdict(Decimal) + for consolidation in children: + currency = consolidation.currency + if not currency: + continue + for type_ in consolidation.types: + type_ = id2types[type_.id] + if type_.company.id not in companies: + continue + value = type_.amount + if type_.statement == 'balance' and type_.assets: + value *= -1 + if type_.company.currency != currency: + value = Currency.compute( + type_.company.currency, value, currency, round=False) + consolidation_sum[consolidation.id] += value + for consolidation in consolidations: + children = cls.search([ + ('parent', 'child_of', [consolidation.id]), + ]) + for child in children: + result[consolidation.id] += consolidation_sum[child.id] + if consolidation.currency: + result[consolidation.id] = consolidation.currency.round( + result[consolidation.id]) + if consolidation.statement == 'balance' and consolidation.assets: + result[consolidation.id] *= -1 + return result + + @classmethod + def get_amount_cmp(cls, consolidations, name): + transaction = Transaction() + current = transaction.context + if not current.get('comparison'): + return dict.fromkeys([c.id for c in consolidations], None) + new = {} + for key, value in current.items(): + if key.endswith('_cmp'): + new[key[:-4]] = value + with transaction.set_context(new): + return cls.get_amount(consolidations, name) + + @classmethod + def view_attributes(cls): + return super().view_attributes() + [ + ('/tree/field[@name="amount_cmp"]', 'tree_invisible', + ~Eval('comparison', False)), + ] + + @classmethod + def copy(cls, consolidations, default=None): + if default is None: + default = {} + else: + default = default.copy() + default.setdefault('types', None) + return super().copy(consolidations, default=default) + + +class ConsolidationBalanceSheetContext(ModelView): + "Consolidation Balance Sheet Context" + __name__ = 'account.consolidation.balance_sheet.context' + date = fields.Date("Date", required=True) + posted = fields.Boolean("Posted Move", help="Only include posted moves.") + companies = fields.Many2Many('company.company', None, None, "Companies") + currency = fields.Many2One('currency.currency', "Currency", required=True) + + comparison = fields.Boolean("Comparison") + date_cmp = fields.Date( + "Date", + states={ + 'required': Eval('comparison', False), + 'invisible': ~Eval('comparison', False), + }) + + @classmethod + def default_date(cls): + Date = Pool().get('ir.date') + return Transaction().context.get('date', Date.today()) + + @classmethod + def default_posted(cls): + return Transaction().context.get('posted', False) + + @classmethod + def default_currency(cls): + pool = Pool() + Company = pool.get('company.company') + company_id = Transaction().context.get('company') + if company_id: + return Company(company_id).currency.id + + @classmethod + def default_companies(cls): + context = Transaction().context + return context.get( + 'companies', + [context['company']] if context.get('company') else None) + + @classmethod + def default_comparison(cls): + return False + + @fields.depends('comparison', 'date', 'date_cmp') + def on_change_comparison(self): + self.date_cmp = None + if self.comparison and self.date: + self.date_cmp = self.date - relativedelta(years=1) + + @classmethod + def view_attributes(cls): + return super().view_attributes() + [ + ('/form/separator[@id="comparison"]', 'states', { + 'invisible': ~Eval('comparison', False), + }), + ] + + +class ConsolidationIncomeStatementContext(ModelView): + "Consolidation Income Statement Context" + __name__ = 'account.consolidation.income_statement.context' + from_date = fields.Date( + "From Date", + domain=[ + If(Eval('to_date') & Eval('from_date'), + ('from_date', '<=', Eval('to_date')), + ()), + ]) + to_date = fields.Date( + "To Date", + domain=[ + If(Eval('from_date') & Eval('to_date'), + ('to_date', '>=', Eval('from_date')), + ()), + ]) + companies = fields.Many2Many('company.company', None, None, "Companies") + currency = fields.Many2One('currency.currency', "Currency", required=True) + posted = fields.Boolean('Posted Move', help="Only include posted moves.") + comparison = fields.Boolean('Comparison') + from_date_cmp = fields.Date( + "From Date", + domain=[ + If(Eval('to_date_cmp') & Eval('from_date_cmp'), + ('from_date_cmp', '<=', Eval('to_date_cmp')), + ()), + ], + states={ + 'invisible': ~Eval('comparison', False), + }) + to_date_cmp = fields.Date( + "To Date", + domain=[ + If(Eval('from_date_cmp') & Eval('to_date_cmp'), + ('to_date_cmp', '>=', Eval('from_date_cmp')), + ()), + ], + states={ + 'invisible': ~Eval('comparison', False), + }) + + @classmethod + def default_posted(cls): + return False + + @classmethod + def default_comparison(cls): + return False + + @classmethod + def default_currency(cls): + pool = Pool() + Company = pool.get('company.company') + company_id = Transaction().context.get('company') + if company_id: + return Company(company_id).currency.id + + @classmethod + def default_companies(cls): + context = Transaction().context + return context.get( + 'companies', + [context['company']] if context.get('company') else None) + + @classmethod + def view_attributes(cls): + return super().view_attributes() + [ + ('/form/separator[@id="comparison"]', 'states', { + 'invisible': ~Eval('comparison', False), + }), + ] + + +class ConsolidationStatement(Report): + __name__ = 'account.consolidation.statement' + + @classmethod + def get_context(cls, records, header, data): + pool = Pool() + Company = pool.get('company.company') + User = pool.get('res.user') + transaction = Transaction() + context = transaction.context + user = User(transaction.user) + + report_context = super().get_context(records, header, data) + + companies = set(context.get('companies', [])).intersection( + map(int, user.companies)) + report_context['companies'] = Company.browse(companies) + + if data.get('model_context') is not None: + Context = pool.get(data['model_context']) + values = {} + for field in Context._fields: + if field in context: + values[field] = context[field] + report_context['ctx'] = Context(**values) + + report_context['consolidations'] = zip_longest( + records, data.get('paths') or [], fillvalue=[]) + return report_context diff --git a/account.xml b/account.xml new file mode 100644 index 0000000000..b72a939c60 --- /dev/null +++ b/account.xml @@ -0,0 +1,219 @@ + + + + + + account.account.type + + account_type_form + + + + account.account.type + + account_type_list + + + + account.move + + move_form + + + + account.move + + move_list + + + + account.move.line + + move_line_form + + + + account.move.line + + move_line_list + + + + account.consolidation + form + consolidation_form + + + + account.consolidation + tree + + children + consolidation_tree + + + + account.consolidation + tree + + consolidation_list + + + + Account Consolidations + account.consolidation + + + + + + + + + + + + + + + + Account Consolidations + account.consolidation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + account.consolidation + tree + children + consolidation_balance_sheet_tree + + + + Consolidated Balance Sheet + account.consolidation + account.consolidation.balance_sheet.context + + + + + + + + + + + + + account.consolidation.balance_sheet.context + form + consolidation_balance_sheet_context_form + + + + account.consolidation + tree + children + consolidation_income_statement_tree + + + + Consolidated Income Statement + account.consolidation + account.consolidation.income_statement.context + + + + + + + + + + + + account.consolidation.income_statement.context + form + consolidation_income_statement_context_form + + + + Statement + listed + account.consolidation + account.consolidation.statement + account_consolidation/consolidation_statement.fodt + + + form_print + account.consolidation,-1 + + + + + + + + + + account.invoice + + invoice_form + + + diff --git a/consolidation_statement.fodt b/consolidation_statement.fodt new file mode 100644 index 0000000000..c2611986db --- /dev/null +++ b/consolidation_statement.fodt @@ -0,0 +1,596 @@ + + + + LibreOffice/7.2.6.2$Linux_X86_64 LibreOffice_project/20$Build-22008-06-07T15:26:412008-08-27T17:03:361PT0S + + + 4445 + 0 + 48129 + 21989 + true + false + + + view2 + 17152 + 20350 + 0 + 4445 + 48128 + 26432 + 0 + 0 + false + 100 + false + false + false + + + + + false + false + false + true + true + true + true + true + false + 0 + false + false + false + false + false + true + false + false + false + false + false + true + true + true + false + false + false + false + false + false + false + true + false + false + true + false + false + false + true + 0 + 1 + true + false + + high-resolution + false + + + false + false + true + false + true + true + false + true + + true + 4093925 + + true + false + true + 0 + + false + false + false + false + false + true + false + false + false + false + true + false + false + + false + false + true + false + false + false + false + false + false + false + false + false + 2070049 + false + false + false + false + false + false + true + true + false + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Companies: <', '.join(c.rec_name for c in companies)> + + + Statement + + + Print Date: <format_date(datetime.date.today(), user.language)>at <datetime.datetime.now().strftime('%H:%M:%S')> + + + + + + + + + + + User: <user.rec_name> + + + 2/2 + + + + + + + + + + + + + + + + + <choose> + <when test="data.get('model_context') == 'account.consolidation.income_statement.context'"> + Income Statement + <if test="ctx.from_date or ctx.to_date"> + From Date: <format_date(ctx.from_date, user.language) if ctx.from_date else ''>To <format_date(ctx.to_date, user.language) if ctx.to_date else ''> + </if> + </when> + <when test="data.get('model_context') == 'account.consolidation.balance_sheet.context'"> + Balance Sheet + Date: <format_date(ctx.date, user.language) if ctx.date else ''> + </when> + <otherwise> + Statement + </otherwise> + </choose> + + + + + + <for each="consolidation, path in consolidations"> + + + + + + + + <choose> + <when test="len(path) <= 1"> + <consolidation.name> + </when> + <when test="len(path) == 2"> + <for each="_ in range(len(path) -1)"></for><consolidation.name> + </when> + <otherwise> + <for each="_ in range(len(path) -1)"></for><consolidation.name> + </otherwise> + </choose> + + + <format_currency(consolidation.amount, user.language, consolidation.currency) if consolidation.currency else ''> + + + + + </for> + + + + + + + + + + \ No newline at end of file diff --git a/doc/conf.py b/doc/conf.py new file mode 100644 index 0000000000..8513b72dd2 --- /dev/null +++ b/doc/conf.py @@ -0,0 +1,61 @@ +# This file is part of Tryton. The COPYRIGHT file at the top level of +# this repository contains the full copyright notices and license terms. + +modules_url = 'https://docs.tryton.org/projects/modules-{module}/en/{series}/' +trytond_url = 'https://docs.tryton.org/projects/server/en/{series}/' + + +def get_info(): + import configparser + import os + import subprocess + import sys + + module_dir = os.path.dirname(os.path.dirname(__file__)) + + config = configparser.ConfigParser() + config.read_file(open(os.path.join(module_dir, 'tryton.cfg'))) + info = dict(config.items('tryton')) + + result = subprocess.run( + [sys.executable, 'setup.py', '--name'], + stdout=subprocess.PIPE, check=True, cwd=module_dir) + info['name'] = result.stdout.decode('utf-8').strip() + + result = subprocess.run( + [sys.executable, 'setup.py', '--version'], + stdout=subprocess.PIPE, check=True, cwd=module_dir) + version = result.stdout.decode('utf-8').strip() + if 'dev' in version: + info['series'] = 'latest' + else: + info['series'] = '.'.join(version.split('.', 2)[:2]) + + for key in {'depends', 'extras_depend'}: + info[key] = info.get(key, '').strip().splitlines() + info['modules'] = set(info['depends'] + info['extras_depend']) + info['modules'] -= {'ir', 'res'} + + return info + + +info = get_info() + +master_doc = 'index' +project = info['name'] +release = version = info['series'] +default_role = 'ref' +highlight_language = 'none' +extensions = [ + 'sphinx.ext.intersphinx', + ] +intersphinx_mapping = { + 'trytond': (trytond_url.format(series=version), None), + } +intersphinx_mapping.update({ + m: (modules_url.format( + module=m.replace('_', '-'), series=version), None) + for m in info['modules'] + }) + +del get_info, info, modules_url, trytond_url diff --git a/doc/design.rst b/doc/design.rst new file mode 100644 index 0000000000..ff70fddd55 --- /dev/null +++ b/doc/design.rst @@ -0,0 +1,40 @@ +****** +Design +****** + +The *Account Consolidation Module* introduces the following concepts: + +.. _model-account.consolidation: + +Account Consolidation +===================== + +The *Account Consolidation* concept defines the structure of the accounting +reports for multiple `Companies `. +It groups `Account types ` of different +companies on a consolidated balance sheet or income statement. + +When used as the consolidated balance sheet or income statement the amount +shown includes the amounts of all the account types of the record for all the +selected companies. + +.. seealso:: + + The list of account consolidation can be found by opening the main menu item: + + |Financial --> Configuration --> General Account --> Account Consolidations|__ + + .. |Financial --> Configuration --> General Account --> Account Consolidations| replace:: :menuselection:`Financial --> Configuration --> General Account --> Account Consolidations` + __ https://demo.tryton.org/model/account.consolidation + + +Reports +------- + +.. _report-account.consolidation.statement: + +Statement +^^^^^^^^^ + +The *Statement* report is used to get a printed copy of the open parts of the +consolidated balance sheet and income statements. diff --git a/doc/index.rst b/doc/index.rst new file mode 100644 index 0000000000..ef4f3d26f1 --- /dev/null +++ b/doc/index.rst @@ -0,0 +1,12 @@ +############################ +Account Consolidation Module +############################ + +The *Account Consolidation Module* allows consolidate accounting report of +multiple companies. + +.. toctree:: + :maxdepth: 2 + + usage + design diff --git a/doc/usage.rst b/doc/usage.rst new file mode 100644 index 0000000000..36e5e01a3e --- /dev/null +++ b/doc/usage.rst @@ -0,0 +1,32 @@ +***** +Usage +***** + +Consolidated reports are found under the :menuselection:`Financial --> +Reporting` menu item. + +.. _Using the consolidated balance sheet: + +Using the consolidated balance sheet +==================================== + +The [:menuselection:`Financial --> Reporting --> Consolidated Balance Sheet`] +shows the consolidated `Companies' ` assets and +liabilities for the chosen date and `Currency +`. + +You can use the :guilabel:`Comparison` checkbox to do a comparison between two +different dates. + +.. _Using the consolidated income statement: + +Using the consolidated income statement +======================================= + +The [:menuselection:`Financial --> Reporting --> Consolidated Income Statemet`] +shows the consolidated `Companies' ` revenue and +expenses for the chosen period of time and `Currency +`. + +You can use the :guilabel:`Comparison` checkbox to do a comparison between two +different periods of time. diff --git a/exceptions.py b/exceptions.py new file mode 100644 index 0000000000..ebf23f8acc --- /dev/null +++ b/exceptions.py @@ -0,0 +1,8 @@ +# 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 trytond.model.exceptions import ValidationError + + +class InvoiceConsolidationCompanyError(ValidationError): + pass diff --git a/message.xml b/message.xml new file mode 100644 index 0000000000..dc19bb5698 --- /dev/null +++ b/message.xml @@ -0,0 +1,10 @@ + + + + + + To book the invoice "%(invoice)s" a consolidation you must define consolidation company for it. + + + diff --git a/setup.py b/setup.py new file mode 100644 index 0000000000..3f4fd9c042 --- /dev/null +++ b/setup.py @@ -0,0 +1,156 @@ +#!/usr/bin/env python3 +# 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 io +import os +import re +from configparser import ConfigParser + +from setuptools import find_packages, setup + + +def read(fname): + content = io.open( + os.path.join(os.path.dirname(__file__), fname), + 'r', encoding='utf-8').read() + content = re.sub( + r'(?m)^\.\. toctree::\r?\n((^$|^\s.*$)\r?\n)*', '', content) + return content + + +def get_require_version(name): + if minor_version % 2: + require = '%s >= %s.%s.dev0, < %s.%s' + else: + require = '%s >= %s.%s, < %s.%s' + require %= (name, major_version, minor_version, + major_version, minor_version + 1) + return require + + +config = ConfigParser() +config.read_file(open(os.path.join(os.path.dirname(__file__), 'tryton.cfg'))) +info = dict(config.items('tryton')) +for key in ('depends', 'extras_depend', 'xml'): + if key in info: + info[key] = info[key].strip().splitlines() +version = info.get('version', '0.0.1') +major_version, minor_version, _ = version.split('.', 2) +major_version = int(major_version) +minor_version = int(minor_version) +name = 'trytond_account_consolidation' + +download_url = 'http://downloads.tryton.org/%s.%s/' % ( + major_version, minor_version) +if minor_version % 2: + version = '%s.%s.dev0' % (major_version, minor_version) + download_url = ( + 'hg+http://hg.tryton.org/modules/%s#egg=%s-%s' % ( + name[8:], name, version)) +local_version = [] +if os.environ.get('CI_JOB_ID'): + local_version.append(os.environ['CI_JOB_ID']) +else: + for build in ['CI_BUILD_NUMBER', 'CI_JOB_NUMBER']: + if os.environ.get(build): + local_version.append(os.environ[build]) + else: + local_version = [] + break +if local_version: + version += '+' + '.'.join(local_version) + +requires = [] +for dep in info.get('depends', []): + if not re.match(r'(ir|res)(\W|$)', dep): + requires.append(get_require_version('trytond_%s' % dep)) +requires.append(get_require_version('trytond')) + +tests_require = [get_require_version('trytond_account_invoice')] +dependency_links = [] +if minor_version % 2: + dependency_links.append( + 'https://trydevpi.tryton.org/?local_version=' + + '.'.join(local_version) + ) + +setup(name=name, + version=version, + description="Tryton module consolidate accounting of many companies", + long_description=read('README.rst'), + author='Tryton', + author_email='bugs@tryton.org', + url='http://www.tryton.org/', + download_url=download_url, + project_urls={ + "Bug Tracker": 'https://bugs.tryton.org/', + "Documentation": ( + 'https://docs.tryton.org/projects/modules-account-consolidation'), + "Forum": 'https://www.tryton.org/forum', + "Source Code": 'https://hg.tryton.org/modules/account_consolidation', + }, + keywords='tryton account consolidation', + package_dir={'trytond.modules.account_consolidation': '.'}, + packages=( + ['trytond.modules.account_consolidation'] + + ['trytond.modules.account_consolidation.%s' % p + for p in find_packages()] + ), + package_data={ + 'trytond.modules.account_consolidation': (info.get('xml', []) + + ['tryton.cfg', 'view/*.xml', 'locale/*.po', '*.fodt', + 'icons/*.svg', 'tests/*.rst']), + }, + classifiers=[ + 'Development Status :: 5 - Production/Stable', + 'Environment :: Plugins', + 'Framework :: Tryton', + 'Intended Audience :: Developers', + 'Intended Audience :: Financial and Insurance Industry', + 'Intended Audience :: Legal Industry', + 'License :: OSI Approved :: ' + 'GNU General Public License v3 or later (GPLv3+)', + 'Natural Language :: Bulgarian', + 'Natural Language :: Catalan', + 'Natural Language :: Chinese (Simplified)', + 'Natural Language :: Czech', + 'Natural Language :: Dutch', + 'Natural Language :: English', + 'Natural Language :: Finnish', + 'Natural Language :: French', + 'Natural Language :: German', + 'Natural Language :: Hungarian', + 'Natural Language :: Indonesian', + 'Natural Language :: Italian', + 'Natural Language :: Persian', + 'Natural Language :: Polish', + 'Natural Language :: Portuguese (Brazilian)', + 'Natural Language :: Romanian', + 'Natural Language :: Russian', + 'Natural Language :: Slovenian', + 'Natural Language :: Spanish', + 'Natural Language :: Turkish', + 'Operating System :: OS Independent', + 'Programming Language :: Python :: 3', + 'Programming Language :: Python :: 3.7', + 'Programming Language :: Python :: 3.8', + 'Programming Language :: Python :: 3.9', + 'Programming Language :: Python :: 3.10', + 'Programming Language :: Python :: Implementation :: CPython', + 'Topic :: Office/Business', + 'Topic :: Office/Business :: Financial :: Accounting', + ], + license='GPL-3', + python_requires='>=3.7', + install_requires=requires, + extras_require={ + 'test': tests_require, + }, + dependency_links=dependency_links, + zip_safe=False, + entry_points=""" + [trytond.modules] + account_consolidation = trytond.modules.account_consolidation + """, # noqa: E501 + ) diff --git a/tests/__init__.py b/tests/__init__.py new file mode 100644 index 0000000000..4effdfa4a2 --- /dev/null +++ b/tests/__init__.py @@ -0,0 +1,2 @@ +# This file is part of Tryton. The COPYRIGHT file at the top level of +# this repository contains the full copyright notices and license terms. diff --git a/tests/scenario_consolidation.rst b/tests/scenario_consolidation.rst new file mode 100644 index 0000000000..ac94e2686e --- /dev/null +++ b/tests/scenario_consolidation.rst @@ -0,0 +1,204 @@ +============================== +Account Consolidation Scenario +============================== + +Imports:: + + >>> from decimal import Decimal + + >>> from proteus import Model, Report + + >>> from trytond.tests.tools import activate_modules, set_user + >>> from trytond.modules.account.tests.tools import ( + ... create_fiscalyear, create_chart, get_accounts) + >>> from trytond.modules.currency.tests.tools import get_currency + >>> from trytond.modules.company.tests.tools import create_company + +Activate modules:: + + >>> config = activate_modules(['account_consolidation']) + + >>> Company = Model.get('company.company') + >>> Consolidation = Model.get('account.consolidation') + >>> Journal = Model.get('account.journal') + >>> Move = Model.get('account.move') + >>> Party = Model.get('party.party') + >>> User = Model.get('res.user') + +Get journals:: + + >>> expense_journal, = Journal.find([('code', '=', 'EXP')]) + >>> revenue_journal, = Journal.find([('code', '=', 'REV')]) + +Create currencies:: + + >>> usd = get_currency('USD') + >>> eur = get_currency('EUR') + +Create parties:: + + >>> supplier = Party(name="Supplier") + >>> supplier.save() + >>> customer = Party(name="Customer") + >>> customer.save() + +Create companies:: + + >>> party = Party(name="Dunder Mifflin") + >>> party.save() + >>> _ = create_company(party, usd) + >>> dunder_mifflin, = Company.find([('party', '=', party.id)], limit=1) + + >>> party = Party(name="Saber") + >>> party.save() + >>> _ = create_company(party, eur) + >>> saber, = Company.find([('party', '=', party.id)], limit=1) + + >>> user = User(config.user) + >>> user.company_filter = 'all' + >>> user.companies.extend([dunder_mifflin, saber]) + >>> user.save() + >>> set_user(user.id) + + +Create fiscal year for Dunder Mifflin:: + + >>> fiscalyear = create_fiscalyear(dunder_mifflin) + >>> fiscalyear.click('create_period') + >>> period = fiscalyear.periods[0] + +Create chart of accounts for Dunder Mifflin:: + + >>> _ = create_chart(dunder_mifflin) + >>> accounts_dunder = get_accounts(dunder_mifflin) + +Create some moves for Dunder Mifflin:: + + >>> move = Move(company=dunder_mifflin) + >>> move.journal = revenue_journal + >>> move.period = period + >>> line = move.lines.new( + ... account=accounts_dunder['receivable'], + ... party=customer, + ... debit=Decimal('200.00')) + >>> line = move.lines.new( + ... account=accounts_dunder['revenue'], + ... credit=Decimal('200.00')) + >>> move.click('post') + + >>> move = Move(company=dunder_mifflin, consolidation_company=saber) + >>> move.journal = expense_journal + >>> move.period = period + >>> line = move.lines.new( + ... account=accounts_dunder['payable'], + ... party=saber.party, + ... credit=Decimal('100.00')) + >>> line = move.lines.new( + ... account=accounts_dunder['expense'], + ... debit=Decimal('100.00')) + >>> move.click('post') + +Create fiscal year for Saber:: + + >>> fiscalyear = create_fiscalyear(saber) + >>> fiscalyear.click('create_period') + >>> period = fiscalyear.periods[0] + +Create chart of accounts for Saber:: + + >>> _ = create_chart(saber) + >>> accounts_saber = get_accounts(saber) + +Create same moves for Saber:: + + >>> move = Move(company=saber, consolidation_company=dunder_mifflin) + >>> move.journal = revenue_journal + >>> move.period = period + >>> line = move.lines.new( + ... account=accounts_saber['receivable'], + ... party=dunder_mifflin.party, + ... debit=Decimal('50.00')) + >>> line = move.lines.new( + ... account=accounts_saber['revenue'], + ... credit=Decimal('50.00')) + >>> move.click('post') + + >>> move = Move(company=saber) + >>> move.journal = expense_journal + >>> move.period = period + >>> line = move.lines.new( + ... account=accounts_saber['payable'], + ... party=supplier, + ... credit=Decimal('40.00')) + >>> line = move.lines.new( + ... account=accounts_saber['expense'], + ... debit=Decimal('40.00')) + >>> move.click('post') + + Setup consolidation:: + + >>> balance_group = Consolidation(name="Balance") + >>> balance_group.statement = 'balance' + >>> receivable_group = balance_group.children.new( + ... name="Receivable", assets=True) + >>> receivable_group.types.append(accounts_dunder['receivable'].type) + >>> receivable_group.types.append(accounts_saber['receivable'].type) + >>> payable_group = balance_group.children.new( + ... name="Payable") + >>> payable_group.types.append(accounts_dunder['payable'].type) + >>> payable_group.types.append(accounts_saber['payable'].type) + >>> balance_group.save() + + >>> income_group = Consolidation(name="Income") + >>> income_group.statement = 'income' + >>> income_group.save() + + >>> revenue_group = Consolidation(name="Revenue") + >>> revenue_group.statement = 'income' + >>> revenue_group.parent = income_group + >>> revenue_group.types.append(accounts_dunder['revenue'].type) + >>> revenue_group.types.append(accounts_saber['revenue'].type) + >>> revenue_group.save() + + >>> expense_group = Consolidation(name="Expense") + >>> expense_group.statement = 'income' + >>> expense_group.parent = income_group + >>> expense_group.types.append(accounts_dunder['expense'].type) + >>> expense_group.types.append(accounts_saber['expense'].type) + >>> expense_group.save() + +Check consolidation amount only for Dunder Mifflin:: + + >>> with config.set_context( + ... companies=[dunder_mifflin.id], currency=usd.id): + ... Consolidation(balance_group.id).amount + Decimal('-100.00') + + >>> with config.set_context( + ... companies=[dunder_mifflin.id], currency=eur.id): + ... Consolidation(balance_group.id).amount + Decimal('-200.00') + + >>> with config.set_context( + ... companies=[dunder_mifflin.id], currency=usd.id): + ... Consolidation(income_group.id).amount + Decimal('100.00') + +Check consolidation amount only for Dunder Mifflin and Saber:: + + >>> with config.set_context( + ... companies=[dunder_mifflin.id, saber.id], currency=usd.id): + ... Consolidation(balance_group.id).amount + Decimal('-180.00') + + >>> with config.set_context( + ... companies=[dunder_mifflin.id, saber.id], currency=usd.id): + ... Consolidation(income_group.id).amount + Decimal('180.00') + +Test report:: + + >>> statement = Report('account.consolidation.statement') + >>> with config.set_context( + ... companies=[dunder_mifflin.id, saber.id], currency=usd.id): + ... _ = statement.execute(Consolidation.find([])) diff --git a/tests/scenario_invoice.rst b/tests/scenario_invoice.rst new file mode 100644 index 0000000000..213fa40547 --- /dev/null +++ b/tests/scenario_invoice.rst @@ -0,0 +1,67 @@ +================ +Invoice Scenario +================ + +Imports:: + + >>> from decimal import Decimal + + >>> from proteus import Model + + >>> from trytond.tests.tools import activate_modules + >>> from trytond.modules.account.tests.tools import ( + ... create_fiscalyear, create_chart, get_accounts) + >>> from trytond.modules.account_invoice.tests.tools import ( + ... set_fiscalyear_invoice_sequences) + >>> from trytond.modules.company.tests.tools import create_company + +Activate modules:: + + >>> config = activate_modules(['account_consolidation', 'account_invoice']) + + >>> Company = Model.get('company.company') + >>> Invoice = Model.get('account.invoice') + >>> Party = Model.get('party.party') + +Create companies:: + + >>> party = Party(name="Dunder Mifflin") + >>> party.save() + >>> _ = create_company(party) + >>> dunder_mifflin, = Company.find([('party', '=', party.id)], limit=1) + + >>> party = Party(name="Saber") + >>> party.save() + >>> _ = create_company(party) + >>> saber, = Company.find([('party', '=', party.id)], limit=1) + +Create fiscal year:: + + >>> fiscalyear = set_fiscalyear_invoice_sequences( + ... create_fiscalyear(dunder_mifflin)) + >>> fiscalyear.click('create_period') + >>> period_ids = [p.id for p in fiscalyear.periods] + +Create chart of accounts:: + + >>> _ = create_chart(dunder_mifflin) + >>> accounts = get_accounts(dunder_mifflin) + +Create invoice:: + + >>> invoice = Invoice() + >>> invoice.party = saber.party + >>> line = invoice.lines.new() + >>> line.account = accounts['revenue'] + >>> line.quantity = 5 + >>> line.unit_price = Decimal('10.0000') + >>> invoice.click('post') + >>> invoice.state + 'posted' + +Check consolidation company:: + + >>> invoice.consolidation_company == saber + True + >>> invoice.move.consolidation_company == saber + True diff --git a/tests/test_module.py b/tests/test_module.py new file mode 100644 index 0000000000..90955941ff --- /dev/null +++ b/tests/test_module.py @@ -0,0 +1,12 @@ +# 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 trytond.tests.test_tryton import ModuleTestCase + + +class AccountConsolidationTestCase(ModuleTestCase): + "Test Account Consolidation module" + module = 'account_consolidation' + extras = ['account_invoice'] + + +del ModuleTestCase diff --git a/tests/test_scenario.py b/tests/test_scenario.py new file mode 100644 index 0000000000..dc1d23e7e5 --- /dev/null +++ b/tests/test_scenario.py @@ -0,0 +1,8 @@ +# 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 trytond.tests.test_tryton import load_doc_tests + + +def load_tests(*args, **kwargs): + return load_doc_tests(__name__, __file__, *args, **kwargs) diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000000..4a3ebfb08b --- /dev/null +++ b/tox.ini @@ -0,0 +1,17 @@ +[tox] +envlist = {py37,py38,py39,py310}-{sqlite,postgresql} + +[testenv] +extras = test +commands = + coverage run --include=.*/account_consolidation/* -m unittest discover -s tests + coverage report --include=.*/account_consolidation/* --omit=*/tests/* +deps = + coverage + postgresql: psycopg2 >= 2.7.0 +setenv = + sqlite: TRYTOND_DATABASE_URI={env:SQLITE_URI:sqlite://} + postgresql: TRYTOND_DATABASE_URI={env:POSTGRESQL_URI:postgresql://} + sqlite: DB_NAME={env:SQLITE_NAME::memory:} + postgresql: DB_NAME={env:POSTGRESQL_NAME:test} +install_command = pip install --pre --find-links https://trydevpi.tryton.org/?local_version={env:CI_JOB_ID:{env:CI_BUILD_NUMBER:}.{env:CI_JOB_NUMBER:}} {opts} {packages} diff --git a/tryton.cfg b/tryton.cfg new file mode 100644 index 0000000000..e677251d4e --- /dev/null +++ b/tryton.cfg @@ -0,0 +1,11 @@ +[tryton] +version=6.5.0 +depends: + account + company + currency + ir +extras_depend: + account_invoice +xml: + account.xml diff --git a/view/account_type_form.xml b/view/account_type_form.xml new file mode 100644 index 0000000000..fb2ef49e8d --- /dev/null +++ b/view/account_type_form.xml @@ -0,0 +1,9 @@ + + + + + + diff --git a/view/account_type_list.xml b/view/account_type_list.xml new file mode 100644 index 0000000000..dec758b556 --- /dev/null +++ b/view/account_type_list.xml @@ -0,0 +1,8 @@ + + + + + + + diff --git a/view/consolidation_balance_sheet_context_form.xml b/view/consolidation_balance_sheet_context_form.xml new file mode 100644 index 0000000000..96e802ea4a --- /dev/null +++ b/view/consolidation_balance_sheet_context_form.xml @@ -0,0 +1,27 @@ + + +
+ + + + +
diff --git a/view/consolidation_balance_sheet_tree.xml b/view/consolidation_balance_sheet_tree.xml new file mode 100644 index 0000000000..cb9a798260 --- /dev/null +++ b/view/consolidation_balance_sheet_tree.xml @@ -0,0 +1,8 @@ + + + + + + + diff --git a/view/consolidation_form.xml b/view/consolidation_form.xml new file mode 100644 index 0000000000..f8ca1c677b --- /dev/null +++ b/view/consolidation_form.xml @@ -0,0 +1,21 @@ + + +
+