PySquashfsImage

https://pypi.org/project/PySquashfsImage/
Admin
PySquashfsImage is a lightweight library and tool for reading and extracting squashfs 4.0 little...
Tokens:2,939
Snippets:39
Trust Score:10
Update:5 months ago
Show doc for...
Tokens:
Raw
### Install PySquashfsImage

Source: https://pypi.org/project/PySquashfsImage

Install the PySquashfsImage library using pip. Ensure you have Python 2.7 or a compatible Python 3 version installed.

```bash
pip install PySquashfsImage
```

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

### Print absolute paths of all entries using a context manager

Source: https://pypi.org/project/PySquashfsImage

Use a context manager to ensure the Squashfs image is properly closed. This example iterates through all entries and prints their absolute paths.

```python
from PySquashfsImage import SquashFsImage

# Use with a context manager (recommended).
with SquashFsImage.from_file('/path/to/my/image.img') as image:
    for file in image:
        print(file.path)
```

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

### List Squashfs Image Contents

Source: https://pypi.org/project/PySquashfsImage

Use `pysquashfs list` to display the contents of a squashfs filesystem. Options allow for recursive listing and filtering by file type.

```bash
$ pysquashfs list -h
```

```bash
$ pysquashfs list myimage.img -r -t d
```

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

### List all elements in a Squashfs image

Source: https://pypi.org/project/PySquashfsImage

Iterate through all items in a Squashfs image file and print their names. The image is opened from a file path and closed afterwards.

```python
from PySquashfsImage import SquashFsImage

image = SquashFsImage.from_file('/path/to/my/image.img')
for item in image:
    print(item.name)
image.close()
```

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

### Save a directory's content from a Squashfs image

Source: https://pypi.org/project/PySquashfsImage

Select a directory from the Squashfs image and extract its entire content to a specified local path. The `extract_dir` function handles metadata preservation.

```python
from PySquashfsImage import SquashFsImage
from PySquashfsImage.extract import extract_dir

with SquashFsImage.from_file('/path/to/my/image.img') as image:
    mydir = image.select("/mydir")
    if mydir is not None:
        # Metadata is handled the same way as with extract_file().
        extract_dir(mydir, "/tmp/mydir")
```

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

### Save a file's content from a Squashfs image

Source: https://pypi.org/project/PySquashfsImage

Find a specific file within the Squashfs image and save its content to a local file. For large files, it is recommended to iterate over the content blocks.

```python
from PySquashfsImage import SquashFsImage
from PySquashfsImage.extract import extract_file

with SquashFsImage.from_file('/path/to/my/image.img') as image:
    myfile = image.find('myfilename')
    if myfile is not None:
        with open('/tmp/' + myfile.name, 'wb') as f:
            print('Saving original ' + myfile.path + ' in /tmp/' + myfile.name)
            f.write(myfile.read_bytes())

    # If the file is large it's preferable to iterate over its content.
    hugefile = image.select("/hugedir/myhugefile.big")
    with open("myhugefile.big", "wb") as f:
        for block in hugefile.iter_bytes():
            f.write(block)

    # Or use extract_file(), which preserves the file's metadata (except extended attributes).
    extract_file(myfile, "myextractedfile")
```

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

### Extract Files from Squashfs Image

Source: https://pypi.org/project/PySquashfsImage

The `pysquashfs extract` command allows you to extract files and directories from a squashfs image to a specified destination. The `-f` flag can be used to overwrite existing files.

```bash
$ pysquashfs extract -h
```

```bash
$ pysquashfs extract myimage.img -p /bin -d /tmp
```

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

### Print non-directory entries from image bytes

Source: https://pypi.org/project/PySquashfsImage

Create a Squashfs image object from raw bytes read from a file. This snippet iterates through the entries and prints the paths of items that are not directories.

```python
from PySquashfsImage import SquashFsImage

with open('/path/to/my/image.img', "rb") as f:
    imgbytes = f.read()

# Create an image from bytes.
with SquashFsImage.from_bytes(imgbytes) as image:
    for item in image:
        if not item.is_dir:
            print(item.path)
```

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

### Scan Squashfs Image for Superblocks

Source: https://pypi.org/project/PySquashfsImage

Use `pysquashfs scan` to find and display information about all superblocks within a squashfs file. This is useful for identifying the filesystem's metadata.

```bash
$ pysquashfs scan -h
```

```bash
$ pysquashfs scan myimage.img
```
Tokens:
Raw