by Lawrence R. Rogers (2016-12-27):
* Release 3.0-1
Version 3.0 (2016-12-27)
Support RAR5 archive format. It is actually completely different archive format from RAR3 one, only is uses same file extension and tools are old one.
Except incompatibilies noted below, most of code should notice no change, existing RarInfo fields will continue using RAR3-compatible values (eg. RarInfo.host_os). RAR5-specific values will use new fields.
Incompatibilities between rarfile v2.x and 3.x:
Default PATH_SEP is now ‘/’ instead ‘\’.
Removed NEED_COMMENTS option, comments are always extracted.
Removed UNICODE_COMMENTS option, they are always decoded.
Removed USE_DATETIME option, RarInfo.date_time is always tuple, RarInfo.mtime, RarInfo.atime, RarInfo.ctime and RarInfo.arctime are always datetime.datetime objects.
Fixed bug when calling rarfp.open() on a RarInfo structure.
Code refactor to allow 2 different file format parsers.
Code cleanups to pass modern linters.
New testing and linting setup based on Tox.
Use setuptools instead distutils for install.
Version 2.8 (2016-06-07)
Fix: support solid archives from in-memory file object. Full archive will be written out to temp file. [#21]
Fix: ask unrar stop switches scanning, to handle archive names starting with “-”. (Alexander Shadchin) [#12]
Fix: add missing _parse_error variable to RarFile object. (Gregory Mazzola) [#20]
Fix: return proper boolean from RarInfo.needs_password(). [#22]
Fix: do not insert non-string rarfile into exception string. (Tim Muller) [#23]
Fix: make RarFile.extract() and RarFile.testrar() support in-memory archives.
Use cryptography module as preferred crypto backend. PyCrypto will be used as fallback.
Cleanup: remove compat code for Python 2.4/2.5/2.6.
Version 2.7 (2014-11-23)
Allow use of bsdtar as decompression backend. It sits on top of libarchive, which has support for reading RAR archives.
Limitations of libarchive RAR backend:
* Does not support solid archives.
* Does not support password-protected archives.
* Does not support “parsing filters” used for audio/image/executable data, so few non-solid, non-encrypted archives also fail.
Now rarfile checks if unrar and if not then tries bsdtar. If that works, then keeps using it. If not then configuration stays with unrar which will then appear in error messages.
Both RarFile and is_rarfile() now accept file-like object. Eg. io.BytesIO. Only requirement is that the object must be seekable. This mirrors similar funtionality in zipfile.
Based on patch by Chase Zhang.
Uniform error handling. RarFile accepts errors="strict" argument.
Allow user to tune whether parsing and missing file errors will raise exception. If error is not raised, the error string can be queried with RarFile.strerror() method.
by Marko Kreen (2013-04-10):
* Release 2.6-1
Version 2.6 (2013-04-10)
Add context manager support for RarFile class. Both RarFile and RarExtFile support with statement now. (Wentao Han)
RarFile.volumelist() method, returns filenames of archive volumes.
Re-throw clearer error in case unrar is not found in PATH.
Sync new unrar4.x error code from rar.txt.
Use Sphinx for documentation, push docs to rtfd.org
Version 2.5 (2012-01-19)
RarExtFile.read() and RarExtFile.readinto() now do looping read to work properly on short reads. Important for Python 3.2+ where read from pipe can return short result even on blocking file descriptor.
Proper error reporting in RarFile.extract(), RarFile.extractall() and RarFile.testrar().
RarExtFile.read() from unrar pipe: prefer to return unrar error code, if thats not available, do own error checks.
Avoid string addition in RarExtFile.read(), instead use always list+join to merge multi-part reads.
dumprar: dont re-encode byte strings (Python 2.x). This avoids unneccessary failure when printing invalid unicode.
Version 2.4 (2011-11-05)
USE_DATETIME: survive bad values from RAR
Fix bug in corrupt unicode filename handling
dumprar: make unicode chars work with both pipe and console
Version 2.3 (2011-07-03)
Support .seek() method on file streams. (Kristian Larsson)
Support .readinto() method on file streams. Optimized implementation is available on Python 2.6+ where memoryview is available.
Support file comments - RarInfo.comment contains decompressed data if available.
File objects returned by RarFile.open() are io.RawIOBase-compatible. They can further wrapped with io.BufferedReader and io.TextIOWrapper.
Now .getinfo() uses dict lookup instead of sequential scan when searching archive entry. This speeds up prococessing for archives that have many entries.
Option UNICODE_COMMENTS to decode both archive and file comments to unicode. It uses TRY_ENCODINGS for list of encodings to try. If off, comments are left as byte strings. Default: 0
Option PATH_SEP to change path separator. Default: r'\', set rarfile.PATH_SEP='/' to be compatibe with zipfile.
Option USE_DATETIME to convert timestamps to datetime objects. Default: 0, timestamps are tuples.
Option TRY_ENCODINGS to allow tuning attempted encoding list.
Reorder RarInfo fiels to better show zipfile-compatible fields.
Standard regtests to make sure various features work
Drop RarInfo.unicode_filename, plain RarInfo.filename is already unicode since 2.0.
.read(-1) reads now until EOF. Previously it returned empty buffer.
Make encrypted headers work with Python 3.x bytes() and with old 2.x ‘sha’ module.
Simplify subprocess.Popen usage when launching unrar. Previously it tried to optimize and work around OS/Python bugs, but this is not maintainable.
Use temp rar file hack on multi-volume archives too.
Always .wait() on unrar, to avoid zombies
Convert struct.error to BadRarFile
Plug some fd leaks. Affected: Jython, PyPy.
Broken archives are handled more robustly.