| Name | ataraxis-base-utilities JSON |
| Version |
3.0.1
JSON |
| download |
| home_page | None |
| Summary | Provides a minimalistic set of shared utility functions used to support most other Sun Lab projects. |
| upload_time | 2024-11-24 18:37:03 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.11 |
| license | GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The GNU General Public License is a free, copyleft license for software and other kinds of works. The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others. For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it. For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions. Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users. Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free. The precise terms and conditions for copying, distribution and modification follow. TERMS AND CONDITIONS 0. Definitions. "This License" refers to version 3 of the GNU General Public License. "Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. "The Program" refers to any copyrightable work licensed under this License. Each licensee is addressed as "you". "Licensees" and "recipients" may be individuals or organizations. To "modify" a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a "modified version" of the earlier work or a work "based on" the earlier work. A "covered work" means either the unmodified Program or a work based on the Program. To "propagate" a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. To "convey" a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. An interactive user interface displays "Appropriate Legal Notices" to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. 1. Source Code. The "source code" for a work means the preferred form of the work for making modifications to it. "Object code" means any non-source form of a work. A "Standard Interface" means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. The "System Libraries" of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A "Major Component", in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. The "Corresponding Source" for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work. The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. The Corresponding Source for a work in source code form is that same work. 2. Basic Permissions. All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. 3. Protecting Users' Legal Rights From Anti-Circumvention Law. No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures. 4. Conveying Verbatim Copies. You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. 5. Conveying Modified Source Versions. You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: a) The work must carry prominent notices stating that you modified it, and giving a relevant date. b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to "keep intact all notices". c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so. A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an "aggregate" if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. 6. Conveying Non-Source Forms. You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge. c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements. e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. A "User Product" is either (1) a "consumer product", which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, "normally used" refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. "Installation Information" for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying. 7. Additional Terms. "Additional permissions" are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or d) Limiting the use for publicity purposes of names of licensors or authors of the material; or e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors. All other non-permissive additional terms are considered "further restrictions" within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way. 8. Termination. You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10. 9. Acceptance Not Required for Having Copies. You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so. 10. Automatic Licensing of Downstream Recipients. Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. An "entity transaction" is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it. 11. Patents. A "contributor" is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's "contributor version". A contributor's "essential patent claims" are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, "control" includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. In the following three paragraphs, a "patent license" is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To "grant" such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. "Knowingly relying" means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. A patent license is "discriminatory" if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. 12. No Surrender of Others' Freedom. If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. 13. Use with the GNU Affero General Public License. Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such. 14. Revised Versions of this License. The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation. If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program. Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version. 15. Disclaimer of Warranty. THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 16. Limitation of Liability. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 17. Interpretation of Sections 15 and 16. If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. <one line to give the program's name and a brief idea of what it does.> Copyright (C) <year> <name of author> This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see <https://www.gnu.org/licenses/>. Also add information on how to contact you by electronic and paper mail. If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode: <program> Copyright (C) <year> <name of author> This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an "about box". You should also get your employer (if you work as a programmer) or school, if any, to sign a "copyright disclaimer" for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see <https://www.gnu.org/licenses/>. The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read <https://www.gnu.org/licenses/why-not-lgpl.html>. |
| keywords |
ataraxis
console
logging
utilities
utility-classes
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# ataraxis-base-utilities
Python library that provides a minimalistic set of shared utility functions used to support most other Sun Lab projects.
[](https://github.com/astral-sh/uv)
[](https://github.com/astral-sh/ruff)
___
## Detailed Description
This library is one of the two 'base' dependency libraries used by every other Sun Lab project (the other being
[ataraxis-automation](https://github.com/Sun-Lab-NBB/ataraxis-automation)). It aggregates common utility functions
that are expected to be shared and reused by many other lab projects, such as message and error logging. This library is
designed to avoid re-implementing the same set of utility features for every lab project. This is important, since most
of our codebases employ a highly modular and decentralized design with many independent subprojects dynamically
assembled into functional pipelines. Generally, any class or function copied with minor modifications into five
or more Sun Lab projects is a good candidate for inclusion into this library.
Despite a strong focus on supporting Sun Lab projects, this library can be used in non-lab projects with minor
refactoring. Specifically, anyone willing to reuse this library in their project may need to adjust the default values
and configurations used throughout this library to match their specific needs. Otherwise, it should be readily
integrable with any other project due to its minimalistic design (both in terms of features and dependencies).
___
## Features
- Supports Windows, Linux, and OSx.
- Loguru-based Console class that provides message and logging functionality.
- Frequently re-implemented utility method, such as a method that ensures the parent directory of a file path exists.
- Pure-python API.
- GPL 3 License.
___
## Table of Contents
- [Dependencies](#dependencies)
- [Installation](#installation)
- [Usage](#usage)
- [API Documentation](#api-documentation)
- [Developers](#developers)
- [Versioning](#versioning)
- [Authors](#authors)
- [License](#license)
- [Acknowledgements](#Acknowledgments)
___
## Dependencies
For users, all library dependencies are installed automatically for all supported installation methods
(see [Installation](#installation) section). For developers, see the [Developers](#developers) section for
information on installing additional development dependencies.
___
## Installation
### Source
1. Download this repository to your local machine using your preferred method, such as git-cloning. Optionally, use one
of the stable releases that include precompiled binary wheels in addition to source code.
2. ```cd``` to the root directory of the project using your command line interface of choice.
3. Run ```python -m pip install .``` to install the project. Alternatively, if using a distribution with precompiled
binaries, use ```python -m pip install WHEEL_PATH```, replacing 'WHEEL_PATH' with the path to the wheel file.
### PIP
Use the following command to install the library using PIP: ```pip install ataraxis-base-utilities```
___
## Usage
This section is broken into subsections for each exposed utility class or module. For each, it progresses from a
minimalistic example and / or 'quickstart' to detailed notes on nuanced class functionality
(if the class has such functionality).
### Console
The Console class provides message and error display (via terminal) and logging (to files) functionality. Primarily,
this is realized through the [loguru](https://github.com/Delgan/loguru) backend. It is highly advised to check loguru
documentation to understand how Console functions under-the-hood, although this is not strictly required. As a secondary
backend, the class uses [click](https://click.palletsprojects.com/en/8.1.x/), so it may be beneficial to review its
documentation if loguru backend is not appropriate for your specific use case.
#### Quickstart
Most class functionality revolves around 2 methods: ```echo()``` and ```error()```. To make adoption as frictionless
as possible, we offer a preconfigured class instance exposed through 'console' class variable that can be used 'as-is'
and shared between multiple modules:
```
from ataraxis_base_utilities import console
# The class is disabled by default, so it needs to be enabled to see method outputs. You do not need to have it enabled
# to add error() or echo() calls to your code though.
console.enable()
# Use this instead of print()!
console.echo("This is essentially a better 'print'.")
# Use this instead of 'raise Exception'!
console.error("This is essentially a better 'raise'.")
```
#### Echo
Console.echo() method can be thought of as a better print() with some additional functionality. For example, you can
provide the desired message 'level' to finely control how it will be processed:
```
from ataraxis_base_utilities import console, LogLevel
console.enable()
# By default, console is configured to NOT print debug messages. You will not see anything after this call
console.echo(message='Debug', level=LogLevel.DEBUG)
# But you will see this information message
console.echo(message='Info', level=LogLevel.INFO)
# Or this error message
console.echo(message='Error', level=LogLevel.ERROR)
# Disabled console will not print any messages at all.
console.disable()
status = console.echo(message='Info', level=LogLevel.INFO)
# To help you track if console is not printing due to being disabled, it returns 'False' when you call echo() while the
# class is disabled.
assert status is False
# However, if lack of printing is due to how console is configured and not it being disabled, the status will be set to
# 'True'.
console.enable()
status = console.echo(message='Debug', level=LogLevel.DEBUG)
assert status
```
#### Error
Console.error() method can be thought of as a more nuanced 'raise Exception' directive. Most of the additional
functionality of this method comes from Console class configuration, and in its most basic form, this is just a
wrapper around 'raise':
```
from ataraxis_base_utilities import console
console.enable()
# By default, console uses 'default callback' to abort the active runtime after raising an error. Since this will
# interrupt this example, this needs to be disabled. See 'error runtime control' section for more details.
console.set_callback(None)
# You can specify the exception to be raised by providing it as an 'error' argument. By default, this argument is
# set to RuntimeError.
console.error(message="TypeError", error=TypeError)
# This works for custom exceptions as well!
class CustomError(Exception):
pass
console.error(message="CustomError", error=CustomError)
# When console is disabled, error() behaves identically to 'raise' directive. This way, your errors will always be
# raised, regardless of whether console is enabled or not.
console.disable()
console.error(message="ValueError", error=ValueError)
```
#### Format Message
All console methods format input messages to fit the default width-limit of 120 characters. This was chosen as it is
both likely to fit into any modern terminal and gives us a little more space than the default legacy '80' limit used by
many projects. The formatting takes into consideration that 'loguru' backend adds some ID information to the beginning
of each method, so the text should look good regardless of the backend used. In the case that you want to use console
as a formatter, rather than a message processor, you can use Console.format_message() method:
```
from ataraxis_base_utilities import console
# Let's use this test message
message = (
"This is a very long message that exceeds our default limit of 120 characters. As such, it needs to be wrapped to "
"appear correctly when printed to terminal (or saved to a log file)."
)
# This shows how the message looks without formatting
print(message)
# This formats the message according to our standards. Note how this works regardless of whether console is enabled or
# not!
formatted_message = console.format_message(message)
# See how it compares to the original message!
print(formatted_message)
```
#### Configuring console: enable / disable
By default, console starts 'disabled.' You can enable or disable it at any time! When using console to add functionality
to libraries, do not enable() the console. This way, you both add console functionality to your library and allow the
end-user to decide how much output they want to see and in what format.
```
from ataraxis_base_utilities import console, LogLevel
# Most basically, the console can be enabled() or disabled() any time using the appropriate methods:
console.enable()
console.disable()
# To check the current console status, you can use the getter method:
assert not console.is_enabled
```
#### Configuring console: output control
By default, console is configured to print information and error messages to the terminal. However, you can
flexibly set what kind of messages it processes and where they go. To do so, you can use the extensive set of setter and
getter methods.
```
from ataraxis_base_utilities import console, LogLevel
console.enable()
# Consider debug message printing, which is disabled by default:
console.echo('Debug', level=LogLevel.DEBUG)
# If we enable debug printing, the message will show up in terminal as expected:
console.set_debug_terminal(True)
console.echo('Debug', level=LogLevel.DEBUG)
# To verify if a particular output format for a message type is enabled, you can use the getter method:
assert console.debug_terminal
assert not console.error_file
# The class allows you to flexibly configure terminal-printing and file-logging for Debug-, Info to Warning and Error+
# messages. The default 'console' configuration can be obtained by using the following setter methods and arguments:
console.set_debug_terminal(False)
console.set_debug_file(False)
console.set_message_terminal(True)
console.set_message_file(False)
console.set_error_terminal(True)
console.set_error_file(False)
# Note, 'getter' properties are named identical to setter methods, minus the 'set_' part:
assert not console.debug_terminal
assert not console.debug_file
assert console.message_terminal
assert not console.message_file
assert console.error_terminal
assert not console.error_file
```
#### Configuring console: log paths
For a message to be written to a log file, it is not enough to just 'enable' that output type. Additionally, you need
to provide console with a path to the log file to write to and, if it does not exist, create. This is done through a
separate set of setter and getter methods:
```
from ataraxis_base_utilities import console, LogExtensions
from pathlib import Path
# By default, the console is not provided with a path to the message log file and does not support writing messages to
# log file.
assert console.message_log_path is None
# You can provide it with a custom log file to enable logging functionality:
example_path = f"example{LogExtensions.LOG}"
console.set_message_log_path(Path(example_path))
assert console.message_log_path == Path(example_path)
# Note that the class supports only a set of file-extensions. For your convenience, they are available from
# LogExtensions class:
log_file = Path(f"example{LogExtensions.LOG}")
text_file = Path(f"example{LogExtensions.TXT}")
json_file = Path(f"example{LogExtensions.JSON}")
# As with other class configuration attributes, you can flexibly configure log files for each of the supported message
# groups:
console.set_message_log_path(log_file)
console.set_debug_log_path(text_file)
console.set_error_log_path(json_file)
# You can retrieve the used log file path at any time using an appropriate getter property:
log_file = console.message_log_path
text_file = console.debug_log_path
json_file = console.error_log_path
```
#### Configuring console: error runtime control
Console.error() significantly expands your ability to control how errors are handled. Specifically, its behavior can
range from generating default Python tracebacks to redirecting errors to log files to executing custom error callback
functions. Note, most of this functionality is only supported by our default 'loguru' backend.
```
from ataraxis_base_utilities import console, default_callback
console.enable()
# By default, the console is configured to call sys.exit() as a callback to prevent providing two error traces: one from
# loguru and the other from Python. To prevent this behavior, set console callback to None:
console.set_callback(None)
# This prints the error to terminal, but does not abort runtime.
try:
console.error("Test error", RuntimeError)
except RuntimeError:
print("You will not see this.")
# By default, console will not re-raise the logged error as a Python error.
assert not console.reraise
# However, if your use case needs this functionality, you can always enable it:
console.set_reraise(True)
try:
console.error("Test error", ValueError)
except ValueError:
print("The error was re-raised as expected.")
# WARNING! Callbacks, when provided, are executed before re-raising the error. If callback calls runtime-breaking
# functions, such as sys.exit(), it will interfere with error re-raising.
def benign_callback():
print('I do not cause a runtime error.')
console.set_callback(benign_callback)
try:
console.error("Test error", TypeError)
except TypeError:
print("Benign callback did not interfere with raising the error.")
# Default callback will, however, clash with 'reraise' functionality:
console.set_callback(default_callback)
try:
# This will abort the runtime through 'default_callback' calling sys.exit().
console.error("Test error", KeyError)
except KeyError:
print("This will not be displayed.")
```
#### Custom Console instances:
While this class is designed ot be used through the 'console' variable, you can also instantiate and use a custom
Console class instance. Unlike 'console' variable, this class will not be shared across all modules and libraries,
potentially allowing to isolate its configuration from the rest of your project. Note, since 'LOGURU' backend uses the
shared 'logger,' instantiating a new CConsole class does not automatically guarantee isolation!
```
from ataraxis_base_utilities import Console, LogBackends, LogExtensions
# The most important advantage of using the custom console is the ability to specify the backend other than the default
# 'LOGURU' backend. # All supported backends are available through the LogBackends enumeration.
click_console = Console(logger_backend=LogBackends.CLICK)
# Additionally, you can customize the formatting applied to messages:
format_console = Console(line_width=200, break_long_words=True, break_on_hyphens=True, use_color=False)
# Finally, you can make console safer by overriding the 'auto_handles' attribute to prevent 'LOGURU' consoles from
# automatically editing the shared 'logger' instance handles. To learn more about handles, see 'add_handles()' section.
loguru_console = Console(logger_backend=LogBackends.LOGURU, auto_handles=False)
# All attributes discussed in previous sections can be set by initialization arguments to the Console class:
def custom_callback():
"""Custom callback function"""
pass
debug_log_path = f"debug{LogExtensions.LOG}"
example_console = Console(
logger_backend=LogBackends.LOGURU,
debug_log_path=debug_log_path,
message_log_path=None,
error_log_path=None,
line_width=120,
error_callback=custom_callback,
auto_handles=True,
break_long_words=True,
break_on_hyphens=True,
use_color=False,
debug_terminal=True,
debug_file=True,
message_terminal=False,
message_file=True,
error_terminal=False,
error_file=True,
reraise_errors=True
)
```
#### Loguru Console: add_handles()
This section only applies to Console using 'loguru' backend, which includes the default 'console' variable. Loguru
relies on its 'logger' variable to be provided with handles that determine how to process messages. Similarly, Console
comes with add_handles() method that can be called to replace active handles with console-specific handles. Note, since
'logger' is shared across all libraries and modules, editing handles can interfere with any other class that uses
logger. Default console is written with the assumption that nothing else uses logger and, by default, removes all active
handles before adding its custom handles before adding its custom handles. Not only this, but it also calls
add_handles() automatically when initialized or when any of its attributes are edited.
```
from ataraxis_base_utilities import Console, LogBackends, LogExtensions
# By default, uses loguru backend
console = Console(auto_handles=False)
console.enable()
# Consoles that are not initialized with auto_handles=True require manually calling add_handles() method before calling
# echo() or error() methods.
console.add_handles(remove_existing_handles=False) # This call will NOT remove default handles
# This should produce two messages: one using the default 'console' variable handle that replaced 'logger' handle and
# another using the custom handle we added with add_handles() call.
console.echo("Hello, World!")
# To reset all handles, we cna use the default add_handles() argument:
console.add_handles()
console.echo("Now there is only one")
# Another important feature only available through 'add_handles' is the ability to 'enqueue' messages. This helps with
# using console from multiple processes by passing all messages through a shared processing queue.
console.add_handles(enqueue=True)
console.echo("The API remains the same though!")
```
#### Additional notes on usage:
Generally, Console class is designed to be used across many libraries that may also be dependent on each other.
Therefore, it should be used similar to how it is advised to use Loguru for logging: when using Console in a library,
do not call add_handles() or enable() methods. The only exception to this rule is when running in interactive mode
(cli, benchmark, script) that is known to be the highest hierarchy (nothing else imports your code, it imports
everything else).
To facilitate correct usage, the library exposes 'console' variable preconfigured to use Loguru backend and is
not enabled by default. You can use this variable to add Console-backed printing and logging functionality to your
library. Whenever your library is imported, the end-user can then enable() and add_handles() using the same 'console'
variable, which will automatically work for all console-based statements across all libraries. This way, the exact
configuration is left up to end-user, but your code will still raise errors and can be debugged using custom
logging configurations.
### Standalone Methods
The standalone methods are a broad collection of utility functions that either abstract away the boilerplate code for
common data manipulations or provide novel functionality not commonly available through popular Python libraries used
by our projects. Generally, these methods are straightforward to use and do not require detailed explanation:
#### Ensure list
As the name implies, this method ensures that the input is a Python list. If the input is not a Python list, the method
converts it into a list. If conversion fails, the method raises a ValueError.
```
import numpy as np
from ataraxis_base_utilities import ensure_list
# Ensures and, if necessary, converts inputs to the Python list type:
out_list = ensure_list(input_item=(1, 2, 3, 4))
assert isinstance(out_list, list)
assert out_list == [1, 2, 3, 4]
# It works for a wide range of inputs numpy arrays...
numpy_array = np.array([1, 2, 3, 4])
out_list = ensure_list(input_item=numpy_array)
assert isinstance(out_list, list)
assert out_list == [1, 2, 3, 4]
# And scalars
out_list = ensure_list(input_item=1)
assert isinstance(out_list, list)
assert out_list == [1]
```
#### Compare nested tuples
This method is designed to compliment numpy 'array_equal' method to provide a way of comparing two-dimensional (nested)
tuples. The method allows comparing Python tuple with multiple element datatypes and uneven sub-tuple topologies: the
functionality that is not present in the array_equal() method.
```
from ataraxis_base_utilities import compare_nested_tuples
# The method works for different sub-tuple shapes and element datatypes
tuple_1 = (1, 2, ("text", True))
tuple_2 = (1, 2, ("text", True))
assert compare_nested_tuples(x=tuple_1, y=tuple_2)
# The method takes element datatype into consideration when comparing tuples!
tuple_2 = (1, '2', ("text", True))
assert not compare_nested_tuples(x=tuple_1, y=tuple_2)
```
#### Chunk iterable
This method converts input iterables into chunks of the requested size. Primarily, this is helpful when load-balancing
data for parallel processing and similar operations.
```
import numpy as np
from ataraxis_base_utilities import chunk_iterable
# Note, while the method tries to produce equally sized chunks, the final chunk may contain fewer items if the input
# iterable is not evenly divisible by chunk size. The method returns a Generator that can be used to yield chunks:
x = [1, 2, 3, 4, 5, 6, 7]
chunk_generator = chunk_iterable(iterable=x, chunk_size=2)
expected_chunks = ((1, 2), (3, 4), (5, 6), (7,))
for num, chunk in enumerate(chunk_generator):
assert expected_chunks[num] == chunk
# The method works for both python iterables and one-dimensional numpy arrays. For numpy inputs, it returns numpy
# arrays as outputs:
numpy_x = np.array(x)
chunk_generator = chunk_iterable(iterable=numpy_x, chunk_size=3)
expected_chunks = (np.array([1, 2, 3]), np.array([4, 5, 6]), np.array([7]))
for num, chunk in enumerate(chunk_generator):
assert np.array_equal(expected_chunks[num], chunk)
```
#### Check condition
This method provides a generalized logic comparison interface that functions similar to using the logical operators,
such as '==' directly. The main purpose of this method is to provide an interface that behaves similarly regardless of
input. This is useful in cases such as verifying the output of a function that can return multiple different datatypes.
```
import numpy as np
from ataraxis_base_utilities import check_condition
# The method can be considered a wrapper around common logical operators used for value comparison:
assert check_condition(checked_value=3, condition_value=3, condition_operator='==')
assert check_condition(checked_value='One', condition_value='Two', condition_operator='!=')
# However, it abstracts away working with different types of inputs, such as numpy arrays:
output = check_condition(checked_value=np.array([1, 2, 3]), condition_value=1, condition_operator='==')
assert np.array_equal(output, np.array([True, False, False]))
# And python iterables:
output = check_condition(checked_value=[1, 1, 1], condition_value=1, condition_operator='==')
assert np.array_equal(output, [True, True, True])
```
#### Ensure directory exists
This method was originally defined as private method for the Console class, but it is now a public standalone method.
This method checks whether the directory portion of the input path exists and, if not, it creates the necessary
directory hierarchy. This is helpful when working with files, as files cannot be created if their root directory does
not exist.
```
import tempfile
from pathlib import Path
from ataraxis_base_utilities import ensure_directory_exists
# Precreates a temporary directory
with tempfile.TemporaryDirectory() as temp_dir:
# Defines a file-path that adds two subdirectories and defines a text file
file_path = Path(f"{temp_dir}/subfolder1/subfolder2/my_file.txt")
# Ensures that the first subfolder does not exist
assert not Path(f"{temp_dir}/subfolder1").exists()
# This ensures that the subdirectories exist
ensure_directory_exists(path=file_path)
# Ensures that both subfolders now exist
assert Path(f"{temp_dir}/subfolder1").exists()
assert Path(f"{temp_dir}/subfolder1/subfolder2").exists()
# The method does nothing if the directories already exist.
ensure_directory_exists(path=file_path)
# The method does not create files, it only created directories.
assert not file_path.exists()
```
___
## API Documentation
See the [API documentation](https://ataraxis-base-utilities-api-docs.netlify.app/) for the detailed description of the
methods and classes exposed by components of this library.
___
## Developers
This section provides installation, dependency, and build-system instructions for the developers that want to
modify the source code of this library. Additionally, it contains instructions for recreating the conda environments
that were used during development from the included .yml files.
### Installing the library
1. Download this repository to your local machine using your preferred method, such as git-cloning.
2. ```cd``` to the root directory of the project using your command line interface of choice.
3. Install development dependencies. You have multiple options of satisfying this requirement:
1. **_Preferred Method:_** Use conda or pip to install
[tox](https://tox.wiki/en/latest/user_guide.html) or use an environment that has it installed and
call ```tox -e import``` to automatically import the os-specific development environment included with the
source code in your local conda distribution. Alternatively, you can use ```tox -e create``` to create the
environment from scratch and automatically install the necessary dependencies using pyproject.toml file. See
[environments](#environments) section for other environment installation methods.
2. Run ```python -m pip install .'[dev]'``` command to install development dependencies and the library using
pip. On some systems, you may need to use a slightly modified version of this command:
```python -m pip install .[dev]```.
3. As long as you have an environment with [tox](https://tox.wiki/en/latest/user_guide.html) installed
and do not intend to run any code outside the predefined project automation pipelines, tox will automatically
install all required dependencies for each task.
**Note:** When using tox automation, having a local version of the library may interfere with tox tasks that attempt
to build the library using an isolated environment. While the problem is rare, our 'tox' pipelines automatically
install and uninstall the project from its' conda environment. This relies on a static tox configuration and will only
target the project-specific environment, so it is advised to always ```tox -e import``` or ```tox -e create``` the
project environment using 'tox' before running other tox commands.
### Additional Dependencies
In addition to installing the required python packages, separately install the following dependencies:
1. [Python](https://www.python.org/downloads/) distributions, one for each version that you intend to support.
Currently, this library supports version 3.10 and above. The easiest way to get tox to work as intended is to have
separate python distributions, but using [pyenv](https://github.com/pyenv/pyenv) is a good alternative too.
This is needed for the 'test' task to work as intended.
### Development Automation
This project comes with a fully configured set of automation pipelines implemented using
[tox](https://tox.wiki/en/latest/user_guide.html). Check [tox.ini file](tox.ini) for details about
available pipelines and their implementation. Alternatively, call ```tox list``` from the root directory of the project
to see the list of available tasks.
**Note!** All commits to this project have to successfully complete the ```tox``` task before being pushed to GitHub.
To minimize the runtime task for this task, use ```tox --parallel```.
For more information, you can also see the 'Usage' section of the
[ataraxis-automation project](https://github.com/Sun-Lab-NBB/ataraxis-automation) documentation.
### Environments
All environments used during development are exported as .yml files and as spec.txt files to the [envs](envs) folder.
The environment snapshots were taken on each of the three explicitly supported OS families: Windows 11, OSx (M1) 15.1
and Linux Ubuntu 24.04 LTS.
**Note!** Since the OSx environment was built for an M1 (Apple Silicon) platform, it may not work on Intel-based
Apple devices.
To install the development environment for your OS:
1. Download this repository to your local machine using your preferred method, such as git-cloning.
2. ```cd``` into the [envs](envs) folder.
3. Use one of the installation methods below:
1. **_Preferred Method_**: Install [tox](https://tox.wiki/en/latest/user_guide.html) or use another
environment with already installed tox and call ```tox -e import```.
2. **_Alternative Method_**: Run ```conda env create -f ENVNAME.yml``` or ```mamba env create -f ENVNAME.yml```.
Replace 'ENVNAME.yml' with the name of the environment you want to install (axbu_dev_osx for OSx,
axbu_dev_win for Windows, and axbu_dev_lin for Linux).
**Hint:** while only the platforms mentioned above were explicitly evaluated, this project is likely to work on any
common OS, but may require additional configurations steps.
Since the release of [ataraxis-automation](https://github.com/Sun-Lab-NBB/ataraxis-automation) version 2.0.0 you can
also create the development environment from scratch via pyproject.toml dependencies. To do this, use
```tox -e create``` from project root directory.
### Automation Troubleshooting
Many packages used in 'tox' automation pipelines (uv, mypy, ruff) and 'tox' itself are prone to various failures. In
most cases, this is related to their caching behavior. Despite a considerable effort to disable caching behavior known
to be problematic, in some cases it cannot or should not be eliminated. If you run into an unintelligible error with
any of the automation components, deleting the corresponding .cache (.tox, .ruff_cache, .mypy_cache, etc.) manually
or via a cli command is very likely to fix the issue.
___
## Versioning
We use [semantic versioning](https://semver.org/) for this project. For the versions available, see the
[tags on this repository](https://github.com/Sun-Lab-NBB/ataraxis-base-utilities/tags).
---
## Authors
- Ivan Kondratyev ([Inkaros](https://github.com/Inkaros))
___
## License
This project is licensed under the GPL3 License: see the [LICENSE](LICENSE) file for details.
___
## Acknowledgments
- All Sun Lab [members](https://neuroai.github.io/sunlab/people) for providing the inspiration and comments during the
development of this library.
- [loguru](https://github.com/Delgan/loguru) and [click](https://github.com/pallets/click/) projects for providing
all low-level functionality for the Console class.
- [numpy](https://github.com/numpy/numpy) project for providing low-level functionality for some of the
standalone methods.
- The creators of all other projects used in our development automation pipelines [see pyproject.toml](pyproject.toml).
---
Raw data
{
"_id": null,
"home_page": null,
"name": "ataraxis-base-utilities",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": "Ivan Kondratyev <ik278@cornell.edu>",
"keywords": "ataraxis, console, logging, utilities, utility-classes",
"author": null,
"author_email": "Ivan Kondratyev <ik278@cornell.edu>",
"download_url": "https://files.pythonhosted.org/packages/1e/7e/a2d3e8d00e526d1348fc393e6aab7fa332e4b9bf9707488bcf08de4dcf1a/ataraxis_base_utilities-3.0.1.tar.gz",
"platform": null,
"description": "# ataraxis-base-utilities\n\nPython library that provides a minimalistic set of shared utility functions used to support most other Sun Lab projects.\n\n\n\n[](https://github.com/astral-sh/uv)\n[](https://github.com/astral-sh/ruff)\n\n\n\n\n___\n\n## Detailed Description\n\nThis library is one of the two 'base' dependency libraries used by every other Sun Lab project (the other being \n[ataraxis-automation](https://github.com/Sun-Lab-NBB/ataraxis-automation)). It aggregates common utility functions \nthat are expected to be shared and reused by many other lab projects, such as message and error logging. This library is\ndesigned to avoid re-implementing the same set of utility features for every lab project. This is important, since most\nof our codebases employ a highly modular and decentralized design with many independent subprojects dynamically \nassembled into functional pipelines. Generally, any class or function copied with minor modifications into five \nor more Sun Lab projects is a good candidate for inclusion into this library.\n\nDespite a strong focus on supporting Sun Lab projects, this library can be used in non-lab projects with minor \nrefactoring. Specifically, anyone willing to reuse this library in their project may need to adjust the default values\nand configurations used throughout this library to match their specific needs. Otherwise, it should be readily \nintegrable with any other project due to its minimalistic design (both in terms of features and dependencies).\n___\n\n## Features\n\n- Supports Windows, Linux, and OSx.\n- Loguru-based Console class that provides message and logging functionality.\n- Frequently re-implemented utility method, such as a method that ensures the parent directory of a file path exists.\n- Pure-python API.\n- GPL 3 License.\n___\n\n## Table of Contents\n\n- [Dependencies](#dependencies)\n- [Installation](#installation)\n- [Usage](#usage)\n- [API Documentation](#api-documentation)\n- [Developers](#developers)\n- [Versioning](#versioning)\n- [Authors](#authors)\n- [License](#license)\n- [Acknowledgements](#Acknowledgments)\n___\n\n## Dependencies\n\nFor users, all library dependencies are installed automatically for all supported installation methods \n(see [Installation](#installation) section). For developers, see the [Developers](#developers) section for \ninformation on installing additional development dependencies.\n___\n\n## Installation\n\n### Source\n\n1. Download this repository to your local machine using your preferred method, such as git-cloning. Optionally, use one\n of the stable releases that include precompiled binary wheels in addition to source code.\n2. ```cd``` to the root directory of the project using your command line interface of choice.\n3. Run ```python -m pip install .``` to install the project. Alternatively, if using a distribution with precompiled\n binaries, use ```python -m pip install WHEEL_PATH```, replacing 'WHEEL_PATH' with the path to the wheel file.\n\n### PIP\n\nUse the following command to install the library using PIP: ```pip install ataraxis-base-utilities```\n___\n\n## Usage\nThis section is broken into subsections for each exposed utility class or module. For each, it progresses from a \nminimalistic example and / or 'quickstart' to detailed notes on nuanced class functionality \n(if the class has such functionality).\n\n### Console\nThe Console class provides message and error display (via terminal) and logging (to files) functionality. Primarily, \nthis is realized through the [loguru](https://github.com/Delgan/loguru) backend. It is highly advised to check loguru \ndocumentation to understand how Console functions under-the-hood, although this is not strictly required. As a secondary\nbackend, the class uses [click](https://click.palletsprojects.com/en/8.1.x/), so it may be beneficial to review its \ndocumentation if loguru backend is not appropriate for your specific use case.\n\n#### Quickstart\nMost class functionality revolves around 2 methods: ```echo()``` and ```error()```. To make adoption as frictionless\nas possible, we offer a preconfigured class instance exposed through 'console' class variable that can be used 'as-is'\nand shared between multiple modules:\n```\nfrom ataraxis_base_utilities import console\n\n# The class is disabled by default, so it needs to be enabled to see method outputs. You do not need to have it enabled\n# to add error() or echo() calls to your code though.\nconsole.enable()\n\n# Use this instead of print()!\nconsole.echo(\"This is essentially a better 'print'.\")\n\n# Use this instead of 'raise Exception'!\nconsole.error(\"This is essentially a better 'raise'.\")\n```\n\n#### Echo\nConsole.echo() method can be thought of as a better print() with some additional functionality. For example, you can\nprovide the desired message 'level' to finely control how it will be processed:\n```\nfrom ataraxis_base_utilities import console, LogLevel\nconsole.enable()\n\n# By default, console is configured to NOT print debug messages. You will not see anything after this call\nconsole.echo(message='Debug', level=LogLevel.DEBUG)\n\n# But you will see this information message\nconsole.echo(message='Info', level=LogLevel.INFO)\n\n# Or this error message\nconsole.echo(message='Error', level=LogLevel.ERROR)\n\n# Disabled console will not print any messages at all.\nconsole.disable()\nstatus = console.echo(message='Info', level=LogLevel.INFO)\n\n# To help you track if console is not printing due to being disabled, it returns 'False' when you call echo() while the\n# class is disabled.\nassert status is False\n\n# However, if lack of printing is due to how console is configured and not it being disabled, the status will be set to\n# 'True'.\nconsole.enable()\nstatus = console.echo(message='Debug', level=LogLevel.DEBUG)\nassert status\n```\n\n#### Error\nConsole.error() method can be thought of as a more nuanced 'raise Exception' directive. Most of the additional \nfunctionality of this method comes from Console class configuration, and in its most basic form, this is just a\nwrapper around 'raise':\n```\nfrom ataraxis_base_utilities import console\nconsole.enable()\n\n# By default, console uses 'default callback' to abort the active runtime after raising an error. Since this will\n# interrupt this example, this needs to be disabled. See 'error runtime control' section for more details.\nconsole.set_callback(None)\n\n# You can specify the exception to be raised by providing it as an 'error' argument. By default, this argument is\n# set to RuntimeError.\nconsole.error(message=\"TypeError\", error=TypeError)\n\n\n# This works for custom exceptions as well!\nclass CustomError(Exception):\n pass\n\n\nconsole.error(message=\"CustomError\", error=CustomError)\n\n\n# When console is disabled, error() behaves identically to 'raise' directive. This way, your errors will always be\n# raised, regardless of whether console is enabled or not.\nconsole.disable()\nconsole.error(message=\"ValueError\", error=ValueError)\n```\n\n#### Format Message\nAll console methods format input messages to fit the default width-limit of 120 characters. This was chosen as it is \nboth likely to fit into any modern terminal and gives us a little more space than the default legacy '80' limit used by\nmany projects. The formatting takes into consideration that 'loguru' backend adds some ID information to the beginning \nof each method, so the text should look good regardless of the backend used. In the case that you want to use console\nas a formatter, rather than a message processor, you can use Console.format_message() method:\n```\nfrom ataraxis_base_utilities import console\n\n# Let's use this test message\nmessage = (\n \"This is a very long message that exceeds our default limit of 120 characters. As such, it needs to be wrapped to \"\n \"appear correctly when printed to terminal (or saved to a log file).\"\n)\n\n# This shows how the message looks without formatting\nprint(message)\n\n# This formats the message according to our standards. Note how this works regardless of whether console is enabled or \n# not!\nformatted_message = console.format_message(message)\n\n# See how it compares to the original message!\nprint(formatted_message)\n```\n\n#### Configuring console: enable / disable\nBy default, console starts 'disabled.' You can enable or disable it at any time! When using console to add functionality\nto libraries, do not enable() the console. This way, you both add console functionality to your library and allow the \nend-user to decide how much output they want to see and in what format.\n```\nfrom ataraxis_base_utilities import console, LogLevel\n\n# Most basically, the console can be enabled() or disabled() any time using the appropriate methods:\nconsole.enable()\nconsole.disable()\n\n# To check the current console status, you can use the getter method:\nassert not console.is_enabled\n```\n\n#### Configuring console: output control\nBy default, console is configured to print information and error messages to the terminal. However, you can \nflexibly set what kind of messages it processes and where they go. To do so, you can use the extensive set of setter and\ngetter methods.\n```\nfrom ataraxis_base_utilities import console, LogLevel\nconsole.enable()\n\n# Consider debug message printing, which is disabled by default:\nconsole.echo('Debug', level=LogLevel.DEBUG)\n\n# If we enable debug printing, the message will show up in terminal as expected:\nconsole.set_debug_terminal(True)\nconsole.echo('Debug', level=LogLevel.DEBUG)\n\n# To verify if a particular output format for a message type is enabled, you can use the getter method:\nassert console.debug_terminal\nassert not console.error_file\n\n# The class allows you to flexibly configure terminal-printing and file-logging for Debug-, Info to Warning and Error+\n# messages. The default 'console' configuration can be obtained by using the following setter methods and arguments:\nconsole.set_debug_terminal(False)\nconsole.set_debug_file(False)\nconsole.set_message_terminal(True)\nconsole.set_message_file(False)\nconsole.set_error_terminal(True)\nconsole.set_error_file(False)\n\n# Note, 'getter' properties are named identical to setter methods, minus the 'set_' part:\nassert not console.debug_terminal\nassert not console.debug_file\nassert console.message_terminal\nassert not console.message_file\nassert console.error_terminal\nassert not console.error_file\n```\n\n#### Configuring console: log paths\nFor a message to be written to a log file, it is not enough to just 'enable' that output type. Additionally, you need \nto provide console with a path to the log file to write to and, if it does not exist, create. This is done through a \nseparate set of setter and getter methods:\n```\nfrom ataraxis_base_utilities import console, LogExtensions\nfrom pathlib import Path\n\n# By default, the console is not provided with a path to the message log file and does not support writing messages to\n# log file.\nassert console.message_log_path is None\n\n# You can provide it with a custom log file to enable logging functionality:\nexample_path = f\"example{LogExtensions.LOG}\"\nconsole.set_message_log_path(Path(example_path))\nassert console.message_log_path == Path(example_path)\n\n# Note that the class supports only a set of file-extensions. For your convenience, they are available from\n# LogExtensions class:\nlog_file = Path(f\"example{LogExtensions.LOG}\")\ntext_file = Path(f\"example{LogExtensions.TXT}\")\njson_file = Path(f\"example{LogExtensions.JSON}\")\n\n# As with other class configuration attributes, you can flexibly configure log files for each of the supported message\n# groups:\nconsole.set_message_log_path(log_file)\nconsole.set_debug_log_path(text_file)\nconsole.set_error_log_path(json_file)\n\n# You can retrieve the used log file path at any time using an appropriate getter property:\nlog_file = console.message_log_path\ntext_file = console.debug_log_path\njson_file = console.error_log_path\n```\n\n#### Configuring console: error runtime control\nConsole.error() significantly expands your ability to control how errors are handled. Specifically, its behavior can \nrange from generating default Python tracebacks to redirecting errors to log files to executing custom error callback\nfunctions. Note, most of this functionality is only supported by our default 'loguru' backend.\n```\nfrom ataraxis_base_utilities import console, default_callback\nconsole.enable()\n\n# By default, the console is configured to call sys.exit() as a callback to prevent providing two error traces: one from\n# loguru and the other from Python. To prevent this behavior, set console callback to None:\nconsole.set_callback(None)\n\n# This prints the error to terminal, but does not abort runtime.\ntry:\n console.error(\"Test error\", RuntimeError)\nexcept RuntimeError:\n print(\"You will not see this.\")\n\n# By default, console will not re-raise the logged error as a Python error.\nassert not console.reraise\n\n# However, if your use case needs this functionality, you can always enable it:\nconsole.set_reraise(True)\n\ntry:\n console.error(\"Test error\", ValueError)\nexcept ValueError:\n print(\"The error was re-raised as expected.\")\n\n\n# WARNING! Callbacks, when provided, are executed before re-raising the error. If callback calls runtime-breaking\n# functions, such as sys.exit(), it will interfere with error re-raising.\ndef benign_callback():\n print('I do not cause a runtime error.')\n\n\nconsole.set_callback(benign_callback)\ntry:\n console.error(\"Test error\", TypeError)\nexcept TypeError:\n print(\"Benign callback did not interfere with raising the error.\")\n\n# Default callback will, however, clash with 'reraise' functionality:\nconsole.set_callback(default_callback)\ntry:\n # This will abort the runtime through 'default_callback' calling sys.exit().\n console.error(\"Test error\", KeyError)\nexcept KeyError:\n print(\"This will not be displayed.\")\n```\n\n#### Custom Console instances:\nWhile this class is designed ot be used through the 'console' variable, you can also instantiate and use a custom \nConsole class instance. Unlike 'console' variable, this class will not be shared across all modules and libraries, \npotentially allowing to isolate its configuration from the rest of your project. Note, since 'LOGURU' backend uses the \nshared 'logger,' instantiating a new CConsole class does not automatically guarantee isolation!\n```\nfrom ataraxis_base_utilities import Console, LogBackends, LogExtensions\n\n# The most important advantage of using the custom console is the ability to specify the backend other than the default\n# 'LOGURU' backend. # All supported backends are available through the LogBackends enumeration.\nclick_console = Console(logger_backend=LogBackends.CLICK)\n\n# Additionally, you can customize the formatting applied to messages:\nformat_console = Console(line_width=200, break_long_words=True, break_on_hyphens=True, use_color=False)\n\n# Finally, you can make console safer by overriding the 'auto_handles' attribute to prevent 'LOGURU' consoles from \n# automatically editing the shared 'logger' instance handles. To learn more about handles, see 'add_handles()' section.\nloguru_console = Console(logger_backend=LogBackends.LOGURU, auto_handles=False)\n\n\n# All attributes discussed in previous sections can be set by initialization arguments to the Console class:\ndef custom_callback():\n \"\"\"Custom callback function\"\"\"\n pass\n\n\ndebug_log_path = f\"debug{LogExtensions.LOG}\"\n\nexample_console = Console(\n logger_backend=LogBackends.LOGURU,\n debug_log_path=debug_log_path,\n message_log_path=None,\n error_log_path=None,\n line_width=120,\n error_callback=custom_callback,\n auto_handles=True,\n break_long_words=True,\n break_on_hyphens=True,\n use_color=False,\n debug_terminal=True,\n debug_file=True,\n message_terminal=False,\n message_file=True,\n error_terminal=False,\n error_file=True,\n reraise_errors=True\n )\n```\n\n#### Loguru Console: add_handles()\nThis section only applies to Console using 'loguru' backend, which includes the default 'console' variable. Loguru \nrelies on its 'logger' variable to be provided with handles that determine how to process messages. Similarly, Console\ncomes with add_handles() method that can be called to replace active handles with console-specific handles. Note, since\n'logger' is shared across all libraries and modules, editing handles can interfere with any other class that uses \nlogger. Default console is written with the assumption that nothing else uses logger and, by default, removes all active\nhandles before adding its custom handles before adding its custom handles. Not only this, but it also calls \nadd_handles() automatically when initialized or when any of its attributes are edited.\n```\nfrom ataraxis_base_utilities import Console, LogBackends, LogExtensions\n\n# By default, uses loguru backend\nconsole = Console(auto_handles=False)\nconsole.enable()\n\n# Consoles that are not initialized with auto_handles=True require manually calling add_handles() method before calling\n# echo() or error() methods.\nconsole.add_handles(remove_existing_handles=False) # This call will NOT remove default handles\n\n# This should produce two messages: one using the default 'console' variable handle that replaced 'logger' handle and\n# another using the custom handle we added with add_handles() call.\nconsole.echo(\"Hello, World!\")\n\n# To reset all handles, we cna use the default add_handles() argument:\nconsole.add_handles()\nconsole.echo(\"Now there is only one\")\n\n# Another important feature only available through 'add_handles' is the ability to 'enqueue' messages. This helps with\n# using console from multiple processes by passing all messages through a shared processing queue.\nconsole.add_handles(enqueue=True)\nconsole.echo(\"The API remains the same though!\")\n```\n\n#### Additional notes on usage:\nGenerally, Console class is designed to be used across many libraries that may also be dependent on each other. \nTherefore, it should be used similar to how it is advised to use Loguru for logging: when using Console in a library, \ndo not call add_handles() or enable() methods. The only exception to this rule is when running in interactive mode \n(cli, benchmark, script) that is known to be the highest hierarchy (nothing else imports your code, it imports \neverything else).\n\nTo facilitate correct usage, the library exposes 'console' variable preconfigured to use Loguru backend and is \nnot enabled by default. You can use this variable to add Console-backed printing and logging functionality to your \nlibrary. Whenever your library is imported, the end-user can then enable() and add_handles() using the same 'console'\nvariable, which will automatically work for all console-based statements across all libraries. This way, the exact \nconfiguration is left up to end-user, but your code will still raise errors and can be debugged using custom \nlogging configurations.\n\n### Standalone Methods\nThe standalone methods are a broad collection of utility functions that either abstract away the boilerplate code for \ncommon data manipulations or provide novel functionality not commonly available through popular Python libraries used \nby our projects. Generally, these methods are straightforward to use and do not require detailed explanation:\n\n#### Ensure list\n\nAs the name implies, this method ensures that the input is a Python list. If the input is not a Python list, the method\nconverts it into a list. If conversion fails, the method raises a ValueError.\n\n```\nimport numpy as np\nfrom ataraxis_base_utilities import ensure_list\n\n# Ensures and, if necessary, converts inputs to the Python list type:\nout_list = ensure_list(input_item=(1, 2, 3, 4))\nassert isinstance(out_list, list)\nassert out_list == [1, 2, 3, 4]\n\n# It works for a wide range of inputs numpy arrays...\nnumpy_array = np.array([1, 2, 3, 4])\nout_list = ensure_list(input_item=numpy_array)\nassert isinstance(out_list, list)\nassert out_list == [1, 2, 3, 4]\n\n# And scalars\nout_list = ensure_list(input_item=1)\nassert isinstance(out_list, list)\nassert out_list == [1]\n```\n\n#### Compare nested tuples\nThis method is designed to compliment numpy 'array_equal' method to provide a way of comparing two-dimensional (nested)\ntuples. The method allows comparing Python tuple with multiple element datatypes and uneven sub-tuple topologies: the \nfunctionality that is not present in the array_equal() method.\n\n```\nfrom ataraxis_base_utilities import compare_nested_tuples\n\n# The method works for different sub-tuple shapes and element datatypes\ntuple_1 = (1, 2, (\"text\", True))\ntuple_2 = (1, 2, (\"text\", True))\nassert compare_nested_tuples(x=tuple_1, y=tuple_2)\n\n# The method takes element datatype into consideration when comparing tuples!\ntuple_2 = (1, '2', (\"text\", True))\nassert not compare_nested_tuples(x=tuple_1, y=tuple_2)\n```\n\n#### Chunk iterable\nThis method converts input iterables into chunks of the requested size. Primarily, this is helpful when load-balancing \ndata for parallel processing and similar operations.\n```\n\nimport numpy as np\nfrom ataraxis_base_utilities import chunk_iterable\n\n# Note, while the method tries to produce equally sized chunks, the final chunk may contain fewer items if the input\n# iterable is not evenly divisible by chunk size. The method returns a Generator that can be used to yield chunks:\nx = [1, 2, 3, 4, 5, 6, 7]\nchunk_generator = chunk_iterable(iterable=x, chunk_size=2)\n\nexpected_chunks = ((1, 2), (3, 4), (5, 6), (7,))\nfor num, chunk in enumerate(chunk_generator):\n assert expected_chunks[num] == chunk\n\n# The method works for both python iterables and one-dimensional numpy arrays. For numpy inputs, it returns numpy\n# arrays as outputs:\nnumpy_x = np.array(x)\nchunk_generator = chunk_iterable(iterable=numpy_x, chunk_size=3)\n\nexpected_chunks = (np.array([1, 2, 3]), np.array([4, 5, 6]), np.array([7]))\nfor num, chunk in enumerate(chunk_generator):\n assert np.array_equal(expected_chunks[num], chunk)\n```\n\n#### Check condition\nThis method provides a generalized logic comparison interface that functions similar to using the logical operators, \nsuch as '==' directly. The main purpose of this method is to provide an interface that behaves similarly regardless of \ninput. This is useful in cases such as verifying the output of a function that can return multiple different datatypes.\n\n```\nimport numpy as np\nfrom ataraxis_base_utilities import check_condition\n\n# The method can be considered a wrapper around common logical operators used for value comparison:\nassert check_condition(checked_value=3, condition_value=3, condition_operator='==')\nassert check_condition(checked_value='One', condition_value='Two', condition_operator='!=')\n\n# However, it abstracts away working with different types of inputs, such as numpy arrays:\noutput = check_condition(checked_value=np.array([1, 2, 3]), condition_value=1, condition_operator='==')\nassert np.array_equal(output, np.array([True, False, False]))\n\n# And python iterables:\noutput = check_condition(checked_value=[1, 1, 1], condition_value=1, condition_operator='==')\nassert np.array_equal(output, [True, True, True])\n```\n\n#### Ensure directory exists\nThis method was originally defined as private method for the Console class, but it is now a public standalone method. \nThis method checks whether the directory portion of the input path exists and, if not, it creates the necessary \ndirectory hierarchy. This is helpful when working with files, as files cannot be created if their root directory does\nnot exist.\n```\nimport tempfile\nfrom pathlib import Path\nfrom ataraxis_base_utilities import ensure_directory_exists\n\n# Precreates a temporary directory\nwith tempfile.TemporaryDirectory() as temp_dir:\n\n # Defines a file-path that adds two subdirectories and defines a text file\n file_path = Path(f\"{temp_dir}/subfolder1/subfolder2/my_file.txt\")\n\n # Ensures that the first subfolder does not exist\n assert not Path(f\"{temp_dir}/subfolder1\").exists()\n\n # This ensures that the subdirectories exist\n ensure_directory_exists(path=file_path)\n\n # Ensures that both subfolders now exist\n assert Path(f\"{temp_dir}/subfolder1\").exists()\n assert Path(f\"{temp_dir}/subfolder1/subfolder2\").exists()\n\n # The method does nothing if the directories already exist.\n ensure_directory_exists(path=file_path)\n\n # The method does not create files, it only created directories.\n assert not file_path.exists()\n```\n___\n\n## API Documentation\n\nSee the [API documentation](https://ataraxis-base-utilities-api-docs.netlify.app/) for the detailed description of the \nmethods and classes exposed by components of this library.\n___\n\n## Developers\n\nThis section provides installation, dependency, and build-system instructions for the developers that want to\nmodify the source code of this library. Additionally, it contains instructions for recreating the conda environments\nthat were used during development from the included .yml files.\n\n### Installing the library\n\n1. Download this repository to your local machine using your preferred method, such as git-cloning.\n2. ```cd``` to the root directory of the project using your command line interface of choice.\n3. Install development dependencies. You have multiple options of satisfying this requirement:\n 1. **_Preferred Method:_** Use conda or pip to install\n [tox](https://tox.wiki/en/latest/user_guide.html) or use an environment that has it installed and\n call ```tox -e import``` to automatically import the os-specific development environment included with the\n source code in your local conda distribution. Alternatively, you can use ```tox -e create``` to create the \n environment from scratch and automatically install the necessary dependencies using pyproject.toml file. See \n [environments](#environments) section for other environment installation methods.\n 2. Run ```python -m pip install .'[dev]'``` command to install development dependencies and the library using \n pip. On some systems, you may need to use a slightly modified version of this command: \n ```python -m pip install .[dev]```.\n 3. As long as you have an environment with [tox](https://tox.wiki/en/latest/user_guide.html) installed\n and do not intend to run any code outside the predefined project automation pipelines, tox will automatically\n install all required dependencies for each task.\n\n**Note:** When using tox automation, having a local version of the library may interfere with tox tasks that attempt\nto build the library using an isolated environment. While the problem is rare, our 'tox' pipelines automatically \ninstall and uninstall the project from its' conda environment. This relies on a static tox configuration and will only \ntarget the project-specific environment, so it is advised to always ```tox -e import``` or ```tox -e create``` the \nproject environment using 'tox' before running other tox commands.\n\n### Additional Dependencies\n\nIn addition to installing the required python packages, separately install the following dependencies:\n\n1. [Python](https://www.python.org/downloads/) distributions, one for each version that you intend to support. \n Currently, this library supports version 3.10 and above. The easiest way to get tox to work as intended is to have \n separate python distributions, but using [pyenv](https://github.com/pyenv/pyenv) is a good alternative too. \n This is needed for the 'test' task to work as intended.\n\n### Development Automation\n\nThis project comes with a fully configured set of automation pipelines implemented using \n[tox](https://tox.wiki/en/latest/user_guide.html). Check [tox.ini file](tox.ini) for details about \navailable pipelines and their implementation. Alternatively, call ```tox list``` from the root directory of the project\nto see the list of available tasks.\n\n**Note!** All commits to this project have to successfully complete the ```tox``` task before being pushed to GitHub. \nTo minimize the runtime task for this task, use ```tox --parallel```.\n\nFor more information, you can also see the 'Usage' section of the \n[ataraxis-automation project](https://github.com/Sun-Lab-NBB/ataraxis-automation) documentation.\n\n### Environments\n\nAll environments used during development are exported as .yml files and as spec.txt files to the [envs](envs) folder.\nThe environment snapshots were taken on each of the three explicitly supported OS families: Windows 11, OSx (M1) 15.1\nand Linux Ubuntu 24.04 LTS.\n\n**Note!** Since the OSx environment was built for an M1 (Apple Silicon) platform, it may not work on Intel-based \nApple devices.\n\nTo install the development environment for your OS:\n\n1. Download this repository to your local machine using your preferred method, such as git-cloning.\n2. ```cd``` into the [envs](envs) folder.\n3. Use one of the installation methods below:\n 1. **_Preferred Method_**: Install [tox](https://tox.wiki/en/latest/user_guide.html) or use another\n environment with already installed tox and call ```tox -e import```.\n 2. **_Alternative Method_**: Run ```conda env create -f ENVNAME.yml``` or ```mamba env create -f ENVNAME.yml```. \n Replace 'ENVNAME.yml' with the name of the environment you want to install (axbu_dev_osx for OSx, \n axbu_dev_win for Windows, and axbu_dev_lin for Linux).\n\n**Hint:** while only the platforms mentioned above were explicitly evaluated, this project is likely to work on any \ncommon OS, but may require additional configurations steps.\n\nSince the release of [ataraxis-automation](https://github.com/Sun-Lab-NBB/ataraxis-automation) version 2.0.0 you can \nalso create the development environment from scratch via pyproject.toml dependencies. To do this, use \n```tox -e create``` from project root directory.\n\n### Automation Troubleshooting\n\nMany packages used in 'tox' automation pipelines (uv, mypy, ruff) and 'tox' itself are prone to various failures. In \nmost cases, this is related to their caching behavior. Despite a considerable effort to disable caching behavior known \nto be problematic, in some cases it cannot or should not be eliminated. If you run into an unintelligible error with \nany of the automation components, deleting the corresponding .cache (.tox, .ruff_cache, .mypy_cache, etc.) manually \nor via a cli command is very likely to fix the issue.\n___\n\n## Versioning\n\nWe use [semantic versioning](https://semver.org/) for this project. For the versions available, see the \n[tags on this repository](https://github.com/Sun-Lab-NBB/ataraxis-base-utilities/tags).\n\n---\n\n## Authors\n\n- Ivan Kondratyev ([Inkaros](https://github.com/Inkaros))\n___\n\n## License\n\nThis project is licensed under the GPL3 License: see the [LICENSE](LICENSE) file for details.\n___\n\n## Acknowledgments\n\n- All Sun Lab [members](https://neuroai.github.io/sunlab/people) for providing the inspiration and comments during the\n development of this library.\n- [loguru](https://github.com/Delgan/loguru) and [click](https://github.com/pallets/click/) projects for providing\n all low-level functionality for the Console class.\n- [numpy](https://github.com/numpy/numpy) project for providing low-level functionality for some of the \n standalone methods.\n- The creators of all other projects used in our development automation pipelines [see pyproject.toml](pyproject.toml).\n\n---\n",
"bugtrack_url": null,
"license": "GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The GNU General Public License is a free, copyleft license for software and other kinds of works. The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others. For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it. For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions. Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users. Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free. The precise terms and conditions for copying, distribution and modification follow. TERMS AND CONDITIONS 0. Definitions. \"This License\" refers to version 3 of the GNU General Public License. \"Copyright\" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. \"The Program\" refers to any copyrightable work licensed under this License. Each licensee is addressed as \"you\". \"Licensees\" and \"recipients\" may be individuals or organizations. To \"modify\" a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a \"modified version\" of the earlier work or a work \"based on\" the earlier work. A \"covered work\" means either the unmodified Program or a work based on the Program. To \"propagate\" a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. To \"convey\" a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. An interactive user interface displays \"Appropriate Legal Notices\" to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. 1. Source Code. The \"source code\" for a work means the preferred form of the work for making modifications to it. \"Object code\" means any non-source form of a work. A \"Standard Interface\" means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. The \"System Libraries\" of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A \"Major Component\", in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. The \"Corresponding Source\" for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work. The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. The Corresponding Source for a work in source code form is that same work. 2. Basic Permissions. All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. 3. Protecting Users' Legal Rights From Anti-Circumvention Law. No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures. 4. Conveying Verbatim Copies. You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. 5. Conveying Modified Source Versions. You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: a) The work must carry prominent notices stating that you modified it, and giving a relevant date. b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to \"keep intact all notices\". c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so. A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an \"aggregate\" if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. 6. Conveying Non-Source Forms. You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge. c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements. e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. A \"User Product\" is either (1) a \"consumer product\", which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, \"normally used\" refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. \"Installation Information\" for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying. 7. Additional Terms. \"Additional permissions\" are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or d) Limiting the use for publicity purposes of names of licensors or authors of the material; or e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors. All other non-permissive additional terms are considered \"further restrictions\" within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way. 8. Termination. You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10. 9. Acceptance Not Required for Having Copies. You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so. 10. Automatic Licensing of Downstream Recipients. Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. An \"entity transaction\" is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it. 11. Patents. A \"contributor\" is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's \"contributor version\". A contributor's \"essential patent claims\" are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, \"control\" includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. In the following three paragraphs, a \"patent license\" is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To \"grant\" such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. \"Knowingly relying\" means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. A patent license is \"discriminatory\" if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. 12. No Surrender of Others' Freedom. If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. 13. Use with the GNU Affero General Public License. Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such. 14. Revised Versions of this License. The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License \"or any later version\" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation. If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program. Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version. 15. Disclaimer of Warranty. THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM \"AS IS\" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 16. Limitation of Liability. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 17. Interpretation of Sections 15 and 16. If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the \"copyright\" line and a pointer to where the full notice is found. <one line to give the program's name and a brief idea of what it does.> Copyright (C) <year> <name of author> This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see <https://www.gnu.org/licenses/>. Also add information on how to contact you by electronic and paper mail. If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode: <program> Copyright (C) <year> <name of author> This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an \"about box\". You should also get your employer (if you work as a programmer) or school, if any, to sign a \"copyright disclaimer\" for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see <https://www.gnu.org/licenses/>. The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read <https://www.gnu.org/licenses/why-not-lgpl.html>.",
"summary": "Provides a minimalistic set of shared utility functions used to support most other Sun Lab projects.",
"version": "3.0.1",
"project_urls": {
"Documentation": "https://ataraxis-base-utilities-api-docs.netlify.app/",
"Homepage": "https://github.com/Sun-Lab-NBB/ataraxis-base-utilities"
},
"split_keywords": [
"ataraxis",
" console",
" logging",
" utilities",
" utility-classes"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6b066926fdbc5671afee72a84e2774e46412bb91ca2d998ca46b5eb5801f6857",
"md5": "ee21a5696c83001d34078695ec15bce9",
"sha256": "57c461f683b07a11550a25c02b38f3e9ed320585c711c2a14a7a9d723475e887"
},
"downloads": -1,
"filename": "ataraxis_base_utilities-3.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ee21a5696c83001d34078695ec15bce9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 65061,
"upload_time": "2024-11-24T18:36:58",
"upload_time_iso_8601": "2024-11-24T18:36:58.807239Z",
"url": "https://files.pythonhosted.org/packages/6b/06/6926fdbc5671afee72a84e2774e46412bb91ca2d998ca46b5eb5801f6857/ataraxis_base_utilities-3.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1e7ea2d3e8d00e526d1348fc393e6aab7fa332e4b9bf9707488bcf08de4dcf1a",
"md5": "26ab06fb4d42e411ff969fc04093bc36",
"sha256": "951221100b991691433e948e546e7d2c16f4c8e8877d5144e5fb1ff9c6992013"
},
"downloads": -1,
"filename": "ataraxis_base_utilities-3.0.1.tar.gz",
"has_sig": false,
"md5_digest": "26ab06fb4d42e411ff969fc04093bc36",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 94086,
"upload_time": "2024-11-24T18:37:03",
"upload_time_iso_8601": "2024-11-24T18:37:03.404649Z",
"url": "https://files.pythonhosted.org/packages/1e/7e/a2d3e8d00e526d1348fc393e6aab7fa332e4b9bf9707488bcf08de4dcf1a/ataraxis_base_utilities-3.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-24 18:37:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Sun-Lab-NBB",
"github_project": "ataraxis-base-utilities",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"tox": true,
"lcname": "ataraxis-base-utilities"
}
