diff options
38 files changed, 3093 insertions, 0 deletions
diff --git a/.gitignore.copy b/.gitignore.copy new file mode 100644 index 0000000..3f8c2f5 --- /dev/null +++ b/.gitignore.copy @@ -0,0 +1,11 @@ +.gitignore +main.py +*.swp +__pycache__ +*pyc +*pyo +*txt +*swp +*bak +*rej +*orig @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> + 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. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + 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 <https://www.gnu.org/licenses/>. + +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: + + <program> Copyright (C) <year> <name of author> + 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 +<https://www.gnu.org/licenses/>. + + 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 +<https://www.gnu.org/licenses/why-not-lgpl.html>. @@ -0,0 +1,12 @@ +Python 101 +========== + +This repository carries a series of exercices I did to learn Python. + +The subjects are not included from py00 to py05, after that, I tried to include +a Docstring that explains what the subject asked us, the students. + +License +------- + +See COPYING. diff --git a/py00/ex0/ft_hello_garden.py b/py00/ex0/ft_hello_garden.py new file mode 100644 index 0000000..9885c07 --- /dev/null +++ b/py00/ex0/ft_hello_garden.py @@ -0,0 +1,2 @@ +def ft_hello_garden(): + print("Hello, Garden Community!") diff --git a/py00/ex1/ft_garden_name.py b/py00/ex1/ft_garden_name.py new file mode 100644 index 0000000..a0259b5 --- /dev/null +++ b/py00/ex1/ft_garden_name.py @@ -0,0 +1,4 @@ +def ft_garden_name(): + var = input("Enter garden name: ") + print("Garden: " + var) + print("Status: Growing well!") diff --git a/py00/ex2/ft_plot_area.py b/py00/ex2/ft_plot_area.py new file mode 100644 index 0000000..1ea6d1a --- /dev/null +++ b/py00/ex2/ft_plot_area.py @@ -0,0 +1,6 @@ +def ft_plot_area(): + length = input("Enter length: ") + length = int(length) + width = input("Enter width: ") + width = int(width) + print("Plot area: ", length * width) diff --git a/py00/ex3/ft_harvest_total.py b/py00/ex3/ft_harvest_total.py new file mode 100644 index 0000000..d01db24 --- /dev/null +++ b/py00/ex3/ft_harvest_total.py @@ -0,0 +1,5 @@ +def ft_harvest_total(): + one = int(input("Day 1 harvest: ")) + two = int(input("Day 2 harvest: ")) + three = int(input("Day 3 harvest: ")) + print("Total harvest :", one + two + three) diff --git a/py00/ex4/ft_plant_age.py b/py00/ex4/ft_plant_age.py new file mode 100644 index 0000000..b2d645b --- /dev/null +++ b/py00/ex4/ft_plant_age.py @@ -0,0 +1,6 @@ +def ft_plant_age(): + age = int(input("Enter plant age in days: ")) + if age > 60: + print("Plant is ready to harvest!") + else: + print("Plant needs more time to grow.") diff --git a/py00/ex5/ft_water_reminder.py b/py00/ex5/ft_water_reminder.py new file mode 100644 index 0000000..2f456ed --- /dev/null +++ b/py00/ex5/ft_water_reminder.py @@ -0,0 +1,6 @@ +def ft_water_reminder(): + day = int(input("Days since last watering: ")) + if day > 2: + print("Water the plants!") + else: + print("Plants are fine") diff --git a/py00/ex6/ft_count_harvest_iterative.py b/py00/ex6/ft_count_harvest_iterative.py new file mode 100644 index 0000000..23c6657 --- /dev/null +++ b/py00/ex6/ft_count_harvest_iterative.py @@ -0,0 +1,5 @@ +def ft_count_harvest_iterative(): + count = int(input("Days until harvest: ")) + for i in range(1, count + 1, + 1): + print("Days ", i) + print("Harvest time!") diff --git a/py00/ex6/ft_count_harvest_recursive.py b/py00/ex6/ft_count_harvest_recursive.py new file mode 100644 index 0000000..f25372b --- /dev/null +++ b/py00/ex6/ft_count_harvest_recursive.py @@ -0,0 +1,14 @@ +def ft_print_days(days, count): + if days > 0: + print("Day:", count) + count += 1 + days -= 1 + ft_print_days(days, count) + else: + print("Harvest time!") + + +def ft_count_harvest_recursive(): + days = int(input("Days until harvest: ")) + count = 1 + ft_print_days(days, count) diff --git a/py00/ex7/ft_seed_inventory.py b/py00/ex7/ft_seed_inventory.py new file mode 100644 index 0000000..5c76e0e --- /dev/null +++ b/py00/ex7/ft_seed_inventory.py @@ -0,0 +1,10 @@ +def ft_seed_inventory(seed_type: str, quantity: int, unit: str) -> None: + seed_type = seed_type.capitalize() + if unit == "packets": + print(seed_type + " seeds: " + str(quantity) + " packets available") + elif unit == "grams": + print(seed_type + " seeds: " + str(quantity) + " grams total") + elif unit == "area": + print(seed_type + " seeds: covers " + str(quantity) + " square meters") + else: + print("Unknown unit type") diff --git a/py01/ex0/ft_garden_intro.py b/py01/ex0/ft_garden_intro.py new file mode 100755 index 0000000..a8f45b7 --- /dev/null +++ b/py01/ex0/ft_garden_intro.py @@ -0,0 +1,16 @@ +#!/usr/bin/env python3 + + +def ft_garden_name() -> None: + print("=== Welcome to My Garden ===") + name = "Rose" + height = "25cm" + age = "30 days" + print("Plant: " + name) + print("Height: " + height) + print("Age: " + age) + print("=== End of Program === ") + + +if __name__ == "__main__": + ft_garden_name() diff --git a/py01/ex1/ft_garden_data.py b/py01/ex1/ft_garden_data.py new file mode 100755 index 0000000..e5d8485 --- /dev/null +++ b/py01/ex1/ft_garden_data.py @@ -0,0 +1,35 @@ +#!/usr/bin/env python3 + + +# Create a class +class Plant: + def __init__(self: 'Plant', name: str, height: float, age: int) -> None: + self.name = name + self.height = height + self.age = age + +# Method to grow the age + def grow_age(self: 'Plant') -> None: + self.age += 1 + +# Method to grow the height + def grow_height(self: 'Plant') -> None: + self.height *= 1.04 + +# Method to show the plant information + def show(self: 'Plant') -> None: + print(self.name + ": " + str(round(self.height, 1)) + "cm, " + + str(self.age) + " days old") + + +print("=== Garden Plant Registry ===") + + +def ft_garden_data() -> None: + Params = [("Rose", 25, 30), ("Sunflower", 80, 45), ("Cactus", 15, 120)] + for param in Params: + Plant(*param).show() + + +if __name__ == "__main__": + ft_garden_data() diff --git a/py01/ex2/ft_plant_growth.py b/py01/ex2/ft_plant_growth.py new file mode 100755 index 0000000..c516181 --- /dev/null +++ b/py01/ex2/ft_plant_growth.py @@ -0,0 +1,41 @@ +#!/usr/bin/env python3 + +# Create a class +class Plant: + def __init__(self: 'Plant', name: str, height: float, age: int) -> None: + self.name_is = name + self.height_is = height + self.age_is = age + +# Method to grow the age + def age(self: 'Plant') -> None: + self.age_is += 1 + +# Method to grow the height + def grow(self: 'Plant') -> None: + self.height_is *= 1.04 + +# Method to show the plant information + def show(self: 'Plant') -> None: + print(f" {self.name_is}: {str(round(self.height_is, 1))}cm," + f"{str(self.age_is)} days old") + + +rose = Plant("Rose", 25, 30) + + +def ft_garden_growth(plant: Plant) -> None: + print("=== Garden Plant Growth ===") + plant.show() + start = plant.height_is + count = 7 + for i in range(1, count + 1): + print("=== Day " + str(i) + " ===") + plant.age() + plant.grow() + plant.show() + print("Growth this week: " + str(round(plant.height_is - start, 1)) + "cm") + + +if __name__ == "__main__": + ft_garden_growth(rose) diff --git a/py01/ex3/ft_plant_factory.py b/py01/ex3/ft_plant_factory.py new file mode 100755 index 0000000..15669af --- /dev/null +++ b/py01/ex3/ft_plant_factory.py @@ -0,0 +1,43 @@ +#!/usr/bin/env python3 + + +# Create a class +class Plant(): + + def __init__(self: 'Plant', name: str, height: float, age: int) -> None: + self.name_is = name + self.height_is = height + self.age_is = age + +# Method to grow the age + def age(self: 'Plant') -> None: + self.age_is += 1 + +# Method to grow the height + def height(self: 'Plant') -> None: + self.height_is *= 1.04 + +# Method to show the plant information + def show(self: 'Plant') -> None: + print(self.name_is + ": " + str(round(self.height_is, 1)) + "cm, " + + str(self.age_is) + " days old") + + +Params = [("Rose", 25, 30), + ("Oak", 200, 365), + ("Cactus", 5, 90), + ("Sunflower", 80, 45), + ("Fern", 15, 120)] + + +def ft_plant_factory() -> None: + print("=== Plant Factory Output ===") + for param in Params: + obj = Plant(param[0], param[1], param[2]) # instantiate the object + # obj = Plant(*param) # instantiate the object and unpack with * + print("Created: ", end='') + obj.show() + + +if __name__ == "__main__": + ft_plant_factory() diff --git a/py01/ex4/ft_garden_security.py b/py01/ex4/ft_garden_security.py new file mode 100755 index 0000000..ef983b9 --- /dev/null +++ b/py01/ex4/ft_garden_security.py @@ -0,0 +1,91 @@ +#!/usr/bin/env python3 + + +# Create a class +class Plant(): + + def __init__(self: 'Plant', name: str, height: float, age: int) -> None: + if age < 0: + print("Plant age cannot be negative.") + print("Plant age rejected.") + print("Plant age was set to 0.") + self.name_is = name + self._height_is = height + self._age_is = 0 + if height < 0: + print("Plant height cannot be negative.") + print("Plant height rejected.") + print("Plant height was set to 0.") + self.name_is = name + self._height_is = 0 + self._age_is = age + if height > 0 and age > 0: + self.name_is = name + self._height_is = height + self._age_is = age + +# Method to grow the age + def grow_age(self: 'Plant') -> None: + self._age_is += 1 + +# Method to grow the height + def grow_height(self: 'Plant') -> None: + self._height_is *= 1.04 + +# Getter methods to access private properties + def get_age(self: 'Plant') -> int: + return self._age_is + + def get_height(self: 'Plant') -> float: + return self._height_is + +# Setter methods to modify properties + def set_age(self: 'Plant', age: int) -> None: + if age > 0: + self._age_is = age + print("Plant age was updated.") + else: + print("Plant age cannot be negative.") + print("Plant age rejected.") + + def set_height(self: 'Plant', height: float) -> None: + if height > 0: + self._height_is = round(height) + print("Plant height was updated.") + else: + print("Plant height cannot be negative.") + print("Plant height rejected.") + +# Method to show the plant information + def show(self: 'Plant') -> None: + print(self.name_is + ": " + str(self.get_height()) + "cm, " + + str(self.get_age()) + " days old") + + +def ft_plant_security() -> None: + print("=== Garden Security System ===") + rose = Plant("Rose", -10, 5) + print("Plant created: ", end='') + rose.show() + print() + new_age = 10 + new_height = 50 + print(f"Trying to update height to {new_height} and age to {new_age}...") + print() + rose.set_height(new_height) + rose.set_age(new_age) + print() + print("Current state: ", end='') + rose.show() + print() + print("Updating height to 15 and age to 20...") + print() + rose.set_height(15) + rose.set_age(20) + print() + print("Current state: ", end='') + rose.show() + + +if __name__ == "__main__": + ft_plant_security() diff --git a/py01/ex5/ft_plant_types.py b/py01/ex5/ft_plant_types.py new file mode 100755 index 0000000..d306117 --- /dev/null +++ b/py01/ex5/ft_plant_types.py @@ -0,0 +1,131 @@ +#!/usr/bin/env python3 + +# Create a class +class Plant(): + + def __init__(self: 'Plant', name: str, height: float, age: int) -> None: + self.name_is = name + self._height_is = height + self._age_is = age + +# Method to grow the age + def age(self: 'Plant') -> None: + self._age_is += 1 + +# Method to grow the height + def grow(self: 'Plant') -> None: + self._height_is *= 1.02 + +# Getter methods to access private properties + def get_age(self: 'Plant') -> int: + return self._age_is + + def get_height(self: 'Plant') -> float: + return self._height_is + +# Setter methods to modify properties + def set_age(self: 'Plant', age: int) -> None: + if age > 0: + self._age_is = age + print("Plant age was updated.") + else: + print("Plant age cannot be negative.") + + def set_height(self: 'Plant', height: int) -> None: + if height > 0: + self._height_is = round(height) + print("Plant height was updated.") + else: + print("Plant height cannot be negative.") + +# Method to show the plant information + def show(self: 'Plant') -> None: + print(self.name_is + ": " + str(round(self.get_height(), 1)) + "cm, " + + str(self.get_age()) + " days old") + + +class Flower(Plant): + + def __init__(self: 'Flower', name: str, height: int, + age: int, color: str) -> None: + super(). __init__(name, height, age) + self.color_is = color + self.isblooming = 0 + + def bloom(self: 'Flower') -> None: + self.isblooming = 1 + + def show(self: 'Flower') -> None: + super().show() + print(f" Color: {self.color_is}") + if self.isblooming == 1: + print(self.name_is + " is blooming beautifully!") + else: + print(self.name_is + " has not bloomed yet") + + +class Tree(Plant): + + def __init__(self: 'Tree', name: str, height: int, age: int, + trunk_diameter: int) -> None: + super(). __init__(name, height, age) + self.trunk_diameter_is = trunk_diameter + self.is_producing_shade = 0 + + def produce_shade(self: 'Tree') -> None: + self.is_producing_shade = 1 + print(self.name_is + " now produces a shade of " + + str(self.get_height()) + + "cm long and " + + str(round(self.trunk_diameter_is, 1)) + + "cm wide.") + + def show(self: 'Tree') -> None: + super().show() + + print(f" Trunk diameter: {self.trunk_diameter_is}cm") + + +class Vegetable(Plant): + + def __init__(self: 'Vegetable', name: str, height: int, age: int, + harvest_season: str, nutritional_value: int) -> None: + super(). __init__(name, height, age) + self.harvest_season_is = harvest_season + self.nutritional_value_is = nutritional_value + + def update_nutritional_value(self: 'Vegetable') -> None: + self.nutritional_value_is = 20 + + def show(self: 'Vegetable') -> None: + super().show() + + print(f" Harvest season: {self.harvest_season_is}") + if self.get_age() >= 20: + self.update_nutritional_value() + print(f" Nutritional value: {self.nutritional_value_is}") + + +if __name__ == "__main__": + + print("=== Garden Plant Types ===") + print("=== Flower") + rose = Flower("Rose", 5, 15, "red") + rose.show() + print("[asking the rose to bloom]") + rose.bloom() + rose.show() + print("=== Tree") + oak = Tree("Oak", 200, 365, 5) + oak.show() + print("[asking the oak to produce shade]") + oak.produce_shade() + print("=== Vegetable") + tomato = Vegetable("Tomato", 5, 10, "April", 0) + tomato.show() + print("[make tomato grow and age for 20 days]") + for _ in range(20): + tomato.age() + tomato.grow() + tomato.update_nutritional_value() + tomato.show() diff --git a/py01/ex6/ft_garden_analytics.py b/py01/ex6/ft_garden_analytics.py new file mode 100755 index 0000000..8cd7ef0 --- /dev/null +++ b/py01/ex6/ft_garden_analytics.py @@ -0,0 +1,227 @@ +#!/usr/bin/env python3 + + +# Create a class +class Plant(): + + # Create attributes of class Plant + def __init__(self: 'Plant', name: str, height: float, age: int) -> None: + if not all([name, age, height]): + self.anon() + else: + self.name_is = name + self._height_is = height + self._age_is = age + # instantiating an object of Stat by append brackets to Stat + self.stat = self.Stat() + + # if None is passed as a parameter + def anon(self: 'Plant') -> None: + self.name_is = "Unknown plant" + self._height_is = 0 + self._age_is = 0 + self.stat = self.Stat() + +# Create a nested class + class Stat: + def __init__(self) -> None: + # objects attributes + self._age_counter = 0 + self._grow_counter = 0 + self._show_counter = 0 + self.produce_shade_counter = 0 + + def counter(self) -> None: + self._age_counter += 1 + self._grow_counter += 1 + self._show_counter += 1 + self.produce_shade_counter += 1 + + # Method to grow the age + def age(self: 'Plant') -> None: + self._age_is += 1 + self.stat._age_counter += 1 + +# Method to grow the height + def grow(self: 'Plant') -> None: + self._height_is *= 1.02 + self.stat._grow_counter += 1 + +# Getter methods to access private properties + def get_age(self: 'Plant') -> int: + return self._age_is + + def get_height(self: 'Plant') -> float: + return self._height_is + +# Setter methods to modify properties + def set_age(self: 'Plant', age: int) -> None: + if age > 0: + self._age_is = age + print("Plant age was updated.") + else: + print("Plant age cannot be negative.") + + def set_height(self: 'Plant', height: int) -> None: + if height > 0: + self._height_is = round(height) + print("Plant height was updated.") + else: + print("Plant height cannot be negative.") + + # static method does not take object + @staticmethod + def check_age(a) -> bool: + return a >= 365 + + # Method to show the plant information + def show(self: 'Plant') -> None: + print(f" {self.name_is}: {str(round(self.get_height(), 1))}cm," + f" {str(self.get_age())} days old") + self.stat._show_counter += 1 + + @classmethod + def create_anonymous(cls) -> 'Plant': + return cls("Unknown plant", 0, 0) + + +def show(stat) -> None: + print(f" Stats: {stat._grow_counter} grow,", + f"{stat._age_counter} age,", + f"{stat._show_counter} show") + + +class Flower(Plant): + + def __init__(self: 'Flower', name: str, height: int, + age: int, color: str) -> None: + super(). __init__(name, height, age) + # attributes + self.color = color + self.isblooming = 0 + + def bloom(self: 'Flower') -> None: + self.isblooming = 1 + + def show(self: 'Flower') -> None: + super().show() + print(f" Color: {self.color}") + if self.isblooming == 1: + print(f" {self.name_is} is blooming beautifully!") + else: + print(f" {self.name_is} has not bloomed yet") + + +class Seed(Flower): + def __init__(self: 'Seed', name: str, height: int, + age: int, color: str) -> None: + super(). __init__(name, height, age, color) + self.color = color + self.has_seed = 0 + + def show(self: 'Seed') -> None: + super().show() + if self.isblooming == 1: + self.has_seed = 42 + print(f" Seeds: {self.has_seed}") + else: + print(" Seeds: 0") + + +class Tree(Plant): + + def __init__(self: 'Tree', name: str, height: int, + age: int, trunk_diameter: int) -> None: + super(). __init__(name, height, age) + self.trunk_diameter = trunk_diameter + self.is_producing_shade = 0 + + def produce_shade(self: 'Tree') -> None: + self.is_producing_shade = 1 + self.stat.produce_shade_counter += 1 + print(f" {self.name_is} now produces a shade of,", + f"{str(self.get_height())}cm long", + f"and {str(round(self.trunk_diameter, 1))}cm wide.") + + def show(self: 'Tree') -> None: + super().show() + + print(f" Trunk diameter: {self.trunk_diameter}cm") + + def stats(self: 'Tree') -> None: + print(f" Stats: {self.stat._grow_counter} grow,", + f"{self.stat._age_counter} age,", + f"{self.stat._show_counter} show,", + f"{self.stat.produce_shade_counter} shade") + + +class Vegetable(Plant): + + def __init__(self: 'Vegetable', name: str, height: int, age: int, + harvest_season: int, nutritional_value: int) -> None: + super(). __init__(name, height, age) + self.harvest_season_is = harvest_season + self.nutritional_value_is = nutritional_value + + def update_nutritional_value(self: 'Vegetable') -> None: + self.nutritional_value_is = 20 + + def show(self: 'Vegetable') -> None: + super().show() + + print(f" Harvest season: {self.harvest_season_is}") + if self.get_age() >= 20: + self.update_nutritional_value() + print(f" Nutritional value: {self.nutritional_value_is}") + + +if __name__ == "__main__": + + print("=== Garden Statistics ===") + print("=== Check year-old") + rose = Flower("Rose", 5, 30, "red") + print(" Is 30 days more than a year?", + f"-> {Plant.check_age(30)}") + rose = Flower("Rose", 5, 400, "red") + print(" Is 400 days more than a year?", + f"-> {Plant.check_age(444)}") + print() + print("=== Flower") + rose = Flower("Rose", 5, 15, "red") + rose.show() + print(" [statistics for Rose]") + show(rose.stat) + print(" [asking the rose to grow and bloom]") + rose.bloom() + rose.grow() + rose.show() + print(" [statistics for Rose]") + show(rose.stat) + print() + oak = Tree("Oak", 200, 365, 5) + print("=== Tree") + oak.show() + print(" [statistics for Oak]") + oak.stats() + print(" [asking the oak to produce shade]") + oak.produce_shade() + print(" [statistics for Oak]") + oak.stats() + print() + print("=== Seed") + sunflower = Seed("Sunflower", 80, 45, "yellow") + sunflower.show() + print(" [statistics for Sunflower]") + show(sunflower.stat) + print(" [make sunflower grow, age and bloom]") + sunflower.grow() + sunflower.bloom() + sunflower.age() + sunflower.show() + show(sunflower.stat) + print() + print("=== Anonymous") + anonymous = Plant.create_anonymous() + anonymous.show() + print(" [statistics for Unknown plant]") + show(anonymous.stat) diff --git a/py02/ex0/ft_first_exception.py b/py02/ex0/ft_first_exception.py new file mode 100755 index 0000000..f0c7a7b --- /dev/null +++ b/py02/ex0/ft_first_exception.py @@ -0,0 +1,27 @@ +#!/usr/bin/env python3 +# https://docs.python.org/3/tutorial/errors.html#handling-exceptions + +def input_temperature(temp_str: str) -> int: + print(f" Input data is '{temp_str}'") + tested_value = test_temperature(temp_str) + return tested_value + + +def test_temperature(temp): + try: + temp = int(temp) + except ValueError as ve: + print(" Caught input_temperature error:", ve) + else: + print(f" Temperature is now {temp}°C") + return temp + + +if __name__ == "__main__": + print("=== Garden Temperature ===") + print() + input_temperature("25") + print() + input_temperature("abc") + print() + print(" All tests completed - program didn't crash!") diff --git a/py02/ex1/ft_raise_exception.py b/py02/ex1/ft_raise_exception.py new file mode 100755 index 0000000..7f33045 --- /dev/null +++ b/py02/ex1/ft_raise_exception.py @@ -0,0 +1,35 @@ +#!/usr/bin/env python3 +# https://docs.python.org/3/tutorial/errors.html#handling-exceptions + +def input_temperature(temp_str: str) -> int: + print(f" Input data is '{temp_str}'") + temp = test_temperature(temp_str) + return temp + + +def test_temperature(temp): + try: + temp = int(temp) + if temp > 40: + raise ValueError(f"{temp}°C is too hot for plants (max 40°C)") + elif temp < 0: + raise ValueError(f"{temp}°C is too cold for plants (min 0°C)") + except ValueError as ve: + print(" Caught input_temperature error:", ve) + else: + print(f" Temperature is now {temp}°C") + return temp + + +if __name__ == "__main__": + print("=== Garden Temperature ===") + print() + input_temperature("25") + print() + input_temperature("abc") + print() + input_temperature("100") + print() + input_temperature("-50") + print() + print(" All tests completed - program didn't crash!") diff --git a/py02/ex2/ft_different_errors.py b/py02/ex2/ft_different_errors.py new file mode 100755 index 0000000..cd64d5f --- /dev/null +++ b/py02/ex2/ft_different_errors.py @@ -0,0 +1,36 @@ +#!/usr/bin/env python3 +# https://docs.python.org/3/tutorial/errors.html#handling-exceptions + +def garden_operation(operation_number): + if operation_number == 0: + int("abc") + elif operation_number == 1: + 10 / 0 + elif operation_number == 2: + open("/file.txt") + elif operation_number == 3: + "string" + 3 + else: + print("Operation completed successfully") + + +def test_error_types(): + print("=== Garden Type Demo ===") + for i in range(5): + try: + print(f"Testing operation {i} ...") + garden_operation(i) + except ValueError as err: + print("Caught ValueError", err) + except ZeroDivisionError as err: + print("Caught ZeroDivisionError:", err) + except FileNotFoundError as err: + print("Caught FileNotFoundError:", err) + except TypeError as err: + print("Caught TypeError:", err) + print() + return print("All error types tested successfully!") + + +if __name__ == "__main__": + test_error_types() diff --git a/py02/ex3/ft_custom_errors.py b/py02/ex3/ft_custom_errors.py new file mode 100755 index 0000000..57d5a47 --- /dev/null +++ b/py02/ex3/ft_custom_errors.py @@ -0,0 +1,63 @@ +#!/usr/bin/env python3 + +class GardenError(Exception): + def __init__(self, message="Unknown plant error"): + self.message = message + # Why self.message; why not just 'message' + super().__init__(self.message) + + +class PlantError(GardenError): + pass + + +class WaterError(GardenError): + pass + + +def test_plant_error(veg_item): + if veg_item not in veg_list: + raise PlantError(f"The {veg_item} is not in the list!") + else: + print("The vegetale is in the list") + + +def test_water_error(level): + if level < 10: + raise WaterError("Not enough water in the tank!") + else: + print("We have enough water!") + + +def main(): + print("== Custom Garden Errors Demo") + print() + try: + print("Testing PlantError...") + test_plant_error("spinach") + except PlantError as err: + print("Caught PlantError:", err) + print() + try: + print("Testing WaterError...") + test_water_error(4) + except WaterError as err: + print("Caught WaterError:", err) + try: + print() + print("Testing catching all garden errors...") + test_plant_error("spinach") + except GardenError as err: + print("Caught GardenError:", err) + try: + test_water_error(4) + except GardenError as err: + print("Caught GardenError:", err) + finally: + print() + print("All custom error types work correctly!") + + +if __name__ == "__main__": + veg_list = ["carrot", "fennel", "sesame"] + main() diff --git a/py02/ex4/ft_finally_block.py b/py02/ex4/ft_finally_block.py new file mode 100755 index 0000000..b029636 --- /dev/null +++ b/py02/ex4/ft_finally_block.py @@ -0,0 +1,46 @@ +#!/usr/bin/env python3 + +class GardenError(Exception): + def __init__(self, message="Unknown plant error"): + self.message = message + # Why self.message; why not just 'message' + super().__init__(self.message) + + +class PlantError(GardenError): + pass + + +class WaterError(GardenError): + pass + + +def water_plant(plant): + if plant == plant.capitalize(): + print(f"Watering {plant}: [OK]") + else: + raise PlantError(f"Invalid plant name to water: '{plant}'") + + +def test_watering_system(plants): + print("Open watering system") + try: + for plant in plants: + water_plant(plant) + except PlantError as err: + print("Caught PlantError:", err) + print("...ending tests and returning to main") + finally: + print("Closing watering system") + + +if __name__ == "__main__": + print("=== Garden Watering System ===") + print() + print("Testing valid plants...") + test_watering_system(["Tomato", "Lettuce", "Carrots"]) + print() + print("Testing invalid plants...") + test_watering_system(["Tomato", "lettuce", "Carrots"]) + print() + print("Cleanup always happens, even with errors!") diff --git a/py03/ex0/ft_command_quest.py b/py03/ex0/ft_command_quest.py new file mode 100755 index 0000000..af568f5 --- /dev/null +++ b/py03/ex0/ft_command_quest.py @@ -0,0 +1,23 @@ +#!/usr/bin/env python3 +# print(str(sys.argv)) + +import sys + + +def print_argv(): + print(f"Program name: {sys.argv[0]}") + if not sys.argv[1:]: + print("No argument provided!") + else: + arg_received = len(sys.argv) - 1 + print(f"Arguments received: {arg_received}") + index = 1 + for arg in sys.argv[1:]: + print(f"Argument {index}: {arg}") + index += 1 + print(f"Total arguments: {len(sys.argv)}") + + +if __name__ == "__main__": + print("=== Command Quest ===") + print_argv() diff --git a/py03/ex1/ft_score_analytics.py b/py03/ex1/ft_score_analytics.py new file mode 100755 index 0000000..71210fb --- /dev/null +++ b/py03/ex1/ft_score_analytics.py @@ -0,0 +1,61 @@ +#!/usr/bin/env python3 + +import sys + + +def create_list(): + list_scores = [] + for arg in sys.argv[1:]: + try: + list_scores.append(int(arg)) + except ValueError: + print(f"Skipped '{arg}'") + if not list_scores: + for arg in sys.argv[1:]: + print(f"Invalid parameter: '{arg}'") + raise ValueError("No scores provided. Usage " + "./ft_score_analytics.py <score1> <score2> etc") + return list_scores + + +def check_argument_given(): + if not sys.argv[1:]: + raise ValueError("No scores provided. Usage " + "./ft_score_analytics.py <score1> <score2> etc") + + +def score_processed(list_scores): + print('Scores processed: ', list_scores) + + +def compute_total_score(scores): + total_score = 0 + for score in scores: + total_score += int(score) + return total_score + + +def score_analytics(scores): + score_processed(scores) + total_player = len(scores) + print(f'Total player: {total_player}') + total_score = compute_total_score(scores) + print(f'Total score: {total_score}') + average_score = total_score / total_player + print(f'Average score: {round(average_score, 2)}') + highest_score = max(scores) + print(f'Highest score: {highest_score}') + lowest_score = min(scores) + print(f'Lowest score: {lowest_score}') + score_range = max(scores) - min(scores) + print(f'Score range: {score_range}') + + +if __name__ == "__main__": + print('=== Player Score Analytics ===') + try: + check_argument_given() + scores = create_list() + score_analytics(scores) + except ValueError as err: + print(err) diff --git a/py03/ex2/ft_coordinate_system.py b/py03/ex2/ft_coordinate_system.py new file mode 100755 index 0000000..f0daea1 --- /dev/null +++ b/py03/ex2/ft_coordinate_system.py @@ -0,0 +1,61 @@ +#!/usr/bin/env python3 + +import math + + +class InvalidSyntax(Exception): + def __init__(self, message="Invalid syntax"): + self.message = message + super().__init__(self.message) + + +def get_player_pos(): + while True: + try: + pos = input("Enter new coordinates" + "as floats in format 'x, y, z': ") + split_pos = pos.split(',') + if len(split_pos) != 3: + raise InvalidSyntax() + try: + for element in split_pos: + float(element) + except ValueError: + print(f"Error on parameter '{element}':" + f"could not convert string to float '{element}'") + # break because of True loop + else: + break + except InvalidSyntax as err: + print(err) + return pos + + +def print_info_pos_one(pos): + split_pos: tuple[float, ...] = tuple((float(x) for x in pos.split(","))) + (x1, y1, z1) = split_pos + print(f"It includes: X={x1}, Y={y1}, Z={z1}") + x2 = y2 = z2 = 0 + distance_to_center = math.sqrt((x2-x1)**2 + (y2-y1)**2 + (z2-z1)**2) + print(f"Distance to the center: {round(distance_to_center, 4)}") + + +def compute_distance_btw_pos(str_one, str_two): + pos_one: tuple[float, ...] = tuple((float(x) for x in str_one.split(","))) + (x1, y1, z1) = pos_one + pos_two: tuple[float, ...] = tuple((float(x) for x in str_two.split(","))) + (x2, y2, z2) = pos_two + distance_btw_two = math.sqrt((x2-x1)**2 + (y2-y1)**2 + (z2-z1)**2) + print(f"Distance between the two sets of coordinates: " + f"{round(distance_btw_two, 4)}") + + +if __name__ == "__main__": + print("=== Game Coordinate System ===") + pos_one = get_player_pos() + print(f"Got a first tuple: ({pos_one})") + print_info_pos_one(pos_one) + print() + print("Get a second set of coordinates") + pos_two = get_player_pos() + compute_distance_btw_pos(pos_one, pos_two) diff --git a/py03/ex3/ft_achievement_tracker.py b/py03/ex3/ft_achievement_tracker.py new file mode 100755 index 0000000..81e9c15 --- /dev/null +++ b/py03/ex3/ft_achievement_tracker.py @@ -0,0 +1,94 @@ +#!/usr/bin/env python3 +# https://www.freecodecamp.org/learn/python-v9/review-dictionaries-and-sets/review-dictionaries-and-sets + +import random + + +class Player: + def __init__(self, name: str, achievements: set[str]): + self.name = name + self.achievements = achievements + + +def gen_player_achievements(player: str, achievements: set[str]): + pa = set() + list_ach = list(achievements) + for _ in range(9): + achievement = random.choice(list_ach) + pa.add(achievement) + return pa + + +if __name__ == "__main__": + print("=== Achievement Tracker System ===") + achievements = {'Crafting Genius', + 'World Savior', + 'Master Explorer', + 'Collector Supreme', + 'Untouchable', + 'Boss Slayer', + 'Strategist', + 'Unstoppable', + 'Speed Runner', + 'Survivor', + 'Treasure Hunter', + 'First Steps', + 'Sharp Mind'} + print() + black_for = '\033[0;30m' + pink_bak = '\033[48;5;205m' + stp_color = '\033[0m' + # print players' achievement(s) + players_list: list[str] = ['Alice', 'Bob', 'Charlie', 'Dylan'] + players = [] + i = 0 + for player in players_list: + players.append(Player(player, + gen_player_achievements(player, achievements))) + print(f"{black_for}{pink_bak}Player {players[i].name}:" + f"{stp_color} {players[i].achievements}") + i += 1 + print() + union = players[0].achievements.union(players[1].achievements, + players[2].achievements, + players[3].achievements) + print(f"{black_for}{pink_bak}All distinct achievements:" + f"{stp_color} {union}") + print() + common_achievements = players[0].achievements.intersection( + players[1].achievements, + players[2].achievements, + players[3].achievements) + print(f"{black_for}{pink_bak}Common achievements:" + f"{stp_color} {common_achievements}") + print() + # print players' unique achievement(s) + print("Only", players[0].name, "has: ", + players[0].achievements.difference(players[1].achievements, + players[2].achievements, + players[3].achievements)) + print("Only", players[1].name, "has: ", + players[1].achievements.difference(players[0].achievements, + players[2].achievements, + players[3].achievements)) + print("Only", players[2].name, "has: ", + players[2].achievements.difference(players[1].achievements, + players[0].achievements, + players[3].achievements)) + print("Only", players[3].name, "has: ", + players[3].achievements.difference(players[1].achievements, + players[2].achievements, + players[0].achievements)) + print() + # print what each player is missing + i = 0 + # iterate through the list of string + for player in players_list: + missing = set() + for key in achievements: + # check players' achievement in list of instances + if key not in players[i].achievements: + missing.add(key) + print(f"{black_for}{pink_bak}{players[i].name}" + f" is missing\033[0m {missing}") + i += 1 diff --git a/py03/ex4/ft_inventory_system.py b/py03/ex4/ft_inventory_system.py new file mode 100755 index 0000000..104652a --- /dev/null +++ b/py03/ex4/ft_inventory_system.py @@ -0,0 +1,83 @@ +#!/usr/bin/env python3 +# https://www.freecodecamp.org/learn/python-v9/review-dictionaries-and-sets/review-dictionaries-and-sets + +import sys + + +def ft(): + print("=== Inventory System Analysis ===") + # check for when there are no params given + if len(sys.argv) < 2: + print("Enter items following this format: <item_name>:<quantity>") + return + # initialize dictionary + inventory = {} + # init list to check for duplicates + seen = [] + for arg in sys.argv[1:]: + try: + item, quantity = arg.split(':') + # print redundant item.s + if item in seen: + print(f"Redundant item '{item}' - discaring") + else: + seen.append(item) + try: + # check that quantities are int + int(quantity) + if int(quantity) < 0: + raise ValueError("quantity cannot be negative") + except ValueError as err: + print(f"Quantity error for '{item}': {err}") + else: + # populate dict + inventory[item] = quantity + except ValueError: + print(f"Error - invalid parameter '{arg.rstrip()}'") + if arg == sys.argv[-1] and arg == sys.argv[1]: + return + # check for when there are many invalid param and no valid params + if not seen: + return + if not inventory: + return + print(f"Got inventory: {inventory}") + item_list = [] + for item in inventory.keys(): + item_list.append(item) + print(f"Item list: {item_list}") + total_quantity = 0 + for quantity in inventory.values(): + total_quantity += int(quantity) + print(f"Total quantity for the " + f"{len(inventory.values())} items: {total_quantity}") + # compute percentages + for key in inventory: + per_of_total = round(100 * (int(inventory[key]) / total_quantity), 1) + print(f"Item {key} represents {per_of_total}%") + # look for item with max quantity + max_value = 0 + max_key = item_list[0] + for key in inventory: + if max_value == 0: + max_value = int(inventory[key]) + if int(inventory[key]) > max_value: + max_value = int(inventory[key]) + max_key = key + print(f"Item most abundant: {max_key} with quantity {max_value}") + # look for item with min quantity + min_value = 0 + min_key = item_list[0] + for key in inventory: + if min_value == 0: + min_value = int(inventory[key]) + if int(inventory[key]) < min_value: + min_value = int(inventory[key]) + min_key = key + print(f"Item least abundant: {min_key} with quantity {min_value}") + inventory.update({'magic item': '1'}) + print(inventory) + + +if __name__ == "__main__": + ft() diff --git a/py03/ex5/ft_data_stream.py b/py03/ex5/ft_data_stream.py new file mode 100755 index 0000000..b2b0aa6 --- /dev/null +++ b/py03/ex5/ft_data_stream.py @@ -0,0 +1,50 @@ +#!/usr/bin/env python3 +# https://www.geeksforgeeks.org/python/how-to-yield-values-from-list-in-python/ + +import random + +players = ['john', 'yaya', 'elise', 'niko'] +actions = ['jump', 'walk', 'run', 'swim'] + + +def gen_event(players, actions): + player = random.choice(players) + action = random.choice(actions) + yield player, action + + +# print 1,000 events +for event in range(1000): + # gen_event() returns a 'generator' + g = gen_event(players, actions) + # create a tuple + event_tuple = tuple(next(g)) + # unpack the tuple + (player, action) = event_tuple + print(f"Event {event}: Player {player} did {action}") +print() + +# create a list of 10 tuples +events = [] +for i in range(10): + g = gen_event(players, actions) + event_tuple = tuple(next(g)) + events.append(event_tuple) +print(f"Build a list of 10 events: {events}") +print() + + +# consume list +def consume_event(events, nb_events): + for i in range(nb_events): + ran = random.choice(events) + events.remove(ran) + yield ran + + +nb_events = len(events) + + +for event in consume_event(events, nb_events): + print(f"Got event from list: {event}") + print(f"Remains in list: {events}") diff --git a/py03/ex6/ft_data_alchemist.py b/py03/ex6/ft_data_alchemist.py new file mode 100755 index 0000000..c1d5794 --- /dev/null +++ b/py03/ex6/ft_data_alchemist.py @@ -0,0 +1,33 @@ +#!/usr/bin/env python3 + +import random + +print("=== Game Data Alchemist ===") +mixed = ['Alice', 'bob', 'Charlie', 'dylan', + 'Emma', 'Gregory', 'john', 'kevin', 'Liam'] +print("Initial list of player:", mixed) +print() +all_cap = [name.capitalize() for name in mixed] +print("New list with all names capitalized", all_cap) +print() +cap_only = [name.capitalize() for name in mixed if name == name.title()] +print("New list of capitalized names only", cap_only) +print() +# for name in all_cap: +# score = random.randint(1,300) +# d[name] = score +d = {name: random.randint(1, 300) for name in all_cap} +print("Score dict;", d) +print() +total_score = sum(d[name] for name in d) +nb_names = len(all_cap) +average = round(total_score / nb_names, 2) +print("Score average is:", average) +print() +# ahigher = {} +# for name in d: +# if d[name] > average: +# ahigher[name] = d[name] +# print(ahigher) +higher = {name: d[name] for name in d if d[name] > average} +print("High scores:", higher) diff --git a/py04/ex0/ft_ancient_text.py b/py04/ex0/ft_ancient_text.py new file mode 100755 index 0000000..152c0a2 --- /dev/null +++ b/py04/ex0/ft_ancient_text.py @@ -0,0 +1,44 @@ +#!/usr/bin/env python3 + +import sys + + +def read_content() -> None: + file = None + try: + file = open(sys.argv[1]) + content = file.read() + print(f"Accessing file {sys.argv[1]}") + print("---") + print() + print(content) + except IndexError: + print("Usage: ft_ancient_text.py <file>") + except FileNotFoundError as e: + print(f"Error opening the file '{sys.argv[1]}':", e) + # trying to write when disk is full + # also catch permission errors + except OSError as e: + print(e) + # No permission to read or write + except PermissionError as e: + print(e) + # file encoded in a format other than UTF-8 + except UnicodeDecodeError as e: + print(e) + except IsADirectoryError as e: + print(e) + finally: + if file: + file.close() + print("---") + print(f"File '{sys.argv[1]}' closed.") + + +def main() -> None: + print("=== Cyber Archives Recovery ===") + read_content() + + +if __name__ == "__main__": + main() diff --git a/py04/ex1/ft_archive_creation.py b/py04/ex1/ft_archive_creation.py new file mode 100755 index 0000000..2ae1612 --- /dev/null +++ b/py04/ex1/ft_archive_creation.py @@ -0,0 +1,96 @@ +#!/usr/bin/env python3 + +import sys + + +def read_content() -> None: + file = None + try: + file = open(sys.argv[1]) + content = file.read() + print(f"Accessing file {sys.argv[1]}") + print("---") + print() + print(content) + except IndexError: + print("Usage: ft_ancient_text.py <file>") + except FileNotFoundError as e: + print(f"Error opening the file '{sys.argv[1]}':", e) + # trying to write when disk is full + # also catch permission errors + except OSError as e: + print(e) + # No permission to read or write + except PermissionError as e: + print(e) + # file encoded in a format other than UTF-8 + except UnicodeDecodeError as e: + print(e) + except IsADirectoryError as e: + print(e) + finally: + if file: + file.close() + print("---") + print(f"File '{sys.argv[1]}' closed.") + + +def new_perservation_protocol() -> None: + # give files a value so I can close them anyway + original_file = None + new_file = None + # create a list to store modified lines + data = [] + try: + original_file = open(sys.argv[1], 'r') + print("Transform data") + print("---") + for line in original_file: + line = line.rstrip('\n') + line = line + "#" + data.append(line) + print(line) + original_file.close() + new_file_name = input("Enter a new file name (or empty): ") + if not new_file_name: + print("Not saving data") + else: + print(f"Saving data to '{new_file_name}'") + new_file = open(new_file_name, 'w') + for line in data: + new_file.write(line) + new_file.write('\n') + print(f"Date saved in file '{new_file_name}'") + new_file.close() + except IndexError: + print("No file to copy") + except FileNotFoundError as e: + print(f"Error opening the file '{sys.argv[1]}':", e) + # trying to write when disk is full + # also catch permission errors + except OSError as e: + print(e) + # No permission to read or write + except PermissionError as e: + print(e) + # file encoded in a format other than UTF-8 + except UnicodeDecodeError as e: + print(e) + except IsADirectoryError as e: + print(e) + finally: + if original_file: + original_file.close() + if new_file: + new_file.close() + + +def main() -> None: + print("=== Cyber Archives Recovery & Preservation ===") + read_content() + print() + new_perservation_protocol() + + +if __name__ == "__main__": + main() diff --git a/py04/ex2/ft_stream_management.py b/py04/ex2/ft_stream_management.py new file mode 100755 index 0000000..4c2544b --- /dev/null +++ b/py04/ex2/ft_stream_management.py @@ -0,0 +1,102 @@ +#!/usr/bin/env python3 + +import sys + + +def read_content() -> None: + file = None + try: + file = open(sys.argv[1]) + content = file.read() + print(f"Accessing file {sys.argv[1]}") + print("---") + print() + print(content) + except IndexError: + print("[STDERR] Usage: ft_ancient_text.py <file>", file=sys.stderr) + except FileNotFoundError as e: + print(f"[STDERR] Error opening the file '{sys.argv[1]}':", + e, file=sys.stderr) + # trying to write when disk is full + # also catch permission errors + except OSError as e: + print("[STDERR]", e, file=sys.stderr) + # No permission to read or write + except PermissionError as e: + print("[STDERR]", e, file=sys.stderr) + # file encoded in a format other than UTF-8 + except UnicodeDecodeError as e: + print("[STDERR]", e, file=sys.stderr) + except IsADirectoryError as e: + print("[STDERR]", e, file=sys.stderr) + finally: + if file: + file.close() + print("---") + print(f"File '{sys.argv[1]}' closed.") + + +def new_preservation_protocol() -> None: + # give files a value so I can close them anyway + original_file = None + new_file = None + # create a list to store modified lines + data = [] + try: + original_file = open(sys.argv[1], 'r') + print("Transform data") + print("---") + for line in original_file: + line = line.rstrip('\n') + line = line + "#" + data.append(line) + print(line) + original_file.close() + sys.stdout.write("Enter a new file name (or empty): ") + # flush buffer + sys.stdout.flush() + new_file_name = sys.stdin.readline() + new_file_name = new_file_name.rstrip('\n') + if not new_file_name: + print("Not saving data") + else: + print(f"Saving data to '{new_file_name}'") + new_file = open(new_file_name, 'w') + for line in data: + new_file.write(line) + new_file.write('\n') + print(f"Date saved in file '{new_file_name}'") + new_file.close() + except IndexError: + print("[STDERR] No file to copy", file=sys.stderr) + except FileNotFoundError as e: + print(f"[STDERR] Error opening the file '{sys.argv[1]}':", + e, file=sys.stderr) + # trying to write when disk is full + # also catch permission errors + except OSError as e: + print("[STDERR]", e, file=sys.stderr) + # No permission to read or write + except PermissionError as e: + print("[STDERR]", e, file=sys.stderr) + # file encoded in a format other than UTF-8 + except UnicodeDecodeError as e: + print("[STDERR]", e, file=sys.stderr) + except IsADirectoryError as e: + print("[STDERR]", e, file=sys.stderr) + finally: + if original_file: + original_file.close() + if new_file: + new_file.close() + + +def main() -> None: + print("=== Cyber Archives Recovery & Preservation ===") + read_content() + print() + new_preservation_protocol() + + +if __name__ == "__main__": + main() diff --git a/py04/ex3/ft_vault_security.py b/py04/ex3/ft_vault_security.py new file mode 100755 index 0000000..3395a38 --- /dev/null +++ b/py04/ex3/ft_vault_security.py @@ -0,0 +1,48 @@ +#!/usr/bin/env python3 +# Create a function secure_archive() that provides safe access to any file for +# reading or writing. It returns a tuple (True|False, str) that indicates +# whether the operation #succeeded (the boolean) and provides the associated +# content (either the file’s contents or an error message). The function takes +# the following parameters: a mandatory file name, an optional int or str +# (your choice) that indicates the action to perform (read or write), and +# another optional string that contains the content to write to the file. +# https://docs.python.org/3/library/functions.html#repr + +def secure_archive(file: str, write=None, to_write=None) -> tuple[bool, str]: + try: + with open(file, "r") as f: + content = f.read() + if write is None: + return (True, content) + if write: + with open(file, "w") as f: + f.write(to_write) + return (True, to_write) + except FileNotFoundError as err: + content = f"{err}" + except PermissionError as err: + content = f"{err}" + except OSError as err: + content = f"{err}" + return (False, content) + + +def main() -> None: + to_write = "Content successfully write to file" + print("=== Cyber Archives Security ===") + print("Using 'secure archive' to read from a non-existent file:") + print(secure_archive("file_does_not_exist.txt")) + print() + print("Using 'secure archive' to read from accessible file:") + print(secure_archive("permission_issue.txt")) + print() + print("Using 'secure archive' to read a regular file:") + print(secure_archive("ancient_fragment.txt")) + print() + print("Using 'secure archive' to write content to file :") + # pass 1 to write + print(secure_archive("ancient_fragment.txt", 1, to_write)) + + +if __name__ == "__main__": + main() diff --git a/py05/ex0/data_processor.py b/py05/ex0/data_processor.py new file mode 100755 index 0000000..56166ac --- /dev/null +++ b/py05/ex0/data_processor.py @@ -0,0 +1,236 @@ +#!/usr/bin/env python3 + +from abc import ABC, abstractmethod +import typing +import sys + + +class DataProcessor(ABC): + def __init__(self, name: str) -> None: + self.storage: typing.List[typing.Any] = [] + self.rank: int = 0 + self.counter: int = 0 + self.name = name + + @abstractmethod + def validate(self, data: typing.Any) -> bool: + pass + + @abstractmethod + def ingest(self, data: typing.Any) -> None: + pass + + def output(self) -> tuple[int, str]: + # extract the oldest piece of data + # piece of data is removed + position = self.rank + self.rank += 1 + if isinstance(self.storage[0], dict): + entry = self.storage[0] + output_tuple: tuple = tuple(entry.values()) + to_return = (f"{output_tuple[0]}: {output_tuple[1]}") + self.storage.pop(0) + return position, to_return + to_return = self.storage[0] + self.storage.pop(0) + return position, to_return + + +class NumericProcessor(DataProcessor): + + def validate(self, data: int | float | typing.List[int | float]) -> bool: + try: + if isinstance(data, int): + self.counter += 1 + return True + elif isinstance(data, float): + self.counter += 1 + return True + elif isinstance(data, typing.List): + type_list = "yes" + for item in data: + self.counter += 1 + if not isinstance(item, int | float): + type_list = "no" + self.counter -= 1 + if type_list == "yes": + return True + else: + raise ValueError() + else: + raise ValueError() + except ValueError: + return False + + def ingest(self, data: int | float | typing.List[int | float]) -> None: + try: + if isinstance(data, typing.List): + for item in data: + if isinstance(item, int | float): + self.storage.append(item) + elif isinstance(data, int | float): + self.storage.append(data) + else: + raise ValueError() + except ValueError: + print("Improper numeric data", file=sys.stderr) + + +def is_number(s: str) -> bool: + try: + float(s) + return True + except (ValueError, TypeError): + return False + + +class TextProcessor(DataProcessor): + + def validate(self, data: str | typing.List[str]) -> bool: + try: + if isinstance(data, str): + if is_number(data): + raise ValueError() + else: + self.counter += 1 + return True + elif isinstance(data, typing.List): + for item in data: + if isinstance(item, str): + if is_number(item): + raise ValueError() + return False + elif isinstance(item, dict): + raise ValueError() + return False + else: + self.counter += 1 + if isinstance(item, dict): + raise ValueError() + return False + return True + else: + raise ValueError() + except ValueError: + return False + + def ingest(self, data: str | typing.List[str]) -> None: + try: + if isinstance(data, str): + self.storage.append(data) + elif isinstance(data, typing.List): + for item in data: + if is_number(item): + raise ValueError() + elif isinstance(item, dict): + raise ValueError() + else: + self.storage.append(item) + else: + raise ValueError() + except ValueError: + print("Improper text data", file=sys.stderr) + + +class LogProcessor(DataProcessor): + + def validate(self, data: dict | typing.List[dict]) -> bool: + try: + if isinstance(data, dict): + return True + if isinstance(data, typing.List): + for item in data: + if isinstance(item, dict): + self.counter += 1 + else: + raise ValueError() + return False + return True + else: + raise ValueError() + except ValueError: + return False + + def ingest(self, data: dict | typing.List[dict]) -> None: + try: + if isinstance(data, dict): + for item in data: + self.storage.append(item) + elif isinstance(data, typing.List): + for item in data: + if isinstance(item, dict): + self.storage.append(item) + else: + raise ValueError() + except ValueError: + print("Improper log data", file=sys.stderr) + + +def testNumericProcessor() -> None: + is_num = NumericProcessor("Numeric Processor") + test_num: typing.List = [42, 42.0, 'FortyTwo'] + for item in test_num: + print(f"Trying to validate input {item}: ", end='') + print(is_num.validate(item)) + print("Testing invalid ingestion of string 'foo' without prior validation") + print("Got exception: ", end='') + # flush buffer + sys.stdout.flush() + # will raise a mypy error + is_num.ingest('foo') + is_num.ingest([1, 2, 3, 4, 5]) + print(f"Processing data: {is_num.storage}") + print(f"Extracting {len(is_num.storage)} values...") + while is_num.storage: + position, value = is_num.output() + print(f"Numeric value {position} : {value}") + + +def testTextProcessor() -> None: + is_text = TextProcessor("Text Processor") + # test_text: typing.List = ['42', '42.0', 'FortyTwo', ['More', '43']] + test_text: typing.List = ['42', '42.0', 'FortyTwo'] + for item in test_text: + print(f"Trying to validate input {item}: ", end='') + print(is_text.validate(item)) + test_list_text: typing.List = ['Hello', 'Nexus', 'FortyTwo'] + print(f"Trying to validate '{test_list_text}': " + f"{is_text.validate(test_list_text)}") + is_text.ingest(test_list_text) + print(f"Processing data: {is_text.storage}") + print(f"Extracting {len(is_text.storage)} values...") + while is_text.storage: + position, value = is_text.output() + print(f"Text value {position} : {value}") + + +def testLogProcessor() -> None: + log = [{'log_level': 'NOTICE', + 'log_message': 'Connection to server'}, + {'log_level': 'ERROR', + 'log_message': 'Unauthorized access!!'}] + is_log = LogProcessor("Log Processor") + # will raise a mypy error + print(f"Trying to validate input 'Hello': {is_log.validate('Hello')}") + is_log.ingest(log) + print(f"Processing data: {is_log.storage}") + print(f"Extracting {len(is_log.storage)} values...") + while is_log.storage: + position, value = is_log.output() + print(f"Log entry {position} : {value}") + + +def main() -> None: + print("=== Code Nexus - Data Processor ===") + print("Testing Numeric Processor...") + testNumericProcessor() + print() + print("Testing Text Processor...") + testTextProcessor() + print() + print("Testing Log Processor...") + testLogProcessor() + + +if __name__ == "__main__": + main() diff --git a/py05/ex1/data_stream.py b/py05/ex1/data_stream.py new file mode 100755 index 0000000..b457a24 --- /dev/null +++ b/py05/ex1/data_stream.py @@ -0,0 +1,278 @@ +#!/usr/bin/env python3 + +from abc import ABC, abstractmethod +import typing +import sys + + +class DataProcessor(ABC): + def __init__(self, name: str) -> None: + self.storage: typing.List[typing.Any] = [] + self.rank: int = 0 + self.counter: int = 0 + self.name = name + + @abstractmethod + def validate(self, data: typing.Any) -> bool: + pass + + @abstractmethod + def ingest(self, data: typing.Any) -> None: + pass + + def output(self) -> tuple[int, str]: + # extract the oldest piece of data + # piece of data is removed + position = self.rank + self.rank += 1 + if isinstance(self.storage[0], dict): + entry = self.storage[0] + output_tuple: tuple = tuple(entry.values()) + to_return = (f"{output_tuple[0]}: {output_tuple[1]}") + self.storage.pop(0) + return position, to_return + to_return = self.storage[0] + self.storage.pop(0) + return position, to_return + + +class NumericProcessor(DataProcessor): + + def validate(self, data: int | float | typing.List[int | float]) -> bool: + try: + if isinstance(data, int): + self.counter += 1 + return True + elif isinstance(data, float): + self.counter += 1 + return True + elif isinstance(data, typing.List): + type_list = "yes" + for item in data: + self.counter += 1 + if not isinstance(item, int | float): + type_list = "no" + self.counter -= 1 + if type_list == "yes": + return True + else: + raise ValueError() + else: + raise ValueError() + except ValueError: + return False + + def ingest(self, data: int | float | typing.List[int | float]) -> None: + try: + if isinstance(data, typing.List): + for item in data: + if isinstance(item, int | float): + self.storage.append(item) + elif isinstance(data, int | float): + self.storage.append(data) + else: + raise ValueError() + except ValueError: + print("Improper numeric data", file=sys.stderr) + + +def is_number(s: str) -> bool: + try: + float(s) + return True + except (ValueError, TypeError): + return False + + +class TextProcessor(DataProcessor): + + def validate(self, data: str | typing.List[str]) -> bool: + try: + if isinstance(data, str): + if is_number(data): + raise ValueError() + else: + self.counter += 1 + return True + elif isinstance(data, typing.List): + for item in data: + if isinstance(item, str): + if is_number(item): + raise ValueError() + return False + else: + self.counter += 1 + if isinstance(item, dict): + raise ValueError() + return False + return True + else: + raise ValueError() + except ValueError: + return False + + def ingest(self, data: str | typing.List[str]) -> None: + try: + if isinstance(data, str): + self.storage.append(data) + elif isinstance(data, typing.List): + for item in data: + if is_number(item): + raise ValueError() + elif isinstance(item, dict): + raise ValueError() + else: + self.storage.append(item) + else: + raise ValueError() + except ValueError: + print("Improper text data", file=sys.stderr) + + +class LogProcessor(DataProcessor): + + def validate(self, data: dict | typing.List[dict]) -> bool: + try: + if isinstance(data, dict): + return True + if isinstance(data, typing.List): + for item in data: + if isinstance(item, dict): + self.counter += 1 + else: + raise ValueError() + return False + return True + else: + raise ValueError() + except ValueError: + return False + + def ingest(self, data: dict | typing.List[dict]) -> None: + try: + if isinstance(data, dict): + for item in data: + self.storage.append(item) + elif isinstance(data, typing.List): + for item in data: + if isinstance(item, dict): + self.storage.append(item) + else: + raise ValueError() + except ValueError: + print("Improper log data", file=sys.stderr) + + +class DataStream(): + def __init__(self) -> None: + self.processor: list = [] + self.counter: int = 0 + + def register_processor(self, proc: DataProcessor) -> None: + # method that allows you to register a new data processor to process + # the data stream. + self.processor.append(proc) + + def process_stream(self, stream: list[typing.Any]) -> None: + # method that will analyze each element of the list received as a + # parameter and send it to the appropriate registered data processor. + # Error messages will be printed if no data processor can handle an + # element + for item in stream: + try: + for processor in self.processor: + # route towards appropriate processors + if processor.validate(item): + processor.ingest(item) + # stop when appropriate processors is found + break + else: + raise ValueError() + except ValueError: + print(f"Data Stream Error - Can't process " + f"element in stream: {item}", file=sys.stderr) + + def print_processors_stats(self) -> None: + if self.processor == []: + print("No processor found, no data") + else: + for processor in self.processor: + remaining = len(processor.storage) + print(f"{processor.name}: total {processor.counter} items " + f"processed, remaining {remaining} on processor") + + def consume_processors(self, rm_1: int, rm_2: int, rm_3: int) -> None: + for processor in self.processor: + if processor.name == "Numeric Processor": + for _ in range(rm_1): + processor.output() + elif processor.name == "Text Processor": + for _ in range(rm_2): + processor.output() + elif processor.name == "Log Processor": + for _ in range(rm_3): + processor.output() + + +def main() -> None: + + # Create a test scenario that demonstrates the correct processing of a data + # stream. Display statistics on registered data processors, consume + # elements using the output method of each data processor and show updated + # statistics + + print("=== Code Nexus - Data Stream ===") + print() + print("Initialize Data Stream...") + print() + processors = DataStream() + print("=== DataStream statistic ===") + processors.print_processors_stats() + print() + # initialize processors + is_num = NumericProcessor("Numeric Processor") + print("Registering Numeric Processor") + print() + processors.register_processor(is_num) + batch_one = ['Hello world', + [3.14, -1, 2.71], + [{ + 'log_level': 'WARNING', + ' log_message': 'Telnet access! Use ssh instead' + }, + { + 'log_level': 'INFO', + 'log_message': 'User wil is connected' + }], + 42, + ['Hi', 'five']] + print(f"Sending first batch of data on stream: {batch_one}") + processors.process_stream(batch_one) + print() + print("=== DataStream statistic ===") + processors.print_processors_stats() + print() + print("Registering other data processors") + is_text = TextProcessor("Text Processor") + is_log = LogProcessor("Log Processor") + processors.register_processor(is_text) + processors.register_processor(is_log) + print() + print("Send the same batch again") + processors.process_stream(batch_one) + print() + print("=== DataStream statistic ===") + processors.print_processors_stats() + print() + consume_num = 3 + consume_text = 2 + consume_log = 1 + print(f"Consume some elements from the data processors:" + f" Numeric {consume_num}, Text {consume_text}, Log {consume_log}") + processors.consume_processors(consume_num, consume_text, consume_log) + print("=== DataStream statistic ===") + processors.print_processors_stats() + + +if __name__ == "__main__": + main() diff --git a/py05/ex2/data_pipeline.py b/py05/ex2/data_pipeline.py new file mode 100755 index 0000000..a558ac6 --- /dev/null +++ b/py05/ex2/data_pipeline.py @@ -0,0 +1,338 @@ +#!/usr/bin/env python3 +# +# "Briefing: Your task is to integrate work from past exercices into a complete +# data processing pipeline that demonstrates understanding of polymorphic +# concepts. Use your code from Exercise 1 and improve it in order to obtain a +# complete data pipeline. Your DataStream class already handles input streams. +# You need now to handle the output part of the pipeline. This will be achieved +# by using a plugin system for export classes, made export-compatible through +# duck typing." +# +# https://typing.python.org/en/latest/spec/protocol.html + +from abc import ABC, abstractmethod +import typing +import sys + + +class ExportPlugin(typing.Protocol): + + def process_output(self, data: list[tuple[int, str]]) -> None: + # The type of the data parameter is a list of tuples that matches the + # return value of the output method from the DataProcessor class. + # output CSV or JSON + # if list output as CSV + ... + + +class ExportCSV(ExportPlugin): + + def process_output(self, data: list[tuple[int, str]]) -> None: + i = 0 + print("CSV Output:") + for item in data: + print(data[i][1], end='') + if item is not data[-1]: + print(',', end='') + else: + print() + i += 1 + + +class ExportJSON(ExportPlugin): + + def process_output(self, data: list[tuple[int, str]]) -> None: + i = 0 + print("JSON Output:") + print("{", end='') + for item in data: + print(f"\"item_{data[i][0]}\": \"{data[i][1]}\"", end='') + if item is not data[-1]: + print(', ', end='') + else: + print(end='') + i += 1 + print("}") + + +class DataProcessor(ABC): + def __init__(self, name: str) -> None: + self.storage: typing.List[typing.Any] = [] + self.rank: int = 0 + self.counter: int = 0 + self.name = name + + @abstractmethod + def validate(self, data: typing.Any) -> bool: + pass + + @abstractmethod + def ingest(self, data: typing.Any) -> None: + pass + + def output(self) -> tuple[int, str]: + # extract the oldest piece of data + # piece of data is removed + position = self.rank + self.rank += 1 + if isinstance(self.storage[0], dict): + entry = self.storage[0] + output_tuple: tuple = tuple(entry.values()) + to_return = (f"{output_tuple[0]}: {output_tuple[1]}") + self.storage.pop(0) + return position, to_return + to_return = self.storage[0] + self.storage.pop(0) + return position, to_return + + +class NumericProcessor(DataProcessor): + + def validate(self, data: int | float | typing.List[int | float]) -> bool: + try: + if isinstance(data, int): + self.counter += 1 + return True + elif isinstance(data, float): + self.counter += 1 + return True + elif isinstance(data, typing.List): + type_list = "yes" + for item in data: + self.counter += 1 + if not isinstance(item, int | float): + type_list = "no" + self.counter -= 1 + if type_list == "yes": + return True + else: + raise ValueError() + else: + raise ValueError() + except ValueError: + return False + + def ingest(self, data: int | float | typing.List[int | float]) -> None: + try: + if isinstance(data, typing.List): + for item in data: + if isinstance(item, int | float): + self.storage.append(item) + elif isinstance(data, int | float): + self.storage.append(data) + else: + raise ValueError() + except ValueError: + print("Improper numeric data", file=sys.stderr) + + +def is_number(s: str) -> bool: + try: + float(s) + return True + except (ValueError, TypeError): + return False + + +class TextProcessor(DataProcessor): + + def validate(self, data: str | typing.List[str]) -> bool: + try: + if isinstance(data, str): + if is_number(data): + raise ValueError() + else: + self.counter += 1 + return True + elif isinstance(data, typing.List): + for item in data: + if isinstance(item, str): + if is_number(item): + raise ValueError() + return False + else: + self.counter += 1 + if isinstance(item, dict): + raise ValueError() + return False + return True + else: + raise ValueError() + except ValueError: + return False + + def ingest(self, data: str | typing.List[str]) -> None: + try: + if isinstance(data, str): + self.storage.append(data) + elif isinstance(data, typing.List): + for item in data: + if is_number(item): + raise ValueError() + elif isinstance(item, dict): + raise ValueError() + else: + self.storage.append(item) + else: + raise ValueError() + except ValueError: + print("Improper text data", file=sys.stderr) + + +class LogProcessor(DataProcessor): + + def validate(self, data: dict | typing.List[dict]) -> bool: + try: + if isinstance(data, dict): + return True + if isinstance(data, typing.List): + for item in data: + if isinstance(item, dict): + self.counter += 1 + else: + raise ValueError() + return False + return True + else: + raise ValueError() + except ValueError: + return False + + def ingest(self, data: dict | typing.List[dict]) -> None: + try: + if isinstance(data, dict): + for item in data: + self.storage.append(item) + elif isinstance(data, typing.List): + for item in data: + if isinstance(item, dict): + self.storage.append(item) + else: + raise ValueError() + except ValueError: + print("Improper log data", file=sys.stderr) + + +class DataStream(): + def __init__(self) -> None: + self.processor: list = [] + self.counter: int = 0 + + def register_processor(self, proc: DataProcessor) -> None: + # method that allows you to register a new data processor to process + # the data stream. + self.processor.append(proc) + + def process_stream(self, stream: list[typing.Any]) -> None: + # method that will analyze each element of the list received as a + # parameter and send it to the appropriate registered data processor. + # Error messages will be printed if no data processor can handle an + # element + for item in stream: + try: + for processor in self.processor: + # route towards appropriate processors + if processor.validate(item): + processor.ingest(item) + # stop when appropriate processors is found + break + else: + raise ValueError() + except ValueError: + print(f"Data Stream Error - Can't process " + f"element in stream: {item}", file=sys.stderr) + + def print_processors_stats(self) -> None: + if self.processor == []: + print("No processor found, no data") + else: + for processor in self.processor: + remaining = len(processor.storage) + print(f"{processor.name}: total {processor.counter} items " + f"processed, remaining {remaining} on processor") + + def output_pipeline(self, nb: int, plugin: ExportPlugin) -> None: + # method, to be used after calling process_stream, that will consume nb + # elements from all registered data processors and export them using + # the provided compatible plugin. + for processor in self.processor: + tmp = [] + for _ in range(nb): + # to make check whether there is something to output + if processor.storage: + tmp.append(processor.output()) + plugin.process_output(tmp) + + +def main() -> None: + + # Create a test scenario that demonstrates the correct processing of a data + # stream. Display statistics on registered data processors, consume + # elements using the output method of each data processor and show updated + # statistics + + print("=== Code Nexus - Data Pipeline ===") + print() + print("Initialize Data Stream...") + print() + processors = DataStream() + print("=== DataStream statistic ===") + processors.print_processors_stats() + print() + # initialize processors + is_num = NumericProcessor("Numeric Processor") + is_text = TextProcessor("Text Processor") + is_log = LogProcessor("Log Processor") + print("Registering Processors") + print() + processors.register_processor(is_num) + processors.register_processor(is_text) + processors.register_processor(is_log) + batch_one = ['Hello world', + [3.14, -1, 2.71], + [{ + 'log_level': 'WARNING', + ' log_message': 'Telnet access! Use ssh instead' + }, + { + 'log_level': 'INFO', + 'log_message': 'User wil is connected' + }], + 42, + ['Hi', 'five']] + print(f"Sending first batch of data on stream: {batch_one}") + processors.process_stream(batch_one) + print() + print("=== DataStream statistic ===") + processors.print_processors_stats() + print() + print("Send 3 processed data from each processor to a CSV plugin:") + PluginCSV = ExportCSV() + processors.output_pipeline(3, PluginCSV) + print() + print("=== DataStream statistic ===") + processors.print_processors_stats() + print() + batch_two = [21, + ['I love AI', 'LLMs are wonderful', 'Stay healthy'], + [{'log_level': ' ERROR', 'log_message': '500 server crash'}, + {'log_level': 'NOTICE', + 'log_message': 'Certificate expires in 10 days'}], + [32, 42, 64, 84, 128, 168], + 'World hello'] + print(f"Send another batch of data : {batch_two}") + processors.process_stream(batch_two) + print() + print("=== DataStream statistic ===") + processors.print_processors_stats() + print() + print("Send 5 processed data from each processor to a JSON plugin:") + PluginJSON = ExportJSON() + processors.output_pipeline(5, PluginJSON) + print() + print("=== DataStream statistic ===") + processors.print_processors_stats() + + +if __name__ == "__main__": + main() |