diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml new file mode 100644 index 0000000..94aacfa --- /dev/null +++ b/.github/workflows/test.yml @@ -0,0 +1,26 @@ +name: Tests + +on: + pull_request: + branches: [ main ] + +jobs: + test: + runs-on: ubuntu-latest + strategy: + matrix: + python-version: ['3.12'] + + steps: + - uses: actions/checkout@v3 + + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v4 + with: + python-version: ${{ matrix.python-version }} + + - name: Install dependencies and run tests + run: | + python -m pip install --upgrade pip + pip install pytest pytest-cov + make ci diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..8c6ae29 --- /dev/null +++ b/.gitignore @@ -0,0 +1,11 @@ +/src/version/_version.py +src/*.egg-info +__pycache__ +dist +build +out +.venv +.env +.coverage +.*.history* +*.tags.cache* diff --git a/.idea/.gitignore b/.idea/.gitignore new file mode 100644 index 0000000..26d3352 --- /dev/null +++ b/.idea/.gitignore @@ -0,0 +1,3 @@ +# Default ignored files +/shelf/ +/workspace.xml diff --git a/LICENSE b/LICENSE index be3f7b2..261eeb9 100644 --- a/LICENSE +++ b/LICENSE @@ -1,661 +1,201 @@ - GNU AFFERO GENERAL PUBLIC LICENSE - Version 3, 19 November 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 Affero General Public License is a free, copyleft license for -software and other kinds of works, specifically designed to ensure -cooperation with the community in the case of network server software. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -our General Public Licenses are 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. - - 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. - - Developers that use our General Public Licenses protect your rights -with two steps: (1) assert copyright on the software, and (2) offer -you this License which gives you legal permission to copy, distribute -and/or modify the software. - - A secondary benefit of defending all users' freedom is that -improvements made in alternate versions of the program, if they -receive widespread use, become available for other developers to -incorporate. Many developers of free software are heartened and -encouraged by the resulting cooperation. However, in the case of -software used on network servers, this result may fail to come about. -The GNU General Public License permits making a modified version and -letting the public access it on a server without ever releasing its -source code to the public. - - The GNU Affero General Public License is designed specifically to -ensure that, in such cases, the modified source code becomes available -to the community. It requires the operator of a network server to -provide the source code of the modified version running there to the -users of that server. Therefore, public use of a modified version, on -a publicly accessible server, gives the public access to the source -code of the modified version. - - An older license, called the Affero General Public License and -published by Affero, was designed to accomplish similar goals. This is -a different license, not a version of the Affero GPL, but Affero has -released a new version of the Affero GPL which permits relicensing under -this license. - - 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 Affero 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. Remote Network Interaction; Use with the GNU General Public License. - - Notwithstanding any other provision of this License, if you modify the -Program, your modified version must prominently offer all users -interacting with it remotely through a computer network (if your version -supports such interaction) an opportunity to receive the Corresponding -Source of your version by providing access to the Corresponding Source -from a network server at no charge, through some standard or customary -means of facilitating copying of software. This Corresponding Source -shall include the Corresponding Source for any work covered by version 3 -of the GNU General Public License that is incorporated pursuant to the -following paragraph. - - 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 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 work with which it is combined will remain governed by version -3 of the GNU General Public License. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU Affero 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 Affero 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 Affero 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 Affero 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 Affero 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 Affero General Public License for more details. - - You should have received a copy of the GNU Affero General Public License - along with this program. If not, see . - -Also add information on how to contact you by electronic and paper mail. - - If your software can interact with users remotely through a computer -network, you should also make sure that it provides a way for users to -get its source. For example, if your program is a web application, its -interface could display a "Source" link that leads users to an archive -of the code. There are many ways you could offer source, and different -solutions will be better for different programs; see section 13 for the -specific requirements. - - 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 AGPL, see -. + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md index e594511..cda89bc 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ [![PyPI version](https://badge.fury.io/py/cedarscript-editor.svg)](https://pypi.org/project/cedarscript-editor/) [![Python Versions](https://img.shields.io/pypi/pyversions/cedarscript-editor.svg)](https://pypi.org/project/cedarscript-editor/) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) -[![AGPL v3](https://img.shields.io/badge/License-AGPL%20v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0) +[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) `CEDARScript Editor (Python)` is a [CEDARScript](https://bit.ly/cedarscript) runtime for interpreting `CEDARScript` scripts and performing code analysis and modification operations on a codebase. diff --git a/pyproject.toml b/pyproject.toml index 479924b..da22f44 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -8,11 +8,11 @@ dynamic = ["version"] description = "A library for executing CEDARScript, a SQL-like language for code analysis and transformations" authors = [{ name = "Elifarley", email = "cedarscript@orgecc.com" }] readme = "README.md" -license = {text = "AGPL-3.0"} +license = {text = "Apache-2.0"} classifiers = [ "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.12", - "License :: OSI Approved :: GNU Affero General Public License v3", + "License :: OSI Approved :: Apache Software License", "Operating System :: OS Independent", "Intended Audience :: Developers", "Topic :: Software Development :: Libraries :: Python Modules", @@ -22,11 +22,12 @@ classifiers = [ ] keywords = ["cedarscript", "code-editing", "refactoring", "code-analysis", "sql-like", "ai-assisted-development"] dependencies = [ - "cedarscript-ast-parser>=0.5.6", - "grep-ast==0.3.3", + "orgecc-pylib>=0.1.3", + "cedarscript-ast-parser>=0.7.0", + "grep-ast==0.4.1", # https://github.com/tree-sitter/py-tree-sitter/issues/303 # https://github.com/grantjenks/py-tree-sitter-languages/issues/64 - "tree-sitter<0.22", # 0.22 breaks tree-sitter-languages + "tree-sitter==0.21.3", # 0.22 breaks tree-sitter-languages "tree-sitter-languages==1.10.2", ] requires-python = ">=3.11" @@ -40,6 +41,7 @@ Repository = "https://github.com/CEDARScript/cedarscript-editor-python.git" [project.optional-dependencies] dev = [ "pytest>=7.0", + "pytest-cov>=6.0.0", "black>=22.0", "isort>=5.0", "flake8>=4.0", @@ -56,13 +58,13 @@ package-dir = {"" = "src"} # >>> SETUPTOOLS_SCM_PRETEND_VERSION=0.0.2 python -m build # To dry-run and see version: # >>> python -m setuptools_scm -write_to = "src/cedarscript_editor/_version.py" +write_to = "src/version/_version.py" # Append .post{number of commits} to your version if there are commits after the last tag. version_scheme = "post-release" [tool.setuptools.packages.find] where = ["src"] -include = ["cedarscript_editor*", "text_manipulation*"] +include = ["version", "tree-sitter-queries", "cedarscript_editor*", "text_manipulation*"] exclude = ["cedarscript_ast_parser.tests*"] namespaces = false diff --git a/src/cedarscript_editor/__init__.py b/src/cedarscript_editor/__init__.py index c7b6dcf..c7b0617 100644 --- a/src/cedarscript_editor/__init__.py +++ b/src/cedarscript_editor/__init__.py @@ -1,4 +1,4 @@ -from ._version import __version__ +from version import __version__ import re from .cedarscript_editor import CEDARScriptEditor from cedarscript_ast_parser import CEDARScriptASTParser diff --git a/src/cedarscript_editor/case_filter.py b/src/cedarscript_editor/case_filter.py index 4bdc545..0d54fb2 100644 --- a/src/cedarscript_editor/case_filter.py +++ b/src/cedarscript_editor/case_filter.py @@ -82,6 +82,8 @@ def _matches_when(line: str, when: CaseWhen, indent_level: int, line_num: int) - return True if when.indent_level is not None and indent_level == when.indent_level: return True + if when.line_matcher and stripped == when.line_matcher.strip(): + return True if when.line_number is not None and line_num == when.line_number: return True return False diff --git a/src/cedarscript_editor/tree_sitter_identifier_finder.py b/src/cedarscript_editor/tree_sitter_identifier_finder.py index dab8e30..586e0ef 100644 --- a/src/cedarscript_editor/tree_sitter_identifier_finder.py +++ b/src/cedarscript_editor/tree_sitter_identifier_finder.py @@ -9,8 +9,8 @@ from text_manipulation.range_spec import IdentifierBoundaries, RangeSpec, ParentInfo, ParentRestriction from text_manipulation import IdentifierFinder from tree_sitter_languages import get_language, get_parser - -from .tree_sitter_identifier_queries import LANG_TO_TREE_SITTER_QUERY +from pylibtreesitter import nodes_by_type_suffix +from .tree_sitter_identifier_queries import get_query """ Parser for extracting identifier information from source code using tree-sitter. @@ -48,7 +48,7 @@ def __init__(self, fname: str, source: str | Sequence[str], parent_restriction: self.query_info = None _log.info(f"[TreeSitterIdentifierFinder] NO LANGUAGE for `{fname}`") return - self.query_info: dict[str, dict[str, str]] = LANG_TO_TREE_SITTER_QUERY[langstr] + self.query_info: dict[str, str] = get_query(langstr) self.language = get_language(langstr) _log.info(f"[TreeSitterIdentifierFinder] Selected {self.language}") self.tree = get_parser(langstr).parse(bytes(source, "utf-8")) @@ -128,7 +128,8 @@ def find_identifiers( match identifier_type: case 'method': identifier_type = 'function' - candidate_nodes = self.language.query(self.query_info[identifier_type].format(name=name)).captures(self.tree.root_node) + _query = self.query_info[identifier_type].format(name=name) + candidate_nodes = self.language.query(_query).captures(self.tree.root_node) if not candidate_nodes: return [] # Convert captures to boundaries and filter by parent @@ -198,9 +199,9 @@ def parents(self) -> list[ParentInfo]: current = self.node.parent while current: - # Check if current node is a container type we care about - if current.type.endswith('_definition'): - # Try to find the name node - exact field depends on language + # Check if current node is a container type we care about - TODO exact field depends on language + if current.type.endswith('_definition') and current.type != 'decorated_definition': + # Try to find the name node - TODO exact field depends on language name = None for child in current.children: if child.type == 'identifier' or child.type == 'name': @@ -242,14 +243,13 @@ def associate_identifier_parts(captures: Iterable[CaptureInfo], lines: Sequence[ raise ValueError(f'Parent node not found for [{capture.capture_type} - {capture.node_type}] ({capture.node.text.decode("utf-8").strip()})') match capture_type: case 'body': - parent = parent._replace(body=range_spec) + parent.body=range_spec case 'docstring': - parent = parent._replace(docstring=range_spec) + parent.docstring=range_spec case 'decorator': - parent = parent.decorators.append(range_spec) + parent.append_decorator(range_spec) case _ as invalid: raise ValueError(f'Invalid capture type: {invalid}') - identifier_map[parent_key] = parent return sorted(identifier_map.values(), key=lambda x: x.whole.start) @@ -260,6 +260,12 @@ def find_parent_definition(node): while node.parent: node = node.parent if node.type.endswith('_definition'): + if node.type == 'decorated_definition': + node = nodes_by_type_suffix(node.named_children, '_definition') + if node: + if len(node) > 1: + raise ValueError(f'{len(node)} parent definitions found: {node}') + return node[0] return node return None @@ -278,4 +284,48 @@ def capture2identifier_boundaries(captures, lines: Sequence[str]) -> list[Identi unique_captures = {} for capture in captures: unique_captures[f'{capture.range[0]}:{capture.capture_type}'] = capture - return associate_identifier_parts(unique_captures.values(), lines) + # unique_captures={ + # '14:function.definition': CaptureInfo(capture_type='function.definition', node=), + # '12:function.decorator': CaptureInfo(capture_type='function.decorator', node=), + # '13:function.decorator': CaptureInfo(capture_type='function.decorator', node=), + # '15:function.body': CaptureInfo(capture_type='function.body', node=), + # '15:function.docstring': CaptureInfo(capture_type='function.docstring', node=) + # } + return associate_identifier_parts(sort_captures(unique_captures), lines) + +def parse_capture_key(key): + """ + Parses the dictionary key into line number and capture type. + Args: + key (str): The key in the format 'line_number:capture_type'. + Returns: + tuple: (line_number as int, capture_type as str) + """ + line_number, capture_type = key.split(':') + return int(line_number), capture_type.split('.')[-1] + +def get_sort_priority(): + """ + Returns a dictionary mapping capture types to their sort priority. + Returns: + dict: Capture type priorities. + """ + return {'definition': 1, 'decorator': 2, 'body': 3, 'docstring': 4} + +def sort_captures(captures): + """ + Sorts the values of the captures dictionary by capture type and line number. + Args: + captures (dict): The dictionary to sort. + Returns: + list: Sorted list of values. + """ + priority = get_sort_priority() + sorted_items = sorted( + captures.items(), + key=lambda item: ( + priority[parse_capture_key(item[0])[1]], # Sort by capture type priority + parse_capture_key(item[0])[0] # Then by line number + ) + ) + return [value for _, value in sorted_items] diff --git a/src/cedarscript_editor/tree_sitter_identifier_queries.py b/src/cedarscript_editor/tree_sitter_identifier_queries.py index d232313..1f58fc3 100644 --- a/src/cedarscript_editor/tree_sitter_identifier_queries.py +++ b/src/cedarscript_editor/tree_sitter_identifier_queries.py @@ -30,1134 +30,25 @@ # except KeyError: # return +from importlib.resources import files -LANG_TO_TREE_SITTER_QUERY = { - "python": { - 'function': """ - ; Regular and async function definitions with optional docstring - (function_definition - name: (identifier) @_function_name - (#match? @_function_name "^{name}$") - body: (block) @function.body) @function.definition +_tree_sitter_queries = files("tree-sitter-queries") - (function_definition - name: (identifier) @_function_name - (#match? @_function_name "^{name}$") - body: (block - . - (expression_statement - (string) @function.docstring)? - . - (_)*)) - ; Decorated function definitions (including async) with optional docstring - (decorated_definition - (decorator)+ - (function_definition - name: (identifier) @_function_name - (#match? @_function_name "^{name}$") - body: (block) @function.body)) @function.definition - - (decorated_definition - (decorator)+ - (function_definition - name: (identifier) @_function_name - (#match? @_function_name "^{name}$") - body: (block - . - (expression_statement - (string) @function.docstring)? - . - (_)*))) - - ; Method definitions in classes (including async and decorated) with optional docstring - (class_definition - body: (block - (function_definition - name: (identifier) @_function_name - (#match? @_function_name "^{name}$") - body: (block) @function.body) @function.definition)) - - (class_definition - body: (block - (function_definition - name: (identifier) @_function_name - (#match? @_function_name "^{name}$") - body: (block - . - (expression_statement - (string) @function.docstring)? - . - (_)*)))) -""", - - 'class': """ - ; Regular and decorated class definitions (including nested) with optional docstring - (class_definition - name: (identifier) @_class_name - (#match? @_class_name "^{name}$") - body: (block) @class.body) @class.definition - - (class_definition - name: (identifier) @_class_name - (#match? @_class_name "^{name}$") - body: (block - . - (expression_statement - (string) @class.docstring)? - . - (_)*)) - - ; Decorated class definitions - (decorated_definition - (decorator)+ - (class_definition - name: (identifier) @_class_name - (#match? @_class_name "^{name}$") - body: (block) @class.body)) @class.definition - - (decorated_definition - (decorator)+ - (class_definition - name: (identifier) @_class_name - (#match? @_class_name "^{name}$") - body: (block - . - (expression_statement - (string) @class.docstring)? - . - (_)*))) - - ; Nested class definitions within other classes - (class_definition - body: (block - (class_definition - name: (identifier) @_class_name - (#match? @_class_name "^{name}$") - body: (block) @class.body) @class.definition)) - - (class_definition - body: (block - (class_definition - name: (identifier) @_class_name - (#match? @_class_name "^{name}$") - body: (block - . - (expression_statement - (string) @class.docstring)? - . - (_)*)))) -""" - }, - "kotlin": { - 'function': """ - ; Regular function definitions with optional annotations and KDoc - (function_declaration - (modifiers (annotation) @function.decorator)* - name: (simple_identifier) @_function_name - body: (function_body) @function.body) @function.definition - - (function_declaration - (modifiers (annotation) @function.decorator)* - (comment) @function.docstring - name: (simple_identifier) @_function_name - body: (function_body) @function.body) @function.definition - - ; Function definitions with type parameters - (function_declaration - (modifiers (annotation) @function.decorator)* - name: (simple_identifier) @_function_name - type_parameters: (type_parameters) - body: (function_body) @function.body) @function.definition - - (function_declaration - (modifiers (annotation) @function.decorator)* - (comment) @function.docstring - name: (simple_identifier) @_function_name - type_parameters: (type_parameters) - body: (function_body) @function.body) @function.definition - - ; Method definitions in classes - (class_body - (function_declaration - (modifiers (annotation) @function.decorator)* - name: (simple_identifier) @_function_name - body: (function_body) @function.body) @function.definition) - - (class_body - (function_declaration - (modifiers (annotation) @function.decorator)* - (comment) @function.docstring - name: (simple_identifier) @_function_name - body: (function_body) @function.body) @function.definition) - - ; Constructor definitions - (class_body - (constructor_declaration - (modifiers (annotation) @function.decorator)* - body: (function_body) @function.body) @function.definition) - - (class_body - (constructor_declaration - (modifiers (annotation) @function.decorator)* - (comment) @function.docstring - body: (function_body) @function.body) @function.definition) - - ; Extension functions - (function_declaration - (modifiers (annotation) @function.decorator)* - receiver_type: (type_reference) - name: (simple_identifier) @_function_name - body: (function_body) @function.body) @function.definition - - (function_declaration - (modifiers (annotation) @function.decorator)* - (comment) @function.docstring - receiver_type: (type_reference) - name: (simple_identifier) @_function_name - body: (function_body) @function.body) @function.definition - - ; Backticked function names - (function_declaration - (modifiers (annotation) @function.decorator)* - name: (simple_identifier (identifier_string)) @_function_name - body: (function_body) @function.body) @function.definition - - (function_declaration - (modifiers (annotation) @function.decorator)* - (comment) @function.docstring - name: (simple_identifier (identifier_string)) @_function_name - body: (function_body) @function.body) @function.definition - - ; Lambda expressions - (lambda_literal - body: (_) @function.body) @function.definition - """, - - 'class': """ - ; Regular class definitions with optional annotations and KDoc - (class_declaration - (modifiers (annotation) @class.decorator)* - name: (type_identifier) @_class_name - body: (class_body) @class.body) @class.definition - - (class_declaration - (modifiers (annotation) @class.decorator)* - (comment) @class.docstring - name: (type_identifier) @_class_name - body: (class_body) @class.body) @class.definition - - ; Interface definitions - (interface_declaration - (modifiers (annotation) @class.decorator)* - name: (type_identifier) @_class_name - body: (class_body) @class.body) @class.definition - - (interface_declaration - (modifiers (annotation) @class.decorator)* - (comment) @class.docstring - name: (type_identifier) @_class_name - body: (class_body) @class.body) @class.definition - - ; Object declarations - (object_declaration - (modifiers (annotation) @class.decorator)* - name: (type_identifier) @_class_name - body: (class_body) @class.body) @class.definition - - (object_declaration - (modifiers (annotation) @class.decorator)* - (comment) @class.docstring - name: (type_identifier) @_class_name - body: (class_body) @class.body) @class.definition - - ; Nested class definitions - (class_body - (class_declaration - (modifiers (annotation) @class.decorator)* - name: (type_identifier) @_class_name - body: (class_body) @class.body) @class.definition) - - (class_body - (class_declaration - (modifiers (annotation) @class.decorator)* - (comment) @class.docstring - name: (type_identifier) @_class_name - body: (class_body) @class.body) @class.definition) - - ; Data class definitions - (class_declaration - (modifiers (annotation) @class.decorator)* - "data" - name: (type_identifier) @_class_name - body: (class_body) @class.body) @class.definition - - (class_declaration - (modifiers (annotation) @class.decorator)* - (comment) @class.docstring - "data" - name: (type_identifier) @_class_name - body: (class_body) @class.body) @class.definition - - ; Enum class definitions - (class_declaration - (modifiers (annotation) @class.decorator)* - "enum" - name: (type_identifier) @_class_name - body: (class_body) @class.body) @class.definition - - (class_declaration - (modifiers (annotation) @class.decorator)* - (comment) @class.docstring - "enum" - name: (type_identifier) @_class_name - body: (class_body) @class.body) @class.definition - """ - }, - - "php": { - 'function': """ - ; Regular function definitions with optional attributes and docstring - (function_definition - (attribute_list)? @function.decorator - name: (name) @function.name - body: (compound_statement) @function.body) @function.definition - - (function_definition - (attribute_list)? @function.decorator - (comment) @function.docstring - name: (name) @function.name - body: (compound_statement) @function.body) @function.definition - - ; Method definitions in classes with optional attributes and docstring - (method_declaration - (attribute_list)? @function.decorator - name: (name) @function.name - body: (compound_statement) @function.body) @function.definition - - (method_declaration - (attribute_list)? @function.decorator - (comment) @function.docstring - name: (name) @function.name - body: (compound_statement) @function.body) @function.definition - - ; Anonymous functions - (anonymous_function - (attribute_list)? @function.decorator - body: (compound_statement) @function.body) @function.definition - - ; Arrow functions - (arrow_function - (attribute_list)? @function.decorator - body: (expression) @function.body) @function.definition - """, - - 'class': ("class.definition", "class.name", "class.body", "class.docstring", "class.decorator", """ - ; Regular class definitions with optional attributes and docstring - (class_declaration - (attribute_list)? @class.decorator - name: (name) @class.name - body: (declaration_list) @class.body) @class.definition - - (class_declaration - (attribute_list)? @class.decorator - (comment) @class.docstring - name: (name) @class.name - body: (declaration_list) @class.body) @class.definition - - ; Interface definitions - (interface_declaration - (attribute_list)? @class.decorator - name: (name) @class.name - body: (declaration_list) @class.body) @class.definition - - (interface_declaration - (attribute_list)? @class.decorator - (comment) @class.docstring - name: (name) @class.name - body: (declaration_list) @class.body) @class.definition - - ; Trait definitions - (trait_declaration - (attribute_list)? @class.decorator - name: (name) @class.name - body: (declaration_list) @class.body) @class.definition - - (trait_declaration - (attribute_list)? @class.decorator - (comment) @class.docstring - name: (name) @class.name - body: (declaration_list) @class.body) @class.definition - - ; Enum definitions - (enum_declaration - (attribute_list)? @class.decorator - name: (name) @class.name - body: (enum_declaration_list) @class.body) @class.definition - - (enum_declaration - (attribute_list)? @class.decorator - (comment) @class.docstring - name: (name) @class.name - body: (enum_declaration_list) @class.body) @class.definition - """) - }, - - "rust": { - 'function': """ - ; Function definitions with optional attributes, visibility, and docstring - (function_item - (attribute_item)? @function.decorator - (visibility_modifier)? - (function_modifiers)? - "fn" - name: (identifier) @function.name - parameters: (parameters) - return_type: (_)? - body: (block) @function.body) @function.definition - - (function_item - (attribute_item)? @function.decorator - (visibility_modifier)? - (function_modifiers)? - (line_comment)+ @function.docstring - "fn" - name: (identifier) @function.name - parameters: (parameters) - return_type: (_)? - body: (block) @function.body) @function.definition - - ; Method definitions in impl blocks - (impl_item - (attribute_item)? @function.decorator - (visibility_modifier)? - (function_modifiers)? - "fn" - name: (identifier) @function.name - parameters: (parameters) - return_type: (_)? - body: (block) @function.body) @function.definition - - (impl_item - (attribute_item)? @function.decorator - (visibility_modifier)? - (function_modifiers)? - (line_comment)+ @function.docstring - "fn" - name: (identifier) @function.name - parameters: (parameters) - return_type: (_)? - body: (block) @function.body) @function.definition - - ; Async function definitions - (function_item - (attribute_item)? @function.decorator - (visibility_modifier)? - "async" - "fn" - name: (identifier) @function.name - parameters: (parameters) - return_type: (_)? - body: (block) @function.body) @function.definition - - ; Const function definitions - (function_item - (attribute_item)? @function.decorator - (visibility_modifier)? - "const" - "fn" - name: (identifier) @function.name - parameters: (parameters) - return_type: (_)? - body: (block) @function.body) @function.definition - """, - - 'class': ("class.definition", "class.name", "class.body", "class.docstring", "class.decorator", """ - ; Struct definitions with optional attributes, visibility, and docstring - (struct_item - (attribute_item)? @class.decorator - (visibility_modifier)? - "struct" - name: (type_identifier) @class.name - body: (field_declaration_list)? @class.body) @class.definition - - (struct_item - (attribute_item)? @class.decorator - (visibility_modifier)? - (line_comment)+ @class.docstring - "struct" - name: (type_identifier) @class.name - body: (field_declaration_list)? @class.body) @class.definition - - ; Enum definitions - (enum_item - (attribute_item)? @class.decorator - (visibility_modifier)? - "enum" - name: (type_identifier) @class.name - body: (enum_variant_list) @class.body) @class.definition - - (enum_item - (attribute_item)? @class.decorator - (visibility_modifier)? - (line_comment)+ @class.docstring - "enum" - name: (type_identifier) @class.name - body: (enum_variant_list) @class.body) @class.definition - - ; Trait definitions - (trait_item - (attribute_item)? @class.decorator - (visibility_modifier)? - "trait" - name: (type_identifier) @class.name - body: (declaration_list) @class.body) @class.definition - - (trait_item - (attribute_item)? @class.decorator - (visibility_modifier)? - (line_comment)+ @class.docstring - "trait" - name: (type_identifier) @class.name - body: (declaration_list) @class.body) @class.definition - - ; Union definitions - (union_item - (attribute_item)? @class.decorator - (visibility_modifier)? - "union" - name: (type_identifier) @class.name - body: (field_declaration_list) @class.body) @class.definition - - (union_item - (attribute_item)? @class.decorator - (visibility_modifier)? - (line_comment)+ @class.docstring - "union" - name: (type_identifier) @class.name - body: (field_declaration_list) @class.body) @class.definition - """) - }, - - "go": { - 'function': """ - ; Function declarations with optional docstring - (function_declaration - (comment)* @function.docstring - name: (identifier) @function.name - body: (block) @function.body) @function.definition - - ; Method declarations with optional docstring - (method_declaration - (comment)* @function.docstring - name: (field_identifier) @function.name - body: (block) @function.body) @function.definition - """, - - 'class': ("class.definition", "class.name", "class.body", "class.docstring", "class.decorator", """ - ; Struct type definitions with optional docstring - (type_declaration - (type_spec - name: (type_identifier) @class.name - type: (struct_type - (field_declaration_list) @class.body))) @class.definition - - (type_declaration - (comment)* @class.docstring - (type_spec - name: (type_identifier) @class.name - type: (struct_type - (field_declaration_list) @class.body))) @class.definition - - ; Interface type definitions with optional docstring - (type_declaration - (type_spec - name: (type_identifier) @class.name - type: (interface_type - (method_spec_list) @class.body))) @class.definition - - (type_declaration - (comment)* @class.docstring - (type_spec - name: (type_identifier) @class.name - type: (interface_type - (method_spec_list) @class.body))) @class.definition - """) - }, - - "cpp": { - 'function': """ - ; Function definitions - (function_definition - declarator: (function_declarator - declarator: (identifier) @function.name) - body: (compound_statement) @function.body) @function.definition - - ; Method definitions - (function_definition - declarator: (function_declarator - declarator: (field_identifier) @function.name) - body: (compound_statement) @function.body) @function.definition - - ; Constructor definitions - (constructor_or_destructor_definition - declarator: (function_declarator - declarator: (qualified_identifier - name: (identifier) @function.name)) - body: (compound_statement) @function.body) @function.definition - - ; Destructor definitions - (constructor_or_destructor_definition - declarator: (function_declarator - declarator: (destructor_name - (identifier) @function.name)) - body: (compound_statement) @function.body) @function.definition - - ; Operator overloading definitions - (function_definition - declarator: (function_declarator - declarator: (operator_name) @function.name) - body: (compound_statement) @function.body) @function.definition - - ; Lambda expressions - (lambda_expression - body: (compound_statement) @function.body) @function.definition - """, - - 'class': ("class.definition", "class.name", "class.body", "class.docstring", "class.decorator", """ - ; Class definitions - (class_specifier - name: (type_identifier) @class.name - body: (field_declaration_list) @class.body) @class.definition - - ; Struct definitions - (struct_specifier - name: (type_identifier) @class.name - body: (field_declaration_list) @class.body) @class.definition - - ; Union definitions - (union_specifier - name: (type_identifier) @class.name - body: (field_declaration_list) @class.body) @class.definition - - ; Enum definitions - (enum_specifier - name: (type_identifier) @class.name - body: (enumerator_list) @class.body) @class.definition - - ; Template class definitions - (template_declaration - (class_specifier - name: (type_identifier) @class.name - body: (field_declaration_list) @class.body)) @class.definition - - ; Template struct definitions - (template_declaration - (struct_specifier - name: (type_identifier) @class.name - body: (field_declaration_list) @class.body)) @class.definition - """) - }, - - "c": { - 'function': """ - ; Function definitions - (function_definition - declarator: (function_declarator - declarator: (identifier) @function.name) - body: (compound_statement) @function.body) @function.definition - - ; Function definitions with type qualifiers - (function_definition - type: (type_qualifier) - declarator: (function_declarator - declarator: (identifier) @function.name) - body: (compound_statement) @function.body) @function.definition - - ; Function declarations (prototypes) - (declaration - declarator: (function_declarator - declarator: (identifier) @function.name)) @function.definition - """, - - 'class': ("class.definition", "class.name", "class.body", "class.docstring", "class.decorator", """ - ; Struct definitions - (struct_specifier - name: (type_identifier) @class.name - body: (field_declaration_list) @class.body) @class.definition - - ; Union definitions - (union_specifier - name: (type_identifier) @class.name - body: (field_declaration_list) @class.body) @class.definition - - ; Enum definitions - (enum_specifier - name: (type_identifier) @class.name - body: (enumerator_list) @class.body) @class.definition - - ; Typedef struct definitions - (declaration - (type_qualifier)* - "typedef" - (type_qualifier)* - (struct_specifier - name: (type_identifier) @class.name - body: (field_declaration_list) @class.body) - (type_identifier)) @class.definition - - ; Typedef union definitions - (declaration - (type_qualifier)* - "typedef" - (type_qualifier)* - (union_specifier - name: (type_identifier) @class.name - body: (field_declaration_list) @class.body) - (type_identifier)) @class.definition - - ; Typedef enum definitions - (declaration - (type_qualifier)* - "typedef" - (type_qualifier)* - (enum_specifier - name: (type_identifier) @class.name - body: (enumerator_list) @class.body) - (type_identifier)) @class.definition - """) - }, - - "java": { - 'function': """ - ; Method declarations - (method_declaration - (modifiers)? @function.decorator - (_method_header - name: (identifier) @function.name) - body: (block) @function.body) @function.definition - - ; Compact constructor declarations (for records) - (compact_constructor_declaration - (modifiers)? @function.decorator - name: (identifier) @function.name - body: (block) @function.body) @function.definition - - ; Constructor declarations - (constructor_declaration - (modifiers)? @function.decorator - (_constructor_declarator - name: (identifier) @function.name) - body: (constructor_body) @function.body) @function.definition - """, - - 'class': ("class.definition", "class.name", "class.body", "class.docstring", "class.decorator", """ - ; Class declarations - (class_declaration - (modifiers)? @class.decorator - "class" - name: (identifier) @class.name - body: (class_body) @class.body) @class.definition - - ; Interface declarations - (interface_declaration - (modifiers)? @class.decorator - "interface" - name: (identifier) @class.name - body: (interface_body) @class.body) @class.definition - - ; Enum declarations - (enum_declaration - (modifiers)? @class.decorator - "enum" - name: (identifier) @class.name - body: (enum_body) @class.body) @class.definition - - ; Record declarations - (record_declaration - (modifiers)? @class.decorator - "record" - name: (identifier) @class.name - body: (class_body) @class.body) @class.definition - - ; Annotation type declarations - (annotation_type_declaration - (modifiers)? @class.decorator - "@interface" - name: (identifier) @class.name - body: (annotation_type_body) @class.body) @class.definition - """) - }, - - "javascript": { - 'function': """ - ; Function declarations - (function_declaration - name: (identifier) @function.name - body: (statement_block) @function.body) @function.definition - - ; Function expressions - (function_expression - name: (identifier)? @function.name - body: (statement_block) @function.body) @function.definition - - ; Arrow functions - (arrow_function - body: [(expression) (statement_block)] @function.body) @function.definition - - ; Method definitions - (method_definition - name: [(property_identifier) (private_property_identifier)] @function.name - body: (statement_block) @function.body) @function.definition - - ; Generator functions - (generator_function_declaration - name: (identifier) @function.name - body: (statement_block) @function.body) @function.definition - - (generator_function - name: (identifier)? @function.name - body: (statement_block) @function.body) @function.definition - - ; Async functions - (function_declaration - "async" - name: (identifier) @function.name - body: (statement_block) @function.body) @function.definition - - (function_expression - "async" - name: (identifier)? @function.name - body: (statement_block) @function.body) @function.definition - - (arrow_function - "async" - body: [(expression) (statement_block)] @function.body) @function.definition - - ; Decorators for class methods - (method_definition - decorator: (decorator)+ @function.decorator - name: [(property_identifier) (private_property_identifier)] @function.name - body: (statement_block) @function.body) @function.definition - """, - - 'class': ("class.definition", "class.name", "class.body", "class.docstring", "class.decorator", """ - ; Class declarations - (class_declaration - name: (identifier) @class.name - body: (class_body) @class.body) @class.definition - - ; Class expressions - (class - name: (identifier)? @class.name - body: (class_body) @class.body) @class.definition - - ; Decorators for classes - (class_declaration - decorator: (decorator)+ @class.decorator - name: (identifier) @class.name - body: (class_body) @class.body) @class.definition - - (class - decorator: (decorator)+ @class.decorator - name: (identifier)? @class.name - body: (class_body) @class.body) @class.definition - """) - }, - - "lua": { - 'function': """ - ; Function definitions - (function_definition - "function" - (parameter_list) @function.parameters - (block) @function.body) @function.definition - - ; Local function definitions - (local_function_definition_statement - "local" "function" - (identifier) @function.name - (parameter_list) @function.parameters - (block) @function.body) @function.definition - - ; Function definition statements - (function_definition_statement - "function" - (identifier) @function.name - (parameter_list) @function.parameters - (block) @function.body) @function.definition - - ; Function definition statements with table methods - (function_definition_statement - "function" - ((identifier) @function.name - ":" (identifier) @function.method) - (parameter_list) @function.parameters - (block) @function.body) @function.definition - """, - - 'class': ("class.definition", "class.name", "class.body", "class.docstring", "class.decorator", """ - ; Lua doesn't have built-in classes, but tables are often used to simulate them - ; We'll capture table definitions that might represent "classes" - (variable_assignment - (variable_list - (variable) @class.name) - "=" - (expression_list - (table) @class.body)) @class.definition - """) - }, - - "fortran": { - 'function': """ - (function - (function_statement - name: (identifier) @function.name) - body: (_) @function.body) @function.definition - """, - - 'class': ("class.definition", "class.name", "class.body", "class.docstring", "class.decorator", """ - (derived_type_definition - (derived_type_statement - name: (_type_name) @class.name) - body: (_) @class.body) @class.definition - """) - }, - - "scala": { - 'function': """ - (function_definition - (annotation)* @function.decorator - (modifiers)? @function.decorator - "def" - name: (_identifier) @function.name - type_parameters: (type_parameters)? - parameters: (parameters)* - return_type: ((_type) @function.return_type)? - body: [ - (indented_block) @function.body - (block) @function.body - (expression) @function.body - ]?) @function.definition - - (function_declaration - (annotation)* @function.decorator - (modifiers)? @function.decorator - "def" - name: (_identifier) @function.name - type_parameters: (type_parameters)? - parameters: (parameters)* - return_type: ((_type) @function.return_type)?) @function.definition - """, - - 'class': ("class.definition", "class.name", "class.body", "class.docstring", "class.decorator", """ - (class_definition - (annotation)* @class.decorator - (modifiers)? @class.decorator - "class" - name: (_identifier) @class.name - type_parameters: (type_parameters)? - parameters: (class_parameters)* - (extends_clause)? - (derives_clause)? - body: (template_body)?) @class.definition - - (object_definition - (annotation)* @class.decorator - (modifiers)? @class.decorator - "object" - name: (_identifier) @class.name - (extends_clause)? - (derives_clause)? - body: (template_body)?) @class.definition - - (trait_definition - (annotation)* @class.decorator - (modifiers)? @class.decorator - "trait" - name: (_identifier) @class.name - type_parameters: (type_parameters)? - parameters: (class_parameters)* - (extends_clause)? - (derives_clause)? - body: (template_body)?) @class.definition - - (enum_definition - (annotation)* @class.decorator - "enum" - name: (_identifier) @class.name - type_parameters: (type_parameters)? - parameters: (class_parameters)* - (extends_clause)? - (derives_clause)? - body: (enum_body)) @class.definition - """) - }, - - "c_sharp": { - 'function': """ - ; Method declarations - (method_declaration - (attribute_list)? @function.decorator - (modifier)* @function.decorator - type: (_) - name: (identifier) @function.name - parameters: (parameter_list) - body: (block) @function.body) @function.definition - - ; Constructor declarations - (constructor_declaration - (attribute_list)? @function.decorator - (modifier)* @function.decorator - name: (identifier) @function.name - parameters: (parameter_list) - body: (block) @function.body) @function.definition - - ; Destructor declarations - (destructor_declaration - (attribute_list)? @function.decorator - "extern"? @function.decorator - "~" - name: (identifier) @function.name - parameters: (parameter_list) - body: (block) @function.body) @function.definition - - ; Operator declarations - (operator_declaration - (attribute_list)? @function.decorator - (modifier)* @function.decorator - type: (_) - "operator" - operator: (_) - parameters: (parameter_list) - body: (block) @function.body) @function.definition - - ; Conversion operator declarations - (conversion_operator_declaration - (attribute_list)? @function.decorator - (modifier)* @function.decorator - ("implicit" | "explicit") - "operator" - type: (_) - parameters: (parameter_list) - body: (block) @function.body) @function.definition - - ; Local function statements - (local_function_statement - (attribute_list)? @function.decorator - (modifier)* @function.decorator - type: (_) - name: (identifier) @function.name - parameters: (parameter_list) - body: (block) @function.body) @function.definition - """, - - 'class': ("class.definition", "class.name", "class.body", "class.docstring", "class.decorator", """ - ; Class declarations - (class_declaration - (attribute_list)? @class.decorator - (modifier)* @class.decorator - "class" - name: (identifier) @class.name - body: (declaration_list) @class.body) @class.definition - - ; Struct declarations - (struct_declaration - (attribute_list)? @class.decorator - (modifier)* @class.decorator - "struct" - name: (identifier) @class.name - body: (declaration_list) @class.body) @class.definition - - ; Interface declarations - (interface_declaration - (attribute_list)? @class.decorator - (modifier)* @class.decorator - "interface" - name: (identifier) @class.name - body: (declaration_list) @class.body) @class.definition - - ; Enum declarations - (enum_declaration - (attribute_list)? @class.decorator - (modifier)* @class.decorator - "enum" - name: (identifier) @class.name - body: (enum_member_declaration_list) @class.body) @class.definition - - ; Record declarations - (record_declaration - (attribute_list)? @class.decorator - (modifier)* @class.decorator - "record" - name: (identifier) @class.name - body: (declaration_list) @class.body) @class.definition - """) - }, - - "cobol": { - 'function': """ - (function_definition - (function_division - name: (program_name) @function.name) - (environment_division)? - (data_division)? - (procedure_division) @function.body) @function.definition - """, - - 'class': ("class.definition", "class.name", "class.body", "class.docstring", "class.decorator", """ - (data_division - (file_section - (file_description - name: (WORD) @class.name - (record_description_list) @class.body))) @class.definition - - (data_division - (working_storage_section - (data_description - level_number: (level_number) - name: (entry_name) @class.name - (repeat ($._data_description_clause))* @class.body))) @class.definition - """) - }, - - "matlab": { - 'function': """ - (function_definition - (function_output)? - name: (identifier) @function.name - (function_arguments)? - (_end_of_line) - (arguments_statement)* - body: (block)? @function.body) @function.definition - - (function_definition - (function_output)? - "get." @function.decorator - name: (identifier) @function.name - (function_arguments)? - (_end_of_line) - (arguments_statement)* - body: (block)? @function.body) @function.definition - - (function_definition - (function_output)? - "set." @function.decorator - name: (identifier) @function.name - (function_arguments)? - (_end_of_line) - (arguments_statement)* - body: (block)? @function.body) @function.definition - """, - - 'class': ("class.definition", "class.name", "class.body", "class.docstring", "class.decorator", """ - (class_definition - (attributes)? @class.decorator - name: (identifier) @class.name - (superclasses)? - (_end_of_line) - body: (_ (properties | methods | events | enumeration | ";")*)+ @class.body) @class.definition - """) +def get_query(langstr: str) -> dict[str, str]: + basedir = _tree_sitter_queries / langstr + if not basedir.exists(): + raise KeyError(f"Missing language dir: {basedir}") + base_template = (basedir / "basedef.scm").read_text(encoding='utf-8') + common_template = (basedir / "common.scm").read_text(encoding='utf-8') + templates2 = { + "function": (basedir / "functions.scm").read_text(encoding='utf-8'), + "class": (basedir / "classes.scm").read_text(encoding='utf-8') + } + return { + _type: templates2[_type].format( + definition_base=base_template.format(type=_type), + common_body=common_template.format(type=_type) + ) + for _type in ["function", "class"] } - -} diff --git a/src/text_manipulation/__init__.py b/src/text_manipulation/__init__.py index 1a8552b..96a6f58 100644 --- a/src/text_manipulation/__init__.py +++ b/src/text_manipulation/__init__.py @@ -1,3 +1,4 @@ +from version import __version__ from .line_kit import get_line_indent_count, extract_indentation from .range_spec import RangeSpec, IdentifierBoundaries from .text_editor_kit import read_file, write_file, bow_to_search_range @@ -5,6 +6,7 @@ from .indentation_kit import IndentationInfo __all__ = [ + "__version__", "IndentationInfo", "IdentifierBoundaries", "IdentifierFinder", diff --git a/src/text_manipulation/range_spec.py b/src/text_manipulation/range_spec.py index 8f02e8e..1f9a6e8 100644 --- a/src/text_manipulation/range_spec.py +++ b/src/text_manipulation/range_spec.py @@ -13,6 +13,7 @@ from collections.abc import Sequence from typing import NamedTuple, TypeAlias from functools import total_ordering +from dataclasses import dataclass, field from cedarscript_ast_parser import Marker, RelativeMarker, RelativePositionType, MarkerType, BodyOrWhole @@ -331,8 +332,8 @@ class ParentInfo(NamedTuple): ParentRestriction: TypeAlias = RangeSpec | str | None - -class IdentifierBoundaries(NamedTuple): +@dataclass +class IdentifierBoundaries: """ Represents the boundaries of an identifier in code, including its whole range and body range. @@ -347,8 +348,12 @@ class IdentifierBoundaries(NamedTuple): whole: RangeSpec body: RangeSpec | None = None docstring: RangeSpec | None = None - decorators: list[RangeSpec] = [] - parents: list[ParentInfo] = [] + decorators: list[RangeSpec] = field(default_factory=list) + parents: list[ParentInfo] = field(default_factory=list) + + def append_decorator(self, decorator: RangeSpec): + self.decorators.append(decorator) + self.whole = self.whole._replace(start = min(self.whole.start, decorator.start)) def __str__(self): return f'IdentifierBoundaries({self.whole} (BODY: {self.body}) )' @@ -361,7 +366,7 @@ def start_line(self) -> int: @property def body_start_line(self) -> int: """Return the 1-indexed start line of the identifier's body.""" - return self.body.start + 1 + return self.body.start + 1 if self.body else None @property def end_line(self) -> int: diff --git a/src/text_manipulation/text_editor_kit.py b/src/text_manipulation/text_editor_kit.py index 836992e..0c0a342 100644 --- a/src/text_manipulation/text_editor_kit.py +++ b/src/text_manipulation/text_editor_kit.py @@ -8,7 +8,7 @@ from collections.abc import Sequence from typing import Protocol, runtime_checkable -from os import PathLike +from os import PathLike, path from cedarscript_ast_parser import Marker, RelativeMarker, RelativePositionType, Segment, MarkerType, BodyOrWhole from .range_spec import IdentifierBoundaries, RangeSpec @@ -24,7 +24,7 @@ def read_file(file_path: str | PathLike) -> str: Returns: str: The contents of the file as a string. """ - with open(file_path, 'r') as file: + with open(path.normpath(file_path), 'r') as file: return file.read() @@ -36,7 +36,7 @@ def write_file(file_path: str | PathLike, lines: Sequence[str]): file_path (str | PathLike): The path to the file to be written. lines (Sequence[str]): The lines to be written to the file. """ - with open(file_path, 'w') as file: + with open(path.normpath(file_path), 'w') as file: file.writelines([line + '\n' for line in lines]) diff --git a/src/tree-sitter-queries/TODO/TODO.txt b/src/tree-sitter-queries/TODO/TODO.txt new file mode 100644 index 0000000..b298f4d --- /dev/null +++ b/src/tree-sitter-queries/TODO/TODO.txt @@ -0,0 +1,845 @@ +LANG_TO_TREE_SITTER_QUERY = { + "php": { + 'function': """ + ; Regular function definitions with optional attributes and docstring + (function_definition + (attribute_list)? @function.decorator + name: (name) @function.name + body: (compound_statement) @function.body) @function.definition + + (function_definition + (attribute_list)? @function.decorator + (comment) @function.docstring + name: (name) @function.name + body: (compound_statement) @function.body) @function.definition + + ; Method definitions in classes with optional attributes and docstring + (method_declaration + (attribute_list)? @function.decorator + name: (name) @function.name + body: (compound_statement) @function.body) @function.definition + + (method_declaration + (attribute_list)? @function.decorator + (comment) @function.docstring + name: (name) @function.name + body: (compound_statement) @function.body) @function.definition + + ; Anonymous functions + (anonymous_function + (attribute_list)? @function.decorator + body: (compound_statement) @function.body) @function.definition + + ; Arrow functions + (arrow_function + (attribute_list)? @function.decorator + body: (expression) @function.body) @function.definition + """, + + 'class': ("class.definition", "class.name", "class.body", "class.docstring", "class.decorator", """ + ; Regular class definitions with optional attributes and docstring + (class_declaration + (attribute_list)? @class.decorator + name: (name) @class.name + body: (declaration_list) @class.body) @class.definition + + (class_declaration + (attribute_list)? @class.decorator + (comment) @class.docstring + name: (name) @class.name + body: (declaration_list) @class.body) @class.definition + + ; Interface definitions + (interface_declaration + (attribute_list)? @class.decorator + name: (name) @class.name + body: (declaration_list) @class.body) @class.definition + + (interface_declaration + (attribute_list)? @class.decorator + (comment) @class.docstring + name: (name) @class.name + body: (declaration_list) @class.body) @class.definition + + ; Trait definitions + (trait_declaration + (attribute_list)? @class.decorator + name: (name) @class.name + body: (declaration_list) @class.body) @class.definition + + (trait_declaration + (attribute_list)? @class.decorator + (comment) @class.docstring + name: (name) @class.name + body: (declaration_list) @class.body) @class.definition + + ; Enum definitions + (enum_declaration + (attribute_list)? @class.decorator + name: (name) @class.name + body: (enum_declaration_list) @class.body) @class.definition + + (enum_declaration + (attribute_list)? @class.decorator + (comment) @class.docstring + name: (name) @class.name + body: (enum_declaration_list) @class.body) @class.definition + """) + }, + + "rust": { + 'function': """ + ; Function definitions with optional attributes, visibility, and docstring + (function_item + (attribute_item)? @function.decorator + (visibility_modifier)? + (function_modifiers)? + "fn" + name: (identifier) @function.name + parameters: (parameters) + return_type: (_)? + body: (block) @function.body) @function.definition + + (function_item + (attribute_item)? @function.decorator + (visibility_modifier)? + (function_modifiers)? + (line_comment)+ @function.docstring + "fn" + name: (identifier) @function.name + parameters: (parameters) + return_type: (_)? + body: (block) @function.body) @function.definition + + ; Method definitions in impl blocks + (impl_item + (attribute_item)? @function.decorator + (visibility_modifier)? + (function_modifiers)? + "fn" + name: (identifier) @function.name + parameters: (parameters) + return_type: (_)? + body: (block) @function.body) @function.definition + + (impl_item + (attribute_item)? @function.decorator + (visibility_modifier)? + (function_modifiers)? + (line_comment)+ @function.docstring + "fn" + name: (identifier) @function.name + parameters: (parameters) + return_type: (_)? + body: (block) @function.body) @function.definition + + ; Async function definitions + (function_item + (attribute_item)? @function.decorator + (visibility_modifier)? + "async" + "fn" + name: (identifier) @function.name + parameters: (parameters) + return_type: (_)? + body: (block) @function.body) @function.definition + + ; Const function definitions + (function_item + (attribute_item)? @function.decorator + (visibility_modifier)? + "const" + "fn" + name: (identifier) @function.name + parameters: (parameters) + return_type: (_)? + body: (block) @function.body) @function.definition + """, + + 'class': ("class.definition", "class.name", "class.body", "class.docstring", "class.decorator", """ + ; Struct definitions with optional attributes, visibility, and docstring + (struct_item + (attribute_item)? @class.decorator + (visibility_modifier)? + "struct" + name: (type_identifier) @class.name + body: (field_declaration_list)? @class.body) @class.definition + + (struct_item + (attribute_item)? @class.decorator + (visibility_modifier)? + (line_comment)+ @class.docstring + "struct" + name: (type_identifier) @class.name + body: (field_declaration_list)? @class.body) @class.definition + + ; Enum definitions + (enum_item + (attribute_item)? @class.decorator + (visibility_modifier)? + "enum" + name: (type_identifier) @class.name + body: (enum_variant_list) @class.body) @class.definition + + (enum_item + (attribute_item)? @class.decorator + (visibility_modifier)? + (line_comment)+ @class.docstring + "enum" + name: (type_identifier) @class.name + body: (enum_variant_list) @class.body) @class.definition + + ; Trait definitions + (trait_item + (attribute_item)? @class.decorator + (visibility_modifier)? + "trait" + name: (type_identifier) @class.name + body: (declaration_list) @class.body) @class.definition + + (trait_item + (attribute_item)? @class.decorator + (visibility_modifier)? + (line_comment)+ @class.docstring + "trait" + name: (type_identifier) @class.name + body: (declaration_list) @class.body) @class.definition + + ; Union definitions + (union_item + (attribute_item)? @class.decorator + (visibility_modifier)? + "union" + name: (type_identifier) @class.name + body: (field_declaration_list) @class.body) @class.definition + + (union_item + (attribute_item)? @class.decorator + (visibility_modifier)? + (line_comment)+ @class.docstring + "union" + name: (type_identifier) @class.name + body: (field_declaration_list) @class.body) @class.definition + """) + }, + + "go": { + 'function': """ + ; Function declarations with optional docstring + (function_declaration + (comment)* @function.docstring + name: (identifier) @function.name + body: (block) @function.body) @function.definition + + ; Method declarations with optional docstring + (method_declaration + (comment)* @function.docstring + name: (field_identifier) @function.name + body: (block) @function.body) @function.definition + """, + + 'class': ("class.definition", "class.name", "class.body", "class.docstring", "class.decorator", """ + ; Struct type definitions with optional docstring + (type_declaration + (type_spec + name: (type_identifier) @class.name + type: (struct_type + (field_declaration_list) @class.body))) @class.definition + + (type_declaration + (comment)* @class.docstring + (type_spec + name: (type_identifier) @class.name + type: (struct_type + (field_declaration_list) @class.body))) @class.definition + + ; Interface type definitions with optional docstring + (type_declaration + (type_spec + name: (type_identifier) @class.name + type: (interface_type + (method_spec_list) @class.body))) @class.definition + + (type_declaration + (comment)* @class.docstring + (type_spec + name: (type_identifier) @class.name + type: (interface_type + (method_spec_list) @class.body))) @class.definition + """) + }, + + "cpp": { + 'function': """ + ; Function definitions + (function_definition + declarator: (function_declarator + declarator: (identifier) @function.name) + body: (compound_statement) @function.body) @function.definition + + ; Method definitions + (function_definition + declarator: (function_declarator + declarator: (field_identifier) @function.name) + body: (compound_statement) @function.body) @function.definition + + ; Constructor definitions + (constructor_or_destructor_definition + declarator: (function_declarator + declarator: (qualified_identifier + name: (identifier) @function.name)) + body: (compound_statement) @function.body) @function.definition + + ; Destructor definitions + (constructor_or_destructor_definition + declarator: (function_declarator + declarator: (destructor_name + (identifier) @function.name)) + body: (compound_statement) @function.body) @function.definition + + ; Operator overloading definitions + (function_definition + declarator: (function_declarator + declarator: (operator_name) @function.name) + body: (compound_statement) @function.body) @function.definition + + ; Lambda expressions + (lambda_expression + body: (compound_statement) @function.body) @function.definition + """, + + 'class': ("class.definition", "class.name", "class.body", "class.docstring", "class.decorator", """ + ; Class definitions + (class_specifier + name: (type_identifier) @class.name + body: (field_declaration_list) @class.body) @class.definition + + ; Struct definitions + (struct_specifier + name: (type_identifier) @class.name + body: (field_declaration_list) @class.body) @class.definition + + ; Union definitions + (union_specifier + name: (type_identifier) @class.name + body: (field_declaration_list) @class.body) @class.definition + + ; Enum definitions + (enum_specifier + name: (type_identifier) @class.name + body: (enumerator_list) @class.body) @class.definition + + ; Template class definitions + (template_declaration + (class_specifier + name: (type_identifier) @class.name + body: (field_declaration_list) @class.body)) @class.definition + + ; Template struct definitions + (template_declaration + (struct_specifier + name: (type_identifier) @class.name + body: (field_declaration_list) @class.body)) @class.definition + """) + }, + + "c": { + 'function': """ + ; Function definitions + (function_definition + declarator: (function_declarator + declarator: (identifier) @function.name) + body: (compound_statement) @function.body) @function.definition + + ; Function definitions with type qualifiers + (function_definition + type: (type_qualifier) + declarator: (function_declarator + declarator: (identifier) @function.name) + body: (compound_statement) @function.body) @function.definition + + ; Function declarations (prototypes) + (declaration + declarator: (function_declarator + declarator: (identifier) @function.name)) @function.definition + """, + + 'class': ("class.definition", "class.name", "class.body", "class.docstring", "class.decorator", """ + ; Struct definitions + (struct_specifier + name: (type_identifier) @class.name + body: (field_declaration_list) @class.body) @class.definition + + ; Union definitions + (union_specifier + name: (type_identifier) @class.name + body: (field_declaration_list) @class.body) @class.definition + + ; Enum definitions + (enum_specifier + name: (type_identifier) @class.name + body: (enumerator_list) @class.body) @class.definition + + ; Typedef struct definitions + (declaration + (type_qualifier)* + "typedef" + (type_qualifier)* + (struct_specifier + name: (type_identifier) @class.name + body: (field_declaration_list) @class.body) + (type_identifier)) @class.definition + + ; Typedef union definitions + (declaration + (type_qualifier)* + "typedef" + (type_qualifier)* + (union_specifier + name: (type_identifier) @class.name + body: (field_declaration_list) @class.body) + (type_identifier)) @class.definition + + ; Typedef enum definitions + (declaration + (type_qualifier)* + "typedef" + (type_qualifier)* + (enum_specifier + name: (type_identifier) @class.name + body: (enumerator_list) @class.body) + (type_identifier)) @class.definition + """) + }, + + "java": { + 'function': """ + ; Method declarations + (method_declaration + (modifiers)? @function.decorator + (_method_header + name: (identifier) @function.name) + body: (block) @function.body) @function.definition + + ; Compact constructor declarations (for records) + (compact_constructor_declaration + (modifiers)? @function.decorator + name: (identifier) @function.name + body: (block) @function.body) @function.definition + + ; Constructor declarations + (constructor_declaration + (modifiers)? @function.decorator + (_constructor_declarator + name: (identifier) @function.name) + body: (constructor_body) @function.body) @function.definition + """, + + 'class': ("class.definition", "class.name", "class.body", "class.docstring", "class.decorator", """ + ; Class declarations + (class_declaration + (modifiers)? @class.decorator + "class" + name: (identifier) @class.name + body: (class_body) @class.body) @class.definition + + ; Interface declarations + (interface_declaration + (modifiers)? @class.decorator + "interface" + name: (identifier) @class.name + body: (interface_body) @class.body) @class.definition + + ; Enum declarations + (enum_declaration + (modifiers)? @class.decorator + "enum" + name: (identifier) @class.name + body: (enum_body) @class.body) @class.definition + + ; Record declarations + (record_declaration + (modifiers)? @class.decorator + "record" + name: (identifier) @class.name + body: (class_body) @class.body) @class.definition + + ; Annotation type declarations + (annotation_type_declaration + (modifiers)? @class.decorator + "@interface" + name: (identifier) @class.name + body: (annotation_type_body) @class.body) @class.definition + """) + }, + + "javascript": { + 'function': """ + ; Function declarations + (function_declaration + name: (identifier) @function.name + body: (statement_block) @function.body) @function.definition + + ; Function expressions + (function_expression + name: (identifier)? @function.name + body: (statement_block) @function.body) @function.definition + + ; Arrow functions + (arrow_function + body: [(expression) (statement_block)] @function.body) @function.definition + + ; Method definitions + (method_definition + name: [(property_identifier) (private_property_identifier)] @function.name + body: (statement_block) @function.body) @function.definition + + ; Generator functions + (generator_function_declaration + name: (identifier) @function.name + body: (statement_block) @function.body) @function.definition + + (generator_function + name: (identifier)? @function.name + body: (statement_block) @function.body) @function.definition + + ; Async functions + (function_declaration + "async" + name: (identifier) @function.name + body: (statement_block) @function.body) @function.definition + + (function_expression + "async" + name: (identifier)? @function.name + body: (statement_block) @function.body) @function.definition + + (arrow_function + "async" + body: [(expression) (statement_block)] @function.body) @function.definition + + ; Decorators for class methods + (method_definition + decorator: (decorator)+ @function.decorator + name: [(property_identifier) (private_property_identifier)] @function.name + body: (statement_block) @function.body) @function.definition + """, + + 'class': ("class.definition", "class.name", "class.body", "class.docstring", "class.decorator", """ + ; Class declarations + (class_declaration + name: (identifier) @class.name + body: (class_body) @class.body) @class.definition + + ; Class expressions + (class + name: (identifier)? @class.name + body: (class_body) @class.body) @class.definition + + ; Decorators for classes + (class_declaration + decorator: (decorator)+ @class.decorator + name: (identifier) @class.name + body: (class_body) @class.body) @class.definition + + (class + decorator: (decorator)+ @class.decorator + name: (identifier)? @class.name + body: (class_body) @class.body) @class.definition + """) + }, + + "lua": { + 'function': """ + ; Function definitions + (function_definition + "function" + (parameter_list) @function.parameters + (block) @function.body) @function.definition + + ; Local function definitions + (local_function_definition_statement + "local" "function" + (identifier) @function.name + (parameter_list) @function.parameters + (block) @function.body) @function.definition + + ; Function definition statements + (function_definition_statement + "function" + (identifier) @function.name + (parameter_list) @function.parameters + (block) @function.body) @function.definition + + ; Function definition statements with table methods + (function_definition_statement + "function" + ((identifier) @function.name + ":" (identifier) @function.method) + (parameter_list) @function.parameters + (block) @function.body) @function.definition + """, + + 'class': ("class.definition", "class.name", "class.body", "class.docstring", "class.decorator", """ + ; Lua doesn't have built-in classes, but tables are often used to simulate them + ; We'll capture table definitions that might represent "classes" + (variable_assignment + (variable_list + (variable) @class.name) + "=" + (expression_list + (table) @class.body)) @class.definition + """) + }, + + "fortran": { + 'function': """ + (function + (function_statement + name: (identifier) @function.name) + body: (_) @function.body) @function.definition + """, + + 'class': ("class.definition", "class.name", "class.body", "class.docstring", "class.decorator", """ + (derived_type_definition + (derived_type_statement + name: (_type_name) @class.name) + body: (_) @class.body) @class.definition + """) + }, + + "scala": { + 'function': """ + (function_definition + (annotation)* @function.decorator + (modifiers)? @function.decorator + "def" + name: (_identifier) @function.name + type_parameters: (type_parameters)? + parameters: (parameters)* + return_type: ((_type) @function.return_type)? + body: [ + (indented_block) @function.body + (block) @function.body + (expression) @function.body + ]?) @function.definition + + (function_declaration + (annotation)* @function.decorator + (modifiers)? @function.decorator + "def" + name: (_identifier) @function.name + type_parameters: (type_parameters)? + parameters: (parameters)* + return_type: ((_type) @function.return_type)?) @function.definition + """, + + 'class': ("class.definition", "class.name", "class.body", "class.docstring", "class.decorator", """ + (class_definition + (annotation)* @class.decorator + (modifiers)? @class.decorator + "class" + name: (_identifier) @class.name + type_parameters: (type_parameters)? + parameters: (class_parameters)* + (extends_clause)? + (derives_clause)? + body: (template_body)?) @class.definition + + (object_definition + (annotation)* @class.decorator + (modifiers)? @class.decorator + "object" + name: (_identifier) @class.name + (extends_clause)? + (derives_clause)? + body: (template_body)?) @class.definition + + (trait_definition + (annotation)* @class.decorator + (modifiers)? @class.decorator + "trait" + name: (_identifier) @class.name + type_parameters: (type_parameters)? + parameters: (class_parameters)* + (extends_clause)? + (derives_clause)? + body: (template_body)?) @class.definition + + (enum_definition + (annotation)* @class.decorator + "enum" + name: (_identifier) @class.name + type_parameters: (type_parameters)? + parameters: (class_parameters)* + (extends_clause)? + (derives_clause)? + body: (enum_body)) @class.definition + """) + }, + + "c_sharp": { + 'function': """ + ; Method declarations + (method_declaration + (attribute_list)? @function.decorator + (modifier)* @function.decorator + type: (_) + name: (identifier) @function.name + parameters: (parameter_list) + body: (block) @function.body) @function.definition + + ; Constructor declarations + (constructor_declaration + (attribute_list)? @function.decorator + (modifier)* @function.decorator + name: (identifier) @function.name + parameters: (parameter_list) + body: (block) @function.body) @function.definition + + ; Destructor declarations + (destructor_declaration + (attribute_list)? @function.decorator + "extern"? @function.decorator + "~" + name: (identifier) @function.name + parameters: (parameter_list) + body: (block) @function.body) @function.definition + + ; Operator declarations + (operator_declaration + (attribute_list)? @function.decorator + (modifier)* @function.decorator + type: (_) + "operator" + operator: (_) + parameters: (parameter_list) + body: (block) @function.body) @function.definition + + ; Conversion operator declarations + (conversion_operator_declaration + (attribute_list)? @function.decorator + (modifier)* @function.decorator + ("implicit" | "explicit") + "operator" + type: (_) + parameters: (parameter_list) + body: (block) @function.body) @function.definition + + ; Local function statements + (local_function_statement + (attribute_list)? @function.decorator + (modifier)* @function.decorator + type: (_) + name: (identifier) @function.name + parameters: (parameter_list) + body: (block) @function.body) @function.definition + """, + + 'class': ("class.definition", "class.name", "class.body", "class.docstring", "class.decorator", """ + ; Class declarations + (class_declaration + (attribute_list)? @class.decorator + (modifier)* @class.decorator + "class" + name: (identifier) @class.name + body: (declaration_list) @class.body) @class.definition + + ; Struct declarations + (struct_declaration + (attribute_list)? @class.decorator + (modifier)* @class.decorator + "struct" + name: (identifier) @class.name + body: (declaration_list) @class.body) @class.definition + + ; Interface declarations + (interface_declaration + (attribute_list)? @class.decorator + (modifier)* @class.decorator + "interface" + name: (identifier) @class.name + body: (declaration_list) @class.body) @class.definition + + ; Enum declarations + (enum_declaration + (attribute_list)? @class.decorator + (modifier)* @class.decorator + "enum" + name: (identifier) @class.name + body: (enum_member_declaration_list) @class.body) @class.definition + + ; Record declarations + (record_declaration + (attribute_list)? @class.decorator + (modifier)* @class.decorator + "record" + name: (identifier) @class.name + body: (declaration_list) @class.body) @class.definition + """) + }, + + "cobol": { + 'function': """ + (function_definition + (function_division + name: (program_name) @function.name) + (environment_division)? + (data_division)? + (procedure_division) @function.body) @function.definition + """, + + 'class': ("class.definition", "class.name", "class.body", "class.docstring", "class.decorator", """ + (data_division + (file_section + (file_description + name: (WORD) @class.name + (record_description_list) @class.body))) @class.definition + + (data_division + (working_storage_section + (data_description + level_number: (level_number) + name: (entry_name) @class.name + (repeat ($._data_description_clause))* @class.body))) @class.definition + """) + }, + + "matlab": { + 'function': """ + (function_definition + (function_output)? + name: (identifier) @function.name + (function_arguments)? + (_end_of_line) + (arguments_statement)* + body: (block)? @function.body) @function.definition + + (function_definition + (function_output)? + "get." @function.decorator + name: (identifier) @function.name + (function_arguments)? + (_end_of_line) + (arguments_statement)* + body: (block)? @function.body) @function.definition + + (function_definition + (function_output)? + "set." @function.decorator + name: (identifier) @function.name + (function_arguments)? + (_end_of_line) + (arguments_statement)* + body: (block)? @function.body) @function.definition + """, + + 'class': ("class.definition", "class.name", "class.body", "class.docstring", "class.decorator", """ + (class_definition + (attributes)? @class.decorator + name: (identifier) @class.name + (superclasses)? + (_end_of_line) + body: (_ (properties | methods | events | enumeration | ";")*)+ @class.body) @class.definition + """) + } \ No newline at end of file diff --git a/src/tree-sitter-queries/kotlin/basedef.scm b/src/tree-sitter-queries/kotlin/basedef.scm new file mode 100644 index 0000000..3945591 --- /dev/null +++ b/src/tree-sitter-queries/kotlin/basedef.scm @@ -0,0 +1,3 @@ +name: (simple_identifier) @_{type}_name +(#match? @_{type}_name "^{{name}}$") +(#set! role name) diff --git a/src/tree-sitter-queries/kotlin/classes.scm b/src/tree-sitter-queries/kotlin/classes.scm new file mode 100644 index 0000000..2514261 --- /dev/null +++ b/src/tree-sitter-queries/kotlin/classes.scm @@ -0,0 +1,28 @@ +; Regular class definitions with optional annotations and KDoc +(class_declaration + (modifiers (annotation) )* @class.decorator + (comment)? @class.docstring + ["data" "enum"]? @class.subtype + {definition_base} + body: (class_body) @class.body +) @class.definition + +; Interface definitions +(interface_declaration + (modifiers (annotation) @class.decorator)* + (comment)? @class.docstring + name: (type_identifier) @_class_name + (#match? @_class_name "^{{name}}$") + (#set! role name) + body: (class_body) @class.body +) @class.definition + +; Object declarations +(object_declaration + (modifiers (annotation) @class.decorator)* + (comment)? @class.docstring + name: (type_identifier) @_class_name + (#match? @_class_name "^{{name}}$") + (#set! role name) + body: (class_body) @class.body +) @class.definition diff --git a/src/tree-sitter-queries/kotlin/common.scm b/src/tree-sitter-queries/kotlin/common.scm new file mode 100644 index 0000000..e69de29 diff --git a/src/tree-sitter-queries/kotlin/functions.scm b/src/tree-sitter-queries/kotlin/functions.scm new file mode 100644 index 0000000..462f3d1 --- /dev/null +++ b/src/tree-sitter-queries/kotlin/functions.scm @@ -0,0 +1,21 @@ +(function_declaration + (comment)? @function.docstring + (modifiers (annotation) )* @function.decorator + (receiver_type: (type_reference))? @function.receiver + (comment)? @function.docstring + {definition_base} + (type_parameters: (type_parameters))? @function.type_parameters + body: (function_body) @function.body +) @function.definition + +; Constructor definitions +(constructor_declaration + (modifiers (annotation) )* @function.decorator + (comment)? @function.docstring + body: (function_body) @function.body +) @function.definition + +; Lambda expressions +(lambda_literal + body: (_) @function.body +) @function.definition \ No newline at end of file diff --git a/src/tree-sitter-queries/python/basedef.scm b/src/tree-sitter-queries/python/basedef.scm new file mode 100644 index 0000000..cd512a5 --- /dev/null +++ b/src/tree-sitter-queries/python/basedef.scm @@ -0,0 +1,3 @@ +name: (identifier) @_{type}_name +(#match? @_{type}_name "^{{name}}$") +(#set! role name) diff --git a/src/tree-sitter-queries/python/classes.scm b/src/tree-sitter-queries/python/classes.scm new file mode 100644 index 0000000..1a8fc49 --- /dev/null +++ b/src/tree-sitter-queries/python/classes.scm @@ -0,0 +1,37 @@ +; Class Definitions +(class_definition + {definition_base} + {common_body} +) @class.definition + +; Decorated Class Definitions +(decorated_definition + (decorator)+ @class.decorator + (class_definition + {definition_base} + {common_body} + ) @class.definition +) + +; Nested Classes +(class_definition + body: (block + (class_definition + {definition_base} + {common_body} + ) @class.definition + ) +) + +; Decorated Nested Classes +(class_definition + body: (block + (decorated_definition + (decorator)+ @class.decorator + (class_definition + {definition_base} + {common_body} + ) @class.definition + ) + ) +) diff --git a/src/tree-sitter-queries/python/common.scm b/src/tree-sitter-queries/python/common.scm new file mode 100644 index 0000000..8d196ab --- /dev/null +++ b/src/tree-sitter-queries/python/common.scm @@ -0,0 +1,6 @@ +; Common pattern for body and docstring capture +body: (block + . + (expression_statement + (string) @{type}.docstring)? + ) @{type}.body diff --git a/src/tree-sitter-queries/python/functions.scm b/src/tree-sitter-queries/python/functions.scm new file mode 100644 index 0000000..76d1912 --- /dev/null +++ b/src/tree-sitter-queries/python/functions.scm @@ -0,0 +1,14 @@ +; Function Definitions +(function_definition + {definition_base} + {common_body} +) @function.definition + +; Decorated Function Definitions +(decorated_definition + (decorator)+ @function.decorator + (function_definition + {definition_base} + {common_body} + ) @function.definition +) diff --git a/src/version/__init__.py b/src/version/__init__.py new file mode 100644 index 0000000..32495d2 --- /dev/null +++ b/src/version/__init__.py @@ -0,0 +1,3 @@ +from ._version import version + +__version__ = version diff --git a/tests/corpus/chat.make-top-level-from-method.1/chat.xml b/tests/corpus/chat.make-top-level-from-method.1/chat.xml index 0e22884..9fd81e1 100644 --- a/tests/corpus/chat.make-top-level-from-method.1/chat.xml +++ b/tests/corpus/chat.make-top-level-from-method.1/chat.xml @@ -11,14 +11,14 @@ Here's my plan to implement the requested changes: Here's the CEDARScript script: ```CEDARScript --- 1. Move the `_candidate()` method from the `A` class, placing it at the top level, just before the line where its class starts +# 1. Move the `_candidate()` method from the `A` class, placing it at the top level, just before the line where its class starts UPDATE CLASS "A" FROM FILE "main.py" MOVE FUNCTION "_candidate" INSERT BEFORE CLASS "A" RELATIVE INDENTATION 0; --- 2. Update the copied function to remove references to `self` +# 2. Update the copied function to remove references to `self` UPDATE FUNCTION "_candidate" FROM FILE "main.py" REPLACE LINE "def _candidate(self, a, b, c):" @@ -26,7 +26,7 @@ WITH CONTENT ''' @0:def _candidate(a, b, c): '''; --- 3. Update ALL call sites of the method `_candidate()` to call the new top-level function with the same name +# 3. Update ALL call sites of the method `_candidate()` to call the new top-level function with the same name UPDATE FUNCTION "_check" FROM FILE "main.py" REPLACE LINE "self._candidate(" diff --git a/tests/corpus/move.decorated-method/1.py b/tests/corpus/move.decorated-method/1.py new file mode 100644 index 0000000..77b936c --- /dev/null +++ b/tests/corpus/move.decorated-method/1.py @@ -0,0 +1,24 @@ +class SpyderKernel(IPythonKernel): + """Spyder kernel for Jupyter.""" + + shell_class = SpyderShell + @comm_handler + def safe_exec(self, filename): + """Safely execute a file using IPKernelApp._exec_file.""" + self.parent._exec_file(filename) + + @comm_handler + def get_fault_text(self, fault_filename, main_id, ignore_ids): + """Get fault text from old run.""" + # Read file + try: + with open(fault_filename, 'r') as f: + fault = f.read() + except FileNotFoundError: + return + return text + + def get_system_threads_id(self): + """Return the list of system threads id.""" + ignore_threads = [ + ] diff --git a/tests/corpus/move.decorated-method/chat.xml b/tests/corpus/move.decorated-method/chat.xml new file mode 100644 index 0000000..e81bef5 --- /dev/null +++ b/tests/corpus/move.decorated-method/chat.xml @@ -0,0 +1,20 @@ + +```CEDARScript +# 1. Move the `get_fault_text` method from the `SpyderKernel` class to be a top-level function +UPDATE METHOD "SpyderKernel.get_fault_text" +FROM FILE "1.py" +MOVE WHOLE +INSERT BEFORE CLASS "SpyderKernel" +RELATIVE INDENTATION 0; + +# 2. Update the copied function to remove references to `self` +UPDATE FUNCTION "get_fault_text" +FROM FILE r"1.py" +REPLACE WHOLE WITH CASE +WHEN REGEX r'''def get_fault_text\(''' THEN SUB +r'''def get_fault_text\(self, fault_filename, main_id, ignore_ids\):''' +r'''def get_fault_text(fault_filename, main_id, ignore_ids):''' +END; + +``` + diff --git a/tests/corpus/move.decorated-method/expected.1.py b/tests/corpus/move.decorated-method/expected.1.py new file mode 100644 index 0000000..c9e571c --- /dev/null +++ b/tests/corpus/move.decorated-method/expected.1.py @@ -0,0 +1,24 @@ +@comm_handler +def get_fault_text(fault_filename, main_id, ignore_ids): + """Get fault text from old run.""" + # Read file + try: + with open(fault_filename, 'r') as f: + fault = f.read() + except FileNotFoundError: + return + return text +class SpyderKernel(IPythonKernel): + """Spyder kernel for Jupyter.""" + + shell_class = SpyderShell + @comm_handler + def safe_exec(self, filename): + """Safely execute a file using IPKernelApp._exec_file.""" + self.parent._exec_file(filename) + + + def get_system_threads_id(self): + """Return the list of system threads id.""" + ignore_threads = [ + ] diff --git a/tests/corpus/move.double-decorated-method/1.py b/tests/corpus/move.double-decorated-method/1.py new file mode 100644 index 0000000..090cc25 --- /dev/null +++ b/tests/corpus/move.double-decorated-method/1.py @@ -0,0 +1,28 @@ +import functools + + +class SpyderKernel(IPythonKernel): + """Spyder kernel for Jupyter.""" + + shell_class = SpyderShell + @comm_handler + def safe_exec(self, filename): + """Safely execute a file using IPKernelApp._exec_file.""" + self.parent._exec_file(filename) + + @comm_handler + @functools.lru_cache(32) + def get_fault_text(self, fault_filename, main_id, ignore_ids): + """Get fault text from old run.""" + # Read file + try: + with open(fault_filename, 'r') as f: + fault = f.read() + except FileNotFoundError: + return + return text + + def get_system_threads_id(self): + """Return the list of system threads id.""" + ignore_threads = [ + ] diff --git a/tests/corpus/move.double-decorated-method/chat.xml b/tests/corpus/move.double-decorated-method/chat.xml new file mode 100644 index 0000000..e81bef5 --- /dev/null +++ b/tests/corpus/move.double-decorated-method/chat.xml @@ -0,0 +1,20 @@ + +```CEDARScript +# 1. Move the `get_fault_text` method from the `SpyderKernel` class to be a top-level function +UPDATE METHOD "SpyderKernel.get_fault_text" +FROM FILE "1.py" +MOVE WHOLE +INSERT BEFORE CLASS "SpyderKernel" +RELATIVE INDENTATION 0; + +# 2. Update the copied function to remove references to `self` +UPDATE FUNCTION "get_fault_text" +FROM FILE r"1.py" +REPLACE WHOLE WITH CASE +WHEN REGEX r'''def get_fault_text\(''' THEN SUB +r'''def get_fault_text\(self, fault_filename, main_id, ignore_ids\):''' +r'''def get_fault_text(fault_filename, main_id, ignore_ids):''' +END; + +``` + diff --git a/tests/corpus/move.double-decorated-method/expected.1.py b/tests/corpus/move.double-decorated-method/expected.1.py new file mode 100644 index 0000000..6e01d81 --- /dev/null +++ b/tests/corpus/move.double-decorated-method/expected.1.py @@ -0,0 +1,28 @@ +import functools + + +@comm_handler +@functools.lru_cache(32) +def get_fault_text(fault_filename, main_id, ignore_ids): + """Get fault text from old run.""" + # Read file + try: + with open(fault_filename, 'r') as f: + fault = f.read() + except FileNotFoundError: + return + return text +class SpyderKernel(IPythonKernel): + """Spyder kernel for Jupyter.""" + + shell_class = SpyderShell + @comm_handler + def safe_exec(self, filename): + """Safely execute a file using IPKernelApp._exec_file.""" + self.parent._exec_file(filename) + + + def get_system_threads_id(self): + """Return the list of system threads id.""" + ignore_threads = [ + ] diff --git a/tests/corpus/refactor-benchmark.indentation-size-discovery/chat.xml b/tests/corpus/refactor-benchmark.indentation-size-discovery/chat.xml index 5a6bb51..10b3956 100644 --- a/tests/corpus/refactor-benchmark.indentation-size-discovery/chat.xml +++ b/tests/corpus/refactor-benchmark.indentation-size-discovery/chat.xml @@ -1,22 +1,22 @@ ```CEDARScript --- Try CST-based indentation discovery --- Move the `__get_brackets` method from the `CodeEditor` class, placing it at the top level, just before the line where its class starts +# Try CST-based indentation discovery +# Move the `__get_brackets` method from the `CodeEditor` class, placing it at the top level, just before the line where its class starts UPDATE CLASS "CodeEditor" FROM FILE "codeeditor.py" MOVE METHOD "__get_brackets" INSERT BEFORE CLASS "CodeEditor" RELATIVE INDENTATION 0; --- 1. Move the method to become a top-level function. +# 1. Move the method to become a top-level function. UPDATE CLASS "AutosaveForPlugin" FROM FILE "autosave.py" MOVE METHOD "get_files_to_recover" INSERT BEFORE CLASS "AutosaveForPlugin" RELATIVE INDENTATION 0; --- 1. Move the `adapt_method_mode` method from the `BaseHandler` class, placing it at the top level, just before the line where its class starts +# 1. Move the `adapt_method_mode` method from the `BaseHandler` class, placing it at the top level, just before the line where its class starts UPDATE CLASS "BaseHandler" FROM FILE "base.py" MOVE METHOD "adapt_method_mode" diff --git a/tests/corpus/update.identifier.case-filter/1.kts b/tests/corpus/update.identifier.case-filter/1.kts new file mode 100644 index 0000000..8b243e9 --- /dev/null +++ b/tests/corpus/update.identifier.case-filter/1.kts @@ -0,0 +1,15 @@ +application { + this.mainClassName = mainVerticleName +} + + +named("run") { + doFirst { + args = listOf( + "run", + mainVerticleName, + "--launcher-class=${application.mainClassName}", + "--on-redeploy=$doOnChange" + ) + } +} diff --git a/tests/corpus/update.identifier.case-filter/chat.xml b/tests/corpus/update.identifier.case-filter/chat.xml index 06412b1..25ba5e6 100644 --- a/tests/corpus/update.identifier.case-filter/chat.xml +++ b/tests/corpus/update.identifier.case-filter/chat.xml @@ -20,7 +20,7 @@ REPLACE WHOLE WITH CASE r'\1' END; --- Update the copied function to remove references to `self` +# Update the copied function to remove references to `self` UPDATE FUNCTION "_make_source_table" FROM FILE "analyzer_cli.py" REPLACE WHOLE WITH CASE @@ -29,7 +29,7 @@ REPLACE WHOLE WITH CASE r'''\1''' END; --- Update ALL call sites of the method `_make_source_table` to call the new top-level function with the same name +# Update ALL call sites of the method `_make_source_table` to call the new top-level function with the same name UPDATE METHOD "DebugAnalyzer.list_source" FROM FILE "analyzer_cli.py" REPLACE BODY WITH CASE @@ -37,5 +37,15 @@ REPLACE BODY WITH CASE r'''self\.(_make_source_table)''' r'''\1''' END; + +UPDATE FILE "1.kts" +REPLACE WHOLE WITH CASE + WHEN LINE 'this.mainClassName = mainVerticleName' THEN SUB + r'''this\.mainClassName = mainVerticleName''' + 'mainClass.set(mainVerticleName)' + WHEN LINE '"--launcher-class=${application.mainClassName}",' THEN SUB + r'''application\.mainClassName''' + 'application.mainClass.get()' + END; ``` diff --git a/tests/corpus/update.identifier.case-filter/expected.1.kts b/tests/corpus/update.identifier.case-filter/expected.1.kts new file mode 100644 index 0000000..5319355 --- /dev/null +++ b/tests/corpus/update.identifier.case-filter/expected.1.kts @@ -0,0 +1,15 @@ +application { + mainClass.set(mainVerticleName) +} + + +named("run") { + doFirst { + args = listOf( + "run", + mainVerticleName, + "--launcher-class=${application.mainClass.get()}", + "--on-redeploy=$doOnChange" + ) + } +} diff --git a/tests/corpus/update.identifier.ed-script-filter/1.py b/tests/corpus/update.identifier.ed-script-filter!nowindows/1.py similarity index 100% rename from tests/corpus/update.identifier.ed-script-filter/1.py rename to tests/corpus/update.identifier.ed-script-filter!nowindows/1.py diff --git a/tests/corpus/update.identifier.ed-script-filter/1.txt b/tests/corpus/update.identifier.ed-script-filter!nowindows/1.txt similarity index 100% rename from tests/corpus/update.identifier.ed-script-filter/1.txt rename to tests/corpus/update.identifier.ed-script-filter!nowindows/1.txt diff --git a/tests/corpus/update.identifier.ed-script-filter/chat.xml b/tests/corpus/update.identifier.ed-script-filter!nowindows/chat.xml similarity index 57% rename from tests/corpus/update.identifier.ed-script-filter/chat.xml rename to tests/corpus/update.identifier.ed-script-filter!nowindows/chat.xml index 3625e6b..d46aeb8 100644 --- a/tests/corpus/update.identifier.ed-script-filter/chat.xml +++ b/tests/corpus/update.identifier.ed-script-filter!nowindows/chat.xml @@ -8,7 +8,7 @@ g/^def convert/s/self, // '''; --- 1. Update the function signature of `calc1()` to add parameter `tax: float` as the first one and use the new parameter instead of `7` +# 1. Update the function signature of `calc1()` to add parameter `tax: float` as the first one and use the new parameter instead of `7` UPDATE FUNCTION "calc1" FROM FILE "1.py" REPLACE WHOLE WITH ED r''' @@ -18,8 +18,8 @@ g/return/s/7.*/tax/ '''; --- 2. Update the function signature of `calc2()` to add parameter `base_tax: float = 1.3` as the last one --- 3. Update ALL call sites of `calc1()` to pass `base_tax` as the first argument +# 2. Update the function signature of `calc2()` to add parameter `base_tax: float = 1.3` as the last one +# 3. Update ALL call sites of `calc1()` to pass `base_tax` as the first argument UPDATE FUNCTION "calc2" FROM FILE "1.py" REPLACE WHOLE WITH ED r''' diff --git a/tests/corpus/update.identifier.ed-script-filter/expected.1.py b/tests/corpus/update.identifier.ed-script-filter!nowindows/expected.1.py similarity index 100% rename from tests/corpus/update.identifier.ed-script-filter/expected.1.py rename to tests/corpus/update.identifier.ed-script-filter!nowindows/expected.1.py diff --git a/tests/corpus/update.identifier.ed-script-filter/expected.1.txt b/tests/corpus/update.identifier.ed-script-filter!nowindows/expected.1.txt similarity index 100% rename from tests/corpus/update.identifier.ed-script-filter/expected.1.txt rename to tests/corpus/update.identifier.ed-script-filter!nowindows/expected.1.txt diff --git a/tests/corpus/update.identifier.move.whole.1/chat.xml b/tests/corpus/update.identifier.move.whole.1/chat.xml index 5742c37..527b753 100644 --- a/tests/corpus/update.identifier.move.whole.1/chat.xml +++ b/tests/corpus/update.identifier.move.whole.1/chat.xml @@ -1,6 +1,6 @@ ```CEDARScript --- A02 becomes local to b +# A02 becomes local to b UPDATE FUNCTION "b" FROM FILE "main.py" MOVE WHOLE INSERT BEFORE CLASS "A02" diff --git a/tests/corpus/update.identifier.move.whole.2/chat.xml b/tests/corpus/update.identifier.move.whole.2/chat.xml index b2b9f2f..d612c4f 100644 --- a/tests/corpus/update.identifier.move.whole.2/chat.xml +++ b/tests/corpus/update.identifier.move.whole.2/chat.xml @@ -1,6 +1,6 @@ ```CEDARScript --- 2nd pst becomes inner of A3 +# 2nd pst becomes inner of A3 UPDATE FUNCTION "pst" OFFSET 1 FROM FILE "main.py" MOVE WHOLE INSERT AFTER CLASS "A3" RELATIVE INDENTATION 1; diff --git a/tests/test_corpus.py b/tests/test_corpus.py index 02a2c15..0408725 100644 --- a/tests/test_corpus.py +++ b/tests/test_corpus.py @@ -1,11 +1,13 @@ import re import shutil +import sys import tempfile import pytest from pathlib import Path from cedarscript_editor import find_commands, CEDARScriptEditor +_no_windows = '!nowindows' def get_test_cases() -> list[str]: """Get all test cases from tests/corpus directory. @@ -40,6 +42,9 @@ def editor(tmp_path_factory): @pytest.mark.parametrize('test_case', get_test_cases()) def test_corpus(editor: CEDARScriptEditor, test_case: str): """Test CEDARScript commands from chat.xml files in corpus.""" + if test_case.casefold().endswith(_no_windows) and sys.platform == 'win32': + pytest.skip(f"Cannot run under Windows: {test_case.removesuffix(_no_windows)}") + try: corpus_dir = Path(__file__).parent / 'corpus' test_dir = corpus_dir / test_case @@ -90,10 +95,10 @@ def check_expected_files(dir_path: Path): continue # Find corresponding expected file in test directory rel_path = path.relative_to(editor.root_path) - if str(rel_path).startswith("."): + if str(rel_path).startswith(".") or str(rel_path).endswith("~"): continue expected_file = test_dir / f"expected.{rel_path}" - assert expected_file.exists(), f"'expecteed.*' file not found: {expected_file}" + assert expected_file.exists(), f"'expected.*' file not found: '{expected_file}'" expected_content = file_to_lines(expected_file, rel_path) actual_content = file_to_lines(path, rel_path) pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy