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
|
rarfile API documentation
=========================
.. contents:: Table Of Contents
Introduction
------------
.. automodule:: rarfile
RarFile class
-------------
.. autoclass:: RarFile
:members:
:inherited-members:
RarInfo class
-------------
.. autoclass:: RarInfo
:members:
:inherited-members:
RarExtFile class
----------------
.. autoclass:: RarExtFile
:members:
:inherited-members:
Functions
---------
.. autofunction:: is_rarfile
Module Configuration
--------------------
.. autodata:: UNRAR_TOOL
.. autodata:: DEFAULT_CHARSET
.. autodata:: TRY_ENCODINGS
.. autodata:: USE_DATETIME
.. autodata:: PATH_SEP
.. autodata:: NEED_COMMENTS
.. autodata:: UNICODE_COMMENTS
.. autodata:: REPORT_BAD_HEADER
.. autodata:: USE_EXTRACT_HACK
.. autodata:: HACK_SIZE_LIMIT
Constants
---------
.. py:data:: RAR_M0
No compression.
.. py:data:: RAR_M1
Compression level `-m1` - Fastest compression.
.. py:data:: RAR_M2
Compression level `-m2`.
.. py:data:: RAR_M3
Compression level `-m3`.
.. py:data:: RAR_M4
Compression level `-m4`.
.. py:data:: RAR_M5
Compression level `-m5` - Maximum compression.
.. py:data:: RAR_OS_MSDOS
.. py:data:: RAR_OS_OS2
.. py:data:: RAR_OS_WIN32
.. py:data:: RAR_OS_UNIX
.. py:data:: RAR_OS_MACOS
.. py:data:: RAR_OS_BEOS
Exceptions
----------
.. autoclass:: Error
.. autoclass:: BadRarFile
.. autoclass:: NotRarFile
.. autoclass:: BadRarName
.. autoclass:: NoRarEntry
.. autoclass:: PasswordRequired
.. autoclass:: NeedFirstVolume
.. autoclass:: NoCrypto
.. autoclass:: RarExecError
.. autoclass:: RarWarning
.. autoclass:: RarFatalError
.. autoclass:: RarCRCError
.. autoclass:: RarLockedArchiveError
.. autoclass:: RarWriteError
.. autoclass:: RarOpenError
.. autoclass:: RarUserError
.. autoclass:: RarMemoryError
.. autoclass:: RarCreateError
.. autoclass:: RarNoFilesError
.. autoclass:: RarUserBreak
.. autoclass:: RarUnknownError
.. autoclass:: RarSignalExit
|