This commit is contained in:
jpmvaz
2026-09-13 19:48:16 +01:00
commit 3e287bda1a
7 changed files with 2375 additions and 0 deletions
+253
View File
@@ -0,0 +1,253 @@
# 📦 Folder Compressor
A command-line Python script that lets you pick any sub-folder and compress it into a `.7z` archive using **7-Zip** with **no compression (store mode)** — maximum speed, zero CPU overhead.
---
## Features
- Browse and select from all sub-folders in any directory
- Displays folder sizes before you choose
- Real-time progress bar with:
- Percentage complete
- Elapsed time
- Live transfer speed (MB/s)
- File count
- Currently processing file name
- Summary report on completion (source size, archive size, time, avg speed)
- Color-coded terminal output (auto-disabled if not supported)
- Cross-platform: Windows, macOS, Linux
---
## Requirements
### Python
Version **3.10 or higher** is required (uses `str | None` union type syntax).
Check your version:
```bash
python --version
# or
python3 --version
```
No third-party packages are needed — only Python's standard library is used.
### 7-Zip
7-Zip must be installed and accessible on your system PATH.
| Platform | Install command |
|----------|----------------|
| **Linux** (Debian/Ubuntu) | `sudo apt install p7zip-full` |
| **Linux** (Fedora/RHEL) | `sudo dnf install p7zip p7zip-plugins` |
| **macOS** (Homebrew) | `brew install p7zip` |
| **macOS** (MacPorts) | `sudo port install p7zip` |
| **Windows** | Download installer from [https://www.7-zip.org/download.html](https://www.7-zip.org/download.html) |
> **Windows note:** After installing, make sure `C:\Program Files\7-Zip\` is added to your system PATH, or the script will auto-detect it from the default install location automatically.
> **Minimum version:** 7-Zip **15.06 or newer** is required for the `-bsp1` progress flag used for real-time output. Most current installs will meet this requirement.
Verify 7-Zip is available:
```bash
7z i
```
---
## Installation
No installation needed. Just download the script:
```bash
# Download compress_folder.py to any directory, then run it directly with Python
```
Optionally make it executable on Linux/macOS:
```bash
chmod +x compress_folder.py
```
---
## Usage
### Basic — scan the current directory
```bash
python compress_folder.py
```
### Specify a directory to scan
```bash
python compress_folder.py /path/to/directory
```
### On Linux/macOS (if made executable)
```bash
./compress_folder.py
./compress_folder.py /path/to/directory
```
### On Windows
```bash
python compress_folder.py
python compress_folder.py C:\Users\YourName\Documents
```
---
## Step-by-step walkthrough
**1. Launch the script**
```
📦 Folder Compressor
Scanning: /home/user/projects
```
**2. Browse the folder list**
All sub-folders are listed with their sizes:
```
Available folders:
[ 1] archive (240.0 MB)
[ 2] builds (1.4 GB)
[ 3] logs (88.3 MB)
[ 4] source (320.5 MB)
Enter the number of the folder to compress:
```
**3. Select a folder**
Type the number and press Enter:
```
Enter the number of the folder to compress: 2
✔ Selected: builds
Calculating source size… 1.4 GB
```
**4. Watch real-time progress**
The progress display updates live in your terminal:
```
████████████████░░░░░░░░░░░░░░░░░░░ 62% elapsed 0m 08s 178.4 MB/s files: 312
↳ builds/release/v2.1.0/installer.exe
```
| Element | Description |
|---------|-------------|
| `████░░░` | Progress bar filling left to right |
| `62%` | Percentage of files processed |
| `elapsed 0m 08s` | Time since compression started |
| `178.4 MB/s` | Rolling average throughput speed |
| `files: 312` | Number of files added so far |
| `↳ filename` | The file currently being processed |
**5. Completion summary**
```
✅ Archive created successfully!
Path : /home/user/projects/builds.7z
Source : 1.4 GB
Archive : 1.4 GB
Time : 0m 09s
Avg speed: 159.2 MB/s
```
The `.7z` archive is saved in the **same parent directory** as the folder you selected.
---
## Compression settings
The script uses the following 7-Zip flags:
| Flag | Value | Meaning |
|------|-------|---------|
| `-t7z` | — | Output format: 7z |
| `-mx=0` | 0 | Compression level 0 = **store** (no compression) |
| `-ms=off` | off | Solid archive **disabled** (faster for many files) |
| `-bsp1` | — | Stream progress output to stdout (enables live display) |
**Why no compression?**
Store mode (`-mx=0`) copies files into the archive as-is without compressing them. This is ideal when:
- Speed matters more than file size reduction
- The contents are already compressed (videos, images, zip files, etc.)
- You want to bundle files for transfer without the CPU cost of compression
---
## How the real-time progress works
7-Zip does not write progress on separate lines — instead it continuously overwrites the same terminal line using special control characters. The exact character it uses depends on the platform:
| Platform | Character used | Code |
|----------|---------------|------|
| Linux / macOS | Backspace | `\x08` |
| Windows | Carriage return | `\r` |
The script reads 7-Zip's output as a raw binary stream and splits on **both** characters, so progress is captured correctly on every platform. The percentage, file count, and current filename are extracted from each segment using a regex and rendered live into two reserved terminal lines that update in place.
---
## Output location
The archive is always created in the **same directory that contains the selected folder**.
Example:
```
/home/user/projects/ ← scanned directory
builds/ ← selected folder
builds.7z ← archive created here
```
If an archive with the same name already exists, 7-Zip will update it (adding/replacing files). Delete the existing `.7z` first if you want a clean archive.
---
## Troubleshooting
**`7-Zip not found` error**
- Ensure 7-Zip is installed (see Requirements above)
- Confirm `7z` is on your PATH: run `which 7z` (Linux/macOS) or `where 7z` (Windows)
- On Windows, try re-installing 7-Zip and ticking the "Add to PATH" option, or place `7z.exe` in `C:\Program Files\7-Zip\` which the script checks automatically
**Progress bar stays at 0% / no stats shown**
- This was a known bug that has been fixed. Make sure you are using the latest version of the script.
- The root cause was that Windows 7-Zip uses `\r` to update progress lines while Linux/macOS uses `\x08` (backspace). The old version only handled backspaces, so on Windows the progress stream was never parsed. The current version handles both.
- If you still see 0% after updating, confirm your 7-Zip version is 15.06 or newer: run `7z i` and check the version line at the top.
**No progress bar / garbled output**
- The live progress display requires a terminal that supports ANSI escape codes
- On older Windows CMD, switch to Windows Terminal or PowerShell
- Progress and stats are still printed even if color/ANSI is not supported
**`SyntaxError` on startup**
- Your Python version is below 3.10 — upgrade to Python 3.10+
**Permission denied on folder**
- Run the script with elevated permissions (`sudo` on Linux/macOS, Run as Administrator on Windows)
- Or select a folder you have read access to
---
## Examples
```bash
# Compress a folder in the current directory (interactive)
python compress_folder.py
# Compress a folder inside a specific path
python compress_folder.py /mnt/data/backups
# Windows example
python compress_folder.py "C:\Users\Alice\Desktop"
```
---
## License
This script is provided as-is for personal and commercial use. No warranty is expressed or implied.
+329
View File
@@ -0,0 +1,329 @@
#!/usr/bin/env python3
"""
Folder Compressor using 7-Zip
Lists available folders, lets you select one, and compresses it
using 7-Zip with no compression (store) at fastest speed.
Real-time progress bar shown during compression.
"""
import os
import re
import sys
import shutil
import subprocess
import time
from pathlib import Path
# ── Terminal color helpers ────────────────────────────────────────────────────
SUPPORTS_COLOR = (
sys.stdout.isatty()
and (sys.platform != "win32" or os.environ.get("WT_SESSION") or os.environ.get("TERM"))
)
def _c(code: str, text: str) -> str:
return f"\033[{code}m{text}\033[0m" if SUPPORTS_COLOR else text
def green(t): return _c("32", t)
def yellow(t): return _c("33", t)
def cyan(t): return _c("36", t)
def bold(t): return _c("1", t)
def dim(t): return _c("2", t)
def red(t): return _c("31", t)
# ── Size / time formatters ────────────────────────────────────────────────────
def fmt_size(b: float) -> str:
for unit in ("B", "KB", "MB", "GB", "TB"):
if b < 1024:
return f"{b:.1f} {unit}"
b /= 1024
return f"{b:.1f} PB"
def fmt_time(seconds: float) -> str:
s = int(seconds)
if s < 60:
return f"{s}s"
m, s = divmod(s, 60)
if m < 60:
return f"{m}m {s:02d}s"
h, m = divmod(m, 60)
return f"{h}h {m:02d}m {s:02d}s"
# ── Folder size calculator ────────────────────────────────────────────────────
def folder_size(path: Path) -> int:
total = 0
for root, _, files in os.walk(path):
for f in files:
try:
total += os.path.getsize(os.path.join(root, f))
except OSError:
pass
return total
# ── 7-Zip locator ─────────────────────────────────────────────────────────────
def find_7zip() -> str | None:
for name in ("7z", "7za", "7zz", "7zip"):
path = shutil.which(name)
if path:
return path
if sys.platform == "win32":
for p in (
r"C:\Program Files\7-Zip\7z.exe",
r"C:\Program Files (x86)\7-Zip\7z.exe",
):
if os.path.isfile(p):
return p
return None
# ── Folder listing / selection ────────────────────────────────────────────────
def list_folders(base_dir: str) -> list[Path]:
base = Path(base_dir)
return sorted(
(e for e in base.iterdir() if e.is_dir()),
key=lambda p: p.name.lower(),
)
def prompt_folder_selection(folders: list[Path]) -> Path:
print("\nAvailable folders:\n")
for i, folder in enumerate(folders, start=1):
try:
sz = folder_size(folder)
size_label = dim(f" ({fmt_size(sz)})")
except PermissionError:
size_label = dim(" (no access)")
print(f" {dim(f'[{i:>3}]')} {folder.name}{size_label}")
print()
while True:
try:
raw = input("Enter the number of the folder to compress: ").strip()
idx = int(raw)
if 1 <= idx <= len(folders):
return folders[idx - 1]
print(f" Please enter a number between 1 and {len(folders)}.")
except ValueError:
print(" Invalid input — please enter a number.")
except (EOFError, KeyboardInterrupt):
print("\nAborted.")
sys.exit(0)
# ── Progress bar renderer ─────────────────────────────────────────────────────
BAR_WIDTH = 36
# Matches 7-Zip progress segments like "47% 3 + path/to/file.bin"
# or just "47%" when no file is on the same segment
_PROGRESS_RE = re.compile(r"(\d{1,3})%(?:\s+(\d+)\s*\+?\s*(.*))?")
# Split on ANY run of backspaces (\x08) or carriage returns (\r).
# - Linux/macOS 7-Zip uses \x08 to erase and rewrite the progress line
# - Windows 7-Zip uses \r to overwrite the progress line
# Both need to be handled so the script works cross-platform.
_SPLIT_RE = re.compile(rb"[\x08\r]+")
def _move_up(n: int):
if SUPPORTS_COLOR:
sys.stdout.write(f"\033[{n}A")
def _clear_line():
if SUPPORTS_COLOR:
sys.stdout.write("\033[2K\r")
else:
sys.stdout.write("\r" + " " * 78 + "\r")
def _redraw(pct: int, elapsed: float, files_done: int,
current_file: str, speed_bps: float):
"""Overwrite the two reserved progress lines in-place."""
filled = int(BAR_WIDTH * pct / 100)
bar = "" * filled + "" * (BAR_WIDTH - filled)
color = green if pct == 100 else cyan
speed_s = f"{fmt_size(speed_bps)}/s" if speed_bps > 0 else ""
_move_up(2)
# Line 1 — bar + stats
_clear_line()
sys.stdout.write(
f" {color(bar)} {bold(f'{pct:>3}%')}"
f" {dim('elapsed')} {dim(fmt_time(elapsed))}"
f" {yellow(speed_s)}"
f" {dim(f'files: {files_done}')}\n"
)
# Line 2 — current file
_clear_line()
label = current_file.strip() or "starting…"
if len(label) > 60:
label = "" + label[-59:]
sys.stdout.write(f" {dim('' + label)}\n")
sys.stdout.flush()
# ── Compression with real-time progress ───────────────────────────────────────
def compress_folder(seven_zip: str, folder: Path, output_dir: Path) -> Path:
archive_path = output_dir / (folder.name + ".7z")
print(f"\n {dim('Calculating source size…')} ", end="", flush=True)
src_size = folder_size(folder)
print(fmt_size(src_size))
cmd = [
seven_zip,
"a",
"-t7z",
"-mx=0", # store no compression
"-ms=off", # no solid archive
"-bsp1", # stream progress to stdout
str(archive_path),
str(folder),
]
print(f"\n {dim('Command: ' + ' '.join(cmd))}")
print()
print(" " + "" * 64)
# Reserve two blank lines for the live display
print()
print()
start_time = time.monotonic()
last_pct = 0
files_done = 0
current_file = ""
speed_bps = 0.0
last_bytes = 0.0
speed_ts = start_time
proc = subprocess.Popen(
cmd,
stdout=subprocess.PIPE,
stderr=subprocess.STDOUT,
# Raw binary — we parse bytes ourselves to handle \x08 and \r
)
buf = b""
while True:
chunk = proc.stdout.read(256)
if not chunk:
break
buf += chunk
elapsed = time.monotonic() - start_time
# Split on runs of \x08 (Linux/macOS) or \r (Windows).
# Each segment between separators is one "visible write" from 7-Zip.
segments = _SPLIT_RE.split(buf)
# Keep the last (potentially incomplete) segment for the next iteration
buf = segments[-1]
for seg in segments[:-1]:
text = seg.decode("utf-8", errors="replace").strip()
if not text:
continue
m = _PROGRESS_RE.search(text)
if m:
pct = min(int(m.group(1)), 100)
files_done = int(m.group(2)) if m.group(2) else files_done
fname = (m.group(3) or "").strip()
if fname:
current_file = fname
# Rolling speed estimate (recalculate every 0.4 s)
if src_size > 0 and pct > 0:
bytes_done = src_size * pct / 100
now = time.monotonic()
dt = now - speed_ts
if dt >= 0.4:
speed_bps = (bytes_done - last_bytes) / dt
last_bytes = bytes_done
speed_ts = now
last_pct = pct
_redraw(pct, elapsed, files_done, current_file, speed_bps)
proc.wait()
elapsed_total = time.monotonic() - start_time
# Lock bar at 100% on success
if proc.returncode == 0:
_redraw(100, elapsed_total, files_done, current_file, speed_bps)
print()
print(" " + "" * 64)
if proc.returncode == 0:
arc_size = archive_path.stat().st_size
avg_speed = src_size / elapsed_total if elapsed_total > 0 else 0
print(f"\n {green('✅ Archive created successfully!')}")
print(f" {bold('Path')} : {archive_path}")
print(f" {bold('Source')} : {fmt_size(src_size)}")
print(f" {bold('Archive')} : {fmt_size(arc_size)}")
print(f" {bold('Time')} : {fmt_time(elapsed_total)}")
print(f" {bold('Avg speed')}: {fmt_size(avg_speed)}/s")
else:
print(f"\n {red(f'❌ 7-Zip exited with code {proc.returncode}.')}")
sys.exit(proc.returncode)
return archive_path
# ── Entry point ───────────────────────────────────────────────────────────────
def main():
scan_dir = os.path.abspath(sys.argv[1] if len(sys.argv) > 1 else os.getcwd())
if not os.path.isdir(scan_dir):
print(f"Error: '{scan_dir}' is not a valid directory.")
sys.exit(1)
print(f"\n{bold('📦 Folder Compressor')}")
print(f" Scanning: {cyan(scan_dir)}\n")
seven_zip = find_7zip()
if not seven_zip:
print(
f"\n{red('❌ 7-Zip not found.')}\n"
" Install it and make sure '7z' (or '7za') is on your PATH.\n"
" • Linux : sudo apt install p7zip-full\n"
" • macOS : brew install p7zip\n"
" • Windows: https://www.7-zip.org/download.html"
)
sys.exit(1)
print(f" {green('')} 7-Zip: {dim(seven_zip)}")
folders = list_folders(scan_dir)
if not folders:
print(f"\nNo sub-folders found in '{scan_dir}'.")
sys.exit(0)
chosen = prompt_folder_selection(folders)
print(f"\n {green('')} Selected: {bold(chosen.name)}")
compress_folder(seven_zip, chosen, chosen.parent)
print()
if __name__ == "__main__":
main()