File: api.rst

package info (click to toggle)
python-rarfile 4.2-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,308 kB
  • sloc: python: 4,180; makefile: 201; sh: 88; awk: 14
file content (97 lines) | stat: -rw-r--r-- 1,730 bytes parent folder | download
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

rarfile API documentation
=========================

.. contents:: Table Of Contents

Introduction
------------

.. automodule:: rarfile

RarFile class
-------------

.. autoclass:: RarFile
   :members:
   :special-members: __enter__, __exit__, __iter__

RarInfo class
-------------

.. autoclass:: RarInfo
   :members:

RarExtFile class
----------------

.. autoclass:: RarExtFile
   :show-inheritance:
   :members:
   :inherited-members:
   :exclude-members: truncate, flush

nsdatetime class
----------------

.. autoclass:: nsdatetime
   :show-inheritance:
   :members:

Functions
---------

.. autofunction:: is_rarfile
.. autofunction:: is_rarfile_sfx

Constants
---------

.. autodata:: RAR_M0
.. autodata:: RAR_M1
.. autodata:: RAR_M2
.. autodata:: RAR_M3
.. autodata:: RAR_M4
.. autodata:: RAR_M5

.. autodata:: RAR_OS_WIN32
.. autodata:: RAR_OS_UNIX
.. autodata:: RAR_OS_MACOS
.. autodata:: RAR_OS_BEOS
.. autodata:: RAR_OS_OS2
.. autodata:: RAR_OS_MSDOS

Warnings
--------

.. autoclass:: UnsupportedWarning

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:: RarWrongPassword
.. autoclass:: RarUnknownError
.. autoclass:: RarSignalExit
.. autoclass:: RarCannotExec