python-cabarchive

https://python-cabarchive.readthedocs.io/
Admin
python-cabarchive is a Python library for parsing and writing Microsoft Cabinet (CAB) archive files,...
Tokens:1,976
Snippets:28
Trust Score:9.6
Update:5 months ago
Show doc for...
Tokens:
Raw
### Create and Save a CAB Archive

Source: https://python-cabarchive.readthedocs.io

Shows how to create a new CabArchive instance, add files to it using CabFile objects, and then save the archive to a byte string.

```python
arc = CabArchive()
arc["test.txt"] = CabFile("test123".encode())
with open("test.cab", "wb") as f:
    f.write(arc.save())
```

--------------------------------

### Load and Read a CAB Archive

Source: https://python-cabarchive.readthedocs.io

Demonstrates how to open a .cab file, read its contents into a CabArchive instance, and access individual files and their metadata. Treats the CabArchive instance like a dictionary.

```python
with open("test.cab", "rb") as f:
    arc = CabArchive(f.read())
cff = arc["test.txt"]
print("filename", cff.filename)     # "test.txt"
print("contents", cff.buf)          # b"test123"
print("created", cff.date.year)     # 2015
for fn in arc:
    print(fn)                       # "test.txt"
```

--------------------------------

### Create a CabFile Instance

Source: https://python-cabarchive.readthedocs.io

Illustrates how to create a CabFile object with specific byte content. If the modification time is not set, the current date and time is used.

```python
cff = CabFile(b"test123")
```

--------------------------------

### CabArchive.parse

Source: https://python-cabarchive.readthedocs.io

Parses binary data from a .cab file into the CabArchive instance.

```APIDOC
## parse(_buf : bytes_) → None

### Description
Parse .cab binary data.

### Parameters
* `self`: A CabArchive instance.
* `bytes` (bytes): Binary blob loaded from disk.

### Raises
* `CorruptionError`: The cab file was invalid or corrupt.
* `NotSupportedError`: The format was not supported, e.g. unknown compression.
```

--------------------------------

### CabFile.time

Source: https://python-cabarchive.readthedocs.io

Property representing the creation time of the file.

```APIDOC
## time _: Optional[datetime.time]¶

### Description
time the file was created
```

--------------------------------

### NotSupportedError Exception

Source: https://python-cabarchive.readthedocs.io

Exception raised when a CAB file format is not supported.

```APIDOC
## exception cabarchive.NotSupportedError

### Description
Bases: `Exception`
The format was not supported, e.g. unknown compression.
```

--------------------------------

### CabFile.is_system

Source: https://python-cabarchive.readthedocs.io

Boolean flag indicating if the file is a system file.

```APIDOC
## is_system¶

### Description
set if file is a system file
```

--------------------------------

### CabFile.date

Source: https://python-cabarchive.readthedocs.io

Property representing the creation date of the file.

```APIDOC
## date _: Optional[datetime.date]¶

### Description
date the file was created
```

--------------------------------

### CabArchive Class

Source: https://python-cabarchive.readthedocs.io

The CabArchive class allows for parsing and writing MS Cabinet archives. It can be treated like a dictionary for accessing archive contents.

```APIDOC
## class cabarchive.CabArchive(_buf : Optional[bytes] = None_, _flattern : bool = False_)

### Description
This instance allows parsing or writing a MS Cabinet archive. You can treat the CabArchive instance like a dictionary when reading and writing archives.

### Parameters
* `_buf` (Optional[bytes]): The binary data of the cabinet archive.
* `_flattern` (bool): Whether to flatten the archive structure.

### Example (Reading)
```python
with open("test.cab", "rb") as f:
    arc = CabArchive(f.read())
cff = arc["test.txt"]
print("filename", cff.filename)     # "test.txt"
print("contents", cff.buf)          # b"test123"
print("created", cff.date.year)     # 2015
for fn in arc:
    print(fn)                       # "test.txt"
```

### Example (Writing)
```python
arc = CabArchive()
arc["test.txt"] = CabFile("test123".encode())
with open("test.cab", "wb") as f:
    f.write(arc.save())
```
```

--------------------------------

### CabArchive.save

Source: https://python-cabarchive.readthedocs.io

Serializes the archive contents into binary data, with options for compression and sorting.

```APIDOC
## save(_compress : bool = False_, _sort : bool = True_) → bytes

### Description
Returns cabinet file data, optionally compressed.

### Parameters
* `self`: A CabArchive instance.
* `compress` (bool): If the binary data should be compressed.
* `sort` (bool): If the file lists should be sorted in a predictable order.

### Returns
The blob of memory that can be written to disk.
```

--------------------------------

### CabFile.is_exec

Source: https://python-cabarchive.readthedocs.io

Boolean flag indicating if the file is executable.

```APIDOC
## is_exec¶

### Description
set if file is executable
```

--------------------------------

### CabFile.buf

Source: https://python-cabarchive.readthedocs.io

Property representing the byte content of the file.

```APIDOC
## buf¶

### Description
bytes to use for the file contents
```

--------------------------------

### CabFile.is_arch

Source: https://python-cabarchive.readthedocs.io

Boolean flag indicating if the file has been modified since the last backup.

```APIDOC
## is_arch¶

### Description
set if file modified since last backup
```

--------------------------------

### CabFile Class

Source: https://python-cabarchive.readthedocs.io

Represents a single file within a Cab archive, holding its content and metadata.

```APIDOC
## class cabarchive.CabFile(_buf : Optional[bytes] = None_, _filename : Optional[str] = None_, _mtime : Optional[datetime.datetime] = None_)

### Description
An object representing a file in a Cab archive. Any number of CabFile instances can be stored in a CabArchive. A new instance can be created with just the data bytes or with an additional `mtime`. If the modification time is not set then the current date and time is used, which may be unhelpful if you require reproducible builds.

### Parameters
* `_buf` (Optional[bytes]): The data bytes for the file content.
* `_filename` (Optional[str]): The filename to be used in the archive.
* `_mtime` (Optional[datetime.datetime]): The modification time of the file.

### Example
```python
cff = CabFile(b"test123")
```
```

--------------------------------

### CabFile.filename

Source: https://python-cabarchive.readthedocs.io

Property representing the filename of the file within the archive.

```APIDOC
## property filename _: Optional[str]¶

### Description
filename to use in the archive
```

--------------------------------

### CabArchive.find_files

Source: https://python-cabarchive.readthedocs.io

Retrieves all files from the archive that match a given glob pattern.

```APIDOC
## find_files(_glob : str_) → List[cabarchive.file.CabFile]

### Description
Gets files from the archive using a glob.

### Parameters
* `self`: A CabArchive instance.
* `glob` (str): File glob, e.g. `*.txt`

### Returns
All CabFile objects that match the filename glob, or None.
```

--------------------------------

### CabArchive.find_file

Source: https://python-cabarchive.readthedocs.io

Retrieves a single file from the archive that matches a given glob pattern.

```APIDOC
## find_file(_glob : str_) → Optional[cabarchive.file.CabFile]

### Description
Gets a file from the archive using a glob.

### Parameters
* `self`: A CabArchive instance.
* `glob` (str): File glob, e.g. `*.txt`

### Returns
The first CabFile that matches the filename glob, or None.
```

--------------------------------

### CorruptionError Exception

Source: https://python-cabarchive.readthedocs.io

Exception raised when a CAB file is found to be invalid or corrupt.

```APIDOC
## exception cabarchive.CorruptionError

### Description
Bases: `Exception`
The cab file was invalid or corrupt.
```

--------------------------------

### CabFile.is_readonly

Source: https://python-cabarchive.readthedocs.io

Boolean flag indicating if the file is read-only.

```APIDOC
## is_readonly¶

### Description
set if file is read-only
```

--------------------------------

### CabFile.is_hidden

Source: https://python-cabarchive.readthedocs.io

Boolean flag indicating if the file is hidden.

```APIDOC
## is_hidden¶

### Description
set if file is hidden
```

--------------------------------

### CabArchive.set_id

Source: https://python-cabarchive.readthedocs.io

Sets the 'Set ID' for multi-file archives.

```APIDOC
## set_id _: int_

### Description
The “Set ID” used for multi-file archives.
```
Tokens:
Raw