From cefd079ef2a39b8f43030b94b749f069ee18701e Mon Sep 17 00:00:00 2001 From: CoolCat467 <52022020+CoolCat467@users.noreply.github.com> Date: Sat, 24 Feb 2024 19:11:48 -0600 Subject: [PATCH] Move everything to seperate `extension` and `utils` modules Also add tests for utils --- src/idlealign.egg-info/PKG-INFO | 733 -------------------- src/idlealign.egg-info/SOURCES.txt | 11 - src/idlealign.egg-info/dependency_links.txt | 0 src/idlealign.egg-info/entry_points.txt | 2 - src/idlealign.egg-info/top_level.txt | 1 - src/idlealign/__init__.py | 565 +-------------- src/idlealign/extension.py | 334 +++++++++ src/idlealign/utils.py | 664 ++++++++++++++++++ tests/test_utils.py | 73 ++ 9 files changed, 1091 insertions(+), 1292 deletions(-) delete mode 100644 src/idlealign.egg-info/PKG-INFO delete mode 100644 src/idlealign.egg-info/SOURCES.txt delete mode 100644 src/idlealign.egg-info/dependency_links.txt delete mode 100644 src/idlealign.egg-info/entry_points.txt delete mode 100644 src/idlealign.egg-info/top_level.txt create mode 100644 src/idlealign/extension.py create mode 100644 src/idlealign/utils.py create mode 100644 tests/test_utils.py diff --git a/src/idlealign.egg-info/PKG-INFO b/src/idlealign.egg-info/PKG-INFO deleted file mode 100644 index e5eefdd..0000000 --- a/src/idlealign.egg-info/PKG-INFO +++ /dev/null @@ -1,733 +0,0 @@ -Metadata-Version: 2.1 -Name: idlealign -Version: 0.1.1 -Summary: Emacs Align by Regular Expression for IDLE -Author: CoolCat467 -License: GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU General Public License is a free, copyleft license for - software and other kinds of works. - - The licenses for most software and other practical works are designed - to take away your freedom to share and change the works. By contrast, - the GNU General Public License is intended to guarantee your freedom to - share and change all versions of a program--to make sure it remains free - software for all its users. We, the Free Software Foundation, use the - GNU General Public License for most of our software; it applies also to - any other work released this way by its authors. You can apply it to - your programs, too. - - When we speak of free software, we are referring to freedom, not - price. Our General Public Licenses are designed to make sure that you - have the freedom to distribute copies of free software (and charge for - them if you wish), that you receive source code or can get it if you - want it, that you can change the software or use pieces of it in new - free programs, and that you know you can do these things. - - To protect your rights, we need to prevent others from denying you - these rights or asking you to surrender the rights. Therefore, you have - certain responsibilities if you distribute copies of the software, or if - you modify it: responsibilities to respect the freedom of others. - - For example, if you distribute copies of such a program, whether - gratis or for a fee, you must pass on to the recipients the same - freedoms that you received. You must make sure that they, too, receive - or can get the source code. And you must show them these terms so they - know their rights. - - Developers that use the GNU GPL protect your rights with two steps: - (1) assert copyright on the software, and (2) offer you this License - giving you legal permission to copy, distribute and/or modify it. - - For the developers' and authors' protection, the GPL clearly explains - that there is no warranty for this free software. For both users' and - authors' sake, the GPL requires that modified versions be marked as - changed, so that their problems will not be attributed erroneously to - authors of previous versions. - - Some devices are designed to deny users access to install or run - modified versions of the software inside them, although the manufacturer - can do so. This is fundamentally incompatible with the aim of - protecting users' freedom to change the software. The systematic - pattern of such abuse occurs in the area of products for individuals to - use, which is precisely where it is most unacceptable. Therefore, we - have designed this version of the GPL to prohibit the practice for those - products. If such problems arise substantially in other domains, we - stand ready to extend this provision to those domains in future versions - of the GPL, as needed to protect the freedom of users. - - Finally, every program is threatened constantly by software patents. - States should not allow patents to restrict development and use of - software on general-purpose computers, but in those that do, we wish to - avoid the special danger that patents applied to a free program could - make it effectively proprietary. To prevent this, the GPL assures that - patents cannot be used to render the program non-free. - - The precise terms and conditions for copying, distribution and - modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of - works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this - License. Each licensee is addressed as "you". "Licensees" and - "recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work - in a fashion requiring copyright permission, other than the making of an - exact copy. The resulting work is called a "modified version" of the - earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based - on the Program. - - To "propagate" a work means to do anything with it that, without - permission, would make you directly or secondarily liable for - infringement under applicable copyright law, except executing it on a - computer or modifying a private copy. Propagation includes copying, - distribution (with or without modification), making available to the - public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other - parties to make or receive copies. Mere interaction with a user through - a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" - to the extent that it includes a convenient and prominently visible - feature that (1) displays an appropriate copyright notice, and (2) - tells the user that there is no warranty for the work (except to the - extent that warranties are provided), that licensees may convey the - work under this License, and how to view a copy of this License. If - the interface presents a list of user commands or options, such as a - menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work - for making modifications to it. "Object code" means any non-source - form of a work. - - A "Standard Interface" means an interface that either is an official - standard defined by a recognized standards body, or, in the case of - interfaces specified for a particular programming language, one that - is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other - than the work as a whole, that (a) is included in the normal form of - packaging a Major Component, but which is not part of that Major - Component, and (b) serves only to enable use of the work with that - Major Component, or to implement a Standard Interface for which an - implementation is available to the public in source code form. A - "Major Component", in this context, means a major essential component - (kernel, window system, and so on) of the specific operating system - (if any) on which the executable work runs, or a compiler used to - produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all - the source code needed to generate, install, and (for an executable - work) run the object code and to modify the work, including scripts to - control those activities. However, it does not include the work's - System Libraries, or general-purpose tools or generally available free - programs which are used unmodified in performing those activities but - which are not part of the work. For example, Corresponding Source - includes interface definition files associated with source files for - the work, and the source code for shared libraries and dynamically - linked subprograms that the work is specifically designed to require, - such as by intimate data communication or control flow between those - subprograms and other parts of the work. - - The Corresponding Source need not include anything that users - can regenerate automatically from other parts of the Corresponding - Source. - - The Corresponding Source for a work in source code form is that - same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of - copyright on the Program, and are irrevocable provided the stated - conditions are met. This License explicitly affirms your unlimited - permission to run the unmodified Program. The output from running a - covered work is covered by this License only if the output, given its - content, constitutes a covered work. This License acknowledges your - rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not - convey, without conditions so long as your license otherwise remains - in force. You may convey covered works to others for the sole purpose - of having them make modifications exclusively for you, or provide you - with facilities for running those works, provided that you comply with - the terms of this License in conveying all material for which you do - not control copyright. Those thus making or running the covered works - for you must do so exclusively on your behalf, under your direction - and control, on terms that prohibit them from making any copies of - your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under - the conditions stated below. Sublicensing is not allowed; section 10 - makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological - measure under any applicable law fulfilling obligations under article - 11 of the WIPO copyright treaty adopted on 20 December 1996, or - similar laws prohibiting or restricting circumvention of such - measures. - - When you convey a covered work, you waive any legal power to forbid - circumvention of technological measures to the extent such circumvention - is effected by exercising rights under this License with respect to - the covered work, and you disclaim any intention to limit operation or - modification of the work as a means of enforcing, against the work's - users, your or third parties' legal rights to forbid circumvention of - technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you - receive it, in any medium, provided that you conspicuously and - appropriately publish on each copy an appropriate copyright notice; - keep intact all notices stating that this License and any - non-permissive terms added in accord with section 7 apply to the code; - keep intact all notices of the absence of any warranty; and give all - recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, - and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to - produce it from the Program, in the form of source code under the - terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent - works, which are not by their nature extensions of the covered work, - and which are not combined with it such as to form a larger program, - in or on a volume of a storage or distribution medium, is called an - "aggregate" if the compilation and its resulting copyright are not - used to limit the access or legal rights of the compilation's users - beyond what the individual works permit. Inclusion of a covered work - in an aggregate does not cause this License to apply to the other - parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms - of sections 4 and 5, provided that you also convey the - machine-readable Corresponding Source under the terms of this License, - in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded - from the Corresponding Source as a System Library, need not be - included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any - tangible personal property which is normally used for personal, family, - or household purposes, or (2) anything designed or sold for incorporation - into a dwelling. In determining whether a product is a consumer product, - doubtful cases shall be resolved in favor of coverage. For a particular - product received by a particular user, "normally used" refers to a - typical or common use of that class of product, regardless of the status - of the particular user or of the way in which the particular user - actually uses, or expects or is expected to use, the product. A product - is a consumer product regardless of whether the product has substantial - commercial, industrial or non-consumer uses, unless such uses represent - the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, - procedures, authorization keys, or other information required to install - and execute modified versions of a covered work in that User Product from - a modified version of its Corresponding Source. The information must - suffice to ensure that the continued functioning of the modified object - code is in no case prevented or interfered with solely because - modification has been made. - - If you convey an object code work under this section in, or with, or - specifically for use in, a User Product, and the conveying occurs as - part of a transaction in which the right of possession and use of the - User Product is transferred to the recipient in perpetuity or for a - fixed term (regardless of how the transaction is characterized), the - Corresponding Source conveyed under this section must be accompanied - by the Installation Information. But this requirement does not apply - if neither you nor any third party retains the ability to install - modified object code on the User Product (for example, the work has - been installed in ROM). - - The requirement to provide Installation Information does not include a - requirement to continue to provide support service, warranty, or updates - for a work that has been modified or installed by the recipient, or for - the User Product in which it has been modified or installed. Access to a - network may be denied when the modification itself materially and - adversely affects the operation of the network or violates the rules and - protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, - in accord with this section must be in a format that is publicly - documented (and with an implementation available to the public in - source code form), and must require no special password or key for - unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this - License by making exceptions from one or more of its conditions. - Additional permissions that are applicable to the entire Program shall - be treated as though they were included in this License, to the extent - that they are valid under applicable law. If additional permissions - apply only to part of the Program, that part may be used separately - under those permissions, but the entire Program remains governed by - this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option - remove any additional permissions from that copy, or from any part of - it. (Additional permissions may be written to require their own - removal in certain cases when you modify the work.) You may place - additional permissions on material, added by you to a covered work, - for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you - add to a covered work, you may (if authorized by the copyright holders of - that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further - restrictions" within the meaning of section 10. If the Program as you - received it, or any part of it, contains a notice stating that it is - governed by this License along with a term that is a further - restriction, you may remove that term. If a license document contains - a further restriction but permits relicensing or conveying under this - License, you may add to a covered work material governed by the terms - of that license document, provided that the further restriction does - not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you - must place, in the relevant source files, a statement of the - additional terms that apply to those files, or a notice indicating - where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the - form of a separately written license, or stated as exceptions; - the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly - provided under this License. Any attempt otherwise to propagate or - modify it is void, and will automatically terminate your rights under - this License (including any patent licenses granted under the third - paragraph of section 11). - - However, if you cease all violation of this License, then your - license from a particular copyright holder is reinstated (a) - provisionally, unless and until the copyright holder explicitly and - finally terminates your license, and (b) permanently, if the copyright - holder fails to notify you of the violation by some reasonable means - prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is - reinstated permanently if the copyright holder notifies you of the - violation by some reasonable means, this is the first time you have - received notice of violation of this License (for any work) from that - copyright holder, and you cure the violation prior to 30 days after - your receipt of the notice. - - Termination of your rights under this section does not terminate the - licenses of parties who have received copies or rights from you under - this License. If your rights have been terminated and not permanently - reinstated, you do not qualify to receive new licenses for the same - material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or - run a copy of the Program. Ancillary propagation of a covered work - occurring solely as a consequence of using peer-to-peer transmission - to receive a copy likewise does not require acceptance. However, - nothing other than this License grants you permission to propagate or - modify any covered work. These actions infringe copyright if you do - not accept this License. Therefore, by modifying or propagating a - covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically - receives a license from the original licensors, to run, modify and - propagate that work, subject to this License. You are not responsible - for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an - organization, or substantially all assets of one, or subdividing an - organization, or merging organizations. If propagation of a covered - work results from an entity transaction, each party to that - transaction who receives a copy of the work also receives whatever - licenses to the work the party's predecessor in interest had or could - give under the previous paragraph, plus a right to possession of the - Corresponding Source of the work from the predecessor in interest, if - the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the - rights granted or affirmed under this License. For example, you may - not impose a license fee, royalty, or other charge for exercise of - rights granted under this License, and you may not initiate litigation - (including a cross-claim or counterclaim in a lawsuit) alleging that - any patent claim is infringed by making, using, selling, offering for - sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this - License of the Program or a work on which the Program is based. The - work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims - owned or controlled by the contributor, whether already acquired or - hereafter acquired, that would be infringed by some manner, permitted - by this License, of making, using, or selling its contributor version, - but do not include claims that would be infringed only as a - consequence of further modification of the contributor version. For - purposes of this definition, "control" includes the right to grant - patent sublicenses in a manner consistent with the requirements of - this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free - patent license under the contributor's essential patent claims, to - make, use, sell, offer for sale, import and otherwise run, modify and - propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express - agreement or commitment, however denominated, not to enforce a patent - (such as an express permission to practice a patent or covenant not to - sue for patent infringement). To "grant" such a patent license to a - party means to make such an agreement or commitment not to enforce a - patent against the party. - - If you convey a covered work, knowingly relying on a patent license, - and the Corresponding Source of the work is not available for anyone - to copy, free of charge and under the terms of this License, through a - publicly available network server or other readily accessible means, - then you must either (1) cause the Corresponding Source to be so - available, or (2) arrange to deprive yourself of the benefit of the - patent license for this particular work, or (3) arrange, in a manner - consistent with the requirements of this License, to extend the patent - license to downstream recipients. "Knowingly relying" means you have - actual knowledge that, but for the patent license, your conveying the - covered work in a country, or your recipient's use of the covered work - in a country, would infringe one or more identifiable patents in that - country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or - arrangement, you convey, or propagate by procuring conveyance of, a - covered work, and grant a patent license to some of the parties - receiving the covered work authorizing them to use, propagate, modify - or convey a specific copy of the covered work, then the patent license - you grant is automatically extended to all recipients of the covered - work and works based on it. - - A patent license is "discriminatory" if it does not include within - the scope of its coverage, prohibits the exercise of, or is - conditioned on the non-exercise of one or more of the rights that are - specifically granted under this License. You may not convey a covered - work if you are a party to an arrangement with a third party that is - in the business of distributing software, under which you make payment - to the third party based on the extent of your activity of conveying - the work, and under which the third party grants, to any of the - parties who would receive the covered work from you, a discriminatory - patent license (a) in connection with copies of the covered work - conveyed by you (or copies made from those copies), or (b) primarily - for and in connection with specific products or compilations that - contain the covered work, unless you entered into that arrangement, - or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting - any implied license or other defenses to infringement that may - otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or - otherwise) that contradict the conditions of this License, they do not - excuse you from the conditions of this License. If you cannot convey a - covered work so as to satisfy simultaneously your obligations under this - License and any other pertinent obligations, then as a consequence you may - not convey it at all. For example, if you agree to terms that obligate you - to collect a royalty for further conveying from those to whom you convey - the Program, the only way you could satisfy both those terms and this - License would be to refrain entirely from conveying the Program. - - 13. Use with the GNU Affero General Public License. - - Notwithstanding any other provision of this License, you have - permission to link or combine any covered work with a work licensed - under version 3 of the GNU Affero General Public License into a single - combined work, and to convey the resulting work. The terms of this - License will continue to apply to the part which is the covered work, - but the special requirements of the GNU Affero General Public License, - section 13, concerning interaction through a network will apply to the - combination as such. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of - the GNU General Public License from time to time. Such new versions will - be similar in spirit to the present version, but may differ in detail to - address new problems or concerns. - - Each version is given a distinguishing version number. If the - Program specifies that a certain numbered version of the GNU General - Public License "or any later version" applies to it, you have the - option of following the terms and conditions either of that numbered - version or of any later version published by the Free Software - Foundation. If the Program does not specify a version number of the - GNU General Public License, you may choose any version ever published - by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future - versions of the GNU General Public License can be used, that proxy's - public statement of acceptance of a version permanently authorizes you - to choose that version for the Program. - - Later license versions may give you additional or different - permissions. However, no additional obligations are imposed on any - author or copyright holder as a result of your choosing to follow a - later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY - APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT - HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY - OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, - THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR - PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM - IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF - ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING - WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS - THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY - GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE - USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF - DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD - PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), - EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF - SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided - above cannot be given local legal effect according to their terms, - reviewing courts shall apply local law that most closely approximates - an absolute waiver of all civil liability in connection with the - Program, unless a warranty or assumption of liability accompanies a - copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest - possible use to the public, the best way to achieve this is to make it - free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest - to attach them to the start of each source file to most effectively - state the exclusion of warranty; and each file should have at least - the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . - - Also add information on how to contact you by electronic and paper mail. - - If the program does terminal interaction, make it output a short - notice like this when it starts in an interactive mode: - - Copyright (C) - This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - - The hypothetical commands `show w' and `show c' should show the appropriate - parts of the General Public License. Of course, your program's commands - might be different; for a GUI interface, you would use an "about box". - - You should also get your employer (if you work as a programmer) or school, - if any, to sign a "copyright disclaimer" for the program, if necessary. - For more information on this, and how to apply and follow the GNU GPL, see - . - - The GNU General Public License does not permit incorporating your program - into proprietary programs. If your program is a subroutine library, you - may consider it more useful to permit linking proprietary applications with - the library. If this is what you want to do, use the GNU Lesser General - Public License instead of this License. But first, please read - . - -Project-URL: Homepage, https://github.com/CoolCat467/idlealign -Project-URL: Source, https://github.com/CoolCat467/idlealign -Project-URL: Bug Tracker, https://github.com/CoolCat467/idlealign/issues -Keywords: align,regex,idle,extension,development -Classifier: Development Status :: 4 - Beta -Classifier: Intended Audience :: Developers -Classifier: Programming Language :: Python :: 3 -Classifier: Programming Language :: Python :: 3.8 -Classifier: Programming Language :: Python :: 3.9 -Classifier: Programming Language :: Python :: 3.10 -Classifier: Programming Language :: Python :: 3.11 -Classifier: Programming Language :: Python :: 3 :: Only -Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3) -Classifier: Operating System :: OS Independent -Classifier: Framework :: IDLE -Classifier: Topic :: Utilities -Classifier: Typing :: Typed -Requires-Python: >=3.8 -Description-Content-Type: text/markdown -License-File: LICENSE -Provides-Extra: user -Requires-Dist: idleuserextend~=0.0.0; extra == "user" - -# IDLEAlign -Python IDLE extension to align code by a regular expression - - - -[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit) -[![code style: black](https://img.shields.io/badge/code_style-black-000000.svg)](https://github.com/psf/black) - - - -## Installation (Without root permissions) -1) Go to terminal and install with `pip install idlealign[user]`. -2) Run command `idleuserextend; idlealign`. You should see the following -output: `Config should be good! Config should be good!`. -3) Open IDLE, go to `Options` -> `Configure IDLE` -> `Extensions`. -If everything went well, alongside `ZzDummy` there should be and -option called `idlealign`. This is where you can configure how -idlealign works. - -## Installation (Legacy, needs root permission) -1) Go to terminal and install with `pip install idlealign`. -2) Run command `idlealign`. You will likely see a message saying -`idlealign not in system registered extensions!`. Run the command -given to add lintcheck to your system's IDLE extension config file. -3) Again run command `idlealign`. This time, you should see the following -output: `Config should be good!`. -4) Open IDLE, go to `Options` -> `Configure IDLE` -> `Extensions`. -If everything went well, alongside `ZzDummy` there should be and -option called `idlealign`. This is where you can configure if -idlealign is enabled or not. diff --git a/src/idlealign.egg-info/SOURCES.txt b/src/idlealign.egg-info/SOURCES.txt deleted file mode 100644 index e482774..0000000 --- a/src/idlealign.egg-info/SOURCES.txt +++ /dev/null @@ -1,11 +0,0 @@ -LICENSE -README.md -pyproject.toml -src/idlealign/__init__.py -src/idlealign/py.typed -src/idlealign.egg-info/PKG-INFO -src/idlealign.egg-info/SOURCES.txt -src/idlealign.egg-info/dependency_links.txt -src/idlealign.egg-info/entry_points.txt -src/idlealign.egg-info/requires.txt -src/idlealign.egg-info/top_level.txt diff --git a/src/idlealign.egg-info/dependency_links.txt b/src/idlealign.egg-info/dependency_links.txt deleted file mode 100644 index e69de29..0000000 diff --git a/src/idlealign.egg-info/entry_points.txt b/src/idlealign.egg-info/entry_points.txt deleted file mode 100644 index 968077f..0000000 --- a/src/idlealign.egg-info/entry_points.txt +++ /dev/null @@ -1,2 +0,0 @@ -[console_scripts] -idlealign = idlealign:check_installed diff --git a/src/idlealign.egg-info/top_level.txt b/src/idlealign.egg-info/top_level.txt deleted file mode 100644 index 3e6de9f..0000000 --- a/src/idlealign.egg-info/top_level.txt +++ /dev/null @@ -1 +0,0 @@ -idlealign diff --git a/src/idlealign/__init__.py b/src/idlealign/__init__.py index c4eb37f..106f185 100644 --- a/src/idlealign/__init__.py +++ b/src/idlealign/__init__.py @@ -4,564 +4,39 @@ from __future__ import annotations +# Copyright (C) 2022-2024 CoolCat467 +# +# 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 . + __title__ = "idlealign" __author__ = "CoolCat467" -__license__ = "GPLv3" +__license__ = "GNU General Public License Version 3" __version__ = "0.1.1" -import sys -from tkinter import BooleanVar, Event, Frame, TclError, Text, Tk, Variable -from tkinter.ttk import Checkbutton, Radiobutton -from typing import TYPE_CHECKING, Any, ClassVar, cast - -from idlelib import searchengine -from idlelib.config import idleConf -from idlelib.searchbase import SearchDialogBase - -if TYPE_CHECKING: - from re import Pattern - - from idlelib.pyshell import PyShellEditorWindow - -def get_required_config( - values: dict[str, str], - bind_defaults: dict[str, str], -) -> str: - """Get required configuration file data.""" - config = "" - # Get configuration defaults - settings = "\n".join( - f"{key} = {default}" for key, default in values.items() - ) - if settings: - config += f"\n[{__title__}]\n{settings}" - if bind_defaults: - config += "\n" - # Get key bindings data - settings = "\n".join( - f"{event} = {key}" for event, key in bind_defaults.items() - ) - if settings: - config += f"\n[{__title__}_cfgBindings]\n{settings}" - return config +from idlealign import utils +from idlealign.extension import idlealign as idlealign def check_installed() -> bool: """Make sure extension installed.""" - # Get list of system extensions - extensions = set(idleConf.defaultCfg["extensions"]) - - # Do we have the user extend extension? - has_user = "idleuserextend" in idleConf.GetExtensions(active_only=True) - - # If we don't, things get messy and we need to change the root config file - ex_defaults = idleConf.defaultCfg["extensions"].file - if has_user: - # Otherwise, idleuserextend patches IDLE and we only need to modify - # the user config file - ex_defaults = idleConf.userCfg["extensions"].file - extensions |= set(idleConf.userCfg["extensions"]) - - # Import this extension (this file), - module = __import__(__title__) - - # Get extension class - if not hasattr(module, __title__): - print( - f"ERROR: Somehow, {__title__} was installed improperly, " - f"no {__title__} class found in module. Please report " - "this on github.", - file=sys.stderr, - ) - sys.exit(1) - - cls = getattr(module, __title__) - - # Get extension class keybinding defaults - required_config = get_required_config( - getattr(cls, "values", {}), - getattr(cls, "bind_defaults", {}), - ) - - # If this extension not in there, - if __title__ not in extensions: - # Tell user how to add it to system list. - print(f"{__title__} not in system registered extensions!") - print( - f"Please run the following command to add {__title__} " - + "to system extensions list.\n", - ) - # Make sure line-breaks will go properly in terminal - add_data = required_config.replace("\n", "\\n") - # Tell them the command - append = "| sudo tee -a" - if has_user: - append = ">>" - print(f"echo -e '{add_data}' {append} {ex_defaults}\n") - else: - print(f"Configuration should be good! (v{__version__})") - return True - return False - - -def ensure_section_exists(section: str) -> bool: - """Ensure section exists in user extensions configuration. - - Returns True if edited. - """ - if section not in idleConf.GetSectionList("user", "extensions"): - idleConf.userCfg["extensions"].AddSection(section) - return True - return False - - -def ensure_values_exist_in_section( - section: str, - values: dict[str, str], -) -> bool: - """For each key in values, make sure key exists. Return if edited. - - If not, create and set to value. - """ - need_save = False - for key, default in values.items(): - value = idleConf.GetOption( - "extensions", - section, - key, - warn_on_default=False, - ) - if value is None: - idleConf.SetOption("extensions", section, key, default) - need_save = True - return need_save - - -def get_search_engine_params( - engine: searchengine.SearchEngine, -) -> dict[str, str | bool]: - """Get current search engine parameters.""" - return { - name: getattr(engine, f"{name}var").get() - for name in ("pat", "re", "case", "word", "wrap", "back") - } - - -def set_search_engine_params( - engine: searchengine.SearchEngine, - data: dict[str, str | bool], -) -> None: - """Get current search engine parameters.""" - for name in ("pat", "re", "case", "word", "wrap", "back"): - if name in data: - getattr(engine, f"{name}var").set(data[name]) - - -class AlignDialog(SearchDialogBase): # type: ignore[misc] - """Dialog for aligning by a pattern in text.""" - - __slots__ = ( - "insert_tags", - "align_side_var", - "extension", - "prev_search_params", - "space_wrap_var", - "search_params", - "global_search_params", - ) - title = "Align Dialog" - icon = "Align" - needwrapbutton = False - - def __init__( - self, - root: Tk, - engine: searchengine.SearchEngine, - extension: idlealign, - ) -> None: - """Create search dialog for aligning text. - - Uses SearchDialogBase as the basis for the GUI and a - searchengine instance to prepare the search. - - Attributes - ---------- - space_wrap_var: BooleanVar of if the align text should be wrapped with spaces - insert_tags: Optional string of tags for text insert - extension: Extension class - prev_search_params: Dictionary of search parameters before opening window - - """ - super().__init__(root, engine) - self.insert_tags: str | list[str] | tuple[str, ...] = () - - self.space_wrap_var = BooleanVar( - root, - True, - ) # Space wrap alignment pattern? - self.align_side_var = BooleanVar(root, False) # Alignment side var - - self.extension = extension - - self.global_search_params: dict[str, str | bool] - self.search_params: dict[str, str | bool] = { - "wrap": False, - "back": False, - } - - def load_prefs(self) -> None: - """Load search engine preferences.""" - self.global_search_params = get_search_engine_params(self.engine) - set_search_engine_params(self.engine, self.search_params) - - def store_prefs(self) -> None: - """Restore global search engine preferences.""" - self.search_params = get_search_engine_params(self.engine) - set_search_engine_params(self.engine, self.global_search_params) - - def open( - self, - searchphrase: str | None = None, - insert_tags: str | list[str] | tuple[str, ...] = (), - ) -> None: - """Make dialog visible on top of others and ready to use. - - Also, highlight the currently selected text. - - Arguments: - --------- - searchphrase: Search phrase to look for or existing phrase. - insert_tags: Tags to use when inserting text. - - """ - self.load_prefs() - - text = self.extension.text - - try: - first = text.index("sel.first") - except TclError: - first = None - try: - last = text.index("sel.last") - except TclError: - last = None - first = first or text.index("insert") - last = last or first - - super().open(text, searchphrase) - - self.extension.show_hit(first, last) - - self.insert_tags = insert_tags - - def close(self, event: Event[Any] | None = None) -> None: - """Close the dialog and remove hit tags.""" - super().close(event) - - # Restore global search engine preferences - self.store_prefs() - - self.extension.hide_hit() - self.insert_tags = () - - def create_option_buttons( - self, - ) -> tuple[Frame, list[tuple[Variable, str]]]: - """Create option buttons.""" - frame: Frame - base_options: list[tuple[Variable, str]] - frame, base_options = super().create_option_buttons() - options = [(self.space_wrap_var, "Space wrap")] - for var, label in options: - btn = Checkbutton(frame, variable=var, text=label) - btn.pack(side="left", fill="both") - base_options.append((var, label)) - return frame, base_options - - def create_other_buttons(self) -> tuple[Frame, list[tuple[bool, str]]]: - """Override so Search Direction is instead Alignment Side.""" - frame = self.make_frame("Alignment Side")[0] - var = self.align_side_var - others = [(False, "Left"), (True, "Right")] - for val, label in others: - btn = Radiobutton(frame, variable=var, value=val, text=label) - btn.pack(side="left", fill="both") - return frame, others - - def create_command_buttons(self) -> None: - """Create command buttons.""" - super().create_command_buttons() - self.make_button("Align", self.default_command, isdef=True) - - def default_command(self, event: Event[Any] | None = None) -> bool: - """Handle align again as the default command.""" - if not self.engine.getpat(): - self.open() - return False - - pattern = self.engine.getprog() - if not pattern: - return False - - space_wrap: bool = self.space_wrap_var.get() - align_side: bool = self.align_side_var.get() - - close = self.extension.align_selected( - pattern, - space_wrap, - align_side, - self.insert_tags, - ) - - if close: - # Close window - self.close() - else: - # Ring bell because something went wrong - self.bell() - return close - - -def get_whole_line(selection: str, add: int = 0) -> str: - """Get whole line of selection and add to line number.""" - line = searchengine.get_line_col(selection)[0] - return f"{line + add}.0" - - -# Important weird: If event handler function returns 'break', -# then it prevents other bindings of same event type from running. -# If returns None, normal and others are also run. - - -class idlealign: # noqa: N801 # Class name must match extension module name - """Add comments from mypy to an open program.""" - - __slots__ = ("editwin", "text") - # Extend the file and format menus. - menudefs: ClassVar = [ - ("format", [("Align Selection", "<>")]), - ] - # Default values for configuration file - values: ClassVar = { - "enable": "True", - "enable_editor": "True", - "enable_shell": "False", - } - # Default key binds for configuration file - bind_defaults: ClassVar = { - "align-selection": "", - } - - def __init__(self, editwin: PyShellEditorWindow) -> None: - """Initialize the settings for this extension.""" - self.editwin = editwin - self.text: Text = editwin.text - - @property - def window(self) -> AlignDialog: - """Window for current text widget.""" - return self.create_window() - - @classmethod - def ensure_bindings_exist(cls) -> bool: - """Ensure key bindings exist in user extensions configuration. - - Return True if need to save. - """ - if not cls.bind_defaults: - return False - - need_save = False - section = f"{cls.__name__}_cfgBindings" - if ensure_section_exists(section): - need_save = True - if ensure_values_exist_in_section(section, cls.bind_defaults): - need_save = True - return need_save - - @classmethod - def ensure_config_exists(cls) -> bool: - """Ensure required configuration exists for this extension. - - Return True if need to save. - """ - need_save = False - if ensure_section_exists(cls.__name__): - need_save = True - if ensure_values_exist_in_section(cls.__name__, cls.values): - need_save = True - return need_save - - @classmethod - def reload(cls) -> None: - """Load class variables from configuration.""" - # Ensure file default values exist so they appear in settings menu - save = cls.ensure_config_exists() - if cls.ensure_bindings_exist() or save: - idleConf.SaveUserCfgFiles() - - # Reload configuration file - idleConf.LoadCfgFiles() - - # For all possible configuration values - for key, default in cls.values.items(): - # Set attribute of key name to key value from configuration file - if key not in {"enable", "enable_editor", "enable_shell"}: - value = idleConf.GetOption( - "extensions", - cls.__name__, - key, - default=default, - ) - setattr(cls, key, value) - - def create_window(self) -> AlignDialog: - """Create align dialog window.""" - root: Tk - root = self.text._root() # type: ignore[attr-defined] - - engine: searchengine.SearchEngine = searchengine.get(root) - - if not hasattr(engine, "_aligndialog"): - engine._aligndialog = AlignDialog(root, engine, self) - return cast(AlignDialog, engine._aligndialog) - - def show_hit(self, first: str, last: str) -> None: - """Highlight text between first and last indices. - - Text is highlighted via the 'hit' tag and the marked - section is brought into view. - - The colors from the 'hit' tag aren't currently shown - when the text is displayed. This is due to the 'sel' - tag being added first, so the colors in the 'sel' - configuration are seen instead of the colors for 'hit'. - """ - text = self.text - text.mark_set("insert", first) - text.tag_remove("sel", "1.0", "end") - text.tag_add("sel", first, last) - text.tag_remove("hit", "1.0", "end") - if first == last: - text.tag_add("hit", first) - else: - text.tag_add("hit", first, last) - text.see("insert") - text.update_idletasks() - - def hide_hit(self) -> None: - """Hide hit after show_hit.""" - self.text.tag_remove("hit", "1.0", "end") - - def align_selected( - self, - pattern: Pattern[str], - space_wrap: bool = True, - align_side: bool = False, - tags: str | list[str] | tuple[str, ...] = (), - ) -> bool: - """Align selected text by pattern. Side False == left. - - Return True if should close window. - """ - # Get start and end from selection, both are strings of {line}.{col} - select_start, select_end = searchengine.get_selection(self.text) - - # Get full first line till one past end line from selection - select_start = get_whole_line(select_start) - grab_end = get_whole_line(select_end, 1) - - # Get the characters from full line selection - chars: str = self.text.get(select_start, grab_end) - - # Split lines - lines = chars.splitlines() - # Keeping track of lines to modify - line_data: dict[int, tuple[str, str]] = {} - - # Finding min width excluding spaces of all lines till start of align pattern - sec_start = 0 - for idx, line in enumerate(lines): - # Regular expression match - match = pattern.search(line) - - if match is None: # If align pattern not in line, skip line - continue - - # Get the where alignment pattern starts and ends at - start, end = match.span() - - prefix = line[:start] - align = line[start:end] - suffix = line[end:] - - # If space wrap is set, wrap alignment text with spaces - if space_wrap: - align = f" {align} " - - if not align_side: # If align to left side - # Strip trailing spaces before align but keep indent - prefix = prefix.rstrip() - suffix = align + suffix.strip() # Strip extra spaces - else: # If align to right side - prefix += align.lstrip() - suffix = suffix.lstrip() - - line_data[idx] = (prefix, suffix) # Remember after we get max - - sec_start = max(sec_start, len(prefix)) # Update max - - if not line_data: - # There are no lines with selected pattern so stop - return False - - changed = False - # For each line selected that had align pattern, add or remove - # spaces from start up to pattern so each pattern starts in the same column - for key, value in line_data.items(): - prefix, suffix = value - - new = prefix.ljust(sec_start) + suffix - - if lines[key] != new: - changed = True - lines[key] = new - - if not changed: - # There was no change so stop - return False - - # Add extra blank line because of how insert works - lines.append("") - # Re-get characters to set - chars = "\n".join(lines) - - # This is all one operation - self.text.undo_block_start() # type: ignore[attr-defined] - - # Replace old text with new aligned text - self.text.delete(select_start, grab_end) - self.text.insert(select_start, chars, tags) - - self.text.undo_block_stop() # type: ignore[attr-defined] - - # Select modified area - self.show_hit(select_start, select_end) - return True - - def align_selection_event(self, event: Event[Any] | None) -> str: - """Align selected text.""" - # pylint: disable=unused-argument - self.reload() - - self.window.open() - return "break" + return utils.check_installed(__title__, __version__, idlealign) idlealign.reload() + if __name__ == "__main__": print(f"{__title__} v{__version__}\nProgrammed by {__author__}.\n") check_installed() diff --git a/src/idlealign/extension.py b/src/idlealign/extension.py new file mode 100644 index 0000000..9aa18e2 --- /dev/null +++ b/src/idlealign/extension.py @@ -0,0 +1,334 @@ +"""Idle Align - Emacs Align by Regular Expression as an IDLE Extension.""" + +# Programmed by CoolCat467 + +from __future__ import annotations + +# Copyright (C) 2022-2024 CoolCat467 +# +# 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 . + +__title__ = "extension" +__author__ = "CoolCat467" +__license__ = "GNU General Public License Version 3" + +from tkinter import BooleanVar, Event, Frame, Tk, Variable +from tkinter.ttk import Checkbutton, Radiobutton +from typing import TYPE_CHECKING, Any, ClassVar, cast + +from idlelib import searchengine +from idlelib.searchbase import SearchDialogBase + +from idlealign import utils + +if TYPE_CHECKING: + from re import Pattern + + +class AlignDialog(SearchDialogBase): # type: ignore[misc] + """Dialog for aligning by a pattern in text.""" + + __slots__ = ( + "insert_tags", + "align_side_var", + "extension", + "prev_search_params", + "space_wrap_var", + "search_params", + "global_search_params", + "selection", + ) + title = "Align Dialog" + icon = "Align" + needwrapbutton = False + + def __init__( + self, + root: Tk, + engine: searchengine.SearchEngine, + extension: idlealign, + ) -> None: + """Create search dialog for aligning text. + + Uses SearchDialogBase as the basis for the GUI and a + searchengine instance to prepare the search. + + Attributes + ---------- + space_wrap_var: BooleanVar of if the align text should be wrapped with spaces + insert_tags: Optional string of tags for text insert + extension: Extension class + prev_search_params: Dictionary of search parameters before opening window + + """ + super().__init__(root, engine) + self.insert_tags: str | list[str] | tuple[str, ...] = () + + self.space_wrap_var = BooleanVar( + root, + True, + ) # Space wrap alignment pattern? + self.align_side_var = BooleanVar(root, False) # Alignment side var + + self.extension = extension + + self.global_search_params: dict[str, str | bool] + self.search_params: dict[str, str | bool] = { + "wrap": False, + "back": False, + } + + self.selection = utils.get_selected_text_indexes(self.extension.text) + + def load_prefs(self) -> None: + """Load search engine preferences.""" + self.global_search_params = utils.get_search_engine_params(self.engine) + utils.set_search_engine_params(self.engine, self.search_params) + + def store_prefs(self) -> None: + """Restore global search engine preferences.""" + self.search_params = utils.get_search_engine_params(self.engine) + utils.set_search_engine_params(self.engine, self.global_search_params) + + def open( + self, + searchphrase: str | None = None, + insert_tags: str | list[str] | tuple[str, ...] = (), + ) -> None: + """Make dialog visible on top of others and ready to use. + + Also, highlight the currently selected text. + + Arguments: + --------- + searchphrase: Search phrase to look for or existing phrase. + insert_tags: Tags to use when inserting text. + + """ + self.load_prefs() + + text = self.extension.text + + super().open(text, searchphrase) + + self.insert_tags = insert_tags + + self.selection = utils.get_selected_text_indexes(text) + utils.show_hit(text, *self.selection) + + def close(self, event: Event[Any] | None = None) -> None: + """Close the dialog and remove hit tags.""" + super().close(event) + + # Restore global search engine preferences + self.store_prefs() + + utils.hide_hit(self.extension.text) + self.insert_tags = () + + def create_option_buttons( + self, + ) -> tuple[Frame, list[tuple[Variable, str]]]: + """Create option buttons.""" + frame: Frame + base_options: list[tuple[Variable, str]] + frame, base_options = super().create_option_buttons() + options = [(self.space_wrap_var, "Space wrap")] + for var, label in options: + btn = Checkbutton(frame, variable=var, text=label) + btn.pack(side="left", fill="both") + base_options.append((var, label)) + return frame, base_options + + def create_other_buttons(self) -> tuple[Frame, list[tuple[bool, str]]]: + """Override so Search Direction is instead Alignment Side.""" + frame = self.make_frame("Alignment Side")[0] + var = self.align_side_var + others = [(False, "Left"), (True, "Right")] + for val, label in others: + btn = Radiobutton(frame, variable=var, value=val, text=label) + btn.pack(side="left", fill="both") + return frame, others + + def create_command_buttons(self) -> None: + """Create command buttons.""" + super().create_command_buttons() + self.make_button("Align", self.default_command, isdef=True) + + def default_command(self, _event: Event[Any] | None = None) -> bool: + """Handle align again as the default command.""" + if not self.engine.getpat(): + self.open() + return False + + pattern = self.engine.getprog() + if not pattern: + return False + + space_wrap: bool = self.space_wrap_var.get() + align_side: bool = self.align_side_var.get() + + close = self.extension.align_selection( + self.selection, + pattern, + space_wrap, + align_side, + self.insert_tags, + ) + + if close: + # Close window + self.close() + else: + # Ring bell because something went wrong + self.bell() + return close + + +# Important weird: If event handler function returns 'break', +# then it prevents other bindings of same event type from running. +# If returns None, normal and others are also run. + + +class idlealign(utils.BaseExtension): # noqa: N801 + """Add comments from mypy to an open program.""" + + __slots__ = () + + # Extend the file and format menus. + menudefs: ClassVar = [ + ("format", [("Align Selection", "<>")]), + ] + + # Default key binds for configuration file + bind_defaults: ClassVar = { + "align-selection": "", + } + + @property + def window(self) -> AlignDialog: + """Window for current text widget.""" + return self.create_window() + + def create_window(self) -> AlignDialog: + """Create align dialog window.""" + root: Tk + root = self.text._root() # type: ignore[attr-defined] + + engine: searchengine.SearchEngine = searchengine.get(root) + + if not hasattr(engine, "_aligndialog"): + engine._aligndialog = AlignDialog(root, engine, self) + return cast(AlignDialog, engine._aligndialog) + + def align_selection( + self, + selection: tuple[str, str], + pattern: Pattern[str], + space_wrap: bool = True, + align_side: bool = False, + tags: str | list[str] | tuple[str, ...] = (), + ) -> bool: + """Align selection by pattern. Side False == left. + + Return True if should close window. + """ + # Get start and end from selection, both are strings of {line}.{col} + select_start, select_end = selection + + # Get full first line till one past end line from selection + select_start = utils.get_whole_line(select_start) + grab_end = utils.get_whole_line(select_end, 1) + + # Get the characters from full line selection + chars: str = self.text.get(select_start, grab_end) + + # Split lines + lines = chars.splitlines() + # Keeping track of lines to modify + line_data: dict[int, tuple[str, str]] = {} + + # Finding min width excluding spaces of all lines till start of align pattern + sec_start = 0 + for idx, line in enumerate(lines): + # Regular expression match + match = pattern.search(line) + + if match is None: # If align pattern not in line, skip line + continue + + # Get the where alignment pattern starts and ends at + start, end = match.span() + + prefix = line[:start] + align = line[start:end] + suffix = line[end:] + + # If space wrap is set, wrap alignment text with spaces + if space_wrap: + align = f" {align} " + + if not align_side: # If align to left side + # Strip trailing spaces before align but keep indent + prefix = prefix.rstrip() + suffix = align + suffix.strip() # Strip extra spaces + else: # If align to right side + prefix += align.lstrip() + suffix = suffix.lstrip() + + line_data[idx] = (prefix, suffix) # Remember after we get max + + sec_start = max(sec_start, len(prefix)) # Update max + + if not line_data: + # There are no lines with selected pattern so stop + return False + + changed = False + # For each line selected that had align pattern, add or remove + # spaces from start up to pattern so each pattern starts in the same column + for key, value in line_data.items(): + prefix, suffix = value + + new = prefix.ljust(sec_start) + suffix + + if lines[key] != new: + changed = True + lines[key] = new + + if not changed: + # There was no change so stop + return False + + # Add extra blank line because of how insert works + lines.append("") + # Re-get characters to set + chars = "\n".join(lines) + + # This is all one operation + with utils.undo_block(self.undo): + # Replace old text with new aligned text + self.text.delete(select_start, grab_end) + self.text.insert(select_start, chars, tags) + + ## # Select modified area + ## utils.show_hit(self.text, select_start, grab_end) + return True + + def align_selection_event(self, _event: Event[Any] | None) -> str: + """Align selected text.""" + self.reload() + + self.window.open() + return "break" diff --git a/src/idlealign/utils.py b/src/idlealign/utils.py new file mode 100644 index 0000000..c6d692b --- /dev/null +++ b/src/idlealign/utils.py @@ -0,0 +1,664 @@ +"""IDLE Extension Utilities.""" + +# Programmed by CoolCat467 + +from __future__ import annotations + +# IDLE Extension Utilities +# Copyright (C) 2023-2024 CoolCat467 +# +# 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 . + +__title__ = "extension-utils" +__author__ = "CoolCat467" +__license__ = "GNU General Public License Version 3" + +import sys +from contextlib import contextmanager +from os.path import abspath +from tkinter import TclError, Text, Tk, messagebox +from typing import TYPE_CHECKING, ClassVar, NamedTuple + +from idlelib import search, searchengine +from idlelib.config import idleConf + +if TYPE_CHECKING: + from collections.abc import Generator, Sequence + + from idlelib.editor import EditorWindow + from idlelib.format import FormatRegion + from idlelib.iomenu import IOBinding + from idlelib.pyshell import PyShellEditorWindow, PyShellFileList + from idlelib.undo import UndoDelegator + + +def get_required_config( + values: dict[str, str], + bind_defaults: dict[str, str], + extension_title: str, +) -> str: + """Get required configuration file data.""" + config = "" + # Get configuration defaults + settings = "\n".join( + f"{key} = {default}" for key, default in values.items() + ) + if settings: + config += f"\n[{extension_title}]\n{settings}" + if bind_defaults: + config += "\n" + # Get key bindings data + settings = "\n".join( + f"{event} = {key}" for event, key in bind_defaults.items() + ) + if settings: + config += f"\n[{extension_title}_cfgBindings]\n{settings}" + return config + + +def check_installed( + extension: str, + version: str, + cls: type[BaseExtension] | None, +) -> bool: + """Make sure extension installed.""" + # Get list of system extensions + extensions = set(idleConf.defaultCfg["extensions"]) + + # Do we have the user extend extension? + has_user = "idleuserextend" in idleConf.GetExtensions(active_only=True) + + # If we don't, things get messy and we need to change the root config file + ex_defaults = idleConf.defaultCfg["extensions"].file + if has_user: + # Otherwise, idleuserextend patches IDLE and we only need to modify + # the user config file + ex_defaults = idleConf.userCfg["extensions"].file + extensions |= set(idleConf.userCfg["extensions"]) + + if cls is None: + # Import extension + module = __import__(extension) + + # Get extension class + if not hasattr(module, extension): + print( + f"ERROR: Somehow, {__title__} was installed improperly, " + f"no {__title__} class found in module. Please report " + "this on github.", + file=sys.stderr, + ) + sys.exit(1) + + cls = getattr(module, extension) + if not issubclass(cls, BaseExtension): + raise ValueError(f"Expected BaseExtension subclass, got {cls!r}") + + # Get extension class keybinding defaults + required_config = get_required_config( + getattr(cls, "values", {}), + getattr(cls, "bind_defaults", {}), + extension, + ) + + # If this extension not in there, + if extension not in extensions: + # Tell user how to add it to system list. + print(f"{extension} not in system registered extensions!") + print( + f"Please run the following command to add {extension} " + + "to system extensions list.\n", + ) + # Make sure line-breaks will go properly in terminal + add_data = required_config.replace("\n", "\\n") + # Tell them the command + append = "| sudo tee -a" + if has_user: + append = ">>" + print(f"echo -e '{add_data}' {append} {ex_defaults}\n") + else: + print(f"Configuration should be good! (v{version})") + return True + return False + + +def get_line_selection(line: int) -> tuple[str, str]: + """Get selection strings for given line.""" + return f"{line}.0", f"{line+1}.0" + + +# Stolen from idlelib.searchengine +def get_line_col(index: str) -> tuple[int, int]: + """Return (line, col) tuple of integers from {line}.{col} string.""" + line, col = map(int, index.split(".", 1)) # Fails on invalid index + return line, col + + +# Stolen from idlelib.searchengine +def get_selected_text_indexes(text: Text) -> tuple[str, str]: + """Return tuple of {line}.{col} indexes from selection or insert mark.""" + try: + first = text.index("sel.first") + except TclError: + first = None + try: + last = text.index("sel.last") + except TclError: + last = None + first = first or text.index("insert") + last = last or first + return first, last + + +def hide_hit(text: Text) -> None: + """Remove `hit` tag from entire file.""" + text.tag_remove("hit", "1.0", "end") + # text.update_idletasks() + + +def set_insert_and_move(text: Text, index: str) -> None: + """Bring area into view. + + Moves `insert` mark and moves to insert mark. + """ + text.mark_set("insert", index) + text.see("insert") + + # Force update + text.update_idletasks() + + +def higlight_region(text: Text, tag: str, first: str, last: str) -> None: + """Add a given tag to the region of text between first and last indices.""" + if first == last: + text.tag_add(tag, first) + else: + text.tag_add(tag, first, last) + + +def show_hit(text: Text, first: str, last: str) -> None: + """Highlight text between first and last indices. + + Indexes are formatted as `{line}.{col}` strings. + + Text is highlighted via the 'hit' tag and the marked + section is brought into view. + + Does not clear previously set hit tags implicitly. + + Note that because of how IDLE works, selection tag ("sel") + will override "hit" tag, so this function removes selection + tags from the entire file. If you need this information, + please use `get_selected_text_indexes` or something equivalent + beforehand. + """ + text.tag_remove("sel", "1.0", "end") + higlight_region(text, "hit", first, last) + + set_insert_and_move(text, first) + + +def get_whole_line(index: str, offset: int = 0) -> str: + """Return index line plus offset at column zero.""" + line = get_line_col(index)[0] + return f"{line + offset}.0" + + +def get_line_indent(text: str, char: str = " ") -> int: + """Return line indent.""" + index = -1 + for index, cur_char in enumerate(text): + if cur_char != char: + return index + return index + 1 + + +def ensure_section_exists(section: str) -> bool: + """Ensure section exists in user extensions configuration. + + Returns True if edited. + """ + if section not in idleConf.GetSectionList("user", "extensions"): + idleConf.userCfg["extensions"].AddSection(section) + return True + return False + + +def ensure_values_exist_in_section( + section: str, + values: dict[str, str], +) -> bool: + """For each key in values, make sure key exists. Return if edited. + + If not, create and set to value. + """ + need_save = False + for key, default in values.items(): + value = idleConf.GetOption( + "extensions", + section, + key, + warn_on_default=False, + ) + if value is None: + idleConf.SetOption("extensions", section, key, default) + need_save = True + return need_save + + +def ask_save_dialog(parent: Text) -> bool: + """Ask to save dialog stolen from idlelib.runscript.ScriptBinding.""" + msg = "Source Must Be Saved\n" + 5 * " " + "OK to Save?" + confirm: bool = messagebox.askokcancel( + title="Save Before Run or Check", + message=msg, + default=messagebox.OK, + parent=parent, + ) + return confirm + + +def get_search_engine_params( + engine: searchengine.SearchEngine, +) -> dict[str, str | bool]: + """Get current search engine parameters.""" + return { + name: getattr(engine, f"{name}var").get() + for name in ("pat", "re", "case", "word", "wrap", "back") + } + + +def set_search_engine_params( + engine: searchengine.SearchEngine, + data: dict[str, str | bool], +) -> None: + """Get current search engine parameters.""" + for name in ("pat", "re", "case", "word", "wrap", "back"): + if name in data: + getattr(engine, f"{name}var").set(data[name]) + + +@contextmanager +def search_engine_block( + engine: searchengine.SearchEngine, +) -> Generator[None, None, None]: + """Search engine modification context manager.""" + global_search_params = get_search_engine_params(engine) + try: + yield None + finally: + set_search_engine_params(engine, global_search_params) + + +@contextmanager +def undo_block(undo: UndoDelegator) -> Generator[None, None, None]: + """Undo block context manager.""" + undo.undo_block_start() + try: + yield None + finally: + undo.undo_block_stop() + + +class Comment(NamedTuple): + """Represents one comment.""" + + file: str + line: int + contents: str + line_end: int | None = None + column: int = 0 + column_end: int | None = None + + +class BaseExtension: + """Base extension class.""" + + __slots__ = ( + "editwin", + "text", + "undo", + "formatter", + "files", + "flist", + "comment_prefix", + ) + + # Extend the file and format menus. + menudefs: ClassVar = [] + + # Default values for configuration file + values: ClassVar = { + "enable": "True", + "enable_editor": "True", + "enable_shell": "False", + } + + # Default key binds for configuration file + bind_defaults: ClassVar = {} + + def __init__( + self, + editwin: PyShellEditorWindow, + *, + comment_prefix: str | None = None, + ) -> None: + """Initialize this extension.""" + self.editwin: PyShellEditorWindow = editwin + self.text: Text = editwin.text + self.undo: UndoDelegator = editwin.undo + self.formatter: FormatRegion = editwin.fregion + self.files: IOBinding = editwin.io + self.flist: PyShellFileList = editwin.flist + + if comment_prefix is None: + comment_prefix = f"{self.__class__.__name__}" + self.comment_prefix = f"# {comment_prefix}: " + + def __repr__(self) -> str: + """Return representation of self.""" + return f"{self.__class__.__name__}({self.editwin!r})" + + @classmethod + def ensure_bindings_exist(cls) -> bool: + """Ensure key bindings exist in user extensions configuration. + + Return True if need to save. + """ + if not cls.bind_defaults: + return False + + need_save = False + section = f"{cls.__name__}_cfgBindings" + if ensure_section_exists(section): + need_save = True + if ensure_values_exist_in_section(section, cls.bind_defaults): + need_save = True + return need_save + + @classmethod + def ensure_config_exists(cls) -> bool: + """Ensure required configuration exists for this extension. + + Return True if need to save. + """ + need_save = False + if ensure_section_exists(cls.__name__): + need_save = True + if ensure_values_exist_in_section(cls.__name__, cls.values): + need_save = True + return need_save + + @classmethod + def reload(cls) -> None: + """Load class variables from configuration.""" + # Ensure file default values exist so they appear in settings menu + save = cls.ensure_config_exists() + if cls.ensure_bindings_exist() or save: + idleConf.SaveUserCfgFiles() + + # Reload configuration file + idleConf.LoadCfgFiles() + + # For all possible configuration values + for key, default in cls.values.items(): + # Set attribute of key name to key value from configuration file + if key not in {"enable", "enable_editor", "enable_shell"}: + value = idleConf.GetOption( + "extensions", + cls.__name__, + key, + default=default, + ) + setattr(cls, key, value) + + def get_line(self, line: int, text_win: Text | None = None) -> str: + """Get the characters from the given line in currently open file.""" + if text_win is None: + text_win = self.text + chars: str = text_win.get(*get_line_selection(line)) + return chars + + def get_comment_line(self, indent: int, content: str) -> str: + """Return comment line given indent and content.""" + strindent = " " * indent + return f"{strindent}{self.comment_prefix}{content}" + + def comment_exists( + self, + line: int, + comment: str, + text_win: Text | None = None, + ) -> bool: + """Return True if comment for message already exists on line.""" + return self.get_comment_line(0, comment) in self.get_line( + line - 1, + text_win=text_win, + ) + + def add_comment( + self, + comment: Comment, + max_exist_up: int = 0, + ) -> bool: + """Return True if added new comment, False if already exists. + + Arguments: + --------- + max_exist_up: Max distance upwards to look for comment to already exist. + + Does not use an undo block, please use one yourself. + + """ + # Get line and message from output + file = comment.file + line = comment.line + msg = comment.contents + + editwin: EditorWindow = self.editwin + + open_file: str | None = self.files.filename + if open_file is None or abspath(open_file) != file: + opened = self.flist.open(file) + if opened is None: + return False + editwin = opened + + # If there is already a comment from us there, ignore that line. + # +1-1 is so at least up by 1 is checked, range(0) = [] + for i in range(max_exist_up + 1): + if self.comment_exists(line - (i - 1), msg, editwin.text): + return False + + # Get line checker is talking about + chars = self.get_line(line, editwin.text) + + # Figure out line indent + indent = get_line_indent(chars) + + # Add comment line + chars = self.get_comment_line(indent, msg) + "\n" + chars + + # Save changes + start, end = get_line_selection(line) + editwin.text.delete(start, end) + editwin.text.insert(start, chars, ()) + return True + + def get_pointers(self, comments: list[Comment]) -> Comment | None: + """Return comment pointing to multiple comments all on the same line. + + If none of the comment pointers are going to be visible + with the comment prefix, returns None. + + Messages must all be on the same line and be in the same file + """ + line = comments[0].line + file = comments[0].file + + # Figure out next line intent + next_line_text = self.get_line(line + 1) + indent = get_line_indent(next_line_text) + + lastcol = len(self.get_comment_line(indent, "")) + + columns: set[int] = set() + + for comment in comments: + if comment.line != line: + raise ValueError(f"Comment `{comment}` not on line `{line}`") + if comment.file != file: + raise ValueError(f"Comment `{comment}` not in file `{file}`") + if comment.column_end is None: + end = comment.column + else: + end = comment.column_end + for col in range(comment.column, end + 1): + columns.add(col) + + new_line = "" + for col in sorted(columns): + spaces = (col - lastcol) - 1 + if spaces < 0: + continue + new_line += " " * spaces + "^" + lastcol = col + + if not new_line.strip(): + return None + + return Comment(file=file, line=line + 1, contents=new_line) + + def add_comments( + self, + comments: Sequence[Comment], + ) -> dict[str, list[int]]: + """Add comments to file(s). Ignores comments that already exist. + + Return dict of per file a list of lines were a comment was added. + + Changes are wrapped in an undo block. + """ + file_comments: dict[str, list[int]] = {} + + with undo_block(self.undo): + total = len(comments) + for comment in reversed(comments): + if self.add_comment(comment, total): + file_comments.setdefault(comment.file, []) + file_comments[comment.file].append(comment.line) + return file_comments + + def add_comment_block( + self, + file: str, + start_line: int, + lines: Sequence[str], + ) -> list[int]: + """Add lines to file, in order as they appear top to bottom. + + Returns list of lines were a comment was added. + + Changes are wrapped in an undo block. + """ + file_comments = self.add_comments( + [ + Comment( + file=file, + line=start_line, + contents=line, + ) + for line in lines + ], + ) + return file_comments[file] + + def remove_selected_extension_comments(self) -> bool: + """Remove selected extension comments. Return if removed any comments. + + Changes are wrapped in an undo block. + """ + # Get selected region lines + head, _tail, chars, lines = self.formatter.get_region() + region_start, _col = get_line_col(head) + + edited = False + with undo_block(self.undo): + for index, line_text in reversed(tuple(enumerate(lines))): + # If after indent there is mypy comment + if line_text.lstrip().startswith(self.comment_prefix): + # If so, remove line + self.text.delete( + *get_line_selection(index + region_start), + ) + edited = True + if not edited: + # Make bell sound so user knows this ran even though + # nothing happened. + self.text.bell() + return edited + + def remove_all_extension_comments(self) -> str: + """Remove all extension comments. + + Changes are wrapped in an undo block. + """ + eof_idx = self.text.index("end") + chars = self.text.get("0.0", eof_idx) + + lines = chars.splitlines() + + edited = False + with undo_block(self.undo): + for index, line_text in reversed(tuple(enumerate(lines))): + # If after indent there is mypy comment + if line_text.lstrip().startswith(self.comment_prefix): + # If so, remove line + self.text.delete(*get_line_selection(index)) + edited = True + if not edited: + # Make bell sound so user knows this ran even though + # nothing happened. + self.text.bell() + return "break" + + def find_next_extension_comment(self, search_wrap: bool = True) -> bool: + """Find next extension comment by hacking the search dialog engine. + + Return True if the search was successful and False otherwise. + """ + root: Tk = self.editwin.root + + # Get search engine singleton from root + engine: searchengine.SearchEngine = searchengine.get(root) + + # With search engine parameter restore block + with search_engine_block(engine): + # Set search pattern to comment starter + set_search_engine_params( + engine, + { + "pat": f"^\\s*{self.comment_prefix}", + "re": True, + "case": True, + "word": False, + "wrap": search_wrap, + "back": False, + }, + ) + + # Find current pattern + found = search.find_again(self.text) + assert isinstance(found, bool) + return found diff --git a/tests/test_utils.py b/tests/test_utils.py new file mode 100644 index 0000000..da7b330 --- /dev/null +++ b/tests/test_utils.py @@ -0,0 +1,73 @@ +from __future__ import annotations + +import pytest +from idlealign import utils + + +def test_get_required_config() -> None: + assert ( + utils.get_required_config( + { + "fish_enabled": "True", + "waffle_mode": "False", + "user_settings": "1, 2, 3", + }, + { + "check_fishes": "Ctrl+Alt+f", + "reboot": "Ctrl+Alt+Del", + }, + "fish_extend", + ) + == """ +[fish_extend] +fish_enabled = True +waffle_mode = False +user_settings = 1, 2, 3 + +[fish_extend_cfgBindings] +check_fishes = Ctrl+Alt+f +reboot = Ctrl+Alt+Del""" + ) + + +@pytest.mark.parametrize( + ("line", "expected"), + [ + ("0.0", (0, 0)), + ("1.0", (1, 0)), + ("0.1", (0, 1)), + ("29120.314817317", (29120, 314817317)), + ("-231.-234327", (-231, -234327)), + ], +) +def test_get_line_col_success(line: str, expected: tuple[int, int]) -> None: + assert utils.get_line_col(line) == expected + + +def test_get_line_selection() -> None: + assert utils.get_line_selection(3) == ("3.0", "4.0") + + +@pytest.mark.parametrize( + "line", + [ + "", + "93732", + "0x7f", + "0x74.0xff", + ], +) +def test_get_line_col_failure(line: str) -> None: + with pytest.raises( + ValueError, + match=r"(not enough values to unpack)|(invalid literal for int\(\) with base 10:)", + ): + utils.get_line_col(line) + + +@pytest.mark.parametrize( + ("text", "expect"), + [(" waf", 2), ("cat", 0), (" fish", 5), (" ", 3), ("", 0)], +) +def test_get_line_indent(text: str, expect: int) -> None: + assert utils.get_line_indent(text, " ") == expect