loongson/pypi/: multivolumefile-0.2.3 metadata and description

multi volume file wrapper library

author	Hiroshi Miura
author_email	miurahr@linux.com
classifiers	Development Status :: 3 - Alpha Environment :: Console License :: OSI Approved :: GNU Lesser General Public License v2 or later (LGPLv2+) Operating System :: MacOS :: MacOS X Operating System :: Microsoft :: Windows Operating System :: POSIX Operating System :: POSIX :: Linux Programming Language :: Python Programming Language :: Python :: 3 Programming Language :: Python :: 3.8 Programming Language :: Python :: 3 :: Only Topic :: Software Development :: Libraries :: Python Modules
description_content_type	text/x-rst
keywords	multivolume,file
license	LGPL-2.1+
provides_extras	type
requires_dist	check-manifest ; extra == 'check' flake8 ; extra == 'check' flake8-black ; extra == 'check' readme-renderer ; extra == 'check' pygments ; extra == 'check' isort (>=5.0.3) ; extra == 'check' twine ; extra == 'check' pytest ; extra == 'test' pytest-cov ; extra == 'test' pyannotate ; extra == 'test' coverage[toml] (>=5.2) ; extra == 'test' coveralls (>=2.1.1) ; extra == 'test' hypothesis ; extra == 'test' mypy ; extra == 'type' mypy-extensions ; extra == 'type'
requires_python	>=3.6

Because this project isn't in the mirror_whitelist, no releases from root/pypi are included.

File	Tox results	History
multivolumefile-0.2.3-py3-none-any.whl Size 17 KB Type Python Wheel Python 3		Uploaded to loongson/pypi by loongson 2022-07-22 10:22:37

multivolumefile

https://coveralls.io/repos/github/miurahr/multivolume/badge.svg?branch=master

MultiVolumefile is a python library to provide a file-object wrapping multiple files as virtually like as a single file. It inherit io.RawIOBase class and support some of its standard methods.

See API details at python library reference

Status

multivolumefile module is under active development and considered as *Alpha* state. It is not good idea to use it on production systems, but it may work well in a limited range of usage. Please check limitations and passed test cases.

Install

You can install it as usual public libraries, you can use pip command

` pip install multivolumefile `

You are also able to add it to your setup.py/cfg as dependency.

Usages

For reading multi-volume files, that has names archive.7z.0001, archive.7z.0002 and so on, you can call multivolumefile as follows;

with multivolumefile.open('archive.7z', 'rb') as vol:
    data = vol.read(100)
    vol.seek(500)

For writing multi-volue files, that has names archive.7z.0001, archive.7z.0002 and so on, you can call multivolumefile as follows;

data = b'abcdefg'
with multivolumefile.open('archive.7z', 'wb') as vol:
    size = vol.write(data)
    vol.seek(0)

you will see file archive.7z.001 are written.

Limitations and known issues

fileno() is not supported and when call it, you will get RuntimeError exception.
There are several non-implemented functions such as truncate() and writeline() that will raise NotimplementedError
There are several non-implemented functions such as readlines(), readline() and readall().
Text mode is not implemented.
*Caution*: When globbing existent volumes, it glob all files other than 4-digit extensions, it may break your data.

Contribution

You are welcome to contribute the project, as usual on github projects, Pull-Requests are always welcome.

License

Multivolume is licensed under GNU Lesser General Public license version 2.1 or later.

ChangeLog

All notable changes to this project will be documented in this file.

Unreleased

Added

Changed

Fixed

Deprecated

Removed

Security

v0.2.3

Added

implement readall()

Chnaged

lint with black

v0.2.2

Added

Add py.typed file for type hinting.

v0.2.1

Added

Add name property that indicate basename of volumes
Add stat() that return stat_result which has as mostly same methods as os.stat_result class except for platform dependent methods.