Skip to main content

The fastest Android super.img dumper, made in Python.

Project description

unsuper

The fastest Android super.img dumper, made in Python.

Version Downloads

Features

  • Extremely fast - Best in its class, see speed below
  • Unsparse support - Automatically unsparses images without any dependancies
  • Smart extraction - Automatically skips empty partitions
  • Selective usage - unsuper can extract only specific partitions or just unsparse the image

Installation

Download the script, or clone into the repository if you want to contribute / fork.

Download and install Python (3.6 and later) and add it to PATH.

Install the numpy module using pip install numpy.

Follow Usage.

Speed

unsuper can unsparse a 6.67GB super.img in only 11 seconds, and dump all available partitions in ~12 seconds on an average NVMe disk with the default of 4 threads. This puts the total extraction time to under 25 seconds, faster than any other competitor. This also means that V2.0 extracts partitions up to 2.5 times faster compared to V1.0.

Performance may vary based on the amount of threads and disk speeds. More threads doesn't always equal to higher speeds.

Usage

unsuper's usage is extremely easy: just state the path to your super.img and start. If no output directory is stated, unsuper will create an "extracted_partitions" folder under your home directory and use it as default.

Extra arguements come AFTER the positional arguements.

positional arguments:
  super_image           Path to super.img file
  output_dir            Output directory for extracted partitions (default: extracted_partitions)

options:
  -h, --help            show this help message and exit
  --version             show program's version number and exit
  -p, --partitions PARTITIONS [PARTITIONS ...]
                        Specific partition names to extract (vendor, product etc.) (default: extract all)
  -j, --jobs JOBS       Number of parallel extraction threads (default: 4)
  -q, --quiet           Suppress progress output
  --list                List available partitions and exit
  --temp-dir TEMP_DIR   Directory for temporary unsparse file (default: system temp directory)
  --unsparse            Unsparse image and save to output directory

For example, if you want to extract the system_a partition using 6 threads:

unsuper.py /path/to/super.img /output_path --partitions system_a --jobs 6

And so on.

unsuper can also simply unsparse an image and save it to a specified directory:

unsuper.py /path/to/super.img /output_path --unsparse

Or list all available partitions and clean after:

unsuper.py /path/to/super.img --list

Notes

If the --list arguement is used with --partitions, it will calculate the specified partitions' sizes and exit.

If the --unsparse arguement is used along with --partitions or --list, the unsparse image will be saved to the output directory and reused for extraction rather than creating a temporary one.

Extras

Enjoy my work? Please consider a small donation!

yellow-button

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

unsuper-2.0.2.tar.gz (10.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

unsuper-2.0.2-py3-none-any.whl (11.4 kB view details)

Uploaded Python 3

File details

Details for the file unsuper-2.0.2.tar.gz.

File metadata

  • Download URL: unsuper-2.0.2.tar.gz
  • Upload date:
  • Size: 10.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.4

File hashes

Hashes for unsuper-2.0.2.tar.gz
Algorithm Hash digest
SHA256 024767ceeeeddd889379ffd52b93e82cc0e537281a9c43cc22ae7f22770a1fe2
MD5 0a9e6fab1932cb08ae321214f6a693bc
BLAKE2b-256 23fc3126072de22d4fd0c67423637af7f9bfebfef1406213e3c7f3ee62a71666

See more details on using hashes here.

File details

Details for the file unsuper-2.0.2-py3-none-any.whl.

File metadata

  • Download URL: unsuper-2.0.2-py3-none-any.whl
  • Upload date:
  • Size: 11.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.4

File hashes

Hashes for unsuper-2.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 169b911fdb9280bfecfeaa41d1611da46972b1d0b6420bc31b44ce5f2445f80a
MD5 2c7cf6dc3947f3c2a1e378a329b1feee
BLAKE2b-256 cfba4782e93913f7869c02d9efe5f358bb35db5929a068841601f9d938e62632

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page