semvec/pypi-packages huggingface dataset:
unrar2-cffi 0.4.1
Read RAR file from python -- cffi edition
Requires Python: >=3.9
Keywords: rar, unrar, archive, cffi

[![Build](https://github.com/noaione/unrar2-cffi/actions/workflows/build.yml/badge.svg)](https://github.com/noaione/unrar2-cffi/actions/workflows/build.yml)

# unrar2-cffi -- Work with RAR files.

## Description

unrar2-cffi is a python extension that exposes [unrar library](https://rarlab.com/rar_add.htm)
functionality through a [`zipfile`](https://docs.python.org/3/library/zipfile.html)-like interface.

This is a fork/modified version of [unrar-cffi](https://pypi.org/project/unrar-cffi/) that supports modern Python starting from 3.9+

This build also target unrar 7.x instead of unrar 5.x from the original unrar-cffi project.

## Difference

This packages has some difference to the original one:
- Added typing information
- Added `__slots__` to improve performance a bit.
- Moved all the `RarInfo` into at-property data
  - Now you can access the raw header data by using `file._header`
- Added docstring to most functions.
- Implement `RarFile.printdir()`

## Features

The package implements the following `RarFile` functions:

 * `namelist()`
 * `infolist()`
 * `getinfo()`
 * `read()`
 * `open()`
 * `testrar()`
 * `rarfile.is_rar_file()`

## Usage

 1. Install with PIP:

    `pip install unrar2-cffi`

 2. Use from code:

```python
from unrar.cffi import rarfile

rar = rarfile.RarFile('sample.rar')

assert rar.testrar() == None

for filename in rar.namelist():
    info = rar.getinfo(filename)
    print("Reading {}, {}, {} bytes ({} bytes compressed)".format(info.filename, info.date_time, info.file_size, info.compress_size))
    data = rar.read(filename)
    print("\t{}...\n".format(data[:100]))
```

## Build

### Requirements
Linux/macOS:
 * gcc compiler suite (`build-essential` packages should be enough)
 * docker (only for `buildmanylinux`)

Windows:
 * VS2022 Build Tools (PLATFORM_TOOLSET=v143)
 * Visual C++ compiler suite
 * `vswhere`

### Build
1. Run `pip install -r requirements.txt` to install the build dependencies.
2. If you are on Windows, make sure you use the VS2022 Build Tools
3. Run `pip install .` to build the package.

### Workarounds
Windows:
* If you need to retarget solution, apply the `0001-build-retarget-to-vs2022-10.0-v143.patch` that will utilize the latest version.