commit 615013dcb9f4c524d15cca251f6b057f9648b9e6 Author: Andreas Schulte Date: Fri Sep 29 15:43:16 2023 +0200 initial release diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..749ccda --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /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/README.md b/README.md new file mode 100644 index 0000000..d9bf54d --- /dev/null +++ b/README.md @@ -0,0 +1,59 @@ +# FSHTBKVS + +The FSHTBKVS (Filesystem Hash Table Based Key Value Store) was developed +to be an easy to deploy key value store with fast lookup times even for (very) +large data sets and without third party dependencies. + +## Usage + +### Basic +```python +from FSHTBKVS import FSHTBKVS + +# create/open a kvs +kvs = FSHTBKVS( + '/home/fshtbkvs/data', # path where the kvs will be created/is located + 'Test_KVS' # name of the kvs +) + +kvs.write('this could be a key', 'this could be a value') # adds/updates a value +kvs.read('this could be a key') # returns the value for a given key +kvs.delete('this could be a key') # deletes a value +``` + +### Advanced +```python +kvs.export_kvs(file='/tmp/kvs_export.fshtbkvs') # exports the whole kvs into a .fshtbkvs file +kvs.import_kvs(file='/tmp/kvs_export.fshtbkvs') # imports a .fshtbkvs file + +kvs.wipe_kvs() # deletes all entries +``` + +### Miscellaneous +```python +kvs.get_entries() # returns the number of entries +kvs.get_kvs_name() # returns the name of the kvs +kvs.get_max_depth() # returns the depth of the kvs +kvs.get_size_of_kvs() # returns the size of the kvs in megabytes (as float) + +kvs.maintain_kvs() # recreates missing/broken .json files and counts all entries +``` + +## Information +When creating a KVS, the optional parameter 'max_depth' can be used. +It specifies how many levels of the hash table will be created. +The default value is 4, which results in 65,536 .json files. This seems to be +a sweet spot for most (hobby) projects. If you expect a very large amount of data, +the value should rather be set higher to keep the access times low. Naturally, +the higher the selected value, the more difficult it is to handle the KVS +(with regard to the file system). + +| max_depth | # of .json files created | +|--------------|-------------------------:| +| 1 | 16 | +| 2 | 256 | +| 3 | 4,096 | +| **4** | **65,536** | +| 5 | 1,048,576 | +| 6 | 16,777,216 | +| 7 | 268,435,456 | diff --git a/fshtbkvs/FSHTBKVS.py b/fshtbkvs/FSHTBKVS.py new file mode 100644 index 0000000..96bf6c0 --- /dev/null +++ b/fshtbkvs/FSHTBKVS.py @@ -0,0 +1,519 @@ +import hashlib +import json +import os +from pathlib import Path + +class FSHTBKVS: + """ + Filesystem Hash Table Based Key Value Store (FSHTBKVS) + + The FSHTBKVS was developed to be an easy to deploy + key value store with fast lookup times for (very) + large data sets and without third party dependencies. + + max_depth and the amount of files created: + 1: 16^1 = 16 + 2: 16^2 = 256 + 3: 16^3 = 4.096 + 4: 16^4 = 65.536 + 5: 16^5 = 1.048.576 + 6: 16^6 = 16.777.216 + 7: 16^7 = 268.435.456 + """ + def __init__(self, root_dir, kvs_name, max_depth=4): + self.__root_dir = os.path.normpath(root_dir) + if not os.path.exists(root_dir): + raise ValueError("root_dir '" + root_dir + "' does not exist") + + self.__kvs_name = kvs_name + self.__root_dir = os.path.join(self.__root_dir, self.__kvs_name) + self.__meta_file = os.path.join(self.__root_dir, 'meta.json') + self.__max_depth = max_depth if max_depth in range(1, 7) else 4 + self.__entries = 0 + self.__all_file_paths = [] + self.__all_folder_paths = [] + + if not os.path.exists(self.__root_dir): + os.makedirs(self.__root_dir) + self.__create_meta_file() + self.__build_all_paths() + + if self.__load_meta_file() is False: + raise OSError( + "Not able to load or restore the meta file: " + + str(self.__meta_file) + ) + + def delete(self, key): + """ + Deletes an entry with the key 'key' from the kvs + """ + + self.__validate_key(key) + + key = self.__process_key(key) + file = self.__get_file_by_key(key) + + data = self.__load_dict_from_json_file(file) + + if not key in data: + return 1 + + del data[key] + data_written = self.__save_dict_to_json_file(file, data) + if not data_written: + return -1 + + self.__entries -= 1 + self.__create_meta_file() + + return 1 + + def export_kvs(self, file=''): + """ + Exports whole kvs data as importable .fshtbkvs file + """ + + if file == '': + file = os.path.join( + os.path.dirname(self.__root_dir), + self.__kvs_name + '.fshtbkvs' + ) + + # build all file paths + if self.__all_file_paths == []: + self.__build_all_file_paths() + + # write all key value pairs to export file + try: + with open(file, 'w') as f_export: + for f in self.__all_file_paths: + data = self.__load_dict_from_json_file(f) + for key, value in data.items(): + f_export.write( + json.dumps( + {key: value}, + ensure_ascii=False + ) + + '\n' + ) + f_export.close() + except: + raise OSError( + "Not able to write kvs export to file: " + + str(file) + ) + + return 1 + + def get_entries(self): + return self.__entries + + def get_kvs_name(self): + return self.__kvs_name + + def get_max_depth(self): + return self.__max_depth + + def get_size_of_kvs(self): + """ + Returns the size of all json files used for storing data in megabytes + """ + + kvs_size_in_megabytes = 0.0 + + if self.__all_file_paths == []: + self.__build_all_file_paths() + + for f in self.__all_file_paths: + if not os.path.exists(f): + self.maintain_kvs() + kvs_size_in_megabytes += ( + os.path.getsize(f) / 1000 / 1000 + ) + + return round(kvs_size_in_megabytes, 6) + + def import_kvs(self, file=''): + """ + Imports .fshtbkvs file into the kvs + """ + + if file == '': + raise ValueError("file must not be empty") + if not os.path.exists(file): + raise ValueError("file does not exist") + + # get all key value pairs line by line and add it to the kvs + with open(file, 'r') as f: + while True: + line = f.readline() + if not line: + break + if line.strip() == '': + continue + try: + for key, value in json.loads(line.strip()).items(): + self.write(key, value) + except: + continue + + return 1 + + def maintain_kvs(self): + """ + Rebuilds broken .json files and, creates missing files and folders + and creates an updated meta file + """ + + # build all paths + self.__build_all_paths() + + # cleanup all json files + self.__entries = 0 + for f in self.__all_file_paths: + data = self.__load_dict_from_json_file(f) + data_clean = {} + + for key, value in data.items(): + try: + self.__validate_key(key) + self.__validate_value(value) + data_clean[key] = value + except: + continue + + data_written = self.__save_dict_to_json_file(f, data_clean) + if not data_written: + return -1 + + self.__entries += len(data_clean) + + self.__create_meta_file() + + return 1 + + def read(self, key): + """ + Returns the entry with the key 'key' from the kvs or 'None', if no entry + exists + """ + + self.__validate_key(key) + + key = self.__process_key(key) + file = self.__get_file_by_key(key) + + data = self.__load_dict_from_json_file(file) + + if not key in data: + return None + + value = data[key] + self.__validate_value(value) + + return value + + def wipe_kvs(self): + """ + Deletes every entry from the kvs and creates an updated meta file + """ + + # delete meta file for auto maintainance, if wiping fails + os.remove(self.__meta_file) + + # make sure, all files and folders exist + self.__build_all_paths() + + # wipe all json files + for f in self.__all_file_paths: + self.__save_dict_to_json_file(f, {}) + + self.__entries = 0 + + return self.__create_meta_file() + + def write(self, key, value): + """ + Adds (or updates) an entry with the key 'key' and the value 'value' + """ + + self.__validate_key(key) + self.__validate_value(value) + + key = self.__process_key(key) + file = self.__get_file_by_key(key) + key_existed = False + + data = self.__load_dict_from_json_file(file) + if key in data: + key_existed = True + + data[key] = value + data_written = self.__save_dict_to_json_file(file, data) + if not data_written: + return -1 + + if not key_existed: + self.__entries += 1 + self.__create_meta_file() + + return 1 + + def __build_all_paths(self): + """ + Gathers all file/folder paths and creates those when missing + """ + + # build all file paths + if self.__all_file_paths == []: + self.__build_all_file_paths() + # build all folder paths + if self.__all_folder_paths == []: + self.__build_all_folder_paths() + # create all folders + for f in self.__all_folder_paths: + os.makedirs(f, exist_ok=True) + # create all files + for f in self.__all_file_paths: + if not os.path.exists(f): + self.__save_dict_to_json_file(f, {}) + + def __build_all_file_paths(self): + """ + Calculates all json file paths + """ + + # build all file paths + def build_all_file_paths(r_root_dir, r_current_depth=1): + # build all file paths recursivly + r_chars = [c for c in '0123456789abcdef'] + r_paths = [] + # base case: return with list of files + if r_current_depth == self.__max_depth: + return [ + (os.path.join(r_root_dir, c + '.json')) for c in r_chars + ] + # recursion: go one step further in the filesystem + for c in r_chars: + for p in build_all_file_paths( + os.path.join(r_root_dir, c), + r_current_depth + 1 + ): + r_paths.append(p) + return r_paths + self.__all_file_paths = build_all_file_paths(self.__root_dir) + + def __build_all_folder_paths(self): + """ + Calculates all folder paths + """ + + # iterate over all files an extract their folders + for f in self.__all_file_paths: + path_tmp = os.path.split(f)[0] + while path_tmp != self.__root_dir: + if not path_tmp in self.__all_folder_paths: + self.__all_folder_paths.append(path_tmp) + path_tmp = os.path.dirname(path_tmp) + + self.__all_folder_paths = sorted(self.__all_folder_paths) + + def __create_meta_file(self): + """ + Creates the kvs meta file + """ + + meta = { + 'kvs_name': self.__kvs_name, + 'max_depth': self.__max_depth, + 'entries': self.__entries + } + return self.__save_dict_to_json_file(self.__meta_file, meta) + + def __get_file_by_key(self, key): + """ + Calculates the corresponding json file for 'key' + """ + + file = self.__root_dir + chars = key[:(self.__max_depth - 1)] + + for c in chars: + file = os.path.join(file, c) + + file = os.path.join( + file, + key[(self.__max_depth - 1):self.__max_depth] + '.json' + ) + + return file + + def __load_dict_from_json_file(self, path_to_file): + """ + Returns the content of the json file 'path_to_file' as dict or an empty + dict, when something went wrong. If something went wrong, maintain_kvs() + gets called (the meta file is an exception here). + """ + + try: + with open(path_to_file, 'r', encoding='UTF-8') as f: + data_as_dict = json.load(f) + f.close() + return data_as_dict + except: + self.__save_dict_to_json_file(path_to_file, {}) + if not path_to_file == self.__meta_file: + self.maintain_kvs() + + return {} + + def __load_meta_file(self): + """ + Reads the meta file or rebuilds it, if it is unreadable (broken/lost) + """ + + def load_max_depth(meta): + if not 'max_depth' in meta: + return False + if not isinstance(meta['max_depth'], int): + return False + if not meta['max_depth'] in range(1, 7): + return False + self.__max_depth = meta['max_depth'] + return True + + def load_entries(meta): + if not 'entries' in meta: + return False + if not isinstance(meta['max_depth'], int): + return False + if not meta['entries'] >= 0: + return False + self.__entries = meta['entries'] + return True + + meta = self.__load_dict_from_json_file(self.__meta_file) + + if meta == {}: + meta_file_restored = self.__restore_meta_file() + if not meta_file_restored: + return False + self.maintain_kvs() + meta = self.__load_dict_from_json_file(self.__meta_file) + + if not load_max_depth(meta): + return False + if not load_entries(meta): + return False + + return True + + def __process_key(self, key): + """ + Processes the key 'key' to match the filesystem based hash table + """ + + if len(key) < self.__max_depth: + return self.__str_to_sha256sum(key) + + char_whitelist = [c for c in '0123456789abcdef'] + for c in key: + if c not in char_whitelist: + return self.__str_to_sha256sum(key) + + return key + + def __restore_meta_file(self): + """ + Tries to restore an broken or lost meta file by guessing the 'max_depth' + """ + + def get_max_depth(r_root_dir, r_current_depth=1): + # build all file paths recursivly + r_chars = [c for c in '0123456789abcdef'] + # base case 1: r_current_depth > 7 + if r_current_depth > 7: + return -1 + # base case 2: json file found + for c in r_chars: + file = os.path.join(r_root_dir, c + '.json') + if os.path.exists(file): + return r_current_depth + # recursion: go one step further in the filesystem + for c in r_chars: + max_depth_guess = get_max_depth( + os.path.join(r_root_dir, c), + r_current_depth + 1 + ) + if max_depth_guess > -1: + return max_depth_guess + return -1 + + max_depth = get_max_depth(self.__root_dir) + + if max_depth == -1: + return False + + self.__max_depth = max_depth + return self.__create_meta_file() + + def __save_dict_to_json_file(self, path_to_file, data_as_dict): + """ + Tries to write the dict 'data_as_dict' to the json file 'path_to_file' + """ + + try: + str_to_write = json.dumps( + data_as_dict, + ensure_ascii=False + ) + with open(path_to_file, 'w', encoding='UTF-8') as f: + f.write(str_to_write) + f.close() + except: + return False + + return True + + def __str_to_sha256sum(self, s): + """ + Returns a hexdigit sha256sum as string for the sring 's' + """ + + return hashlib.sha256(bytes(s, 'utf-8')).hexdigest() + + def __validate_key(self, key): + """ + Validates, if the key 'key' can be used for the kvs + """ + + if not isinstance(key, str): + raise ValueError("key must be of type ") + if key == '': + raise ValueError("key must not be empty") + if len(key) > 64: + raise ValueError("key max length is 64 characters") + + def __validate_value(self, value): + """ + Validates, if the value 'value' can be used for the kvs + """ + + if isinstance(value, list): + for v in value: + self.__validate_value(v) + return + + if isinstance(value, dict): + for k, v in value.items(): + self.__validate_key(k) + self.__validate_value(v) + return + + if not isinstance(value, (str, int, float, bool)): + raise ValueError( + "value must be of type" + + " , , " + + " or " + ) diff --git a/fshtbkvs/__init__.py b/fshtbkvs/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/tests/test_basic.py b/tests/test_basic.py new file mode 100644 index 0000000..94604bf --- /dev/null +++ b/tests/test_basic.py @@ -0,0 +1,597 @@ +import os +import unittest +from fshtbkvs.FSHTBKVS import FSHTBKVS + +class TestFSHTBKVS(unittest.TestCase): + # sha256sum of 'FSHTBKVS': + # 60bffff92d13cbd3fe063c018a2263238b01459c388edd5a1bcef5e61d0c46b5 + def setUp(self): + self.kvs_root = '/tmp' + self.kvs_name = 'test_fshtbkvs' + self.max_depth = 3 + self.kvs_path = os.path.join(self.kvs_root, self.kvs_name) + + def test_000_kvs_created(self): + """ + Test if kvs was created + """ + kvs = FSHTBKVS( + self.kvs_root, + self.kvs_name, + max_depth=self.max_depth + ) + + self.assertTrue( + os.path.exists(self.kvs_path), + self.kvs_path + ' not found!' + ) + + meta_file = os.path.join(self.kvs_path, 'meta.json') + self.assertTrue( + os.path.exists(meta_file), + meta_file + ' not found!' + ) + + chars = [c for c in '0123456789abcdef'] + for c0 in chars: + for c1 in chars: + for c2 in chars: + f = os.path.join( + self.kvs_path, + c0, + c1, + c2 + '.json' + ) + self.assertTrue( + os.path.exists(f), + f + ' not found!' + ) + + def test_001_meta_file_loading_and_getters(self): + """ + Test if value of a non existing key was written to file + """ + kvs = FSHTBKVS( + self.kvs_root, + self.kvs_name + ) + + self.assertEqual(kvs.get_kvs_name(), self.kvs_name) + self.assertEqual(kvs.get_max_depth(), self.max_depth) + self.assertEqual(kvs.get_entries(), 0) + + def test_002_write_non_existing_key(self): + """ + Test if value of a non existing key was written to file + """ + kvs = FSHTBKVS( + self.kvs_root, + self.kvs_name + ) + + self.assertEqual(kvs.write('FSHTBKVS', 'is awesome!'), 1) + + path_to_file = os.path.join(self.kvs_path, '6/0/b.json') + with open(path_to_file, 'r') as f: + data = f.read() + f.close() + + data_expected = ( + '{"' + + '60bffff92d13cbd3fe063c018a2263238b01459c388edd5a1bcef5e61d0c46b5' + + '": "is awesome!"}' + ) + + self.assertEqual(data, data_expected) + self.assertEqual(kvs.get_entries(), 1) + + def test_003_write_existing_key(self): + """ + Test if value of an existing key was updated + """ + kvs = FSHTBKVS( + self.kvs_root, + self.kvs_name + ) + + self.assertEqual(kvs.write('FSHTBKVS', 'is really awesome!'), 1) + + path_to_file = os.path.join(self.kvs_path, '6/0/b.json') + with open(path_to_file, 'r') as f: + data = f.read() + f.close() + + data_expected = ( + '{"' + + '60bffff92d13cbd3fe063c018a2263238b01459c388edd5a1bcef5e61d0c46b5' + + '": "is really awesome!"}' + ) + + self.assertEqual(data, data_expected) + self.assertEqual(kvs.get_entries(), 1) + + def test_004_write_to_non_empty_json_file(self): + """ + Test if a new value can be added to non empty json file + """ + kvs = FSHTBKVS( + self.kvs_root, + self.kvs_name + ) + + self.assertEqual(kvs.write('60bffff92d', 1337), 1) + + path_to_file = os.path.join(self.kvs_path, '6/0/b.json') + with open(path_to_file, 'r') as f: + data = f.read() + f.close() + + data_expected = ( + '{"' + + '60bffff92d13cbd3fe063c018a2263238b01459c388edd5a1bcef5e61d0c46b5' + + '": "is really awesome!", "60bffff92d": 1337}' + ) + + self.assertEqual(data, data_expected) + self.assertEqual(kvs.get_entries(), 2) + + def test_005_read_existing_key(self): + """ + Test if existing key can be read + """ + kvs = FSHTBKVS( + self.kvs_root, + self.kvs_name + ) + + path_to_file = os.path.join(self.kvs_path, '6/0/b.json') + with open(path_to_file, 'r') as f: + data = f.read() + f.close() + + self.assertEqual(kvs.read('FSHTBKVS'), 'is really awesome!') + self.assertEqual(kvs.read('60bffff92d'), 1337) + + def test_006_read_non_existing_key(self): + """ + Test if existing key can be read + """ + kvs = FSHTBKVS( + self.kvs_root, + self.kvs_name + ) + + self.assertEqual(kvs.read('1337'), None) + + def test_007_delete_existing_key(self): + """ + Test if existing key can be deleted + """ + kvs = FSHTBKVS( + self.kvs_root, + self.kvs_name + ) + + self.assertEqual(kvs.read('60bffff92d'), 1337) + self.assertEqual(kvs.delete('60bffff92d'), 1) + self.assertEqual(kvs.read('60bffff92d'), None) + self.assertEqual(kvs.get_entries(), 1) + + def test_008_delete_non_existing_key(self): + """ + Test if non existing key can be deleted without errors + """ + kvs = FSHTBKVS( + self.kvs_root, + self.kvs_name + ) + + self.assertEqual(kvs.read('60bffff92d'), None) + self.assertEqual(kvs.delete('60bffff92d'), 1) + self.assertEqual(kvs.read('60bffff92d'), None) + self.assertEqual(kvs.get_entries(), 1) + + def test_009_write_list(self): + """ + Test if a list can be stored in the kvs + """ + + kvs = FSHTBKVS( + self.kvs_root, + self.kvs_name + ) + + the_first_list = [ + 'I like big butts and I can not lie', + 1584662760, + False, + 3.141592 + ] + + self.assertEqual(kvs.write('the_first_list', the_first_list), 1) + self.assertEqual(kvs.read('the_first_list'), the_first_list) + + class ClassesAreNotSupported: + def __init__(self, power=0): + self.power = power + if self.power > 9000: + print("It's Over 9000!!!") + + piccolo = ClassesAreNotSupported(408) + the_first_list.append(piccolo) + + with self.assertRaises(ValueError): + kvs.write('the_first_list', the_first_list) + + self.assertEqual(kvs.delete('the_first_list'), 1) + + def test_010_write_nested_list(self): + """ + Test if a nested list can be stored in the kvs + """ + + kvs = FSHTBKVS( + self.kvs_root, + self.kvs_name + ) + + the_first_nested_list = [ + [ + 1, + 'Django: The web framework for perfectionists with deadlines.' + ], + [ + 2, + 'Bottle: Python Web Framework' + ], + [ + 3, + 'Flask' + ] + ] + + self.assertEqual(kvs.write('the_first_nested_list', the_first_nested_list), 1) + self.assertEqual(kvs.read('the_first_nested_list'), the_first_nested_list) + + class ClassesAreNotSupported: + def __init__(self, power=0): + self.power = power + if self.power > 9000: + print("It's Over 9000!!!") + + bulma = ClassesAreNotSupported(12) + the_first_nested_list[-1].append(bulma) + + with self.assertRaises(ValueError): + kvs.write('the_first_nested_list', the_first_nested_list) + + self.assertEqual(kvs.delete('the_first_nested_list'), 1) + + def test_011_write_dict(self): + """ + Test if a dict can be stored in the kvs + """ + + kvs = FSHTBKVS( + self.kvs_root, + self.kvs_name + ) + + the_first_dict = { + 'brand': 'Ford', + 'model': 'Mustang', + 'year': 1964 + } + + self.assertEqual(kvs.write('the_first_dict', the_first_dict), 1) + self.assertEqual(kvs.read('the_first_dict'), the_first_dict) + + the_first_dict[0] = 0 + with self.assertRaises(ValueError): + kvs.write('the_first_dict', the_first_dict) + del the_first_dict[0] + + class ClassesAreNotSupported: + def __init__(self, power=0): + self.power = power + if self.power > 9000: + print("It's Over 9000!!!") + + piccolo = ClassesAreNotSupported(408) + the_first_dict['driver'] = piccolo + + with self.assertRaises(ValueError): + kvs.write('the_first_dict', the_first_dict) + + self.assertEqual(kvs.delete('the_first_dict'), 1) + + def test_012_write_nested_dict(self): + """ + Test if a nested dict can be stored in the kvs + """ + + kvs = FSHTBKVS( + self.kvs_root, + self.kvs_name + ) + + the_first_nested_dict = { + '0': { + 'brand': 'Ford', + 'model': 'Mustang', + 'year': 1964 + }, + '1': { + 'brand': 'AC Cars', + 'model': 'AC Cobra', + 'year': 1962 + }, + '2': { + 'brand': 'Rimac', + 'model': 'Nevera', + 'year': 2021 + } + } + + self.assertEqual(kvs.write('the_first_nested_dict', the_first_nested_dict), 1) + self.assertEqual(kvs.read('the_first_nested_dict'), the_first_nested_dict) + + class ClassesAreNotSupported: + def __init__(self, power=0): + self.power = power + if self.power > 9000: + print("It's Over 9000!!!") + + bulma = ClassesAreNotSupported(12) + the_first_nested_dict['2']['driver'] = bulma + + with self.assertRaises(ValueError): + kvs.write('the_first_nested_dict', the_first_nested_dict) + + self.assertEqual(kvs.delete('the_first_nested_dict'), 1) + + def test_013_maintain_kvs_json_file_broken(self): + """ + Test if the kvs can get maintained when a json file is broken + """ + kvs = FSHTBKVS( + self.kvs_root, + self.kvs_name + ) + + path_to_file = os.path.join(self.kvs_path, 'f/f/f.json') + + self.assertEqual(kvs.write('fffffff', "Epstein didn't kill himself"), 1) + self.assertEqual(kvs.read('fffffff'), "Epstein didn't kill himself") + self.assertEqual(kvs.get_entries(), 2) + + with open(path_to_file, 'w', encoding='UTF-8') as f: + f.write('{"fffffff": "Epstein didn\'t kill himself"') + f.close() + + self.assertEqual(kvs.read('fffffff'), None) + self.assertEqual(kvs.get_entries(), 1) + with open(path_to_file, 'r', encoding='UTF-8') as f: + data = f.read() + f.close() + self.assertEqual(data, '{}') + + def test_014_maintain_kvs_json_file_lost(self): + """ + Test if the kvs can get maintained when a json file is lost + """ + kvs = FSHTBKVS( + self.kvs_root, + self.kvs_name + ) + + self.assertEqual(kvs.write('fffffff', "Epstein didn't kill himself"), 1) + self.assertEqual(kvs.read('fffffff'), "Epstein didn't kill himself") + self.assertEqual(kvs.get_entries(), 2) + + path_to_file = os.path.join(self.kvs_path, 'f/f/f.json') + os.remove(path_to_file) + + self.assertEqual(kvs.read('fffffff'), None) + self.assertEqual(kvs.get_entries(), 1) + with open(path_to_file, 'r', encoding='UTF-8') as f: + data = f.read() + f.close() + self.assertEqual(data, '{}') + + def test_015_maintain_kvs_meta_file_broken(self): + """ + Test if the kvs can get maintained when the meta file is broken + """ + + path_to_file = os.path.join(self.kvs_path, 'meta.json') + with open(path_to_file, 'w', encoding='UTF-8') as f: + f.write( + '{"kvs_name": "test_fshtbkvs", "max_depth": 3, "entries": 1' + ) + f.close() + + kvs = FSHTBKVS( + self.kvs_root, + self.kvs_name + ) + + self.assertEqual(kvs.read('FSHTBKVS'), 'is really awesome!') + + path_to_file = os.path.join(self.kvs_path, 'meta.json') + with open(path_to_file, 'r') as f: + data = f.read() + f.close() + data_expected = ( + '{"kvs_name": "test_fshtbkvs", "max_depth": 3, "entries": 1}' + ) + self.assertEqual(data, data_expected) + + def test_016_maintain_kvs_meta_file_lost(self): + """ + Test if the kvs can get maintained when the meta file is lost + """ + + path_to_file = os.path.join(self.kvs_path, 'meta.json') + os.remove(path_to_file) + + kvs = FSHTBKVS( + self.kvs_root, + self.kvs_name + ) + + self.assertEqual(kvs.read('FSHTBKVS'), 'is really awesome!') + + path_to_file = os.path.join(self.kvs_path, 'meta.json') + with open(path_to_file, 'r') as f: + data = f.read() + f.close() + data_expected = ( + '{"kvs_name": "test_fshtbkvs", "max_depth": 3, "entries": 1}' + ) + self.assertEqual(data, data_expected) + + def test_017_export_kvs(self): + """ + Test if the kvs can get exported + """ + + kvs = FSHTBKVS( + self.kvs_root, + self.kvs_name + ) + + entries = { + "e94e8ed9c2": "alfredissimo!", + "5db1fee4b5": 1337, + "26436a96b6": "Who controls the past controls the future.", + "58b6c6c96c": "https://blog.fefe.de/", + "8139b33952": 0.9, + "f99f33e288": "de_dust2", + "e08e0bd862": "Who controls the present controls the past.", + "3cbc87c768": True, + "bbb9abde2d": "Wenn eine Aussage einen trifft, war sie wahrscheinlich auch zutreffend.", + "de650d61f5": 4711 + } + for key, value in entries.items(): + self.assertEqual(kvs.write(key, value), 1) + + path_to_file = os.path.join(self.kvs_path, 'd/e/6.json') + with open(path_to_file, 'w', encoding='UTF-8') as f: + f.write('{"de650d61f5": 4711') + f.close() + + path_to_file = os.path.join( + self.kvs_root, + self.kvs_name, + self.kvs_name + '.fshtbkvs' + + ) + kvs.export_kvs(str(path_to_file)) + + expected_exports = [ + '{"26436a96b6": "Who controls the past controls the future."}', + '{"3cbc87c768": true}', + '{"58b6c6c96c": "https://blog.fefe.de/"}', + '{"5db1fee4b5": 1337}', + '{"60bffff92d13cbd3fe063c018a2263238b01459c388edd5a1bcef5e61d0c46b5": "is really awesome!"}', + '{"8139b33952": 0.9}', + '{"bbb9abde2d": "Wenn eine Aussage einen trifft, war sie wahrscheinlich auch zutreffend."}', + '{"e08e0bd862": "Who controls the present controls the past."}', + '{"e94e8ed9c2": "alfredissimo!"}', + '{"f99f33e288": "de_dust2"}' + ] + + with open(path_to_file, 'r') as f: + lines = f.readlines() + f.close() + + line_number = 0 + for line in lines: + data_expected = expected_exports[line_number] + self.assertEqual(line.strip(), data_expected) + line_number += 1 + + def test_018_wipe_kvs(self): + """ + Test if the kvs can get wiped + """ + + kvs = FSHTBKVS( + self.kvs_root, + self.kvs_name + ) + + self.assertEqual(kvs.wipe_kvs(), 1) + + chars = [c for c in '0123456789abcdef'] + for c0 in chars: + for c1 in chars: + for c2 in chars: + path_to_file = os.path.join( + self.kvs_path, + c0, + c1, + c2 + '.json' + ) + + with open(path_to_file, 'r') as f: + data = f.read() + f.close() + + self.assertEqual(data, '{}') + + self.assertEqual(kvs.get_entries(), 0) + + def test_019_import_kvs(self): + """ + Test if the kvs can get wiped + """ + + kvs = FSHTBKVS( + self.kvs_root, + self.kvs_name + ) + + path_to_file = os.path.join( + self.kvs_root, + self.kvs_name, + self.kvs_name + '.fshtbkvs' + + ) + + self.assertEqual(kvs.import_kvs(str(path_to_file)), 1) + + self.assertEqual(kvs.read('26436a96b6'), 'Who controls the past controls the future.') + self.assertEqual(kvs.read('3cbc87c768'), True) + self.assertEqual(kvs.read('58b6c6c96c'), 'https://blog.fefe.de/') + self.assertEqual(kvs.read('5db1fee4b5'), 1337) + self.assertEqual(kvs.read('FSHTBKVS'), 'is really awesome!') + self.assertEqual(kvs.read('8139b33952'), 0.9) + self.assertEqual(kvs.read('bbb9abde2d'), 'Wenn eine Aussage einen trifft, war sie wahrscheinlich auch zutreffend.') + self.assertEqual(kvs.read('e08e0bd862'), 'Who controls the present controls the past.') + self.assertEqual(kvs.read('e94e8ed9c2'), 'alfredissimo!') + self.assertEqual(kvs.read('f99f33e288'), 'de_dust2') + + self.assertEqual(kvs.get_entries(), 10) + + def test_020_get_size_of_kvs(self): + """ + Test if the size in bytes of the kvs can get calculated + """ + + kvs = FSHTBKVS( + self.kvs_root, + self.kvs_name + ) + + self.assertEqual(kvs.get_size_of_kvs(), 0.008627) + +def purge_test_kvs(): + if os.path.exists('/tmp/test_fshtbkvs'): + os.system('rm -rf /tmp/test_fshtbkvs') + +if __name__ == '__main__': + purge_test_kvs() + unittest.main() + # purge_test_kvs()