pax_global_header00006660000000000000000000000064145230016540014512gustar00rootroot0000000000000052 comment=79d690c651a1df9e12d31c985f45dab2fd2e4b49 fpyutils-4.0.1/000077500000000000000000000000001452300165400133735ustar00rootroot00000000000000fpyutils-4.0.1/.allowed_licenses.yml000066400000000000000000000002611452300165400175070ustar00rootroot00000000000000allowed licenses: [] files to check: - setup.cfg language: python include: - https://codeberg.org/frnmst/licheck/raw/branch/master/examples/python_gpl_compatible.yml fpyutils-4.0.1/.gitignore000066400000000000000000000022621452300165400153650ustar00rootroot00000000000000# Byte-compiled / optimized / DLL files __pycache__/ *.py[cod] *$py.class # C extensions *.so # Distribution / packaging .Python build/ develop-eggs/ dist/ downloads/ eggs/ .eggs/ lib/ lib64/ parts/ sdist/ var/ wheels/ *.egg-info/ .installed.cfg *.egg MANIFEST # PyInstaller # Usually these files are written by a python script from a template # before PyInstaller builds the exe, so as to inject date/other infos into it. *.manifest *.spec # Installer logs pip-log.txt pip-delete-this-directory.txt # Unit test / coverage reports htmlcov/ .tox/ .coverage .coverage.* .cache nosetests.xml coverage.xml *.cover .hypothesis/ # Translations *.mo *.pot # Django stuff: *.log .static_storage/ .media/ local_settings.py # Flask stuff: instance/ .webassets-cache # Scrapy stuff: .scrapy # Sphinx documentation docs/_build/ # PyBuilder target/ # Jupyter Notebook .ipynb_checkpoints # pyenv .python-version # celery beat schedule file celerybeat-schedule # SageMath parsed files *.sage.py # Environments .env .venv env/ venv/ ENV/ env.bak/ venv.bak/ # Spyder project settings .spyderproject .spyproject # Rope project settings .ropeproject # mkdocs documentation /site # mypy .mypy_cache/ fpyutils-4.0.1/.pre-commit-config.yaml000066400000000000000000000050341452300165400176560ustar00rootroot00000000000000# See https://pre-commit.com for more information # See https://pre-commit.com/hooks.html for more hooks repos: - repo: https://github.com/pre-commit/pre-commit-hooks rev: 'v4.5.0' hooks: - id: trailing-whitespace - id: end-of-file-fixer - id: check-yaml - id: check-added-large-files - id: destroyed-symlinks - id: detect-private-key - id: check-ast - id: check-case-conflict - id: debug-statements - id: fix-encoding-pragma - id: forbid-submodules - id: check-symlinks - id: check-shebang-scripts-are-executable - id: check-case-conflict - id: check-added-large-files args: ['--maxkb=4096'] - id: destroyed-symlinks # YAPF and flake8 need to remain pinned. - repo: https://github.com/pre-commit/mirrors-yapf rev: 'v0.32.0' # frozen: v0.32.0 hooks: - id: yapf additional_dependencies: [toml] - repo: https://github.com/pycqa/flake8 rev: '6.0.0' # frozen: 6.0.0 hooks: - id: flake8 additional_dependencies: [flake8-docstrings] - repo: https://github.com/PyCQA/bandit rev: '1.7.5' # Use the sha / tag you want to point at hooks: - id: bandit args: ['--skip', 'B404,B506,B410,B603,B604,B310', '--level', 'LOW'] # - repo: https://github.com/pre-commit/mirrors-mypy # rev: 'v0.991' # hooks: # - id: mypy # args: ['--no-strict-optional', '--ignore-missing-imports', '--show-error-context', '--show-error-codes', '--follow-imports', 'silent'] - repo: https://github.com/pycqa/isort rev: '5.12.0' hooks: - id: isort #- repo: https://codeberg.org/frnmst/licheck # rev: '1.0.0' # hooks: # - id: licheck # args: ['--configuration-file', '.allowed_licenses.yml'] - repo: https://codeberg.org/frnmst/md-toc rev: '8.2.0' # or a specific git tag from md-toc hooks: - id: md-toc args: [-p, 'cmark', '-l6'] # CLI options - repo: https://github.com/mgedmin/check-manifest rev: '0.49' hooks: - id: check-manifest - repo: local hooks: - id: unit-tests name: unit tests language: system entry: make test verbose: true always_run: true pass_filenames: false - id: build-docs name: build docs language: system entry: make doc verbose: true always_run: true pass_filenames: false - repo: https://github.com/jorisroovers/gitlint rev: 'v0.18.0' hooks: - id: gitlint fpyutils-4.0.1/CONTRIBUTING.md000066400000000000000000000001161452300165400156220ustar00rootroot00000000000000# Contributing See https://docs.franco.net.eu.org/fpyutils/contributing.html fpyutils-4.0.1/LICENSE.txt000066400000000000000000001045131452300165400152220ustar00rootroot00000000000000 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 . fpyutils-4.0.1/MANIFEST.in000066400000000000000000000003261452300165400151320ustar00rootroot00000000000000global-include LICENSE.txt global-include README.md global-include CONTRIBUTING.md global-exclude *.txt prune assets prune fpyutils/tests prune docs prune .venv prune packages exclude *.yml *.yaml exclude Makefile fpyutils-4.0.1/Makefile000066400000000000000000000067611452300165400150450ustar00rootroot00000000000000# # Makefile # # Copyright (C) 2017-2022 Franco Masotti (franco \D\o\T masotti {-A-T-} tutanota \D\o\T com) # # This file is part of fpyutils. # # fpyutils 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. # # fpyutils 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 fpyutils. If not, see . # export PACKAGE_NAME=fpyutils # See # https://docs.python.org/3/library/venv.html#how-venvs-work export VENV_CMD=. .venv/bin/activate default: install-dev doc: $(VENV_CMD) \ && $(MAKE) -C docs html \ && $(MAKE) -C docs latexpdf \ && deactivate install: # pip 23 introduced the '--break-system-packages' option. python3 -c 'import pip; import sys; sys.exit(0) if int(pip.__version__.split(".")[0]) >= 23 else sys.exit(1)' \ && pip3 install --break-system-packages . --user \ || pip3 install . --user uninstall: # pip 23 introduced the '--break-system-packages' option. python3 -c 'import pip; import sys; sys.exit(0) if int(pip.__version__.split(".")[0]) >= 23 else sys.exit(1)' \ && pip3 uninstall --break-system-packages --verbose --yes $(PACKAGE_NAME) \ || pip3 uninstall --verbose --yes $(PACKAGE_NAME) install-dev: python3 -m venv .venv $(VENV_CMD) \ && pip install --requirement requirements-freeze.txt \ && deactivate $(VENV_CMD) \ && pre-commit install \ && deactivate $(VENV_CMD) \ && pre-commit install --hook-type commit-msg \ && deactivate regenerate-freeze: uninstall-dev python3 -m venv .venv $(VENV_CMD) \ && pip install --requirement requirements.txt --requirement requirements-dev.txt \ && pip freeze --local > requirements-freeze.txt \ && deactivate uninstall-dev: rm -rf .venv update: install-dev $(VENV_CMD) \ && pre-commit autoupdate \ --repo https://github.com/pre-commit/pre-commit-hooks \ --repo https://github.com/PyCQA/bandit \ --repo https://github.com/pycqa/isort \ --repo https://codeberg.org/frnmst/md-toc \ --repo https://github.com/mgedmin/check-manifest \ --repo https://github.com/jorisroovers/gitlint \ && deactivate test: $(VENV_CMD) \ && tox run-parallel \ && deactivate pre-commit: $(VENV_CMD) \ && pre-commit run --all \ && deactivate dist: # Create a reproducible archive at least on the wheel. # See # https://bugs.python.org/issue31526 # https://bugs.python.org/issue38727 # https://github.com/pypa/setuptools/issues/1468 # https://github.com/pypa/setuptools/issues/2133 # https://reproducible-builds.org/docs/source-date-epoch/ $(VENV_CMD) \ && SOURCE_DATE_EPOCH=$$(git -c log.showSignature='false' log -1 --pretty=%ct) \ python -m build \ && deactivate $(VENV_CMD) \ && twine check --strict dist/* \ && deactivate upload: $(VENV_CMD) \ && twine upload dist/* \ && deactivate clean: rm -rf build dist *.egg-info tests/benchmark-results # Remove all markdown files except the readmes. find -regex ".*\.[mM][dD]" ! -name 'README.md' ! -name 'CONTRIBUTING.md' -type f -exec rm -f {} + $(VENV_CMD) \ && $(MAKE) -C docs clean \ && deactivate .PHONY: default doc install uninstall install-dev uninstall-dev update test clean demo pre-comit fpyutils-4.0.1/README.md000066400000000000000000000054421452300165400146570ustar00rootroot00000000000000# fpyutils [![PyPI fpyutils version](https://img.shields.io/pypi/v/fpyutils.svg)](https://pypi.org/project/fpyutils/) [![Debian 12 package](https://repology.org/badge/version-for-repo/debian_12/fpyutils.svg)](https://repology.org/project/fpyutils/versions) [![nixpkgs unstable package](https://repology.org/badge/version-for-repo/nix_unstable/python:fpyutils.svg)](https://repology.org/project/python:fpyutils/versions) [![Anaconda.org](https://anaconda.org/conda-forge/fpyutils/badges/version.svg)](https://anaconda.org/conda-forge/fpyutils) [![Downloads](https://pepy.tech/badge/fpyutils)](https://pepy.tech/project/fpyutils) [![Dependent repos (via libraries.io)](https://img.shields.io/librariesio/dependent-repos/pypi/fpyutils.svg)](https://libraries.io/pypi/fpyutils/dependents) [![Buy me a coffee](assets/buy_me_a_coffee.svg)](https://buymeacoff.ee/frnmst) A collection of useful non-standard Python functions which aim to be simple to use, highly readable but not efficient. - [fpyutils](#fpyutils) - [Documentation](#documentation) - [API examples](#api-examples) - [License](#license) - [Changelog and trusted source](#changelog-and-trusted-source) - [Support this project](#support-this-project) ## Documentation ## API examples ```python >>> import fpyutils >>> f = open('foo.txt') >>> f.read() "This is\nfoo.\nfoo\nThis is\nnot\nbar.\nAnd it's\n foo\n\nBye!\n" >>> fpyutils.filelines.get_line_matches('foo.txt','foo',5) {1: 3, 2: 8} ``` ## License Copyright (C) 2017-2023 [Franco Masotti](https://blog.franco.net.eu.org/about/#contacts) fpyutils 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. fpyutils 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 fpyutils. If not, see . ## Changelog and trusted source You can check the authenticity of new releases using my public key. Changelogs, instructions, sources and keys can be found at [blog.franco.net.eu.org/software/#fpyutils](https://blog.franco.net.eu.org/software/#fpyutils). ## Support this project - [Buy Me a Coffee](https://www.buymeacoffee.com/frnmst) - Bitcoin: `bc1qnkflazapw3hjupawj0lm39dh9xt88s7zal5mwu` - Monero: `84KHWDTd9hbPyGwikk33Qp5GW7o7zRwPb8kJ6u93zs4sNMpDSnM5ZTWVnUp2cudRYNT6rNqctnMQ9NbUewbj7MzCBUcrQEY` - Dogecoin: `DMB5h2GhHiTNW7EcmDnqkYpKs6Da2wK3zP` - Vertcoin: `vtc1qd8n3jvkd2vwrr6cpejkd9wavp4ld6xfu9hkhh0` fpyutils-4.0.1/assets/000077500000000000000000000000001452300165400146755ustar00rootroot00000000000000fpyutils-4.0.1/assets/buy_me_a_coffee.svg000066400000000000000000000017051452300165400205100ustar00rootroot00000000000000 buybuyme a coffeeme a coffee fpyutils-4.0.1/docs/000077500000000000000000000000001452300165400143235ustar00rootroot00000000000000fpyutils-4.0.1/docs/Makefile000066400000000000000000000011411452300165400157600ustar00rootroot00000000000000# Minimal makefile for Sphinx documentation # # You can set these variables from the command line. SPHINXOPTS = -W SPHINXBUILD = sphinx-build SPHINXPROJ = fpyutils SOURCEDIR = . BUILDDIR = _build # Put it first so that "make" without argument is like "make help". help: @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) .PHONY: help Makefile # Catch-all target: route all unknown targets to Sphinx using the new # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). %: Makefile @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) fpyutils-4.0.1/docs/_static/000077500000000000000000000000001452300165400157515ustar00rootroot00000000000000fpyutils-4.0.1/docs/_static/css/000077500000000000000000000000001452300165400165415ustar00rootroot00000000000000fpyutils-4.0.1/docs/_static/css/custom.css000066400000000000000000000002671452300165400205720ustar00rootroot00000000000000/* See * https://github.com/executablebooks/sphinx-book-theme/issues/732 */ .bd-sidebar-primary div#rtd-footer-container { bottom:-1rem; margin:-1rem; position:fixed; } fpyutils-4.0.1/docs/api.rst000066400000000000000000000016171452300165400156330ustar00rootroot00000000000000Developer Interface =================== .. module:: fpyutils Main Interface -------------- Examples for the most relevant api functions can be viewed in the test file. fpyutils's API uses `type hints`_ instead of assertions to check input and output types. .. _type hints: https://docs.python.org/3/library/typing.html .. autofunction:: fpyutils.filelines.get_line_matches .. autofunction:: fpyutils.filelines.insert_string_at_line .. autofunction:: fpyutils.filelines.remove_line_interval .. autofunction:: fpyutils.shell.execute_command_live_output .. autofunction:: fpyutils.path.add_trailing_slash .. autofunction:: fpyutils.path.gen_pseudorandom_path .. autofunction:: fpyutils.notify.send_email .. autofunction:: fpyutils.notify.send_gotify_message Exceptions ---------- .. autoexception:: fpyutils.exceptions.LineOutOfFileBoundsError .. autoexception:: fpyutils.exceptions.NegativeLineRangeError fpyutils-4.0.1/docs/conf.py000066400000000000000000000120301452300165400156160ustar00rootroot00000000000000# -*- coding: utf-8 -*- # # fpyutils documentation build configuration file, created by # sphinx-quickstart on Sat Nov 18 14:35:00 2017. # # This file is execfile()d with the current directory set to its # containing dir. # # Note that not all possible configuration values are present in this # autogenerated file. # # All configuration values have a default; values that are commented out # serve to show the default. # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. # """Documentation configuration.""" import os import sys sys.path.insert(0, os.path.abspath('..')) # -- General configuration ------------------------------------------------ # General information about the project. project = 'fpyutils' copyright = '2017-2023, Franco Masotti' author = 'Franco Masotti' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. version = '4.0.1' # The full version, including alpha/beta/rc tags. release = '4.0.1' # If your documentation needs a minimal Sphinx version, state it here. # # needs_sphinx = '1.0' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.coverage', 'sphinx_copybutton', ] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] # The suffix(es) of source filenames. # You can specify multiple suffix as a list of string: # source_suffix = '.rst' # The master toctree document. master_doc = 'index' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. language = 'en' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This patterns also effect to html_static_path and html_extra_path exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] # If true, `todo` and `todoList` produce output, else they produce nothing. todo_include_todos = False # -- Options for HTML output ---------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # html_theme = 'sphinx_book_theme' # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['_static'] html_css_files = ['css/custom.css'] # -- Options for HTMLHelp output ------------------------------------------ # Output file base name for HTML help builder. htmlhelp_basename = 'fpyutilsdoc' # -- Options for LaTeX output --------------------------------------------- latex_engine = 'xelatex' latex_elements: dict = { # The paper size ('letterpaper' or 'a4paper'). # 'papersize': 'a4paper', # The font size ('10pt', '11pt' or '12pt'). # # 'pointsize': '10pt', # Additional stuff for the LaTeX preamble. # # 'preamble': '', # Latex figure (float) alignment # # 'figure_align': 'htbp', } # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ (master_doc, 'fpyutils.tex', 'fpyutils Documentation', 'Franco Masotti', 'manual'), ] # -- Options for manual page output --------------------------------------- # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [(master_doc, 'fpyutils', 'fpyutils Documentation', [author], 1)] # -- Options for Texinfo output ------------------------------------------- # Grouping the document tree into Texinfo files. List of tuples # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ (master_doc, 'fpyutils', 'fpyutils Documentation', author, 'fpyutils', 'One line description of project.', 'Miscellaneous'), ] html_theme_options = { 'repository_provider': 'github', 'repository_url': 'https://software.franco.net.eu.org/frnmst/fpyutils', 'use_repository_button': True, 'use_download_button': True, 'use_issues_button': True, } html_baseurl = 'https://docs.franco.net.eu.org/fpyutils/' pygments_style = 'default' html_last_updated_fmt = '%Y-%m-%d %H:%M:%S %z' copybutton_line_continuation_character = '\\' # Epub. epub_theme = 'epub' epub_author = 'Franco Masotti' epub_theme_options = { "relbar1": False, "footer": False, } epub_css_style = [ 'css/epub.css', ] fpyutils-4.0.1/docs/contributing.rst000066400000000000000000000002221452300165400175600ustar00rootroot00000000000000Contributing ============ See `Python contributing `_ fpyutils-4.0.1/docs/copyright_license.rst000066400000000000000000000012761452300165400205750ustar00rootroot00000000000000Copyright and License ===================== Copyright (C) 2017-2023 Franco Masotti (see /README.md) fpyutils 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. fpyutils 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 fpyutils. If not, see . fpyutils-4.0.1/docs/implementing_new_modules.rst000066400000000000000000000004561452300165400221530ustar00rootroot00000000000000Implementing new modules ======================== 1. Define your idea 2. Implement a unit test class 3. Write the code 4. Test it 5. PEP standards compliancy 6. Update the documentation 7. Make a pull request You can also import existing code and adapt it for this library, if you think it's useful. fpyutils-4.0.1/docs/index.rst000066400000000000000000000010451452300165400161640ustar00rootroot00000000000000.. fpyutils documentation master file, created by sphinx-quickstart on Sat Nov 18 14:35:00 2017. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. Welcome to fpyutils's documentation! ==================================== .. toctree:: :maxdepth: 2 :caption: Contents: install api implementing_new_modules contributing workflow source_code copyright_license Indices and tables ================== * :ref:`genindex` * :ref:`modindex` * :ref:`search` fpyutils-4.0.1/docs/install.rst000066400000000000000000000006421452300165400165250ustar00rootroot00000000000000Installation ============ Install fpyutils via pip: :: $ pip3 install fpyutils --user All the necessary dependencies are installed automatically along with the program. Distribution packages --------------------- - A ``PKGBUILD`` for Arch Linux like distributions is available under the ``./packages/aur`` directory as well as on the AUR website. Dependencies ------------ See the ``./setup.cfg`` file. fpyutils-4.0.1/docs/source_code.rst000066400000000000000000000003011452300165400173410ustar00rootroot00000000000000Source code =========== - https://software.franco.net.eu.org/frnmst/fpyutils - https://codeberg.org/frnmst/fpyutils - https://framagit.org/frnmst/fpyutils - https://github.com/frnmst/fpyutils fpyutils-4.0.1/docs/workflow.rst000066400000000000000000000002021452300165400167210ustar00rootroot00000000000000Workflow ======== See `Python workflow `_ fpyutils-4.0.1/fpyutils/000077500000000000000000000000001452300165400152525ustar00rootroot00000000000000fpyutils-4.0.1/fpyutils/__init__.py000066400000000000000000000015061452300165400173650ustar00rootroot00000000000000# -*- coding: utf-8 -*- # # __init__.py # # Copyright (C) 2017-2023 Franco Masotti (see /README.md) # # This file is part of fpyutils. # # fpyutils 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. # # fpyutils 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 fpyutils. If not, see . # """Exposed API.""" from . import exceptions, filelines, notify, path, shell fpyutils-4.0.1/fpyutils/exceptions.py000066400000000000000000000020251452300165400200040ustar00rootroot00000000000000# -*- coding: utf-8 -*- # # exceptions.py # # Copyright (C) 2017-2020 Franco Masotti (see /README.md) # # This file is part of fpyutils. # # fpyutils 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. # # fpyutils 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 fpyutils. If not, see . # """Exceptions file.""" class LineOutOfFileBoundsError(Exception): """Line out of bounds. Raises an exception if there was an attempt to access a non-existing line in a file. """ class NegativeLineRangeError(Exception): """Line range does not make sense.""" fpyutils-4.0.1/fpyutils/filelines.py000066400000000000000000000232651452300165400176060ustar00rootroot00000000000000# -*- coding: utf-8 -*- # # filelines.py # # Copyright (C) 2017-2023 Franco Masotti (see /README.md) # # This file is part of fpyutils. # # fpyutils 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. # # fpyutils 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 fpyutils. If not, see . # """Functions on reading and writing files by line.""" from __future__ import annotations import os import shutil import sys import tempfile from .exceptions import LineOutOfFileBoundsError, NegativeLineRangeError def get_line_matches( input_file: str, pattern: str, max_occurrencies: int = 0, loose_matching: bool = True, keep_all_lines: bool = False) -> tuple[dict[int, int], str]: r"""Get the line numbers of matched patterns and the matched string itself. :parameter input_file: the file that needs to be read. :parameter pattern: the pattern that needs to be searched. :parameter max_occurrencies: the maximum number of expected occurrencies. Defaults to ``0`` which means that all occurrencies will be matched. This parameter is limited by the platform (``sys.maxsize``). :parameter loose_matching: ignore leading and trailing whitespace characters for both pattern and matched strings. Defaults to ``True``. :parameter keep_all_lines: if set to ``True`` returns the whole file content as a string. Defaults to ``False``. :type input_file: str :type pattern: str :type max_occurrencies: int :type loose_matching: bool :type keep_all_lines: bool :returns: occurrency_matches, a dictionary where each key corresponds to the number of occurrencies and each value to the matched line number. If no match was found for that particular occurrency, the key is not set. This means means for example: if the first occurrency of pattern is at line y then: x[1] = y, with x being the dictionary. lines, a string corresponding to the matched lines or the whole file (see ``keep_all_lines`` argument). :rtype: tuple[dict[int, int], str] :raises: a built-in exception. .. note:: Line numbers start from ``1``. """ if max_occurrencies < 0 or max_occurrencies > sys.maxsize: raise ValueError occurrency_counter: int = 0 occurrency_matches: dict[int, int] = dict() lines: list[str] = list() line_original: str if max_occurrencies == 0: # See # https://docs.python.org/3/whatsnew/3.0.html#integers max_occurrencies = sys.maxsize if loose_matching: pattern = pattern.strip() line_counter: int = 1 with open(input_file, 'r') as f: line = f.readline() while line and (keep_all_lines or occurrency_counter < max_occurrencies): line_original = line if loose_matching: line = line.strip() if line == pattern and occurrency_counter < max_occurrencies: occurrency_counter += 1 occurrency_matches[occurrency_counter] = line_counter lines.append(line_original) elif keep_all_lines: lines.append(line_original) line = f.readline() line_counter += 1 return occurrency_matches, ''.join(lines) def insert_string_at_line(input_file: str, string_to_be_inserted: str, put_at_line_number: int, output_file: str, append: bool = True, newline_character: str = os.linesep): r"""Write a string at the specified line. :parameter input_file: the file that needs to be read. :parameter string_to_be_inserted: the string that needs to be added. :parameter put_at_line_number: the line number on which to append the string. :parameter output_file: the file that needs to be written with the new content. :parameter append: decides whether to append or prepend the string at the selected line. Defaults to ``True``. :parameter newline_character: set the character used to fill the file in case line_number is greater than the number of lines of input_file. Defaults to the default platform newline, i.e: ``os.linesep``. :type input_file: str :type string_to_be_inserted: str :type line_number: int :type output_file: str :type append: bool :type newline_character: str :returns: None :raises: a built-in exception. .. note:: Line numbers start from ``1``. .. note:: Existing line endings of the input file are changed to ``newline_character``. """ if put_at_line_number < 1: raise ValueError line_counter: int = 1 loop: bool = True subst_done: bool = False final_string: list[str] = list() with open(input_file, 'r') as f: while loop: current_line: str = f.readline() while current_line: # Lines match. if line_counter == put_at_line_number: subst_done = True if append: # Append. final_string.append(current_line) final_string.append(string_to_be_inserted) else: # Prepend. final_string.append(string_to_be_inserted) final_string.append(current_line) else: # No match, generic line. final_string.append(current_line) current_line = f.readline() line_counter += 1 while not current_line and line_counter <= put_at_line_number: # Out of file bounds. if line_counter == put_at_line_number: final_string.append(string_to_be_inserted) line_counter += 1 # Prepend does not make sense here since we are out of the # file bounds so the `string_to_be_inserted` will always # be the last string inserted in the file. else: final_string.append(newline_character) line_counter += 1 if not current_line or (line_counter > put_at_line_number and subst_done): # All the file has been iterated by this point and the # substitution has been done either in or out of the file # bounds. loop = False # Atomic write. # See # https://stupidpythonideas.blogspot.com/2014/07/getting-atomic-writes-right.html # https://docs.python.org/3/library/os.html#os.fsync with tempfile.NamedTemporaryFile('w', newline=newline_character, delete=False) as f: f.flush() os.fsync(f.fileno()) f.write(''.join(final_string)) shutil.move(f.name, output_file) def remove_line_interval(input_file: str, delete_line_from: int, delete_line_to: int, output_file: str): r"""Remove a line interval. :parameter input_file: the file that needs to be read. :parameter delete_line_from: the line number from which start deleting. :parameter delete_line_to: the line number to which stop deleting. :parameter output_file: the file that needs to be written without the selected lines. :type input_file: str :type delete_line_from: int :type delete_line_to: int :type output_file: str :returns: None :raises: NegativeLineRangeError, LineOutOfFileBoundsError or a built-in exception. .. note:: Line numbers start from ``1``. .. note:: It is possible to remove a single line only. This happens when the parameters delete_line_from and delete_line_to are equal. """ # Invalid line ranges. if delete_line_from < 1 or delete_line_to < 1: raise ValueError # Base case delete_line_to - delete_line_from == 0: single line. if delete_line_to - delete_line_from < 0: raise NegativeLineRangeError line_counter: int = 1 line_to_write: list[str] = list() line: str # Rewrite the file without the string. with open(input_file, 'r') as f: line = f.readline() while line: # Ignore the line interval where the content to be deleted lies. if line_counter >= delete_line_from and line_counter <= delete_line_to: pass # Write the rest of the file. else: line_to_write.append(line) line_counter += 1 line = f.readline() # Invalid line range. if delete_line_from > line_counter or delete_line_to > line_counter: raise LineOutOfFileBoundsError # Atomic write. # See # https://stupidpythonideas.blogspot.com/2014/07/getting-atomic-writes-right.html # https://docs.python.org/3/library/os.html#os.fsync with tempfile.NamedTemporaryFile('w', delete=False) as f: f.flush() os.fsync(f.fileno()) f.write(''.join(line_to_write)) shutil.move(f.name, output_file) if __name__ == '__main__': pass fpyutils-4.0.1/fpyutils/notify.py000066400000000000000000000103251452300165400171350ustar00rootroot00000000000000# -*- coding: utf-8 -*- # # notify.py # # Copyright (C) 2017-2020 Franco Masotti (see /README.md) # # This file is part of fpyutils. # # fpyutils 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. # # fpyutils 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 fpyutils. If not, see . # """Functions on notifications.""" import json import smtplib import ssl import urllib.request from email.mime.text import MIMEText from email.utils import formatdate from .path import add_trailing_slash def send_email(message: str, smtp_server: str, port: int, sender: str, user: str, password: str, receiver: str, subject: str) -> dict: r"""Send an email. :parameter message: the body of the message. :parameter smtp_server: the address of the sending server. :parameter port: the port of the sending server. :parameter sender: the email of the sender. :parameter user: the username of the sender. :parameter password: the password of the sender. :parameter receiver: the email of the receiver. :parameter subject: the subject field of the email. :type message: str :type smtp_server: str :type port: int :type sender: str :type user: str :type password: str :type receiver: str :type subject: str :returns: an empty dictionary on no error, otherwise an exception is raised. :rtype: dict :raises: a built-in exception. """ # https://stackoverflow.com/questions/36832632/sending-mail-via-smtplib-loses-time # # Copyright (C) 2016 tfv @ Stack Overflow (https://stackoverflow.com/a/36834904) # Copyright (C) 2017 recolic @ Stack Overflow (https://stackoverflow.com/a/36834904) # Copyright (C) 2020 Franco Masotti (see /README.md) # # This script is licensed under a # Creative Commons Attribution-ShareAlike 4.0 International License. # # You should have received a copy of the license along with this # work. If not, see . msg = MIMEText(message) msg['Subject'] = subject msg['From'] = sender msg['To'] = receiver msg['Date'] = formatdate(localtime=True) context = ssl.create_default_context() with smtplib.SMTP_SSL(smtp_server, port, context=context) as conn: conn.login(user, password) result = conn.sendmail(sender, receiver, msg.as_string()) return result def send_gotify_message(url: str, token: str, message: str = 'message', title: str = 'title', priority: int = 5): r"""Send a notification to a gotify server. :parameter url: the URL of the Gotify server :parameter token: the APP token :parameter message: the message title. Defaults to ``message``. :parameter title: the text of the message Defaults to ``title``. :parameter priority: the message priority. Defaults to ``5``. :type url: str :type token: str :type message: str :type title: str :type priority: int :returns: a ``http.client.HTTPResponse`` object :raises: ValueError or a built-in exception. """ # All URLs for a gotify server must start with 'http'. if not url.lower().startswith('http'): raise ValueError full_url: str = add_trailing_slash(url) + 'message?token=' + token payload: dict = { 'title': title, 'message': message, 'priority': priority, } data: str = json.dumps(payload) req = urllib.request.Request(url=full_url, data=bytes(data.encode('UTF-8')), method='POST') req.add_header('Content-type', 'application/json; charset=UTF-8') return urllib.request.urlopen(req) if __name__ == '__main__': pass fpyutils-4.0.1/fpyutils/path.py000066400000000000000000000070201452300165400165570ustar00rootroot00000000000000# -*- coding: utf-8 -*- # # path.py # # Copyright (C) 2017-2020 Franco Masotti (see /README.md) # # This file is part of fpyutils. # # fpyutils 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. # # fpyutils 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 fpyutils. If not, see . # """Functions on paths.""" import datetime import hashlib import pathlib import secrets import urllib def add_trailing_slash(uri: str) -> str: r"""Add a trailing slash when needed. :param uri: a string, usually an URI. :type uri: str :returns uri: the input string with a trailing slash. :rtype: str :raises: a built-in exception. """ if uri.endswith('/'): uri = uri else: uri = f"{uri}/" return uri def gen_pseudorandom_path(path_suffix: str = str(), date_component_format: str = '%F_%H-%M-%S_%f', component_separator: str = '_', pseudorandom_component_bytes: int = 4, hash_component_digest_size: int = 3, character_encoding: str = 'UTF-8') -> str: r"""Generate a pseudorandom string useful for paths. :param path_suffix: the final part of the string. Defaults to ``str()``. :param date_component_format: the format of the date component. Defaults to ``%F_%H-%M-%S_%f``. :param component_separator: an element that separates the various components. Defaults to ``_``. :param pseudorandom_component_bytes: the number of bytes of the pseudorandom components. Defaults to ``4``. :param hash_component_digest_size: the digest size of the hashed component. Defaults to ``3``. :param character_encoding: the character encoding of the hashed component. Defaults to ``UTF-8``. :type path_suffix: str :type date_component_format: str :type component_separator: str :type pseudorandom_component_bytes: int :type hash_component_digest_size: int :type character_encoding: str :returns: :rtype: str :raises: a built-in exception. .. note:: This system minimises the risk of collisions for creating a path. """ # 1. the current date. # call the fpyutils.datetime module. date_component: str = datetime.date.strftime(datetime.datetime.now(), date_component_format) # 2. a pseudorandom component. pseudorandom_component: str = secrets.token_urlsafe( nbytes=pseudorandom_component_bytes) # 3. a hash of path_suffix. This will be equal to # 'cec7ea' using blake2b and a digest size of 3. hashed_component: str = (hashlib.blake2b( path_suffix.encode(character_encoding), digest_size=hash_component_digest_size).hexdigest()) # 4. the path suffix, if present. if path_suffix != str(): path_suffix = component_separator + path_suffix return (date_component + component_separator + pseudorandom_component + component_separator + hashed_component + path_suffix) if __name__ == '__main__': pass fpyutils-4.0.1/fpyutils/shell.py000066400000000000000000000057571452300165400167510ustar00rootroot00000000000000# -*- coding: utf-8 -*- # # shell.py # # Copyright (C) 2017-2020 Franco Masotti (see /README.md) # # This file is part of fpyutils. # # fpyutils 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. # # fpyutils 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 fpyutils. If not, see . # """Functions on shell.""" import subprocess import sys def execute_command_live_output( command: str, shell: str = '/bin/bash', dry_run: bool = False, output_character_encoding: str = 'UTF-8') -> int: r"""Execute and print the output of a command relatime. :parameter command: the shell commands that needs to be executed. :parameter shell: the shell binary that will be used to execute the command. Defaults to ``/bin/bash``. :parameter dry_run: print the command instead of executing it. Defaults to ``False``. :parameter output_character_encoding: the character encoding of the output. Defaults to ``UTF-8``. :type command: str :type shell: str :type dry_run: bool :type output_character_encoding: str :returns: process.returncode, the return code of the executed command. :rtype: int :raises: a subprocess, sys or a built-in exception. """ # See https://stackoverflow.com/a/53811881 # # Copyright (C) 2018 Tom Hale @ Stack Exchange (https://stackoverflow.com/a/53811881) # Copyright (C) 2020 Franco Masotti (see /README.md) # # This script is licensed under a # Creative Commons Attribution-ShareAlike 4.0 International License. # # You should have received a copy of the license along with this # work. If not, see . retval: int if dry_run: print(shell + ' -c ' + command) retval = 0 else: # See also https://stackoverflow.com/questions/7407667/python-subprocess-subshells-and-redirection/7407744 # and https://stackoverflow.com/a/58696973 with subprocess.Popen([shell, '-c', command], stderr=subprocess.PIPE) as process: go: bool = True while go: output: str = process.stderr.readline().decode( output_character_encoding) if output == str() and process.poll() is not None: go = False if go and output != str(): sys.stdout.write(output) sys.stdout.flush() retval = process.returncode return retval if __name__ == '__main__': pass fpyutils-4.0.1/fpyutils/tests/000077500000000000000000000000001452300165400164145ustar00rootroot00000000000000fpyutils-4.0.1/fpyutils/tests/__init__.py000066400000000000000000000014261452300165400205300ustar00rootroot00000000000000# -*- coding: utf-8 -*- # # __init__.py # # Copyright (C) 2017-2019 Franco Masotti (see /README.md) # # This file is part of fpyutils. # # fpyutils 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. # # fpyutils 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 fpyutils. If not, see . # """Python discovery file.""" fpyutils-4.0.1/fpyutils/tests/tests.py000077500000000000000000000421761452300165400201450ustar00rootroot00000000000000# -*- coding: utf-8 -*- # # tests.py # # Copyright (C) 2017-2019 Franco Masotti (see /README.md) # # This file is part of fpyutils. # # fpyutils 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. # # fpyutils 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 fpyutils. If not, see . # """Tests.""" import io import pathlib import tempfile import unittest from unittest.mock import mock_open, patch from .. import exceptions, filelines, path, shell # filelines module. FAKE_FILE_AS_STRING = '''\ # One\n\ ## One.Two\n\ ''' FAKE_FILE_AS_STRING_PREPEND_NEWLINE = '''\ \n\ # One\n\ ## One.Two\n\ ''' FAKE_FILE_AS_STRING_R_AS_NEWLINE = '''\ # One\r\ ## One.Two\r\ ''' FAKE_FILE_AS_STRING_RN_AS_NEWLINE = '''\ # One\r\n\ ## One.Two\r\n\ ''' FAKE_FILE_WITH_MATCHES_AS_STRING = '''\ # One\n\ ## One.Two\n\ Hello, this is some content\n\ [](TOC)\n\ This is some more content\n\ Bye\n\ And again let there be\n\ more\n\ content.\n\ [](TOC)\n\ End of toc\n\ ''' class TestFileLines(unittest.TestCase): r"""filelines modules test.""" def test_get_line_matches(self): r"""test_get_line_matches.""" # Zero pattern matches. with patch('builtins.open', mock_open(read_data=FAKE_FILE_AS_STRING)): matches, lines = filelines.get_line_matches(input_file='foo.md', pattern='[](TOC)', max_occurrencies=1) self.assertTrue(1 not in matches) self.assertEqual(lines, str()) # One pattern matches. with patch('builtins.open', mock_open(read_data=FAKE_FILE_WITH_MATCHES_AS_STRING)): matches, lines = filelines.get_line_matches(input_file='foo.md', pattern='[](TOC)', max_occurrencies=1) self.assertEqual(matches[1], 4) self.assertEqual(lines, '[](TOC)\n') self.assertTrue(2 not in matches) # One pattern matches and keep all lines. with patch('builtins.open', mock_open(read_data=FAKE_FILE_WITH_MATCHES_AS_STRING)): matches, lines = filelines.get_line_matches(input_file='foo.md', pattern='[](TOC)', max_occurrencies=1, keep_all_lines=True) self.assertEqual(matches[1], 4) self.assertEqual(lines, FAKE_FILE_WITH_MATCHES_AS_STRING) self.assertTrue(2 not in matches) # More than one pattern matches. with patch('builtins.open', mock_open(read_data=FAKE_FILE_WITH_MATCHES_AS_STRING)): matches, lines = filelines.get_line_matches(input_file='foo.md', pattern='[](TOC)', max_occurrencies=0) self.assertEqual(matches[1], 4) self.assertEqual(matches[2], 10) self.assertEqual(lines, '[](TOC)\n[](TOC)\n') self.assertTrue(3 not in matches) # Zero pattern matches with loose matching disabled. with patch('builtins.open', mock_open(read_data=FAKE_FILE_WITH_MATCHES_AS_STRING)): matches, lines = filelines.get_line_matches(input_file='foo.md', pattern='[](TOC)', max_occurrencies=0, loose_matching=False) self.assertEqual(lines, str()) self.assertTrue(1 not in matches) # More than zero pattern matches with loose matching disabled. with patch('builtins.open', mock_open(read_data=FAKE_FILE_WITH_MATCHES_AS_STRING)): matches, lines = filelines.get_line_matches(input_file='foo.md', pattern='[](TOC)\n', max_occurrencies=0, loose_matching=False) self.assertEqual(matches[1], 4) self.assertEqual(matches[2], 10) self.assertEqual(lines, '[](TOC)\n[](TOC)\n') self.assertTrue(3 not in matches) def _test_helper_insert_string_at_line(self, append, buff, string_to_be_inserted, line_no, newline_character: str = '\n'): r"""Text mode helper.""" with tempfile.TemporaryDirectory() as d: filename = str(pathlib.PurePath(d, 'testing')) with open(filename, 'wb') as f: f.write(bytes(buff, 'UTF-8')) f.flush() filelines.insert_string_at_line(filename, string_to_be_inserted, line_no, filename, append, newline_character) # Open the file in binary mode to read the newlines as-is. with open(filename, 'rb') as f: content = f.read() cnt = content.decode('UTF-8') return cnt def test_insert_string_at_line(self): r"""test_insert_string_at_line.""" string_to_be_inserted = "Some string_to_be_inserted" # Existing line. buff = FAKE_FILE_AS_STRING line_no = 2 append = False newline = '\n' result = self._test_helper_insert_string_at_line( append, buff, string_to_be_inserted, line_no, newline) expected = buff.split('\n')[ 0] + '\n' + string_to_be_inserted + buff.split('\n')[1] + '\n' self.assertEqual(expected, result) # Existing line. Use '\r\n' as newline. buff = FAKE_FILE_AS_STRING line_no = 2 append = False newline = '\r\n' result = self._test_helper_insert_string_at_line( append, buff, string_to_be_inserted, line_no, newline) expected = buff.split('\n')[ 0] + '\r\n' + string_to_be_inserted + buff.split('\n')[1] + '\r\n' self.assertEqual(expected, result) # Existing line. Use '\r' as newline. buff = FAKE_FILE_AS_STRING line_no = 2 append = False newline = '\r' result = self._test_helper_insert_string_at_line( append, buff, string_to_be_inserted, line_no, newline) expected = buff.split('\n')[ 0] + '\r' + string_to_be_inserted + buff.split('\n')[1] + '\r' self.assertEqual(expected, result) # Existing line with '\n' as prefix. buff = FAKE_FILE_AS_STRING_PREPEND_NEWLINE line_no = 3 append = False newline = '\n' result = self._test_helper_insert_string_at_line( append, buff, string_to_be_inserted, line_no, newline) expected = '\n' + buff.split('\n')[ 1] + '\n' + string_to_be_inserted + buff.split('\n')[2] + '\n' self.assertEqual(expected, result) # Work with '\r\n' instead of '\n'. buff = FAKE_FILE_AS_STRING_RN_AS_NEWLINE line_no = 2 append = True newline = '\r\n' result = self._test_helper_insert_string_at_line( append, buff, string_to_be_inserted, line_no, newline) expected = buff.split('\r\n')[0] + '\r\n' + buff.split( '\r\n')[1] + '\r\n' + string_to_be_inserted self.assertEqual(expected, result) # Work with '\r' instead of '\n'. buff = FAKE_FILE_AS_STRING_R_AS_NEWLINE line_no = 2 append = True newline = '\r' result = self._test_helper_insert_string_at_line( append, buff, string_to_be_inserted, line_no, newline) expected = buff.split('\r')[0] + '\r' + buff.split( '\r')[1] + '\r' + string_to_be_inserted self.assertEqual(expected, result) # Work with '\z', an illegal value for newline, instead of '\n'. buff = FAKE_FILE_AS_STRING_R_AS_NEWLINE line_no = 2 append = True newline = r'\z' # Both exceptions are raised. with self.assertRaises((ValueError, OSError)): self._test_helper_insert_string_at_line(append, buff, string_to_be_inserted, line_no, newline) # Last line of a file, append. buff = FAKE_FILE_AS_STRING line_no = 2 append = True newline = '\n' result = self._test_helper_insert_string_at_line( append, buff, string_to_be_inserted, line_no) expected = buff + string_to_be_inserted self.assertEqual(expected, result) # Last line of a file, prepend. buff = FAKE_FILE_AS_STRING line_no = 2 append = False newline = '\n' result = self._test_helper_insert_string_at_line( append, buff, string_to_be_inserted, line_no) expected = buff.split('\n')[ 0] + '\n' + string_to_be_inserted + buff.split('\n')[1] + '\n' self.assertEqual(expected, result) # Last line + 1 of a file, append. buff = FAKE_FILE_AS_STRING line_no = 3 append = True newline = '\n' result = self._test_helper_insert_string_at_line( append, buff, string_to_be_inserted, line_no) expected = buff + string_to_be_inserted self.assertEqual(expected, result) # Last line + 1 of a file, prepend. buff = FAKE_FILE_AS_STRING line_no = 3 append = False newline = '\n' result = self._test_helper_insert_string_at_line( append, buff, string_to_be_inserted, line_no) expected = buff + string_to_be_inserted self.assertEqual(expected, result) # Non existing line, prepend. buff = FAKE_FILE_AS_STRING line_no = 2**5 # We do not need to consider the last component of the buff.split() list. number_of_newlines_after_last_existing_line = line_no - ( len(buff.split('\n')) - 1) append = False result = self._test_helper_insert_string_at_line( append, buff, string_to_be_inserted, line_no) expected = buff.split('\n')[0] + '\n' + buff.split( '\n' )[1] + number_of_newlines_after_last_existing_line * '\n' + string_to_be_inserted self.assertEqual(expected, result) # Non existing line, append. line_no = 2**5 buff = FAKE_FILE_AS_STRING number_of_newlines_after_last_existing_line = line_no - ( len(buff.split('\n')) - 1) append = True result = self._test_helper_insert_string_at_line( append, buff, string_to_be_inserted, line_no) expected = buff.split('\n')[0] + '\n' + buff.split( '\n' )[1] + number_of_newlines_after_last_existing_line * '\n' + string_to_be_inserted self.assertEqual(expected, result) def _test_helper_remove_line_interval(self, buff, line_from, line_to): with tempfile.TemporaryDirectory() as d: filename = str(pathlib.PurePath(d, 'testing')) with open(filename, 'w') as f: f.write(buff) f.flush() filelines.remove_line_interval(filename, line_from, line_to, filename) with open(filename, 'r') as f: content = f.read() return content def test_remove_line_interval(self): r"""test_remove_line_interval.""" # remove_line_interval existing interval. # Assert called with everything except the missing lines. line_from = 5 line_to = 9 buff = FAKE_FILE_WITH_MATCHES_AS_STRING result = self._test_helper_remove_line_interval( buff, line_from, line_to) # Also add missing newline after the join operation. expected = '\n'.join( buff.split('\n')[0:line_from - 1] + buff.split('\n')[line_to:-1]) + '\n' self.assertEqual(expected, result) # remove_line_interval non existing interval. # We simply have to check if the correct exception is raised. line_from = 1 line_to = 4 buff = FAKE_FILE_AS_STRING with self.assertRaises(exceptions.LineOutOfFileBoundsError): self._test_helper_remove_line_interval(buff, line_from, line_to) # Negative line range. line_from = 4 line_to = 1 buff = FAKE_FILE_AS_STRING with self.assertRaises(exceptions.NegativeLineRangeError): self._test_helper_remove_line_interval(buff, line_from, line_to) class TestShell(unittest.TestCase): """shell modules test.""" # See https://stackoverflow.com/a/46307456 # Check the output as well. @unittest.mock.patch('sys.stdout', new_callable=io.StringIO) def assert_stdout(self, command: str, shell_command: str, dry_run: bool, output_character_encoding: str, expected_outputs: list, expected_retvals: list, file_descriptor): r"""Run the assertions by capturing the standard output. file_description is an argument passed by mock. """ retval = shell.execute_command_live_output( command=command, shell=shell_command, dry_run=dry_run, output_character_encoding=output_character_encoding) output = file_descriptor.getvalue() self.assertTrue(retval in expected_retvals) self.assertTrue(output in expected_outputs) def test_execute_command_live_output(self): r"""test_execute_command_live_output.""" self.assert_stdout('true', '/bin/bash', False, 'UTF-8', [str()], [0]) self.assert_stdout('false', '/bin/bash', False, 'UTF-8', [str()], [1]) # Dry runs should always have a return value of 0. self.assert_stdout('true', '/bin/bash', True, 'UTF-8', ['/bin/bash -c true\n'], [0]) self.assert_stdout('false', '/bin/bash', True, 'UTF-8', ['/bin/bash -c false\n'], [0]) # Invalid shell. with self.assertRaises(FileNotFoundError): self.assert_stdout('false', '/bin/an/invalid/command', False, 'UTF-8', ['/bin/bash -c false\n'], [0]) # No problems for dry runs. self.assert_stdout('false', '/bin/an/invalid/command', True, 'UTF-8', ['/bin/an/invalid/command -c false\n'], [0]) # Invalid command. self.assert_stdout('falsse', '/bin/bash', False, 'UTF-8', [ '/bin/bash: falsse: command not found\n', '/bin/bash: line 1: falsse: command not found\n' ], [127]) class TestPath(unittest.TestCase): r"""path modules test.""" def test_gen_pseudorandom_path(self): r"""test_gen_pseudorandom_path.""" # We can only test the length since the output is not deterministic. path_suffix = '1234567890' component_separator = '_' date_component_format = '%F' total_length = 10 + 1 + 6 + 1 + 6 + 1 + len(path_suffix) self.assertEqual( total_length, len( path.gen_pseudorandom_path( path_suffix=path_suffix, date_component_format=date_component_format, component_separator=component_separator))) # No path suffix. path_suffix = str() component_separator = '_' date_component_format = '%F' total_length = 10 + 1 + 6 + 1 + 6 self.assertEqual( total_length, len( path.gen_pseudorandom_path( path_suffix=path_suffix, date_component_format=date_component_format, component_separator=component_separator))) def test_add_trailing_slash(self): r"""test_add_trailing_slash.""" # Empty string. self.assertEqual(path.add_trailing_slash(str()), '/') self.assertEqual(path.add_trailing_slash('/'), '/') self.assertEqual(path.add_trailing_slash('http://a b c/'), 'http://a b c/') self.assertEqual(path.add_trailing_slash('http://a b c'), 'http://a b c/') class TestNotify(unittest.TestCase): r"""notify modules test.""" def test_send_email(self): r"""Nothing to test.""" pass def test_send_gotify_message(self): r"""Nothing to test.""" pass if __name__ == '__main__': unittest.main() fpyutils-4.0.1/packages/000077500000000000000000000000001452300165400151515ustar00rootroot00000000000000fpyutils-4.0.1/packages/aur/000077500000000000000000000000001452300165400157405ustar00rootroot00000000000000fpyutils-4.0.1/packages/aur/PKGBUILD000066400000000000000000000020351452300165400170640ustar00rootroot00000000000000# Maintainer: Franco Masotti (See /README.md in project source) # Contributor: Franco Masotti (See /README.md in project source) pkgname=python-fpyutils pkgver=4.0.1 pkgrel=1 pkgdesc="A collection of useful non-standard Python functions which aim to be simple to use" arch=('any') url="https://blog.franco.net.eu.org/software/#fpyutils" license=('GPL3') depends=('python') makedepends=('python-build' 'python-installer' 'python-wheel' 'python-setuptools') options=(!emptydirs) source=("https://blog.franco.net.eu.org/software/fpyutils-${pkgver}/fpyutils-${pkgver}.tar.gz.sig" "https://blog.franco.net.eu.org/software/fpyutils-${pkgver}/fpyutils-${pkgver}.tar.gz") sha512sums=('SKIP' 'SKIP') check() { cd "${srcdir}"/fpyutils-"${pkgver}" python -m unittest discover --failfast --locals --verbose } build() { cd "${srcdir}"/fpyutils-"${pkgver}" python -m build --wheel --no-isolation } package() { cd "${srcdir}"/fpyutils-"${pkgver}" python -m installer --destdir="${pkgdir}" dist/*.whl } fpyutils-4.0.1/pyproject.toml000066400000000000000000000001311452300165400163020ustar00rootroot00000000000000[build-system] requires = ["setuptools>=39.2.0"] build-backend = "setuptools.build_meta" fpyutils-4.0.1/requirements-dev.txt000066400000000000000000000015631452300165400174400ustar00rootroot00000000000000# requirements-dev.txt # # Copyright (C) 2022-2023 Franco Masotti (see /README.md) # # This file is part of fpyutils. # # fpyutils 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. # # fpyutils 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 fpyutils. If not, see . # # Documentation. sphinx-book-theme>=1.0,<1.1 sphinx-copybutton>=0.5,<0.6 # Tools. tox>=4,<5 twine>=4,<5 build>=1.0,<1.1 pre-commit>=3,<4 fpyutils-4.0.1/requirements-freeze.txt000066400000000000000000000023051452300165400201350ustar00rootroot00000000000000accessible-pygments==0.0.4 alabaster==0.7.13 Babel==2.13.1 beautifulsoup4==4.12.2 build==1.0.3 cachetools==5.3.2 certifi==2023.7.22 cffi==1.16.0 cfgv==3.4.0 chardet==5.2.0 charset-normalizer==3.3.2 colorama==0.4.6 cryptography==41.0.5 distlib==0.3.7 docutils==0.19 filelock==3.13.1 identify==2.5.31 idna==3.4 imagesize==1.4.1 importlib-metadata==6.8.0 jaraco.classes==3.3.0 jeepney==0.8.0 Jinja2==3.1.2 keyring==24.2.0 markdown-it-py==3.0.0 MarkupSafe==2.1.3 mdurl==0.1.2 more-itertools==10.1.0 nh3==0.2.14 nodeenv==1.8.0 packaging==23.2 pkginfo==1.9.6 platformdirs==3.11.0 pluggy==1.3.0 pre-commit==3.5.0 pycparser==2.21 pydata-sphinx-theme==0.14.3 Pygments==2.16.1 pyproject-api==1.6.1 pyproject_hooks==1.0.0 PyYAML==6.0.1 readme-renderer==42.0 requests==2.31.0 requests-toolbelt==1.0.0 rfc3986==2.0.0 rich==13.6.0 SecretStorage==3.3.3 snowballstemmer==2.2.0 soupsieve==2.5 Sphinx==6.2.1 sphinx-book-theme==1.0.1 sphinx-copybutton==0.5.2 sphinxcontrib-applehelp==1.0.7 sphinxcontrib-devhelp==1.0.5 sphinxcontrib-htmlhelp==2.0.4 sphinxcontrib-jsmath==1.0.1 sphinxcontrib-qthelp==1.0.6 sphinxcontrib-serializinghtml==1.1.9 tox==4.11.3 twine==4.0.2 typing_extensions==4.8.0 urllib3==2.0.7 virtualenv==20.24.6 zipp==3.17.0 fpyutils-4.0.1/requirements.txt000066400000000000000000000000001452300165400166450ustar00rootroot00000000000000fpyutils-4.0.1/setup.cfg000066400000000000000000000041271452300165400152200ustar00rootroot00000000000000# -*- coding: utf-8 -*- # # setup.cfg # # Copyright (C) 2022-2023 Franco Masotti (see /README.md) # # This file is part of fpyutils. # # fpyutils 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. # # fpyutils 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 fpyutils. If not, see . # [metadata] name=fpyutils # version needs setuptools >= 39.2.0 version=4.0.1 license=GPLv3+ description=A collection of useful non-standard Python functions which aim to be simple to use, highly readable but not efficient. long_description=file: README.md long_description_content_type=text/markdown author=Franco Masotti author_email=franco.masotti@tutanota.com keywords= utilities text command url=https://blog.franco.net.eu.org/software/#fpyutils classifiers= Development Status :: 5 - Production/Stable Intended Audience :: Developers Topic :: Software Development :: Libraries License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+) Programming Language :: Python :: 3 [options] python_requires = >=3.7, <4 install_requires= packages=find: [options.packages.find] exclude= *tests* [options.package_data] * = *.txt, *.rst [yapf] based_on_style = pep8 indent_width = 4 [flake8] ignore = E125 E131 E501 W503 W504 F401 [isort] # See # https://github.com/ESMValGroup/ESMValCore/issues/777 multi_line_output = 3 include_trailing_comma = true [tox:tox] requires = tox>=4 env_list = py{37,38,39,310,311,312,313} [testenv] description = run the tests with unittest package = wheel wheel_build_env = .pkg commands = python -m unittest fpyutils.tests.tests --failfast --locals --verbose fpyutils-4.0.1/setup.py000066400000000000000000000017351452300165400151130ustar00rootroot00000000000000# -*- coding: utf-8 -*- # # setup.py # # Copyright (C) 2017-2023 Franco Masotti (see /README.md) # # This file is part of fpyutils. # # fpyutils 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. # # fpyutils 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 fpyutils. If not, see . # r"""setup.py.""" import setuptools # See # https://importlib-metadata.readthedocs.io/en/latest/migration.html#pkg-resources-require # import pkg_resources # pkg_resources.require('setuptools>=39.2.0') setuptools.setup()