diff --git a/kiauh/core/submodules/simple_config_parser/.editorconfig b/kiauh/core/submodules/simple_config_parser/.editorconfig new file mode 100644 index 0000000..2546a60 --- /dev/null +++ b/kiauh/core/submodules/simple_config_parser/.editorconfig @@ -0,0 +1,13 @@ +# see https://editorconfig.org/ +root = true + +[*] +end_of_line = lf +trim_trailing_whitespace = true +indent_style = space +insert_final_newline = true +indent_size = 4 +charset = utf-8 + +[*.py] +max_line_length = 88 diff --git a/kiauh/core/submodules/simple_config_parser/.gitignore b/kiauh/core/submodules/simple_config_parser/.gitignore new file mode 100644 index 0000000..a5d5089 --- /dev/null +++ b/kiauh/core/submodules/simple_config_parser/.gitignore @@ -0,0 +1,13 @@ +*.py[cod] +*.pyc +__pycache__ +.pytest_cache/ + +.idea/ +.vscode/ + +.venv*/ +venv*/ + +.coverage +htmlcov/ diff --git a/kiauh/core/submodules/simple_config_parser/LICENSE b/kiauh/core/submodules/simple_config_parser/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/kiauh/core/submodules/simple_config_parser/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/kiauh/core/submodules/simple_config_parser/README.md b/kiauh/core/submodules/simple_config_parser/README.md new file mode 100644 index 0000000..dda49fa --- /dev/null +++ b/kiauh/core/submodules/simple_config_parser/README.md @@ -0,0 +1,6 @@ +# Simple Config Parser + +A custom config parser inspired by Python's configparser module. +Specialized for handling Klipper style config files. + + diff --git a/kiauh/core/submodules/simple_config_parser/pyproject.toml b/kiauh/core/submodules/simple_config_parser/pyproject.toml new file mode 100644 index 0000000..a3bca47 --- /dev/null +++ b/kiauh/core/submodules/simple_config_parser/pyproject.toml @@ -0,0 +1,66 @@ +[project] +name = "simple-config-parser" +version = "0.0.1" +description = "A simple config parser for Python" +authors = [ + {name = "Dominik Willner", email = "th33xitus@gmail.com"}, +] +readme = "README.md" +license = {text = "GPL-3.0-only"} +requires-python = ">=3.8" + +[project.urls] +homepage = "https://github.com/dw-0/simple-config-parser" +repository = "https://github.com/dw-0/simple-config-parser" +documentation = "https://github.com/dw-0/simple-config-parser" + +[project.optional-dependencies] +dev=["ruff"] + +[tool.ruff] +required-version = ">=0.3.4" +respect-gitignore = true +exclude = [".git",".github", "./docs"] +line-length = 88 +indent-width = 4 +output-format = "full" + +[tool.ruff.format] +indent-style = "space" +line-ending = "lf" +quote-style = "double" + +[tool.ruff.lint] +extend-select = ["I"] + +[tool.pytest.ini_options] +minversion = "8.2.1" +testpaths = ["tests/**/*.py"] +addopts = "--cov --cov-config=pyproject.toml --cov-report=html" + +[tool.coverage.run] +branch = true +source = ["src.simple_config_parser"] + +[tool.coverage.report] +# Regexes for lines to exclude from consideration +exclude_also = [ + # Don't complain about missing debug-only code: + "def __repr__", + "if self\\.debug", + + # Don't complain if tests don't hit defensive assertion code: + "raise AssertionError", + "raise NotImplementedError", + + # Don't complain if non-runnable code isn't run: + "if 0:", + "if __name__ == .__main__.:", + + # Don't complain about abstract methods, they aren't run: + "@(abc\\.)?abstractmethod", + ] + +[tool.coverage.html] +title = "SimpleConfigParser Coverage Report" +directory = "htmlcov" diff --git a/kiauh/core/submodules/simple_config_parser/requirements-dev.txt b/kiauh/core/submodules/simple_config_parser/requirements-dev.txt new file mode 100644 index 0000000..7e73e5f --- /dev/null +++ b/kiauh/core/submodules/simple_config_parser/requirements-dev.txt @@ -0,0 +1,3 @@ +ruff >= 0.3.4 +pytest >= 8.2.1 +pytest-cov >= 5.0.0 diff --git a/kiauh/core/submodules/simple_config_parser/src/simple_config_parser/__init__.py b/kiauh/core/submodules/simple_config_parser/src/simple_config_parser/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/kiauh/core/submodules/simple_config_parser/src/simple_config_parser/simple_config_parser.py b/kiauh/core/submodules/simple_config_parser/src/simple_config_parser/simple_config_parser.py new file mode 100644 index 0000000..208a630 --- /dev/null +++ b/kiauh/core/submodules/simple_config_parser/src/simple_config_parser/simple_config_parser.py @@ -0,0 +1,528 @@ +# ======================================================================= # +# Copyright (C) 2020 - 2024 Dominik Willner # +# # +# https://github.com/dw-0/simple-config-parser # +# # +# This file may be distributed under the terms of the GNU GPLv3 license # +# ======================================================================= # + +from __future__ import annotations + +import re +from pathlib import Path +from typing import Callable, Dict, List, Match, Tuple, TypedDict + +_UNSET = object() + + +class Section(TypedDict): + """ + A single section in the config file + + - _raw: The raw representation of the section name + - options: A list of options in the section + """ + + _raw: str + options: List[Option] + + +class Option(TypedDict, total=False): + """ + A single option in a section in the config file + + - is_multiline: Whether the option is a multiline option + - option: The name of the option + - value: The value of the option + - _raw: The raw representation of the option + - _raw_value: The raw value of the option + + A multinline option is an option that contains multiple lines of text following + the option name in the next line. The value of a multiline option is a list of + strings, where each string represents a single line of text. + """ + + is_multiline: bool + option: str + value: str | List[str] + _raw: str + _raw_value: str | List[str] + + +class NoSectionError(Exception): + """Raised when a section is not defined""" + + def __init__(self, section: str): + msg = f"Section '{section}' is not defined" + super().__init__(msg) + + +class NoOptionError(Exception): + """Raised when an option is not defined in a section""" + + def __init__(self, option: str, section: str): + msg = f"Option '{option}' in section '{section}' is not defined" + super().__init__(msg) + + +class DuplicateSectionError(Exception): + """Raised when a section is defined more than once""" + + def __init__(self, section: str): + msg = f"Section '{section}' is defined more than once" + super().__init__(msg) + + +class DuplicateOptionError(Exception): + """Raised when an option is defined more than once""" + + def __init__(self, option: str, section: str): + msg = f"Option '{option}' in section '{section}' is defined more than once" + super().__init__(msg) + + +# noinspection PyMethodMayBeStatic +class SimpleConfigParser: + """A customized config parser targeted at handling Klipper style config files""" + + _SECTION_RE = re.compile(r"\s*\[(\w+ ?\w+)]\s*([#;].*)?$") + _OPTION_RE = re.compile(r"^\s*(\w+)\s*[:=]\s*([^=:].*)\s*([#;].*)?$") + _MLOPTION_RE = re.compile(r"^\s*(\w+)\s*[:=]\s*([#;].*)?$") + _COMMENT_RE = re.compile(r"^\s*([#;].*)?$") + _EMPTY_LINE_RE = re.compile(r"^\s*$") + + BOOLEAN_STATES = { + "1": True, + "yes": True, + "true": True, + "on": True, + "0": False, + "no": False, + "false": False, + "off": False, + } + + def __init__(self): + self._config: Dict = {} + self._header: List[str] = [] + self._all_sections: List[str] = [] + self._all_options: Dict = {} + self.section_name: str = "" + self.in_option_block: bool = False # whether we are in a multiline option block + + def read(self, file: Path) -> None: + """Read the given file and store the result in the internal state""" + + try: + with open(file, "r") as f: + self._parse_config(f.readlines()) + + except OSError: + raise + + def write(self, filename): + """Write the internal state to the given file""" + + content = self._construct_content() + + with open(filename, "w") as f: + f.write(content) + + def _construct_content(self) -> str: + """ + Constructs the content of the configuration file based on the internal state of + the _config object by iterating over the sections and their options. It starts + by checking if a header is present and extends the content list with its elements. + Then, for each section, it appends the raw representation of the section to the + content list. If the section has a body, it iterates over its options and extends + the content list with their raw representations. If an option is multiline, it + also extends the content list with its raw value. Finally, the content list is + joined into a single string and returned. + + :return: The content of the configuration file as a string + """ + content: List[str] = [] + if self._header is not None: + content.extend(self._header) + for section in self._config: + content.append(self._config[section]["_raw"]) + + if (sec_body := self._config[section].get("body")) is not None: + for option in sec_body: + content.extend(option["_raw"]) + if option["is_multiline"]: + content.extend(option["_raw_value"]) + content: str = "".join(content) + + return content + + def sections(self) -> List[str]: + """Return a list of section names""" + + return self._all_sections + + def add_section(self, section: str) -> None: + """Add a new section to the internal state""" + + if section in self._all_sections: + raise DuplicateSectionError(section) + self._all_sections.append(section) + self._all_options[section] = {} + self._config[section] = {"_raw": f"\n[{section}]\n", "body": []} + + def remove_section(self, section: str) -> None: + """Remove the given section""" + + if section not in self._all_sections: + raise NoSectionError(section) + + del self._all_sections[self._all_sections.index(section)] + del self._all_options[section] + del self._config[section] + + def options(self, section) -> List[str]: + """Return a list of option names for the given section name""" + + return self._all_options.get(section) + + def get(self, section: str, option: str, fallback: str | _UNSET = _UNSET) -> str: + """ + Return the value of the given option in the given section + + If the key is not found and 'fallback' is provided, it is used as + a fallback value. + """ + + try: + if section not in self._all_sections: + raise NoSectionError(section) + + if option not in self._all_options.get(section): + raise NoOptionError(option, section) + + return self._all_options[section][option] + except (NoSectionError, NoOptionError): + if fallback is _UNSET: + raise + return fallback + + def getint(self, section: str, option: str, fallback: int | _UNSET = _UNSET) -> int: + """Return the value of the given option in the given section as an int""" + + return self._get_conv(section, option, int, fallback=fallback) + + def getfloat( + self, section: str, option: str, fallback: float | _UNSET = _UNSET + ) -> float: + return self._get_conv(section, option, float, fallback=fallback) + + def getboolean( + self, section: str, option: str, fallback: bool | _UNSET = _UNSET + ) -> bool: + return self._get_conv( + section, option, self._convert_to_boolean, fallback=fallback + ) + + def _convert_to_boolean(self, value) -> bool: + if value.lower() not in self.BOOLEAN_STATES: + raise ValueError("Not a boolean: %s" % value) + return self.BOOLEAN_STATES[value.lower()] + + def _get_conv( + self, + section: str, + option: str, + conv: Callable[[str], int | float | bool], + fallback: _UNSET = _UNSET, + ) -> int | float | bool: + try: + return conv(self.get(section, option, fallback)) + except: + if fallback is not _UNSET: + return fallback + raise + + def items(self, section: str) -> List[Tuple[str, str]]: + """Return a list of (option, value) tuples for a specific section""" + + if section not in self._all_sections: + raise NoSectionError(section) + + result = [] + for _option in self._all_options[section]: + result.append((_option, self._all_options[section][_option])) + + return result + + def set( + self, + section: str, + option: str, + value: str, + multiline: bool = False, + indent: int = 2, + ) -> None: + """Set the given option to the given value in the given section + + If the option is already defined, it will be overwritten. If the option + is not defined yet, it will be added to the section body. + + The multiline parameter can be used to specify whether the value is + multiline or not. If it is not specified, the value will be considered + as multiline if it contains a newline character. The value will then be split + into multiple lines. If the value does not contain a newline character, it + will be considered as a single line value. The indent parameter can be used + to specify the indentation of the multiline value. Indentations are with spaces. + + :param section: The section to set the option in + :param option: The option to set + :param value: The value to set + :param multiline: Whether the value is multiline or not + :param indent: The indentation for multiline values + """ + + if section not in self._all_sections: + raise NoSectionError(section) + + # prepare the options value and raw value depending on the multiline flag + _raw_value: List[str] | None = None + if multiline or "\n" in value: + _multiline = True + _raw: str = f"{option}:\n" + _value: List[str] = value.split("\n") + _raw_value: List[str] = [f"{' ' * indent}{v}\n" for v in _value] + else: + _multiline = False + _raw: str = f"{option}: {value}\n" + _value: str = value + + # the option does not exist yet + if option not in self._all_options.get(section): + _option: Option = { + "is_multiline": _multiline, + "option": option, + "value": _value, + "_raw": _raw, + } + if _raw_value is not None: + _option["_raw_value"] = _raw_value + self._config[section]["body"].insert(0, _option) + + # the option exists and we need to update it + else: + for _option in self._config[section]["body"]: + if _option["option"] == option: + # we preserve inline comments by replacing the old value with the new one + _option["_raw"] = _option["_raw"].replace(_option["value"], _value) + _option["value"] = _value + if _raw_value is not None: + _option["_raw_value"] = _raw_value + break + + self._all_options[section][option] = _value + + def remove_option(self, section: str, option: str) -> None: + """Remove the given option from the given section""" + + if section not in self._all_sections: + raise NoSectionError(section) + + if option not in self._all_options.get(section): + raise NoOptionError(option, section) + + for _option in self._config[section]["body"]: + if _option["option"] == option: + del self._all_options[section][option] + self._config[section]["body"].remove(_option) + break + + def has_section(self, section: str) -> bool: + """Return True if the given section exists, False otherwise""" + return section in self._all_sections + + def has_option(self, section: str, option: str) -> bool: + """Return True if the given option exists in the given section, False otherwise""" + return option in self._all_options.get(section) + + def _is_section(self, line: str) -> bool: + """Check if the given line contains a section definition""" + return self._SECTION_RE.match(line) is not None + + def _is_option(self, line: str) -> bool: + """Check if the given line contains an option definition""" + + match: Match[str] | None = self._OPTION_RE.match(line) + + if not match: + return False + + # if there is no value, it's not a regular option but a multiline option + if match.group(2).strip() == "": + return False + + if not match.group(1).strip() == "": + return True + + return False + + def _is_comment(self, line: str) -> bool: + """Check if the given line is a comment""" + return self._COMMENT_RE.match(line) is not None + + def _is_empty_line(self, line: str) -> bool: + """Check if the given line is an empty line""" + return self._EMPTY_LINE_RE.match(line) is not None + + def _is_multiline_option(self, line: str) -> bool: + """Check if the given line starts a multiline option block""" + + match: Match[str] | None = self._MLOPTION_RE.match(line) + + if not match: + return False + + return True + + def _parse_config(self, content: List[str]) -> None: + """Parse the given content and store the result in the internal state""" + + _curr_multi_opt = "" + + # THE ORDER MATTERS, DO NOT REORDER THE CONDITIONS! + for line in content: + if self._is_section(line): + self._parse_section(line) + + elif self._is_option(line): + self._parse_option(line) + + # if it's not a regular option with the value inline, + # it might be a might be a multiline option block + elif self._is_multiline_option(line): + self.in_option_block = True + _curr_multi_opt = self._OPTION_RE.match(line).group(1).strip() + self._add_option_to_section_body(_curr_multi_opt, "", line) + + elif self.in_option_block: + self._parse_multiline_option(_curr_multi_opt, line) + + # if it's nothing from above, it's probably a comment or an empty line + elif self._is_comment(line) or self._is_empty_line(line): + self._parse_comment(line) + + def _parse_section(self, line: str) -> None: + """Parse a section line and store the result in the internal state""" + + match: Match[str] | None = self._SECTION_RE.match(line) + if not match: + return + + self.in_option_block = False + + section_name: str = match.group(1).strip() + self._store_internal_state_section(section_name, line) + + def _store_internal_state_section(self, section: str, raw_value: str) -> None: + """Store the given section and its raw value in the internal state""" + + if section in self._all_sections: + raise DuplicateSectionError(section) + + self.section_name = section + self._all_sections.append(section) + self._config[section]: Section = {"_raw": raw_value, "body": []} + + def _parse_option(self, line: str) -> None: + """Parse an option line and store the result in the internal state""" + + self.in_option_block = False + + match: Match[str] | None = self._OPTION_RE.match(line) + if not match: + return + + option: str = match.group(1).strip() + value: str = match.group(2).strip() + + if ";" in value: + i = value.index(";") + value = value[:i].strip() + elif "#" in value: + i = value.index("#") + value = value[:i].strip() + + self._store_internal_state_option(option, value, line) + + def _store_internal_state_option( + self, option: str, value: str, raw_value: str + ) -> None: + """Store the given option and its raw value in the internal state""" + + section_options = self._all_options.setdefault(self.section_name, {}) + + if option in section_options: + raise DuplicateOptionError(option, self.section_name) + + section_options[option] = value + self._add_option_to_section_body(option, value, raw_value) + + def _parse_multiline_option(self, curr_ml_opt: str, line: str) -> None: + """Parse a multiline option line and store the result in the internal state""" + + section_options = self._all_options.setdefault(self.section_name, {}) + multiline_options = section_options.setdefault(curr_ml_opt, []) + + _cleaned_line = line.strip().strip("\n") + if _cleaned_line and not self._is_comment(line): + multiline_options.append(_cleaned_line) + + # add the option to the internal multiline option value state + self._ensure_section_body_exists() + for _option in self._config[self.section_name]["body"]: + if _option.get("option") == curr_ml_opt: + _option.update( + is_multiline=True, + _raw_value=_option.get("_raw_value", []) + [line], + value=multiline_options, + ) + + def _parse_comment(self, line: str) -> None: + """ + Parse a comment line and store the result in the internal state + + If the there was no previous section parsed, the lines are handled as + the file header and added to the internal header list as it means, that + we are at the very top of the file. + """ + + self.in_option_block = False + + if not self.section_name: + self._header.append(line) + else: + self._add_option_to_section_body("", "", line) + + def _ensure_section_body_exists(self) -> None: + """ + Ensure that the section body exists in the internal state. + If the section body does not exist, it is created as an empty list + """ + if self.section_name not in self._config: + self._config.setdefault(self.section_name, {}).setdefault("body", []) + + def _add_option_to_section_body( + self, option: str, value: str, line: str, is_multiline: bool = False + ) -> None: + """Add a raw option line to the internal state""" + + self._ensure_section_body_exists() + + new_option: Option = { + "is_multiline": is_multiline, + "option": option, + "value": value, + "_raw": line, + } + + option_body = self._config[self.section_name]["body"] + option_body.append(new_option) diff --git a/kiauh/core/submodules/simple_config_parser/tests/Test SimpleConfigParser.run.xml b/kiauh/core/submodules/simple_config_parser/tests/Test SimpleConfigParser.run.xml new file mode 100644 index 0000000..bc62c5c --- /dev/null +++ b/kiauh/core/submodules/simple_config_parser/tests/Test SimpleConfigParser.run.xml @@ -0,0 +1,21 @@ + + + + + \ No newline at end of file diff --git a/kiauh/core/submodules/simple_config_parser/tests/__init__.py b/kiauh/core/submodules/simple_config_parser/tests/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/kiauh/core/submodules/simple_config_parser/tests/features/internal_state/test_content_handling.py b/kiauh/core/submodules/simple_config_parser/tests/features/internal_state/test_content_handling.py new file mode 100644 index 0000000..d54681e --- /dev/null +++ b/kiauh/core/submodules/simple_config_parser/tests/features/internal_state/test_content_handling.py @@ -0,0 +1,95 @@ +import pytest + +from src.simple_config_parser.simple_config_parser import SimpleConfigParser + + +@pytest.fixture +def parser(): + parser = SimpleConfigParser() + parser._header = ["header1\n", "header2\n"] + parser._config = { + "section1": { + "_raw": "[section1]\n", + "body": [ + { + "_raw": "option1: value1\n", + "_raw_value": "value1\n", + "is_multiline": False, + "option": "option1", + "value": "value1", + }, + { + "_raw": "option2: value2\n", + "_raw_value": "value2\n", + "is_multiline": False, + "option": "option2", + "value": "value2", + }, + ], + }, + "section2": { + "_raw": "[section2]\n", + "body": [ + { + "_raw": "option3: value3\n", + "_raw_value": "value3\n", + "is_multiline": False, + "option": "option3", + "value": "value3", + }, + ], + }, + "section3": { + "_raw": "[section3]\n", + "body": [ + { + "_raw": "option4:\n", + "_raw_value": [" value4\n", " value5\n", " value6\n"], + "is_multiline": True, + "option": "option4", + "value": ["value4", "value5", "value6"], + }, + ], + }, + } + return parser + + +def test_construct_content(parser): + content = parser._construct_content() + assert ( + content == "header1\nheader2\n" + "[section1]\n" + "option1: value1\n" + "option2: value2\n" + "[section2]\n" + "option3: value3\n" + "[section3]\n" + "option4:\n" + " value4\n" + " value5\n" + " value6\n" + ) + + +def test_construct_content_no_header(parser): + parser._header = None + content = parser._construct_content() + assert ( + content == "[section1]\n" + "option1: value1\n" + "option2: value2\n" + "[section2]\n" + "option3: value3\n" + "[section3]\n" + "option4:\n" + " value4\n" + " value5\n" + " value6\n" + ) + + +def test_construct_content_no_sections(parser): + parser._config = {} + content = parser._construct_content() + assert content == "".join(parser._header) diff --git a/kiauh/core/submodules/simple_config_parser/tests/features/internal_state/test_internal_state_changes.py b/kiauh/core/submodules/simple_config_parser/tests/features/internal_state/test_internal_state_changes.py new file mode 100644 index 0000000..af32e1e --- /dev/null +++ b/kiauh/core/submodules/simple_config_parser/tests/features/internal_state/test_internal_state_changes.py @@ -0,0 +1,83 @@ +import pytest + +from src.simple_config_parser.simple_config_parser import ( + DuplicateOptionError, + DuplicateSectionError, + SimpleConfigParser, +) + + +@pytest.fixture +def parser(): + return SimpleConfigParser() + + +class TestInternalStateChanges: + @pytest.mark.parametrize( + "given", ["dummy_section", "dummy_section 2", "another_section"] + ) + def test_ensure_section_body_exists(self, parser, given): + parser._config = {} + parser.section_name = given + parser._ensure_section_body_exists() + + assert parser._config[given] is not None + assert parser._config[given]["body"] == [] + + def test_add_option_to_section_body(self): + pass + + @pytest.mark.parametrize( + "given", ["dummy_section", "dummy_section 2", "another_section\n"] + ) + def test_store_internal_state_section(self, parser, given): + parser._store_internal_state_section(given, given) + + assert parser._all_sections == [given] + assert parser._config[given]["body"] == [] + assert parser._config[given]["_raw"] == given + + def test_duplicate_section_error(self, parser): + section_name = "dummy_section" + parser._all_sections = [section_name] + + with pytest.raises(DuplicateSectionError) as excinfo: + parser._store_internal_state_section(section_name, section_name) + message = f"Section '{section_name}' is defined more than once" + assert message in str(excinfo.value) + + # Check that the internal state of the parser is correct + assert parser.in_option_block is False + assert parser.section_name == "" + assert parser._all_sections == [section_name] + + @pytest.mark.parametrize( + "given_name, given_value, given_raw_value", + [("dummyoption", "dummyvalue", "dummyvalue\n")], + ) + def test_store_internal_state_option( + self, parser, given_name, given_value, given_raw_value + ): + parser.section_name = "dummy_section" + parser._store_internal_state_option(given_name, given_value, given_raw_value) + + assert parser._all_options[parser.section_name] == {given_name: given_value} + + new_option = { + "is_multiline": False, + "option": given_name, + "value": given_value, + "_raw": given_raw_value, + } + assert parser._config[parser.section_name]["body"] == [new_option] + + def test_duplicate_option_error(self, parser): + option_name = "dummyoption" + value = "dummyvalue" + parser.section_name = "dummy_section" + parser._all_options = {parser.section_name: {option_name: value}} + + with pytest.raises(DuplicateOptionError) as excinfo: + parser._store_internal_state_option(option_name, value, value) + message = f"Option '{option_name}' in section '{parser.section_name}' is defined more than once" + assert message in str(excinfo.value) diff --git a/kiauh/core/submodules/simple_config_parser/tests/features/line_parsing/data/case_parse_comment.py b/kiauh/core/submodules/simple_config_parser/tests/features/line_parsing/data/case_parse_comment.py new file mode 100644 index 0000000..d84b40f --- /dev/null +++ b/kiauh/core/submodules/simple_config_parser/tests/features/line_parsing/data/case_parse_comment.py @@ -0,0 +1,6 @@ +testcases = [ + "# comment # 1", + "; comment # 2", + " ; indented comment", + " # another indented comment", +] diff --git a/kiauh/core/submodules/simple_config_parser/tests/features/line_parsing/data/case_parse_option.py b/kiauh/core/submodules/simple_config_parser/tests/features/line_parsing/data/case_parse_option.py new file mode 100644 index 0000000..e4901f5 --- /dev/null +++ b/kiauh/core/submodules/simple_config_parser/tests/features/line_parsing/data/case_parse_option.py @@ -0,0 +1,19 @@ +testcases = [ + ("option: value", "option", "value"), + ("option : value", "option", "value"), + ("option :value", "option", "value"), + ("option= value", "option", "value"), + ("option = value", "option", "value"), + ("option =value", "option", "value"), + ("option: value\n", "option", "value"), + ("option: value # inline comment", "option", "value"), + ("option: value # inline comment\n", "option", "value"), + ("description: homing!", "description", "homing!"), + ("description: inline macro :-)", "description", "inline macro :-)"), + ("path: %GCODES_DIR%", "path", "%GCODES_DIR%"), + ( + "serial = /dev/serial/by-id/", + "serial", + "/dev/serial/by-id/", + ), +] diff --git a/kiauh/core/submodules/simple_config_parser/tests/features/line_parsing/data/case_parse_section.py b/kiauh/core/submodules/simple_config_parser/tests/features/line_parsing/data/case_parse_section.py new file mode 100644 index 0000000..ea1536d --- /dev/null +++ b/kiauh/core/submodules/simple_config_parser/tests/features/line_parsing/data/case_parse_section.py @@ -0,0 +1,6 @@ +testcases = [ + ("[test_section]", "test_section"), + ("[test_section two]", "test_section two"), + ("[section1] # inline comment", "section1"), + ("[section2] ; second comment", "section2"), +] diff --git a/kiauh/core/submodules/simple_config_parser/tests/features/line_parsing/test_line_parsing.py b/kiauh/core/submodules/simple_config_parser/tests/features/line_parsing/test_line_parsing.py new file mode 100644 index 0000000..96366e3 --- /dev/null +++ b/kiauh/core/submodules/simple_config_parser/tests/features/line_parsing/test_line_parsing.py @@ -0,0 +1,92 @@ +import pytest +from data.case_parse_comment import testcases as case_parse_comment +from data.case_parse_option import testcases as case_parse_option +from data.case_parse_section import testcases as case_parse_section + +from src.simple_config_parser.simple_config_parser import ( + Option, + SimpleConfigParser, +) + + +@pytest.fixture +def parser(): + return SimpleConfigParser() + + +class TestLineParsing: + @pytest.mark.parametrize("given, expected", [*case_parse_section]) + def test_parse_section(self, parser, given, expected): + parser._parse_section(given) + + # Check that the internal state of the parser is correct + assert parser.section_name == expected + assert parser.in_option_block is False + assert parser._all_sections == [expected] + assert parser._config[expected]["_raw"] == given + assert parser._config[expected]["body"] == [] + + @pytest.mark.parametrize( + "given, expected_option, expected_value", [*case_parse_option] + ) + def test_parse_option(self, parser, given, expected_option, expected_value): + section_name = "test_section" + parser.section_name = section_name + parser._parse_option(given) + + # Check that the internal state of the parser is correct + assert parser.section_name == section_name + assert parser.in_option_block is False + assert parser._all_options[section_name][expected_option] == expected_value + + section_option = parser._config[section_name]["body"][0] + assert section_option["option"] == expected_option + assert section_option["value"] == expected_value + assert section_option["_raw"] == given + + @pytest.mark.parametrize( + "option, next_line", + [("gcode", "next line"), ("gcode", " {{% some jinja template %}}")], + ) + def test_parse_multiline_option(self, parser, option, next_line): + parser.section_name = "dummy_section" + parser.in_option_block = True + parser._add_option_to_section_body(option, "", option) + parser._parse_multiline_option(option, next_line) + cleaned_next_line = next_line.strip().strip("\n") + + assert parser._all_options[parser.section_name] is not None + assert parser._all_options[parser.section_name][option] == [cleaned_next_line] + + expected_option: Option = { + "is_multiline": True, + "option": option, + "value": [cleaned_next_line], + "_raw": option, + "_raw_value": [next_line], + } + assert parser._config[parser.section_name]["body"] == [expected_option] + + @pytest.mark.parametrize("given", [*case_parse_comment]) + def test_parse_comment(self, parser, given): + parser.section_name = "dummy_section" + parser._parse_comment(given) + + # internal state checks after parsing + assert parser.in_option_block is False + + expected_option = { + "is_multiline": False, + "_raw": given, + "option": "", + "value": "", + } + assert parser._config[parser.section_name]["body"] == [expected_option] + + @pytest.mark.parametrize("given", ["# header line", "; another header line"]) + def test_parse_header_comment(self, parser, given): + parser.section_name = "" + parser._parse_comment(given) + + assert parser.in_option_block is False + assert parser._header == [given] diff --git a/kiauh/core/submodules/simple_config_parser/tests/features/line_type_detection/data/case_line_is_comment.py b/kiauh/core/submodules/simple_config_parser/tests/features/line_type_detection/data/case_line_is_comment.py new file mode 100644 index 0000000..107745c --- /dev/null +++ b/kiauh/core/submodules/simple_config_parser/tests/features/line_type_detection/data/case_line_is_comment.py @@ -0,0 +1,9 @@ +testcases = [ + ("# an arbitrary comment", True), + ("; another arbitrary comment", True), + (" ; indented comment", True), + (" # indented comment", True), + ("not_a: comment", False), + ("also_not_a= comment", False), + ("[definitely_not_a_comment]", False), +] diff --git a/kiauh/core/submodules/simple_config_parser/tests/features/line_type_detection/data/case_line_is_empty.py b/kiauh/core/submodules/simple_config_parser/tests/features/line_type_detection/data/case_line_is_empty.py new file mode 100644 index 0000000..7fe6afc --- /dev/null +++ b/kiauh/core/submodules/simple_config_parser/tests/features/line_type_detection/data/case_line_is_empty.py @@ -0,0 +1,9 @@ +testcases = [ + ("", True), + (" ", True), + ("not empty", False), + (" # indented comment", False), + ("not: empty", False), + ("also_not= empty", False), + ("[definitely_not_empty]", False), +] diff --git a/kiauh/core/submodules/simple_config_parser/tests/features/line_type_detection/data/case_line_is_multiline_option.py b/kiauh/core/submodules/simple_config_parser/tests/features/line_type_detection/data/case_line_is_multiline_option.py new file mode 100644 index 0000000..ed93f87 --- /dev/null +++ b/kiauh/core/submodules/simple_config_parser/tests/features/line_type_detection/data/case_line_is_multiline_option.py @@ -0,0 +1,17 @@ +testcases = [ + ("valid_option:", True), + ("valid_option:\n", True), + ("valid_option: ; inline comment", True), + ("valid_option: # inline comment", True), + ("valid_option :", True), + ("valid_option=", True), + ("valid_option= ", True), + ("valid_option =", True), + ("valid_option = ", True), + ("invalid_option ==", False), + ("invalid_option :=", False), + ("not_a_valid_option", False), + ("", False), + ("# that's a comment", False), + ("; that's a comment", False), +] diff --git a/kiauh/core/submodules/simple_config_parser/tests/features/line_type_detection/data/case_line_is_option.py b/kiauh/core/submodules/simple_config_parser/tests/features/line_type_detection/data/case_line_is_option.py new file mode 100644 index 0000000..280e851 --- /dev/null +++ b/kiauh/core/submodules/simple_config_parser/tests/features/line_type_detection/data/case_line_is_option.py @@ -0,0 +1,30 @@ +testcases = [ + ("valid_option: value", True), + ("valid_option: value\n", True), + ("valid_option: value ; inline comment", True), + ("valid_option: value # inline comment", True), + ("valid_option: value # inline comment\n", True), + ("valid_option : value", True), + ("valid_option :value", True), + ("valid_option= value", True), + ("valid_option = value", True), + ("valid_option =value", True), + ("invalid_option:", False), + ("invalid_option=", False), + ("invalid_option:: value", False), + ("invalid_option :: value", False), + ("invalid_option ::value", False), + ("invalid_option== value", False), + ("invalid_option == value", False), + ("invalid_option ==value", False), + ("invalid_option:= value", False), + ("invalid_option := value", False), + ("invalid_option :=value", False), + ("[that_is_a_section]", False), + ("[that_is_section two]", False), + ("not_a_valid_option", False), + ("description: homing!", True), + ("description: inline macro :-)", True), + ("path: %GCODES_DIR%", True), + ("serial = /dev/serial/by-id/", True), +] diff --git a/kiauh/core/submodules/simple_config_parser/tests/features/line_type_detection/data/case_line_is_section.py b/kiauh/core/submodules/simple_config_parser/tests/features/line_type_detection/data/case_line_is_section.py new file mode 100644 index 0000000..663eabe --- /dev/null +++ b/kiauh/core/submodules/simple_config_parser/tests/features/line_type_detection/data/case_line_is_section.py @@ -0,0 +1,6 @@ +testcases = [ + ("[example_section]", True), + ("[example_section two]", True), + ("not_a_valid_section", False), + ("section: invalid", False), +] diff --git a/kiauh/core/submodules/simple_config_parser/tests/features/line_type_detection/test_line_type_detection.py b/kiauh/core/submodules/simple_config_parser/tests/features/line_type_detection/test_line_type_detection.py new file mode 100644 index 0000000..854fde7 --- /dev/null +++ b/kiauh/core/submodules/simple_config_parser/tests/features/line_type_detection/test_line_type_detection.py @@ -0,0 +1,37 @@ +import pytest +from data.case_line_is_comment import testcases as case_line_is_comment +from data.case_line_is_empty import testcases as case_line_is_empty +from data.case_line_is_multiline_option import ( + testcases as case_line_is_multiline_option, +) +from data.case_line_is_option import testcases as case_line_is_option +from data.case_line_is_section import testcases as case_line_is_section + +from src.simple_config_parser.simple_config_parser import SimpleConfigParser + + +@pytest.fixture +def parser(): + return SimpleConfigParser() + + +class TestLineTypeDetection: + @pytest.mark.parametrize("given, expected", [*case_line_is_section]) + def test_line_is_section(self, parser, given, expected): + assert parser._is_section(given) is expected + + @pytest.mark.parametrize("given, expected", [*case_line_is_option]) + def test_line_is_option(self, parser, given, expected): + assert parser._is_option(given) is expected + + @pytest.mark.parametrize("given, expected", [*case_line_is_multiline_option]) + def test_line_is_multiline_option(self, parser, given, expected): + assert parser._is_multiline_option(given) is expected + + @pytest.mark.parametrize("given, expected", [*case_line_is_comment]) + def test_line_is_comment(self, parser, given, expected): + assert parser._is_comment(given) is expected + + @pytest.mark.parametrize("given, expected", [*case_line_is_empty]) + def test_line_is_empty(self, parser, given, expected): + assert parser._is_empty_line(given) is expected diff --git a/kiauh/core/submodules/simple_config_parser/tests/features/public_api/test_public_api.py b/kiauh/core/submodules/simple_config_parser/tests/features/public_api/test_public_api.py new file mode 100644 index 0000000..10d86b1 --- /dev/null +++ b/kiauh/core/submodules/simple_config_parser/tests/features/public_api/test_public_api.py @@ -0,0 +1,196 @@ +import pytest + +from src.simple_config_parser.simple_config_parser import ( + DuplicateSectionError, + NoOptionError, + NoSectionError, + SimpleConfigParser, +) + + +@pytest.fixture +def parser(): + return SimpleConfigParser() + + +class TestPublicAPI: + def test_has_section(self, parser): + parser._all_sections = ["section1"] + assert parser.has_section("section1") is True + + @pytest.mark.parametrize("section", ["section1", "section2", "section three"]) + def test_add_section(self, parser, section): + parser.add_section(section) + + assert section in parser._all_sections + assert parser._all_options[section] == {} + + cfg_section = {"_raw": f"\n[{section}]\n", "body": []} + assert parser._config[section] == cfg_section + + @pytest.mark.parametrize("section", ["section1", "section2", "section three"]) + def test_add_existing_section(self, parser, section): + parser._all_sections = [section] + + with pytest.raises(DuplicateSectionError): + parser.add_section(section) + + assert parser._all_sections == [section] + + @pytest.mark.parametrize("section", ["section1", "section2", "section three"]) + def test_remove_section(self, parser, section): + parser.add_section(section) + parser.remove_section(section) + + assert section not in parser._all_sections + assert section not in parser._all_options + assert section not in parser._config + + @pytest.mark.parametrize("section", ["section1", "section2", "section three"]) + def test_remove_non_existing_section(self, parser, section): + with pytest.raises(NoSectionError): + parser.remove_section(section) + + def test_get_all_sections(self, parser): + parser.add_section("section1") + parser.add_section("section2") + parser.add_section("section three") + + assert parser.sections() == ["section1", "section2", "section three"] + + def test_has_option(self, parser): + parser.add_section("section1") + parser.set("section1", "option1", "value1") + + assert parser.has_option("section1", "option1") is True + + @pytest.mark.parametrize( + "section, option, value", + [ + ("section1", "option1", "value1"), + ("section2", "option2", "value2"), + ("section three", "option3", "value three"), + ], + ) + def test_set_new_option(self, parser, section, option, value): + parser.add_section(section) + parser.set(section, option, value) + + assert section in parser._all_sections + assert option in parser._all_options[section] + assert parser._all_options[section][option] == value + + assert parser._config[section]["body"][0]["is_multiline"] is False + assert parser._config[section]["body"][0]["option"] == option + assert parser._config[section]["body"][0]["value"] == value + assert parser._config[section]["body"][0]["_raw"] == f"{option}: {value}\n" + + def test_set_existing_option(self, parser): + section, option, value1, value2 = "section1", "option1", "value1", "value2" + + parser.add_section(section) + parser.set(section, option, value1) + parser.set(section, option, value2) + + assert parser._all_options[section][option] == value2 + assert parser._config[section]["body"][0]["is_multiline"] is False + assert parser._config[section]["body"][0]["option"] == option + assert parser._config[section]["body"][0]["value"] == value2 + assert parser._config[section]["body"][0]["_raw"] == f"{option}: {value2}\n" + + def test_set_new_multiline_option(self, parser): + section, option, value = "section1", "option1", "value1\nvalue2\nvalue3" + + parser.add_section(section) + parser.set(section, option, value) + + assert parser._config[section]["body"][0]["is_multiline"] is True + assert parser._config[section]["body"][0]["option"] == option + + values = ["value1", "value2", "value3"] + raw_values = [" value1\n", " value2\n", " value3\n"] + assert parser._config[section]["body"][0]["value"] == values + assert parser._config[section]["body"][0]["_raw"] == f"{option}:\n" + assert parser._config[section]["body"][0]["_raw_value"] == raw_values + assert parser._all_options[section][option] == values + + def test_set_option_of_non_existing_section(self, parser): + with pytest.raises(NoSectionError): + parser.set("section1", "option1", "value1") + + def test_remove_option(self, parser): + section, option, value = "section1", "option1", "value1" + + parser.add_section(section) + parser.set(section, option, value) + parser.remove_option(section, option) + + assert option not in parser._all_options[section] + assert option not in parser._config[section]["body"] + + def test_remove_non_existing_option(self, parser): + parser.add_section("section1") + with pytest.raises(NoOptionError): + parser.remove_option("section1", "option1") + + def test_remove_option_of_non_existing_section(self, parser): + with pytest.raises(NoSectionError): + parser.remove_option("section1", "option1") + + def test_get_option(self, parser): + parser.add_section("section1") + parser.add_section("section2") + parser.set("section1", "option1", "value1") + parser.set("section2", "option2", "value2") + parser.set("section2", "option3", "value two") + + assert parser.get("section1", "option1") == "value1" + assert parser.get("section2", "option2") == "value2" + assert parser.get("section2", "option3") == "value two" + + def test_get_option_of_non_existing_section(self, parser): + with pytest.raises(NoSectionError): + parser.get("section1", "option1") + + def test_get_option_of_non_existing_option(self, parser): + parser.add_section("section1") + with pytest.raises(NoOptionError): + parser.get("section1", "option1") + + def test_get_option_fallback(self, parser): + parser.add_section("section1") + assert parser.get("section1", "option1", "fallback_value") == "fallback_value" + + def test_get_options(self, parser): + parser.add_section("section1") + parser.set("section1", "option1", "value1") + parser.set("section1", "option2", "value2") + parser.set("section1", "option3", "value3") + + options = {"option1": "value1", "option2": "value2", "option3": "value3"} + assert parser.options("section1") == options + + def test_get_option_as_int(self, parser): + parser.add_section("section1") + parser.set("section1", "option1", "1") + + option = parser.getint("section1", "option1") + assert isinstance(option, int) is True + + def test_get_option_as_float(self, parser): + parser.add_section("section1") + parser.set("section1", "option1", "1.234") + + option = parser.getfloat("section1", "option1") + assert isinstance(option, float) is True + + @pytest.mark.parametrize( + "value", + ["True", "true", "on", "1", "yes", "False", "false", "off", "0", "no"], + ) + def test_get_option_as_boolean(self, parser, value): + parser.add_section("section1") + parser.set("section1", "option1", value) + + option = parser.getboolean("section1", "option1") + assert isinstance(option, bool) is True