pax_global_header00006660000000000000000000000064147355033550014524gustar00rootroot0000000000000052 comment=4578257320421a43e306299ff35e1cb598359dbd gio-pyio-0.0.6/000077500000000000000000000000001473550335500132635ustar00rootroot00000000000000gio-pyio-0.0.6/.github/000077500000000000000000000000001473550335500146235ustar00rootroot00000000000000gio-pyio-0.0.6/.github/workflows/000077500000000000000000000000001473550335500166605ustar00rootroot00000000000000gio-pyio-0.0.6/.github/workflows/python-package.yml000066400000000000000000000031051473550335500223140ustar00rootroot00000000000000# This workflow will install Python dependencies, run tests and lint with a variety of Python versions # For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python name: Python package on: push: branches: [ "main" ] pull_request: branches: [ "main" ] jobs: build: runs-on: ubuntu-latest strategy: fail-fast: false matrix: python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"] steps: - uses: actions/checkout@v4 - name: Set up Python ${{ matrix.python-version }} uses: actions/setup-python@v3 with: python-version: ${{ matrix.python-version }} - name: Install dependencies run: | sudo apt-get install -y \ gir1.2-glib-2.0 \ libffi-dev \ libgirepository1.0-dev \ libglib2.0-dev python -m pip install --upgrade pip python -m pip install flake8 pytest twine build if [ -f requirements.txt ]; then pip install -r requirements.txt; fi - name: Lint with flake8 run: | # stop the build if there are Python syntax errors or undefined names flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics - name: Build run: | python -m build python -m pip install -e . twine check dist/* - name: Test with pytest run: | pytest gio-pyio-0.0.6/.github/workflows/python-publish.yml000066400000000000000000000032751473550335500223770ustar00rootroot00000000000000# This workflow uses actions that are not certified by GitHub. # They are provided by a third-party and are governed by # separate terms of service, privacy policy, and support # documentation. # GitHub recommends pinning actions to a commit SHA. # To get a newer version, you will need to update the SHA. # You can also reference a tag or branch, but the action may change without warning. name: Upload Python Package on: release: types: [published] permissions: contents: read jobs: release-build: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - uses: actions/setup-python@v5 with: python-version: "3.x" - name: Build release distributions run: | # NOTE: put your own distribution build steps here. python -m pip install build python -m build - name: Upload distributions uses: actions/upload-artifact@v4 with: name: release-dists path: dist/ pypi-publish: runs-on: ubuntu-latest needs: - release-build permissions: # IMPORTANT: this permission is mandatory for trusted publishing id-token: write # Dedicated environments with protections for publishing are strongly recommended. environment: name: pypi # OPTIONAL: uncomment and update to include your PyPI project URL in the deployment status: # url: https://pypi.org/p/YOURPROJECT steps: - name: Retrieve release distributions uses: actions/download-artifact@v4 with: name: release-dists path: dist/ - name: Publish release distributions to PyPI uses: pypa/gh-action-pypi-publish@release/v1 gio-pyio-0.0.6/.gitignore000066400000000000000000000061031473550335500152530ustar00rootroot00000000000000# Byte-compiled / optimized / DLL files __pycache__/ *.py[cod] *$py.class # C extensions *.so # Distribution / packaging .Python build/ develop-eggs/ dist/ downloads/ eggs/ .eggs/ lib/ lib64/ parts/ sdist/ var/ wheels/ share/python-wheels/ *.egg-info/ .installed.cfg *.egg MANIFEST # PyInstaller # Usually these files are written by a python script from a template # before PyInstaller builds the exe, so as to inject date/other infos into it. *.manifest *.spec # Installer logs pip-log.txt pip-delete-this-directory.txt # Unit test / coverage reports htmlcov/ .tox/ .nox/ .coverage .coverage.* .cache nosetests.xml coverage.xml *.cover *.py,cover .hypothesis/ .pytest_cache/ cover/ # Translations *.mo *.pot # Django stuff: *.log local_settings.py db.sqlite3 db.sqlite3-journal # Flask stuff: instance/ .webassets-cache # Scrapy stuff: .scrapy # Sphinx documentation docs/_build/ # PyBuilder .pybuilder/ target/ # Jupyter Notebook .ipynb_checkpoints # IPython profile_default/ ipython_config.py # pyenv # For a library or package, you might want to ignore these files since the code is # intended to run in multiple environments; otherwise, check them in: # .python-version # pipenv # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. # However, in case of collaboration, if having platform-specific dependencies or dependencies # having no cross-platform support, pipenv may install dependencies that don't work, or not # install all needed dependencies. #Pipfile.lock # poetry # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. # This is especially recommended for binary packages to ensure reproducibility, and is more # commonly ignored for libraries. # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control #poetry.lock # pdm # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. #pdm.lock # pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it # in version control. # https://pdm.fming.dev/latest/usage/project/#working-with-version-control .pdm.toml .pdm-python .pdm-build/ # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm __pypackages__/ # Celery stuff celerybeat-schedule celerybeat.pid # SageMath parsed files *.sage.py # Environments .env .venv env/ venv/ ENV/ env.bak/ venv.bak/ # Spyder project settings .spyderproject .spyproject # Rope project settings .ropeproject # mkdocs documentation /site # mypy .mypy_cache/ .dmypy.json dmypy.json # Pyre type checker .pyre/ # pytype static type analyzer .pytype/ # Cython debug symbols cython_debug/ # PyCharm # JetBrains specific template is maintained in a separate JetBrains.gitignore that can # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore # and can be added to the global gitignore or merged into this file. For a more nuclear # option (not recommended) you can uncomment the following to ignore the entire idea folder. #.idea/ gio-pyio-0.0.6/.readthedocs.yaml000066400000000000000000000004141473550335500165110ustar00rootroot00000000000000version: 2 build: os: ubuntu-22.04 tools: python: "3.12" apt_packages: - gir1.2-glib-2.0 - libffi-dev - libgirepository1.0-dev - libglib2.0-dev sphinx: configuration: docs/source/conf.py python: install: - method: pip path: .gio-pyio-0.0.6/LICENSE000066400000000000000000001045151473550335500142760ustar00rootroot00000000000000 GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The GNU General Public License is a free, copyleft license for software and other kinds of works. The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others. For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it. For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions. Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users. Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free. The precise terms and conditions for copying, distribution and modification follow. TERMS AND CONDITIONS 0. Definitions. "This License" refers to version 3 of the GNU General Public License. "Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. "The Program" refers to any copyrightable work licensed under this License. Each licensee is addressed as "you". "Licensees" and "recipients" may be individuals or organizations. To "modify" a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a "modified version" of the earlier work or a work "based on" the earlier work. A "covered work" means either the unmodified Program or a work based on the Program. To "propagate" a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. To "convey" a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. An interactive user interface displays "Appropriate Legal Notices" to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. 1. Source Code. The "source code" for a work means the preferred form of the work for making modifications to it. "Object code" means any non-source form of a work. A "Standard Interface" means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. The "System Libraries" of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A "Major Component", in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. The "Corresponding Source" for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work. The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. The Corresponding Source for a work in source code form is that same work. 2. Basic Permissions. All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. 3. Protecting Users' Legal Rights From Anti-Circumvention Law. No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures. 4. Conveying Verbatim Copies. You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. 5. Conveying Modified Source Versions. You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: a) The work must carry prominent notices stating that you modified it, and giving a relevant date. b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to "keep intact all notices". c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so. A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an "aggregate" if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. 6. Conveying Non-Source Forms. You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge. c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements. e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. A "User Product" is either (1) a "consumer product", which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, "normally used" refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. "Installation Information" for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying. 7. Additional Terms. "Additional permissions" are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or d) Limiting the use for publicity purposes of names of licensors or authors of the material; or e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors. All other non-permissive additional terms are considered "further restrictions" within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way. 8. Termination. You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10. 9. Acceptance Not Required for Having Copies. You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so. 10. Automatic Licensing of Downstream Recipients. Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. An "entity transaction" is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it. 11. Patents. A "contributor" is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's "contributor version". A contributor's "essential patent claims" are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, "control" includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. In the following three paragraphs, a "patent license" is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To "grant" such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. "Knowingly relying" means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. A patent license is "discriminatory" if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. 12. No Surrender of Others' Freedom. If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. 13. Use with the GNU Affero General Public License. Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such. 14. Revised Versions of this License. The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation. If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program. Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version. 15. Disclaimer of Warranty. THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 16. Limitation of Liability. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 17. Interpretation of Sections 15 and 16. If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see . Also add information on how to contact you by electronic and paper mail. If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode: Copyright (C) This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an "about box". You should also get your employer (if you work as a programmer) or school, if any, to sign a "copyright disclaimer" for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see . The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read . gio-pyio-0.0.6/README.md000066400000000000000000000013071473550335500145430ustar00rootroot00000000000000# gio-pyio Python like IO for gio. [![Documentation Status](https://readthedocs.org/projects/gio-pyio/badge/?version=latest)](https://gio-pyio.readthedocs.io/en/latest/?badge=latest) This library provides python like IO for Gio. It is intended to bridge the gap between Gtk apps using GFile for file handling and python libraries that expect files in the form of [file objects](https://docs.python.org/3/glossary.html#term-file-object). ## Usage See the example below: ```python file = Gio.File.new_for_path('/path/to/json/file.json') with gio_pyio.open(file, 'rb') as file_like: data = json.load(file_like) print(data) ``` For advanced usage see [the reference](https://gio-pyio.readthedocs.io/) gio-pyio-0.0.6/docs/000077500000000000000000000000001473550335500142135ustar00rootroot00000000000000gio-pyio-0.0.6/docs/Makefile000066400000000000000000000011761473550335500156600ustar00rootroot00000000000000# Minimal makefile for Sphinx documentation # # You can set these variables from the command line, and also # from the environment for the first two. SPHINXOPTS ?= SPHINXBUILD ?= sphinx-build SOURCEDIR = source BUILDDIR = build # Put it first so that "make" without argument is like "make help". help: @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) .PHONY: help Makefile # Catch-all target: route all unknown targets to Sphinx using the new # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). %: Makefile @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) gio-pyio-0.0.6/docs/make.bat000066400000000000000000000014441473550335500156230ustar00rootroot00000000000000@ECHO OFF pushd %~dp0 REM Command file for Sphinx documentation if "%SPHINXBUILD%" == "" ( set SPHINXBUILD=sphinx-build ) set SOURCEDIR=source set BUILDDIR=build %SPHINXBUILD% >NUL 2>NUL if errorlevel 9009 ( echo. echo.The 'sphinx-build' command was not found. Make sure you have Sphinx echo.installed, then set the SPHINXBUILD environment variable to point echo.to the full path of the 'sphinx-build' executable. Alternatively you echo.may add the Sphinx directory to PATH. echo. echo.If you don't have Sphinx installed, grab it from echo.https://www.sphinx-doc.org/ exit /b 1 ) if "%1" == "" goto help %SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% goto end :help %SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% :end popd gio-pyio-0.0.6/docs/source/000077500000000000000000000000001473550335500155135ustar00rootroot00000000000000gio-pyio-0.0.6/docs/source/conf.py000066400000000000000000000022361473550335500170150ustar00rootroot00000000000000# Configuration file for the Sphinx documentation builder. # # For the full list of built-in configuration values, see the documentation: # https://www.sphinx-doc.org/en/master/usage/configuration.html # -- Project information ----------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information project = 'gio-pyio' copyright = '2024, Christoph Matthias Kohnen' author = 'Christoph Matthias Kohnen' # -- General configuration --------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.viewcode', ] templates_path = ['_templates'] exclude_patterns = [] intersphinx_mapping = { 'python': ('https://docs.python.org/3', None), 'pygobject': ('https://amolenaar.pages.gitlab.gnome.org/pygobject-docs/', None), } # -- Options for HTML output ------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output html_theme = 'alabaster' html_static_path = ['_static'] gio-pyio-0.0.6/docs/source/index.rst000066400000000000000000000007001473550335500173510ustar00rootroot00000000000000.. currentmodule:: gio_pyio ====================== gio-pyio Documentation ====================== ====== ===================================== PyPI https://pypi.python.org/pypi/gio-pyio GitHub https://github.com/cmkohnen/gio_pyio Docs https://gio-pyio.readthedocs.io/ ====== ===================================== :py:mod:`gio_pyio` API ====================== .. autofunction:: gio_pyio.open .. autoclass:: gio_pyio.StreamWrapper :members:gio-pyio-0.0.6/pyproject.toml000066400000000000000000000013271473550335500162020ustar00rootroot00000000000000# pyproject.toml [build-system] requires = ["setuptools>=61.0.0", "wheel"] build-backend = "setuptools.build_meta" [project] name = "gio-pyio" version = "0.0.6" authors = [ { name="Christoph Matthias Kohnen", email="mail@cmkohnen.de" }, ] description = "Python like IO for gio" readme = "README.md" requires-python = ">=3.8" classifiers = [ "Programming Language :: Python :: 3", "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", "Operating System :: OS Independent", ] dependencies = [ "PyGObject >= 3.42.2", ] [project.urls] Repository = "https://github.com/cmkohnen/gio_pyio" Issues = "https://github.com/cmkohnen/gio_pyio/issues" Documentation = "https://gio-pyio.readthedocs.io"gio-pyio-0.0.6/requirements.txt000066400000000000000000000003311473550335500165440ustar00rootroot00000000000000# # This file is autogenerated by pip-compile with Python 3.12 # by the following command: # # pip-compile pyproject.toml # pycairo==1.26.1 # via pygobject pygobject==3.48.2 # via gio-pyio (pyproject.toml) gio-pyio-0.0.6/src/000077500000000000000000000000001473550335500140525ustar00rootroot00000000000000gio-pyio-0.0.6/src/gio_pyio/000077500000000000000000000000001473550335500156705ustar00rootroot00000000000000gio-pyio-0.0.6/src/gio_pyio/__init__.py000066400000000000000000000474561473550335500200210ustar00rootroot00000000000000"""gio_pyio lib.""" import io import os from gi.repository import GLib, Gio class StreamWrapper(io.IOBase): """Wrap a stream as a `file object`_. See :func:`Gio.open_file_like` for a convenience method to open a file as a `file object`_. Note, that this does not implement buffering, seeking, etc. and relies on the capabilities of *stream*. :param stream stream: A stream to be wrapped. :raises TypeError: Invalid argument. .. _file object: https://docs.python.org/3/glossary.html#term-file-object """ def __init__(self, stream): if isinstance(stream, Gio.InputStream): self._input_stream = stream self._output_stream = None self._ref_stream = stream elif isinstance(stream, Gio.OutputStream): self._input_stream = None self._output_stream = stream self._ref_stream = stream elif isinstance(stream, Gio.IOStream): # For some methods, we assume, both stream represent the same # object as well as being in sync in regards to seeking, that way # we don't need to duplicate logic for most methods. self._input_stream = stream.get_input_stream() self._output_stream = stream.get_output_stream() self._ref_stream = self._input_stream # Keep a reference, or the stream might get closed self._io_stream = stream else: raise TypeError('expected stream, got %s' % type(stream)) def close(self): """Flush and close the underlying stream. This method has no effect if the underlying stream is already closed. Once closed, any operation (e. g. reading or writing) will raise a ValueError. As a convenience, it is allowed to call this method more than once; only the first call, however, will have an effect. """ if hasattr(self, '_io_stream'): self._io_stream.close() return if self.readable(): self._input_stream.close() if self.writable(): self._output_stream.close() @property def closed(self): """``True`` if the underlying stream is closed.""" return self._ref_stream.is_closed() def fileno(self): """Return the underlying file descriptor if it exists. :rtype: int :returns: The underlying file descriptor. :raises ValueError: If the underlying stream is closed. :raises io.UnsupportedOperationException: If the underlying stream is not based on a file descriptor. """ self._checkClosed() if not (self._ref_stream, 'get_fd'): self._unsupported('fileno') return self._ref_stream.get_fd() def flush(self): """Flush the write buffers of the underlying stream if applicable. This does nothing for read-only streams. :raises ValueError: If the underlying stream is closed. """ self._checkClosed() if self.writable(): self._output_stream.flush(None) def readable(self): """Whether or not the stream is readable. :rtype bool: :returns: Whether or not this wrapper can be read from. """ return self._input_stream is not None def read(self, size=-1): """Read up to *size* bytes from the underlying stream and return them. As a convenience if *size* is unspecified or -1, all bytes until EOF are returned. The result may be fewer bytes than requested, if EOF is reached. :param int size: The amount of bytes to read from the underlying stream. :rtype: bytes :returns: Bytes read from the underlying stream. :raises ValueError: If the underlying stream is closed. :raises io.UnsupportedOperationException: If the underlying stream is not readable. """ self._checkClosed() self._checkReadable() if size == 0: return b'' elif size > 0: return self._input_stream.read_bytes(size, None).get_data() # Try to determine the length of the stream, else fall back on # default buffer size for reading if isinstance(self._input_stream, Gio.BufferedInputStream): def_bufsize = self._input_stream.get_buffer_size() else: def_bufsize = io.DEFAULT_BUFFER_SIZE end = None if hasattr(self._input_stream, 'get_size'): end = self._input_stream.get_size() elif hasattr(self._input_stream, 'query_info'): info = self._input_stream.query_info('standard::size', None) end = info.get_size() if end is not None: pos = self._ref_stream.tell() if end >= pos: bufsize = end - pos + 1 else: bufsize = def_bufsize result = bytearray() while True: if len(result) >= bufsize: bufsize = len(result) bufsize += max(bufsize, def_bufsize) n = bufsize - len(result) chunk = self._input_stream.read_bytes(n, None) if chunk.get_size() == 0: # EOF reached break result += chunk.get_data() return bytes(result) read1 = read readall = read def readinto(self, b): """Read bytes into a pre-allocated, writable `bytes-like object`_ *b*. :param bytes-like b: A pre-allocated object. :rtype: int :returns: Number of bytes written. :raises ValueError: If the underlying stream is closed. :raises io.UnsupportedOperationException: If the underlying stream is not readable. .. _bytes-like object: https://docs.python.org/3/glossary.html#term-bytes-like-object """ self._checkClosed() self._checkReadable() view = memoryview(b).cast('B') data = self._input_stream.read_bytes(len(view), None) size = data.get_size() view[:size] = data.get_data() return size readinto1 = readinto def seek(self, offset, whence=os.SEEK_SET): """Change the underlying stream position. *offset* is interpreted relative to the position indicated by *whence*. :param int offset: Where to change the stream position to, relative to *whence* :param int whence: Reference for *offset*. Values are: * 0 -- start of stream (the default); offset should'nt be negative * 1 -- current stream position; offset may be negative * 2 -- end of stream; offset is usually negative :rtype: int :returns: The new absolute position of the underlying stream. :raises ValueError: If the underlying stream is closed. :raises io.UnsupportedOperationException: If the underlying stream is not seekable. """ self._checkClosed() self._checkSeekable() # Enum values in python and Gio: # 0: os.SEEK_SET : Gio.SeekType.CUR # 1: os.SEEK_CUR : Gio.SeekType.SET # 2: os.SEEK_END : Gio.SeekType.END # so 1 and 0 need to be switched if whence != 2: whence = not whence if self.readable(): self._input_stream.seek(offset, whence, None) if self.writable(): self._output_stream.seek(offset, whence, None) return self._ref_stream.tell() def seekable(self): """ Whether or not the stream is seekable. :rtype: bool :returns: Whether or not the underlying stream supports seeking. :raises ValueError: If the underlying stream is closed. """ self._checkClosed() return self._ref_stream.can_seek() def tell(self): """ Tell the current stream position. :rtype: int :returns: The position of the underlying stream. :raises ValueError: If the underlying stream is closed. """ self._checkClosed() return self._ref_stream.tell() def truncate(self, size=None): """Resize the underlying stream to *size*. :param int size: The size, the stream should be set to. If ``None`` the current position is used. :rtype: int :returns: The new size of the underlying stream. :raises ValueError: If the underlying stream is closed. :raises io.UnsupportedOperationException: If the underlying stream can not be written to. """ self._checkClosed() if self._output_stream is None or \ not self._output_stream.can_truncate(): raise io.UnsupportedOperation('truncate') if size is None: size = self._output_stream.tell() self._output_stream.truncate(size) return size def writable(self): """ Wheter or not the stream can be written to. :rtype: bool :returns: Whether or not this wrapper can be written to. """ return self._output_stream is not None def write(self, b): """Write *b* to the underlying stream. :param bytes-like b: Content to be written to the underlying stream. :rtype: int :returns: The number of bytes written to the underlying stream. :raises ValueError: If the underlying stream is closed. :raises io.UnsupportedOperationException: If the underlying stream can not be written to. """ self._checkClosed() self._checkWritable() if b is None or b == b'': return 0 return self._output_stream.write_bytes(GLib.Bytes(b)) def open(file, mode='r', buffering=-1, encoding=None, errors=None, newline=None, native=True): r"""Open the file and create a corresponding `file object`_. If the file cannot be opened, an OSError is raised. This behaves analog to pythons builtin :external:py:func:`open` function. See `Reading and Writing Files`_ for examples of io using python. :param Gio.File file: The file to open. :param str mode: Mode in which the file is opened. Defaults to 'r' which means open for reading in text mode. Other common values are 'w' for writing (truncating the file if it already exists), 'x' for exclusive creation of a new file, and 'a' for appending. The available modes are: ========= =================================================== Character Meaning --------- --------------------------------------------------- 'r' open for reading (default) 'w' open for writing, truncating the file first 'x' create a new file and open it for writing 'a' open for writing, appending to the end of the file 'b' binary mode 't' text mode (default) '+' open a disk file for updating (reading and writing) ========= =================================================== The default value is 'r' (open for reading text, a synonym of 'rt'). For binary random access, the mode 'w+b' opens and truncates the file to 0 bytes, while 'r+b' opens the file without truncation. The 'x' mode implies 'w' and raises an `FileExistsError` if the file already exists. Python distinguishes between files opened in binary and text mode. Files opened in binary mode (appending 'b' to the mode argument) return contents as bytes objects without any decoding. In text mode (the default, or when 't' is appended to the mode argument), the contents of the file are returned as strings, the bytes having first been decoded using *encoding*. :param int buffering: Buffering policy. Pass 0 to switch buffering off (only allowed in binary mode), 1 to select line buffering (only usable in text mode), and an integer > 1 to indicate the size of a fixed-size chunk buffer. When no buffering argument is given. Files are buffered in fixed-size chunks; the size of the buffer is chosen using a heuristic trying to determine the underlying device's blksize and falling back on `io.DEFAULT_BUFFER_SIZE`. The buffer will typically be 4096 or 8192 bytes long. :param str encoding: Encoding used to decode or encode the file. Can only be used in text mode. The default encoding is platform dependent, but any encoding supported by Python can be passed. See the codecs module for the list of supported encodings. :param str errors: How encoding errors are to be handled. Can not be used in binary mode. Pass 'strict' to raise a ValueError exception if there is an encoding error (the default of None has the same effect), or pass 'ignore' to ignore errors. (Note that ignoring encoding errors can lead to data loss.) See the documentation for codecs.register for a list of the permitted encoding error strings. :param str newline: How universal newlines work (only applies to text mode). Can be None, '', '\n', '\r', and '\r\n'. Works as follows: * On input, if newline is None, universal newlines mode is enabled. Lines in the input can end in '\n', '\r', or '\r\n', and these are translated into '\n' before being returned to the caller. If it is '', universal newline mode is enabled, but line endings are returned to the caller untranslated. If it has any of the other legal values, input lines are only terminated by the given string, and the line ending is returned to the caller untranslated. * On output, if newline is None, any '\n' characters written are translated to the system default line separator, os.linesep. If newline is '', no translation takes place. If newline is any of the other legal values, any '\n' characters written are translated to the given string. :param bool native: Try and obtain a file descriptor and use python standard io libraries. If False, the result will always be a wrapped Gio stream. :rtype: file-like :returns: A new `file object`_. When used to open a file in a text mode ('w', 'r', 'wt', 'rt', etc.), the object will be a TextIOWrapper. When used to open a file in a binary mode, the returned class varies: in read binary mode, it will be a BufferedReader; in write binary and append binary modes, it will be a BufferedWriter, and in read/write mode, it will be a BufferedRandom. If buffering is disabled, the object will either be a FileIO or :py:class:`StreamWrapper` depending on python native libraries can be used. :raises TypeError: Invalid argument passed. :raises ValueError: Invalid argument passed. :raises OSError: Failed to open file. .. _file object: https://docs.python.org/3/glossary.html#term-file-object .. _Reading and Writing Files: https://docs.python.org/3/tutorial/inputoutput.html#tut-files """ # Argument validation if not isinstance(mode, str): raise TypeError('invalid mode: %r' % mode) if not isinstance(buffering, int): raise TypeError('invalid buffering: %r' % buffering) modes = set(mode) if modes - set('axrwb+t') or len(mode) > len(modes): raise ValueError('invalid mode: %r' % mode) if encoding is not None and not isinstance(encoding, str): raise TypeError('invalid encoding: %r' % encoding) if errors is not None and not isinstance(errors, str): raise TypeError('invalid errors: %r' % errors) creating = 'x' in modes reading = 'r' in modes writing = 'w' in modes appending = 'a' in modes updating = '+' in modes binary = 'b' in modes if binary and 't' in modes: raise ValueError("can't have text and binary mode at once") if creating + reading + writing + appending > 1: raise ValueError('must have exactly one of create/read/write/append' ' mode') if not (creating or reading or writing or appending): raise ValueError('Must have exactly one of create/read/write/append' ' mode and at most one plus') if binary and encoding is not None: raise ValueError("binary mode doesn't take an encoding argument") if binary and errors is not None: raise ValueError("binary mode doesn't take an errors argument") if binary and newline is not None: raise ValueError("binary mode doesn't take a newline argument") # For non-native files we use the result of `file.get_basename()` rep_str = file.peek_path() if file.is_native() else file.get_basename() file_type = file.query_file_type(Gio.FileQueryInfoFlags.NONE, None) if file_type == Gio.FileType.DIRECTORY: raise OSError(21, "Is a directory: '%s'" % rep_str) if file.query_exists(): if creating: raise OSError(17, "File exists: '%s'" % rep_str) elif reading: raise OSError(2, "No such file or directory: '%s'" % rep_str) if buffering == 0 and not binary: raise ValueError("can't have unbuffered text I/O") if native and file.is_native(): file_like = io.FileIO( file.peek_path(), (creating and 'x' or '') + (reading and 'r' or '') + (writing and 'w' or '') + (appending and 'a' or '') + (updating and '+' or ''), ) else: stream = None # Match given mode to respective opener. All calls are non-async, thus # blocking as well as not cancellable. if updating: if creating: stream = file.create_readwrite(Gio.FileCreateFlags.NONE, None) elif writing: stream = file.replace_readwrite(None, False, Gio.FileCreateFlags.NONE, None) else: stream = file.open_readwrite(None) else: if creating: stream = file.create(Gio.FileCreateFlags.NONE, None) elif reading: stream = file.read(None) elif writing: stream = file.replace(None, False, Gio.FileCreateFlags.NONE, None) elif appending: stream = file.append_to(Gio.FileCreateFlags.NONE, None) # at this point stream should not be `None` or input validation has # failed substantially assert stream is not None file_like = StreamWrapper(stream) line_buffering = False if buffering != 0: if buffering == 1: buffering = -1 line_buffering = True if buffering < 0: buffering = io.DEFAULT_BUFFER_SIZE try: # Try to set buffersize to the blksize of the file system blksize = os.fstat(file_like.fileno()).st_blksize if blksize > 1: buffering = blksize except (OSError, AttributeError): pass if updating: wrapper = io.BufferedRandom elif reading: wrapper = io.BufferedReader else: wrapper = io.BufferedWriter file_like = wrapper(file_like, buffering) if not binary: file_like = io.TextIOWrapper(file_like, encoding=encoding, errors=errors, newline=newline, line_buffering=line_buffering) file_like.mode = mode return file_like gio-pyio-0.0.6/tests/000077500000000000000000000000001473550335500144255ustar00rootroot00000000000000gio-pyio-0.0.6/tests/example.gresource.xml000066400000000000000000000002241473550335500205750ustar00rootroot00000000000000 example_data.json gio-pyio-0.0.6/tests/example_data.json000066400000000000000000000011061473550335500177420ustar00rootroot00000000000000{ "glossary": { "title": "example glossary", "GlossDiv": { "title": "S", "GlossList": { "GlossEntry": { "ID": "SGML", "SortAs": "SGML", "GlossTerm": "Standard Generalized Markup Language", "Acronym": "SGML", "Abbrev": "ISO 8879:1986", "GlossDef": { "para": "A meta-markup language, used to create markup languages such as DocBook.", "GlossSeeAlso": ["GML", "XML"] }, "GlossSee": "markup" } } } } }gio-pyio-0.0.6/tests/test_gio_pyio.py000066400000000000000000000310251473550335500176550ustar00rootroot00000000000000# These test cases are adapted from python's own test for file validation # They are licensed under the # PYTHON SOFTWARE FOUNDATION LICENSE VERSION 2 # https://github.com/python/cpython/blob/main/LICENSE import contextlib import gc import json import subprocess import sys import unittest from array import array from collections import UserList from pathlib import Path from weakref import proxy from gi.repository import GLib, Gio import gio_pyio class GioFileLikeTests(unittest.TestCase): def setUp(self): self.file, stream = Gio.File.new_tmp('TestGFile.XXXXXX') stream.close() self.f = gio_pyio.open(self.file, 'wb', native=False) def tearDown(self): if self.f: self.f.close() with contextlib.suppress(GLib.Error): self.file.delete(None) def testWeakRefs(self): # verify weak references p = proxy(self.f) p.write(b'teststring') self.assertEqual(self.f.tell(), p.tell()) self.f.close() self.f = None gc.collect() self.assertRaises(ReferenceError, getattr, p, 'tell') def testSeekTell(self): self.f.write(bytes(range(20))) self.assertEqual(self.f.tell(), 20) self.f.seek(0) self.assertEqual(self.f.tell(), 0) self.f.seek(10) self.assertEqual(self.f.tell(), 10) self.f.seek(5, 1) self.assertEqual(self.f.tell(), 15) self.f.seek(-5, 1) self.assertEqual(self.f.tell(), 10) self.f.seek(-5, 2) self.assertEqual(self.f.tell(), 15) def testAttributes(self): # verify expected attributes exist self.f.closed # merely shouldn't blow up def testReadinto(self): # verify readinto self.f.write(b'12') self.f.close() a = array('b', b'x' * 10) self.f = gio_pyio.open(self.file, 'rb', native=False) n = self.f.readinto(a) self.assertEqual(b'12', a.tobytes()[:n]) def testReadinto_text(self): # verify readinto refuses text files a = array('b', b'x' * 10) self.f.close() self.f = gio_pyio.open(self.file, encoding='utf-8', native=False) if hasattr(self.f, 'readinto'): self.assertRaises(TypeError, self.f.readinto, a) def testReadintoByteArray(self): self.f.write(bytes([1, 2, 0, 255])) self.f.close() ba = bytearray(b'abcdefgh') with gio_pyio.open(self.file, 'rb', native=False) as f: n = f.readinto(ba) self.assertEqual(ba, b'\x01\x02\x00\xffefgh') self.assertEqual(n, 4) def testWritelinesUserList(self): # verify writelines with instance sequence userlist = UserList([b'1', b'2']) self.f.writelines(userlist) self.f.close() self.f = gio_pyio.open(self.file, 'rb', native=False) buf = self.f.read() self.assertEqual(buf, b'12') def testWritelinesIntegers(self): # verify writelines with integers self.assertRaises(TypeError, self.f.writelines, [1, 2, 3]) def testWritelinesIntegersUserList(self): # verify writelines with integers in UserList userlist = UserList([1, 2, 3]) self.assertRaises(TypeError, self.f.writelines, userlist) def testWritelinesNonString(self): # verify writelines with non-string object class NonString: pass self.assertRaises(TypeError, self.f.writelines, [NonString(), NonString()]) def testWritelinesError(self): self.assertRaises(TypeError, self.f.writelines, [1, 2, 3]) self.assertRaises(TypeError, self.f.writelines, None) self.assertRaises(TypeError, self.f.writelines, 'abc') def testErrors(self): f = self.f self.assertFalse(f.isatty()) self.assertFalse(f.closed) if hasattr(f, 'readinto'): self.assertRaises((OSError, TypeError), f.readinto, '') f.close() self.assertTrue(f.closed) def testReject(self): self.assertRaises(TypeError, self.f.write, 'Hello!') def testMethods(self): methods = [('fileno', ()), ('flush', ()), ('isatty', ()), ('__next__', ()), ('read', ()), ('write', (b'',)), ('readline', ()), ('readlines', ()), ('seek', (0,)), ('tell', ()), ('write', (b'',)), ('writelines', ([],)), ('__iter__', ()), ('truncate', ()), ] # __exit__ should close the file self.f.__exit__(None, None, None) self.assertTrue(self.f.closed) for methodname, args in methods: method = getattr(self.f, methodname) # should raise on closed file self.assertRaises(ValueError, method, *args) # file is closed, __exit__ shouldn't do anything self.assertEqual(self.f.__exit__(None, None, None), None) # it must also return None if an exception was given try: 1 / 0 except ZeroDivisionError: self.assertEqual(self.f.__exit__(*sys.exc_info()), None) def testReadWhenWriting(self): self.assertRaises(OSError, self.f.read) def testModeStrings(self): # check invalid mode strings for mode in ('', 'aU', 'wU+', 'U+', '+U', 'rU+'): try: f = gio_pyio.open(self.file, mode) except ValueError: pass else: f.close() self.fail('%r is an invalid file mode' % mode) # check valid mode strings for mode in ('rt', 'wb', 'a+'): f = gio_pyio.open(self.file, mode, native=False) f.close() f = gio_pyio.open(self.file, mode, native=True) f.close() def testBadModeArgument(self): # verify that we get a sensible error message for bad mode argument bad_mode = 'qwerty' try: f = gio_pyio.open(self.file, bad_mode) except ValueError as msg: if msg.args[0] != 0: s = str(msg) if bad_mode not in s: self.fail('bad error message for invalid mode: %s' % s) # if msg.args[0] == 0, we're probably on Windows where there may be # no obvious way to discover why open() failed. else: f.close() self.fail('no error for invalid mode: %s' % bad_mode) def testIteration(self): # Test the complex interaction when mixing file-iteration and the # various read* methods. dataoffset = 16384 filler = b'ham\n' assert not dataoffset % len(filler), \ 'dataoffset must be multiple of len(filler)' nchunks = dataoffset // len(filler) testlines = [ b'spam, spam and eggs\n', b'eggs, spam, ham and spam\n', b'saussages, spam, spam and eggs\n', b'spam, ham, spam and eggs\n', b'spam, spam, spam, spam, spam, ham, spam\n', b'wonderful spaaaaaam.\n', ] methods = [('readline', ()), ('read', ()), ('readlines', ()), ('readinto', (array('b', b' ' * 100),))] # Prepare the testfile bag = gio_pyio.open(self.file, 'wb') bag.write(filler * nchunks) bag.writelines(testlines) bag.close() # Test for appropriate errors mixing read* and iteration for methodname, args in methods: f = gio_pyio.open(self.file, 'rb', native=False) self.assertEqual(next(f), filler) meth = getattr(f, methodname) meth(*args) # This simply shouldn't fail f.close() # Test to see if harmless (by accident) mixing of read* and # iteration still works. This depends on the size of the internal # iteration buffer (currently 8192,) but we can test it in a # flexible manner. Each line in the bag o' ham is 4 bytes # ("h", "a", "m", "\n"), so 4096 lines of that should get us # exactly on the buffer boundary for any power-of-2 buffersize # between 4 and 16384 (inclusive). f = gio_pyio.open(self.file, 'rb', native=False) for _i in range(nchunks): next(f) testline = testlines.pop(0) try: line = f.readline() except ValueError: self.fail('readline() after next() with supposedly empty ' 'iteration-buffer failed anyway') if line != testline: self.fail('readline() after next() with empty buffer ' 'failed. Got %r, expected %r' % (line, testline)) testline = testlines.pop(0) buf = array('b', b'\x00' * len(testline)) try: f.readinto(buf) except ValueError: self.fail('readinto() after next() with supposedly empty ' 'iteration-buffer failed anyway') line = buf.tobytes() if line != testline: self.fail('readinto() after next() with empty buffer ' 'failed. Got %r, expected %r' % (line, testline)) testline = testlines.pop(0) try: line = f.read(len(testline)) except ValueError: self.fail('read() after next() with supposedly empty ' 'iteration-buffer failed anyway') if line != testline: self.fail('read() after next() with empty buffer ' 'failed. Got %r, expected %r' % (line, testline)) try: lines = f.readlines() except ValueError: self.fail('readlines() after next() with supposedly empty ' 'iteration-buffer failed anyway') if lines != testlines: self.fail('readlines() after next() with empty buffer ' 'failed. Got %r, expected %r' % (line, testline)) f.close() # Reading after iteration hit EOF shouldn't hurt either f = gio_pyio.open(self.file, 'rb', native=False) try: for _line in f: pass try: f.readline() f.readinto(buf) f.read() f.readlines() except ValueError: self.fail('read* failed after next() consumed file') finally: f.close() def testAbles(self): try: f = gio_pyio.open(self.file, 'w', native=False) self.assertEqual(f.readable(), False) self.assertEqual(f.writable(), True) self.assertEqual(f.seekable(), True) f.close() f = gio_pyio.open(self.file, 'r', native=False) self.assertEqual(f.readable(), True) self.assertEqual(f.writable(), False) self.assertEqual(f.seekable(), True) f.close() f = gio_pyio.open(self.file, 'a+', native=False) self.assertEqual(f.readable(), True) self.assertEqual(f.writable(), True) self.assertEqual(f.seekable(), True) self.assertEqual(f.isatty(), False) f.close() finally: pass def testAppend(self): try: f = gio_pyio.open(self.file, 'wb', native=False) f.write(b'spam') f.close() f = gio_pyio.open(self.file, 'ab', native=False) f.write(b'eggs') f.close() f = gio_pyio.open(self.file, 'rb', native=False) d = f.read() f.close() self.assertEqual(d, b'spameggs') finally: pass def testJSON(self): path = Path(Path(__file__).parent, 'example_data.json') file = Gio.File.new_for_path(str(path)) f = gio_pyio.open(file, 'rb', native=False) data = json.load(f) f.close() assert data['glossary']['title'] == 'example glossary' def testGResource(self): parent = Path(__file__).parent subprocess.call( 'glib-compile-resources' + ' --sourcedir=' + str(parent) + ' --target=' + self.file.peek_path() + ' ' + str(Path(parent, 'example.gresource.xml')), shell=True, ) resource = Gio.Resource.load(self.file.peek_path()) resource._register() file = Gio.File.new_for_uri('resource:///example/example_data.json') f = gio_pyio.open(file, 'rb') data = json.load(f) f.close() assert data['glossary']['title'] == 'example glossary'