diff --git a/.codecov.yml b/.codecov.yml deleted file mode 100644 index a052f98..0000000 --- a/.codecov.yml +++ /dev/null @@ -1 +0,0 @@ -comment: no diff --git a/.flake8 b/.flake8 deleted file mode 100644 index c321e71..0000000 --- a/.flake8 +++ /dev/null @@ -1,5 +0,0 @@ -[flake8] -ignore = E203, E266, E501, W503 -max-line-length = 80 -max-complexity = 18 -select = B,C,E,F,W,T4,B9 diff --git a/.gitignore b/.gitignore deleted file mode 100644 index 931d75b..0000000 --- a/.gitignore +++ /dev/null @@ -1,12 +0,0 @@ -*.pyc -*.swp -*.prof -MANIFEST -README.rst -dist/ -build/ -.coverage -.cache/ -*.egg-info/ -.pytest_cache/ -.tox/ diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml deleted file mode 100644 index 8fb20e7..0000000 --- a/.pre-commit-config.yaml +++ /dev/null @@ -1,16 +0,0 @@ -repos: - - repo: https://github.com/PyCQA/isort - rev: 5.9.3 - hooks: - - id: isort - - - repo: https://github.com/psf/black - rev: 21.9b0 - hooks: - - id: black - language_version: python3 - - - repo: https://github.com/PyCQA/flake8 - rev: 4.0.1 - hooks: - - id: flake8 diff --git a/.pre-commit-hooks.yaml b/.pre-commit-hooks.yaml deleted file mode 100644 index 5f2b793..0000000 --- a/.pre-commit-hooks.yaml +++ /dev/null @@ -1,8 +0,0 @@ -- id: blacktex - name: blacktex - description: "Clean up LaTeX files." - entry: blacktex - language: python - language_version: python3 - types: ['tex'] - args: [--in-place] diff --git a/LICENSE b/LICENSE deleted file mode 100644 index 94a9ed0..0000000 --- a/LICENSE +++ /dev/null @@ -1,674 +0,0 @@ - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU General Public License is a free, copyleft license for -software and other kinds of works. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -the GNU General Public License is intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. We, the Free Software Foundation, use the -GNU General Public License for most of our software; it applies also to -any other work released this way by its authors. You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - To protect your rights, we need to prevent others from denying you -these rights or asking you to surrender the rights. Therefore, you have -certain responsibilities if you distribute copies of the software, or if -you modify it: responsibilities to respect the freedom of others. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must pass on to the recipients the same -freedoms that you received. You must make sure that they, too, receive -or can get the source code. And you must show them these terms so they -know their rights. - - Developers that use the GNU GPL protect your rights with two steps: -(1) assert copyright on the software, and (2) offer you this License -giving you legal permission to copy, distribute and/or modify it. - - For the developers' and authors' protection, the GPL clearly explains -that there is no warranty for this free software. For both users' and -authors' sake, the GPL requires that modified versions be marked as -changed, so that their problems will not be attributed erroneously to -authors of previous versions. - - Some devices are designed to deny users access to install or run -modified versions of the software inside them, although the manufacturer -can do so. This is fundamentally incompatible with the aim of -protecting users' freedom to change the software. The systematic -pattern of such abuse occurs in the area of products for individuals to -use, which is precisely where it is most unacceptable. Therefore, we -have designed this version of the GPL to prohibit the practice for those -products. If such problems arise substantially in other domains, we -stand ready to extend this provision to those domains in future versions -of the GPL, as needed to protect the freedom of users. - - Finally, every program is threatened constantly by software patents. -States should not allow patents to restrict development and use of -software on general-purpose computers, but in those that do, we wish to -avoid the special danger that patents applied to a free program could -make it effectively proprietary. To prevent this, the GPL assures that -patents cannot be used to render the program non-free. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Use with the GNU Affero General Public License. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU Affero General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the special requirements of the GNU Affero General Public License, -section 13, concerning interaction through a network will apply to the -combination as such. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . - -Also add information on how to contact you by electronic and paper mail. - - If the program does terminal interaction, make it output a short -notice like this when it starts in an interactive mode: - - Copyright (C) - This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, your program's commands -might be different; for a GUI interface, you would use an "about box". - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU GPL, see -. - - The GNU General Public License does not permit incorporating your program -into proprietary programs. If your program is a subroutine library, you -may consider it more useful to permit linking proprietary applications with -the library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. But first, please read -. diff --git a/README.md b/README.md index 8f103e7..24263e7 100644 --- a/README.md +++ b/README.md @@ -4,25 +4,18 @@

[![PyPi Version](https://img.shields.io/pypi/v/blacktex.svg?style=flat-square)](https://pypi.org/project/blacktex/) -[![Anaconda Cloud](https://anaconda.org/conda-forge/blacktex/badges/version.svg?=style=flat-square)](https://anaconda.org/conda-forge/blacktex/) [![PyPI pyversions](https://img.shields.io/pypi/pyversions/blacktex.svg?style=flat-square)](https://pypi.org/project/blacktex/) [![GitHub stars](https://img.shields.io/github/stars/nschloe/blacktex.svg?style=flat-square&logo=github&label=Stars&logoColor=white)](https://github.com/nschloe/blacktex) [![PyPi downloads](https://img.shields.io/pypi/dm/blacktex.svg?style=flat-square)](https://pypistats.org/packages/blacktex) -[![gh-actions](https://img.shields.io/github/workflow/status/nschloe/blacktex/ci?style=flat-square)](https://github.com/nschloe/blacktex/actions?query=workflow%3Aci) -[![codecov](https://img.shields.io/codecov/c/github/nschloe/blacktex.svg?style=flat-square)](https://codecov.io/gh/nschloe/blacktex) -[![LGTM](https://img.shields.io/lgtm/grade/python/github/nschloe/blacktex.svg?style=flat-square)](https://lgtm.com/projects/g/nschloe/blacktex) -[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg?style=flat-square)](https://github.com/psf/black) - -blacktex is a command-line tool that helps with article editing in LaTeX. It removes all -comments from a given file and corrects [some common +blacktex is a command-line tool that helps with article editing in LaTeX. It +removes all comments from a given file and corrects [some common anti-patterns](http://mirrors.ctan.org/info/l2tabu/english/l2tabuen.pdf). Install with one of ``` pip install -U blacktex -conda install -c conda-forge blacktex ``` Then, with @@ -57,8 +50,3 @@ blacktex -i in0.tex in1.tex ... ``` to modify files in-place. See `blacktex -h` for all options. - -### License - -This software is published under the [GPLv3 -license](https://www.gnu.org/licenses/gpl-3.0.en.html). diff --git a/justfile b/justfile deleted file mode 100644 index a64404d..0000000 --- a/justfile +++ /dev/null @@ -1,22 +0,0 @@ -version := `python3 -c "from src.blacktex.__about__ import __version__; print(__version__)"` - -default: - @echo "\"just publish\"?" - -publish: - @if [ "$(git rev-parse --abbrev-ref HEAD)" != "main" ]; then exit 1; fi - gh release create "v{{version}}" - flit publish - -clean: - @find . | grep -E "(__pycache__|\.pyc|\.pyo$)" | xargs rm -rf - @rm -rf src/*.egg-info/ build/ dist/ .tox/ - -format: - isort . - black . - blacken-docs README.md - -lint: - black --check . - flake8 . diff --git a/logo/Makefile b/logo/Makefile deleted file mode 100644 index aa4c8ed..0000000 --- a/logo/Makefile +++ /dev/null @@ -1,7 +0,0 @@ -logo: - lualatex logo.tex - inkscape --without-gui --file=logo.pdf --export-plain-svg=logo.svg - svgo logo.svg - -clean: - rm -f logo.pdf logo.svg logo.aux logo.log diff --git a/logo/logo.tex b/logo/logo.tex deleted file mode 100644 index bf115dc..0000000 --- a/logo/logo.tex +++ /dev/null @@ -1,12 +0,0 @@ -\documentclass[border=4pt]{standalone} - -\usepackage{xcolor} -\usepackage{pagecolor} -\pagecolor{black} -\color{white} - -\begin{document} - -\textbf{black\TeX} - -\end{document} diff --git a/pyproject.toml b/pyproject.toml deleted file mode 100644 index 8f1973b..0000000 --- a/pyproject.toml +++ /dev/null @@ -1,41 +0,0 @@ -[build-system] -requires = ["flit_core >=3.2,<4"] -build-backend = "flit_core.buildapi" - -[project] -name = "blacktex" -authors = [{name = "Nico Schlömer", email = "nico.schloemer@gmail.com"}] -description = "Clean up your LaTeX files" -readme = "README.md" -license = {file = "LICENSE"} -classifiers = [ - "Development Status :: 4 - Beta", - "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)", - "Operating System :: OS Independent", - "Programming Language :: Python", - "Programming Language :: Python :: 3", - "Programming Language :: Python :: 3.7", - "Programming Language :: Python :: 3.8", - "Programming Language :: Python :: 3.9", - "Programming Language :: Python :: 3.10", - "Topic :: Text Editors :: Text Processing", - "Topic :: Text Processing", - "Topic :: Text Processing :: Markup", - "Topic :: Text Processing :: Markup :: LaTeX", - "Topic :: Utilities", -] -keywords = ["latex", "linting"] -dynamic = ["version"] -requires-python = ">=3.7" -dependencies = ["pylatexenc"] - -[project.urls] -Code = "https://github.com/nschloe/blacktex" -Issues = "https://github.com/nschloe/blacktex/issues" -Funding = "https://github.com/sponsors/nschloe" - -[project.scripts] -blacktex = "blacktex.cli:main" - -[tool.isort] -profile = "black" diff --git a/src/blacktex/__about__.py b/src/blacktex/__about__.py deleted file mode 100644 index 906d362..0000000 --- a/src/blacktex/__about__.py +++ /dev/null @@ -1 +0,0 @@ -__version__ = "0.6.0" diff --git a/src/blacktex/__init__.py b/src/blacktex/__init__.py deleted file mode 100644 index a2ad7fb..0000000 --- a/src/blacktex/__init__.py +++ /dev/null @@ -1,5 +0,0 @@ -from . import cli -from .__about__ import __version__ -from .main import clean - -__all__ = ["__version__", "cli", "clean"] diff --git a/src/blacktex/cli.py b/src/blacktex/cli.py deleted file mode 100644 index 11c089a..0000000 --- a/src/blacktex/cli.py +++ /dev/null @@ -1,71 +0,0 @@ -import argparse -from sys import version_info as vi - -from .__about__ import __version__ -from .main import clean - - -def main(argv=None): - parser = _get_parser() - args = parser.parse_args(argv) - - stdout = [] - return_code = 0 - for fl in args.infiles: - with open(fl.name, encoding=args.encoding) as f: - content = f.read() - out = clean(content, args.keep_comments, args.keep_dollar_math) - if args.in_place: - return_code = return_code or int(content != out) - with open(fl.name, "w", encoding=args.encoding) as f: - f.write(out) - else: - stdout.append(out) - - if not args.in_place: - print("\n".join(stdout), end="") - - return return_code - - -def _get_parser(): - parser = argparse.ArgumentParser(description="Clean up LaTeX files.") - - parser.add_argument( - "infiles", - nargs="+", - type=argparse.FileType("r"), - help="input LaTeX file", - ) - - parser.add_argument( - "-e", - "--encoding", - type=str, - default=None, - help="encoding to use for reading and writing files", - ) - - parser.add_argument( - "-i", "--in-place", action="store_true", help="modify all files in place" - ) - - parser.add_argument( - "-c", "--keep-comments", action="store_true", help="keep comments" - ) - - parser.add_argument( - "-d", - "--keep-dollar-math", - action="store_true", - help="keep inline math with $...$", - ) - - parser.add_argument( - "--version", - "-v", - action="version", - version=f"blacktex {__version__}, Python {vi.major}.{vi.minor}.{vi.micro}", - ) - - return parser diff --git a/src/blacktex/main.py b/src/blacktex/main.py deleted file mode 100644 index 72aa51a..0000000 --- a/src/blacktex/main.py +++ /dev/null @@ -1,325 +0,0 @@ -from __future__ import annotations - -import re -from typing import Callable - -from pylatexenc.latexwalker import ( - LatexCharsNode, - LatexCommentNode, - LatexEnvironmentNode, - LatexGroupNode, - LatexMacroNode, - LatexMathNode, - LatexWalker, - nodelist_to_latex, -) -from pylatexenc.macrospec import ParsedMacroArgs - - -def _traverse_tree(nodelist: list, funs: list[Callable], is_math_mode: bool = False): - for fun in funs: - nodelist_new = [] - for k, node in enumerate(nodelist): - out = fun(node, is_math_mode, nodelist[:k], nodelist[k + 1 :]) - if out is not None: - nodelist_new.append(out) - nodelist = nodelist_new - - for node in nodelist: - if hasattr(node, "nodelist"): - node.nodelist = _traverse_tree( - node.nodelist, funs, is_math_mode | isinstance(node, LatexMathNode) - ) - - return nodelist - - -def _macro(macroname, *nodelists): - """Creates a pylatexenc node that corresponds to \\macroname{nodelist}""" - return LatexMacroNode( - macroname=macroname, - nodeargd=ParsedMacroArgs( - argspec="{" * len(nodelists), - argnlist=[LatexGroupNode(nodelist=nodelist) for nodelist in nodelists], - ), - ) - - -def _remove_comments(node, *_): - """Remove comments.""" - # TODO unless the comment character is the last non-whitespace character in - # a line. (This is often used in macros etc.) - if isinstance(node, LatexCommentNode): - return None - return node - - -def _replace_dollar_dollar(node, *_): - """Replace $$...$$ by \\[...\\].""" - if isinstance(node, LatexMathNode) and node.delimiters == ("$$", "$$"): - node.delimiters = ("\\[", "\\]") - return node - - -def _replace_dollar(node, *_): - """Replace $...$ by \\(...\\). See .""" - if isinstance(node, LatexMathNode) and node.delimiters == ("$", "$"): - node.delimiters = ("\\(", "\\)") - return node - - -def _replace_obsolete_text_mods(node, _, prev_nodes, __): - r"""Replace {\it foo} by \textit{foo} etc""" - # bracket, don't replace; see . - replacements = [ - ("it", "textit"), - ("bf", "textbf"), - ("rm", "textrm"), - ("sc", "textsc"), - ("sf", "textsf"), - ("sl", "textsl"), - ("tt", "texttt"), - # https://tex.stackexchange.com/a/25914/13262: - # [\em] May be useful when defining macros. In continuous text - # \emph{...} should be preferred to \em. - ("em", "emph"), - ] - if not isinstance(node, LatexGroupNode): - return node - # See if the first child in the group is a macro, e.g., {\it ...} - child0 = node.nodelist[0] - if not isinstance(child0, LatexMacroNode): - return node - - for orig, repl in replacements: - if child0.macroname == orig: - node = _macro(repl, node.nodelist[1:]) - # If the previous node is a macro, wrap the \textit in curly braces. - if len(prev_nodes) > 0 and isinstance(prev_nodes[-1], LatexMacroNode): - node = LatexGroupNode(nodelist=[node]) - break - - return node - - -def _replace_dots(node, *_): - if isinstance(node, LatexMacroNode) and node.macroname == "cdots": - node.macroname = "dots" - if isinstance(node, LatexCharsNode) and "..." in node.chars: - node.chars = node.chars.replace("...", r"\dots") - return node - - -def _replace_over(node, *_): - if not isinstance(node, LatexGroupNode): - return node - - k0 = None - for k, n2 in enumerate(node.nodelist): - if isinstance(n2, LatexMacroNode) and n2.macroname == "over": - k0 = k - break - - if k0 is None: - return node - - # We found an \over. Create a \frac from the rest of the nodes. - return _macro("frac", node.nodelist[:k0], node.nodelist[k0 + 1 :]) - - -def _replace_def_by_newcommand(node, *_): - if isinstance(node, LatexMacroNode) and node.macroname == "def": - node.macroname = "newcommand" - return node - - -def _add_backslash_for_keywords(node, is_math_mode, *_): - if not is_math_mode: - return node - if not isinstance(node, LatexCharsNode): - return node - for keyword in ["max", "min", "log", "sin", "cos", "exp"]: - node.chars = node.chars.replace(keyword, f"\\{keyword}") - return node - - -def _replace_eqnarray(node, *_): - if not isinstance(node, LatexEnvironmentNode): - return node - # Also set envname, should be removed at some point - # TODO https://github.com/phfaist/pylatexenc/issues/81 - if node.environmentname == "eqnarray": - node.environmentname = "align" - node.envname = "align" - elif node.environmentname == "eqnarray*": - node.environmentname = "align*" - node.envname = "align*" - return node - - -def _replace_colon_equal_by_coloneqq(node, *_): - if not isinstance(node, LatexCharsNode): - return node - node.chars = re.sub(r":\s*=", r"\\coloneqq ", node.chars) - node.chars = re.sub(r"=\s*:", r"\\eqqcolon ", node.chars) - return node - - -def _add_space_after_single_subsuperscript(node, *_): - if not isinstance(node, LatexCharsNode): - return node - node.chars = re.sub(r"([\^])([^{\\])([^_\^\s\$})])", r"\1\2 \3", node.chars) - return node - - -def _remove_whitespace_before_punctuation(node, *_): - if not isinstance(node, LatexCharsNode): - return node - node.chars = re.sub(r"\s+([\.,;!\?\":])", r"\1", node.chars) - return node - - -def _replace_multi_nbsp(string: str) -> str: - return re.sub("[~]{2,}", r"\\quad ", string) - - -def _replace_centerline(string: str) -> str: - return re.sub(r"\\centerline{", r"{\\centering ", string) - - -def _add_spaces_around_equality_sign(string: str) -> str: - string = re.sub(r"([^\s&])=", r"\1 =", string) - string = re.sub(r"([^\s])&=", r"\1 &=", string) - - string = re.sub(r"=([^\s&])", r"= \1", string) - string = re.sub(r"=&([^\s])", r"=& \1", string) - return string - - -def _si_percentage(string: str) -> str: - # match float like https://stackoverflow.com/a/12643073/353337 - string = re.sub(r"([+-]?([0-9]*[.])?[0-9]+)[ \t]*\\%", r"\\SI{\1}{\%}", string) - return string - - -def _remove_space_before_tabular_column_specification(string: str) -> str: - return re.sub(r"(\\begin{tabular})\s*({.*?})", r"\1\2", string) - - -def _remove_trailing_whitespace(string: str) -> str: - return "\n".join([line.rstrip() for line in string.split("\n")]) - - -def _remove_multiple_spaces(string: str) -> str: - """Replaces multiple spaces by one, except after a newline.""" - return re.sub("([^\n ]) +", r"\1 ", string) - - -def _remove_multiple_newlines(string: str) -> str: - string = re.sub("[\n]{3,}", "\n\n\n", string) - return string - - -def _remove_whitespace_around_brackets(string: str) -> str: - string = re.sub(r"{[ \t]+", "{", string) - string = re.sub(r"[ \t]+}", "}", string) - string = re.sub(r"\([ \t]+", "(", string) - string = re.sub(r"[ \t]+\)", ")", string) - string = re.sub(r"[ \t]+\\right\)", r"\\right)", string) - return string - - -def _add_nbsp_before_reference(string: str) -> str: - string = re.sub(r"\s+\\ref{", r"~\\ref{", string) - string = re.sub(r"\s+\\eqref{", r"~\\eqref{", string) - string = re.sub(r"\s+\\cite", r"~\\cite", string) - return string - - -def _replace_nbsp_space(string: str) -> str: - string = re.sub("~ ", " ", string) - string = re.sub(" ~", " ", string) - return string - - -def _add_linebreak_around_begin_end(string: str) -> str: - string = re.sub(r"([^\n ]) *(\\begin{.*?})", r"\1\n\2", string) - string = re.sub(r"(\\begin{.*?}) *([^\n ])", r"\1\n\2", string) - - string = re.sub(r"([^\n ]) *(\\end{.*?})", r"\1\n\2", string) - string = re.sub(r"(\\end{.*?}) *([^\n ])", r"\1\n\2", string) - - string = re.sub(r"([^\n ]) *(\\\[)", r"\1\n\2", string) - string = re.sub(r"(\\\[) *([^\n ])", r"\1\n\2", string) - - string = re.sub(r"([^\n ]) *(\\\])", r"\1\n\2", string) - string = re.sub(r"(\\\]) *([^\n ])", r"\1\n\2", string) - return string - - -def _put_spec_on_same_line_as_environment(string: str) -> str: - string = re.sub(r"(\\begin{.*?})\s*(\[.*?\])\n", r"\1\2", string) - string = re.sub(r"(\\begin{.*?})\s*(\[.*?\])([^\n])", r"\1\2\n\3", string) - return string - - -def _put_label_on_same_line_as_environment(string: str) -> str: - out = re.sub(r"(\\begin{.*?})(\[.*?])?\s+(\\label{.*?})(\n)?", r"\1\2\3\4", string) - out = re.sub(r"(\\section{.*?})\s+(\\label{.*?})(\n)?", r"\1\2\3", out) - out = re.sub(r"(\\subsection{.*?})\s+(\\label{.*?})(\n)?", r"\1\2\3", out) - return out - - -def _add_linebreak_after_double_backslash(string: str) -> str: - return re.sub(r"\\\\([^\n])", r"\\\\\n\1", string) - - -def _replace_punctuation_at_math_end(string: str) -> str: - """$a+b.$ -> $a+b$.""" - return re.sub(r"([\.,;!\?])\\\)", r"\)\1", string) - - -def clean(string: str, keep_comments: bool = False, keep_dollar: bool = False) -> str: - out = string - out = _remove_trailing_whitespace(out) - - # now apply all functions that operate on the pylatexenc tree - funs = [] - if not keep_comments: - funs.append(_remove_comments) - funs.append(_replace_dollar_dollar) - if not keep_dollar: - funs.append(_replace_dollar) - funs += [ - _replace_obsolete_text_mods, - _replace_dots, - _replace_over, - _replace_def_by_newcommand, - _add_backslash_for_keywords, - _replace_eqnarray, - _replace_colon_equal_by_coloneqq, - _add_space_after_single_subsuperscript, - _remove_whitespace_before_punctuation, - ] - # - w = LatexWalker(out) - nodelist, _, _ = w.get_latex_nodes(pos=0) - nodelist = _traverse_tree(nodelist, funs) - out = nodelist_to_latex(nodelist) - - out = _replace_punctuation_at_math_end(out) - out = _add_nbsp_before_reference(out) - out = _replace_multi_nbsp(out) - out = _replace_nbsp_space(out) - out = _si_percentage(out) - out = _add_linebreak_after_double_backslash(out) - out = _add_linebreak_around_begin_end(out) - out = _replace_centerline(out) - out = _put_spec_on_same_line_as_environment(out) - out = _put_label_on_same_line_as_environment(out) - out = _remove_space_before_tabular_column_specification(out) - out = _add_spaces_around_equality_sign(out) - out = _remove_multiple_newlines(out) - out = _remove_multiple_spaces(out) - out = _remove_whitespace_around_brackets(out) - return out diff --git a/tests/test_blacktex.py b/tests/test_blacktex.py deleted file mode 100644 index 1127a8b..0000000 --- a/tests/test_blacktex.py +++ /dev/null @@ -1,166 +0,0 @@ -import pytest - -import blacktex - - -@pytest.mark.parametrize( - "string, reference", - [ - # dollar replacement: - ("a $a + b = c$ b", r"a \(a + b = c\) b"), - (r"a \$a + b = c\$ b", r"a \$a + b = c\$ b"), - (r"a \\$a + b = c\\$ b", "a \\\\\n\\(a + b = c\\\\\n\\) b"), - # text mods: - (r"{\em it's me!}", r"\emph{it's me!}"), - # comments: - ("lorem %some comment \n %sit amet", "lorem "), - ("% lorem some comment \n sit amet", "sit amet"), - ("A % lorem some comment \n sit amet", "A sit amet"), - ("{equation}%comment", "{equation}"), - # multiple comment lines: - ("A\n%\n%\nB", "A\nB"), - # comment last: - ("somemacro{%\nfoobar% \n}", "somemacro{foobar}"), - # trailing whitespace: - ("lorem \n sit amet", "lorem\n sit amet"), - # obsolete text mod: - (r"lorem {\it ipsum dolor} sit amet", r"lorem \textit{ipsum dolor} sit amet"), - # multiple spaces: - ("lorem ipsum dolor sit amet", "lorem ipsum dolor sit amet"), - # It's allowed as indentation at the beginning of lines: - ("a\n b\nc", "a\n b\nc"), - ("\\[\n S(T)\\leq S(P_n).\n\\]\n", "\\[\n S(T)\\leq S(P_n).\n\\]\n"), - # spaces with brackets: - (r"( 1+2 ) { 3+4 } \left( 5+6 \right)", r"(1+2) {3+4} \left(5+6\right)"), - # multiple newlines: - ("lorem \n\n\n\n\n\n ipsum dolor sit", "lorem\n\n\n ipsum dolor sit"), - # $$: - ("a $$a + b = c$$ b", "a\n\\[\na + b = c\n\\]\nb"), - # whitespace after curly: - ("\\textit{ \nlorem \n\n\n ipsum dol}", "\\textit{\nlorem\n\n\n ipsum dol}"), - # sub/superscript space: - ("2^ng", "2^n g"), - ("1/n^3", "1/n^3"), - ("n^3", "n^3"), - ("(n^3)", "(n^3)"), - ("n^\\alpha", "n^\\alpha"), - ("a^2_PP^2", "a^2_PP^2"), - # Underscore separation just produces too many false positives. Leave as is. - ("2_ng", "2_ng"), - # dots: - ("a,...,b", "a,\\dots,b"), - ("a,\\cdots,b", "a,\\dots,b"), - # punctuation outside math: - ("$a+b.$", "\\(a+b\\)."), - (".$a+b$", ".\\(a+b\\)"), - # - (r"$a$\,$b$", r"\(a\)\,\(b\)"), - # whitespace before punctuation: - ("Some text .", "Some text."), - # nbsp before ref: - ("text \\ref{something}", "text~\\ref{something}"), - # nbsp space: - ("Some ~thing.", "Some thing."), - # double nbsp: - ("Some~~text.", "Some\\quad text."), - # \over to \frac: - ("a{b^{1+y} 2\\over 3^{4+x}}c", "a\\frac{b^{1+y} 2}{3^{4+x}}c"), - ("{\\pi \\over4}", "\\frac{\\pi}{4}"), - # overline warn: - ("\\overline", "\\overline"), - # linebreak after double backslash: - ("T $2\\\\3 4\\\\\n6\\\\[2mm]7$.", "T \\(2\\\\\n3 4\\\\\n6\\\\\n[2mm]7\\)."), - # keywords without backslash: - ( - "maximum and logarithm $max_x log(x)$", - r"maximum and logarithm \(\max_x \log(x)\)", - ), - # def vs. newcommand - (r"\def\e{\text{r}}", r"\newcommand\e{\text{r}}"), - # linebreak around begin/end: - ( - "A\\begin{equation}a+b\\end{equation} B \n\\begin{a}\nd+e\n\\end{a}\nB", - "A\n\\begin{equation}\na+b\n\\end{equation}\nB\n\\begin{a}\nd+e\n\\end{a}\nB", - ), - # indentation is okay - ( - "A\n \\begin{equation}\n a+b\n \\end{equation}", - "A\n \\begin{equation}\n a+b\n \\end{equation}", - ), - # centerline: - ("\\centerline{foobar}", "{\\centering foobar}"), - # eqnarray align: - ( - "A\\begin{eqnarray*}a+b\\end{eqnarray*}F", - "A\n\\begin{align*}\na+b\n\\end{align*}\nF", - ), - # env label: - ( - "A\n\\begin{lemma}\n\\label{lvalpp}\\end{lemma}", - "A\n\\begin{lemma}\\label{lvalpp}\n\\end{lemma}", - ), - ("A\n\\section{Intro}\n\\label{lvalpp}", "A\n\\section{Intro}\\label{lvalpp}"), - ( - "A\n\\subsection{Intro}\n\\label{lvalpp}", - "A\n\\subsection{Intro}\\label{lvalpp}", - ), - # coloneqq - ("A:=b+c", "A\\coloneqq b+c"), - ("A := b+c", "A \\coloneqq b+c"), - ("A : = b+c", "A \\coloneqq b+c"), - ("b+c = : A", "b+c \\eqqcolon A"), - # tabular column spec: - ( - "\\begin{tabular} \n {ccc}\ncontent\\end{tabular}", - "\\begin{tabular}{ccc}\ncontent\n\\end{tabular}", - ), - # env option spec: - ("\\begin{table} \n [h!]G\\end{table}", "\\begin{table}[h!]\nG\n\\end{table}"), - ("\\begin{table} [h!]G\\end{table}", "\\begin{table}[h!]\nG\n\\end{table}"), - ("\\begin{table} [h!]\nG\\end{table}", "\\begin{table}[h!]\nG\n\\end{table}"), - ("\\begin{table} \n [h!]G\\end{table}", "\\begin{table}[h!]\nG\n\\end{table}"), - ( - "\\begin{table} \n [h!]\\label{foo}\\end{table}", - "\\begin{table}[h!]\\label{foo}\n\\end{table}", - ), - ( - "\\begin{table} \n [h!]\\label{foo}\nG\\end{table}", - "\\begin{table}[h!]\\label{foo}\nG\n\\end{table}", - ), - # space around operators: - ("a+b=c", "a+b = c"), - ("a+b&=&c", "a+b &=& c"), - # SI percentage: - (r"20\% \SI{30}{\%}", r"\SI{20}{\%} \SI{30}{\%}"), - # escaped percentage sign: - (r"25\% gain", r"\SI{25}{\%} gain"), - # https://github.com/nschloe/blacktex/issues/46 - (r"\rightline{\bf a}", r"\rightline{\textbf{a}}"), - ], -) -def test_compare(string, reference): - print(repr(string)) - result = blacktex.clean(string) - print(repr(result)) - print(repr(reference)) - assert result == reference - - -def test_readme(): - input_string = ( - "Because of $$a+b=c$$ ({\\it Pythogoras}),\n" - "% @johnny remember to insert name,\n" - "and $y=2^ng$ with $n=1,...,10$, we have ${\\Gamma \\over 2}=8.$" - ) - - out = blacktex.clean(input_string) - print(out) - assert out == ( - "Because of\n" - "\\[\n" - "a+b = c\n" - "\\]\n" - "(\\textit{Pythogoras}),\n" - "and \\(y = 2^n g\\) with \\(n = 1,\\dots,10\\), we have " - "\\(\\frac{\\Gamma}{2} = 8\\)." - ) diff --git a/tests/test_cli.py b/tests/test_cli.py deleted file mode 100644 index 0e7370e..0000000 --- a/tests/test_cli.py +++ /dev/null @@ -1,54 +0,0 @@ -from pathlib import Path -from typing import List - -import pytest -from _pytest.capture import CaptureFixture - -import blacktex - - -@pytest.fixture() -def infiles(tmp_path: Path): - tmp_files = [tmp_path / f"infile_{i}.tex" for i in range(1, 4)] - [tmp_file.write_text(f"{tmp_file.name}\na+b=c") for tmp_file in tmp_files] - yield tmp_files - - -def test_cli_stdout(infiles: List[Path], capsys: CaptureFixture): - infile = infiles[0] - - return_value = blacktex.cli.main([str(infile)]) - - sdtout, _ = capsys.readouterr() - - assert return_value == 0 - assert sdtout == "infile_1.tex\na+b = c" - assert infile.read_text() == "infile_1.tex\na+b=c" - - -def test_cli_encoding(tmp_path: Path): - infile = tmp_path / "infile_encoding.tex" - result = "äöüéкий的" - infile.write_text(result, encoding="utf8") - - return_value = blacktex.cli.main(["-i", "-e=utf8", str(infile)]) - - assert return_value == 0 - assert infile.read_text(encoding="utf8") == result - - -def test_cli_inplace(infiles: List[Path]): - infile = infiles[0] - - return_value = blacktex.cli.main(["-i", str(infile)]) - - assert return_value == 1 - assert infile.read_text() == "infile_1.tex\na+b = c" - - -def test_cli_multiple_files(infiles: List[Path]): - return_value = blacktex.cli.main(["-i", *[str(infile) for infile in infiles]]) - - assert return_value == 1 - for infile in infiles: - assert infile.read_text() == f"{infile.name}\na+b = c" diff --git a/tox.ini b/tox.ini deleted file mode 100644 index cb847e5..0000000 --- a/tox.ini +++ /dev/null @@ -1,11 +0,0 @@ -[tox] -envlist = py3 -isolated_build = True - -[testenv] -deps = - pytest - pytest-cov - # pytest-randomly -commands = - pytest {posargs}