1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
|
Metadata-Version: 2.1
Name: multivolumefile
Version: 0.2.3
Summary: multi volume file wrapper library
Home-page: https://github.com/miurahr/multivolume
Author: Hiroshi Miura
Author-email: miurahr@linux.com
License: LGPL-2.1+
Description: ===============
multivolumefile
===============
.. image:: https://coveralls.io/repos/github/miurahr/multivolume/badge.svg?branch=master
:target: https://coveralls.io/github/miurahr/multivolume?branch=master
.. image:: https://github.com/miurahr/multivolume/workflows/Run%20Tox%20tests/badge.svg
:target: https://github.com/miurahr/multivolume/actions
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`_
.. _`python library reference`: https://docs.python.org/3/library/io.html
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;
.. code-block::
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;
.. code-block::
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.
`v0.2.0`_
=========
Added
-----
* Type hint information bundled.
Fixed
-----
* Seek() returns current position.
Changed
-------
* Explanation of unsupported methods an modes in README
`v0.1.4`_
=========
Fixed
-----
* Fix append mode bug.
`v0.1.3`_
=========
Fixed
-----
* Fix added volume size become wrong
`v0.1.2`_
=========
Fixed
-----
* Fix append mode (#1)
`v0.1.1`_
=========
Fixed
-----
* Fin NotImplementedError when writing boudning of target files
`v0.1.0`_
=========
* ***API changed***
Added
-----
* Add mode 'x', 'xb' and 'xt'
* Add mode 'a', 'ab' and 'at'
* Support flush()
Changed
-------
* Change API: file argument of 'r' and 'rb' now single basename instead of list of files
`v0.0.5`_
=========
* Support context manager
* Support read functions.
.. History links
.. _Unreleased: https://github.com/miurahr/py7zr/compare/v0.2.2...HEAD
.. _v0.2.2: https://github.com/miurahr/py7zr/compare/v0.2.1...v0.2.2
.. _v0.2.1: https://github.com/miurahr/py7zr/compare/v0.2.0...v0.2.1
.. _v0.2.0: https://github.com/miurahr/py7zr/compare/v0.1.4...v0.2.0
.. _v0.1.4: https://github.com/miurahr/py7zr/compare/v0.1.3...v0.1.4
.. _v0.1.3: https://github.com/miurahr/py7zr/compare/v0.1.2...v0.1.3
.. _v0.1.2: https://github.com/miurahr/py7zr/compare/v0.1.1...v0.1.2
.. _v0.1.1: https://github.com/miurahr/py7zr/compare/v0.1.0...v0.1.1
.. _v0.1.0: https://github.com/miurahr/py7zr/compare/v0.0.5...v0.1.0
.. _v0.0.5: https://github.com/miurahr/py7zr/compare/v0.0.1...v0.0.5
Keywords: multivolume,file
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: GNU Lesser General Public License v2 or later (LGPLv2+)
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.6
Description-Content-Type: text/x-rst
Provides-Extra: test
Provides-Extra: type
Provides-Extra: check
|
