v1.8.0: CLI and Abort Improvements

[MPZ-00]

This release brings major improvements to the command-line interface, custom filename generation, and graceful abort handling for voe-dl.

New Features

Custom Filename Generation

• --name flag: Set custom base names for downloaded videos
• --numbering flag: Automatically add episode numbering in S##E## format
  • Extracts episode tags from URLs (e.g., S01E05, S2E10)
  • Generates sequential numbering if no tag is found
  • Supports flexible formats (S1E5 to S99E99)
  • Defaults to "Episode" prefix when used without --name
• #: title prefix: Set a custom title for batch downloads by adding #: Title as the first line in your links file

Dry-Run Mode

• --dry-run flag: Test your download setup without actually downloading files
• Perfect for validating links, checking filename patterns, and testing configurations

Graceful Abort Handling

• Ctrl+C support: Press Ctrl+C to gracefully abort all downloads
• SIGINT signal handler: Immediate response to abort signals (no waiting for blocking I/O)
• Interactive cleanup prompt: Choose whether to keep or delete .part files after abort
  • Keep: Resume downloads later
  • Delete: Start fresh next time
• Progress hooks: yt-dlp downloads now respect abort signals during active transfers
• Custom exception: New DownloadAbortedException for clearer error handling

Enhanced CLI

• Mutually exclusive arguments: -u (single URL) and -l (list file) are now properly validated
• Worker control: Configure parallel download threads with -w flag (default: 4)

Improvements

Multi-Threading Enhancements

• Global stop event for coordinating abort across all threads
• Proper executor shutdown with future cancellation on abort
• Thread-safe argument passing using copy.copy()
• Separate success and failure counters for better progress reporting
• Eliminated code duplication with helper functions

Better User Experience

• Output flushing to prevent interleaved messages from threads
• Clear status messages for downloads in progress
• Improved error reporting with detailed failure information

Bug Fixes

• Fixed Ctrl+C not stopping downloads immediately
• Fixed PermissionError when cleaning up .part files during active downloads
• Fixed CancelledError tracebacks appearing in console
• Fixed redundant future completion checks
• Fixed signal handler being registered multiple times

Documentation

• Comprehensive README updates with examples for all new features
• CHANGELOG fully updated with all changes
• Build instructions maintained in BUILD.md

Credits

Special thanks to all contributors and the GitHub Copilot review system for helping improve code quality!

Installation

Download voe-dl.exe from the releases page or run from source:

git clone https://github.com/MPZ-00/voe-dl.git
cd voe-dl
pip install -r requirements.txt
python dl.py -h

Example Usage

# Single download with custom name
voe-dl -u https://voe.sx/video --name "MyVideo"

# Batch download with episode numbering
voe-dl -l links.txt --name "Series Name" --numbering

# Test without downloading
voe-dl -l links.txt --dry-run

# 8 parallel downloads
voe-dl -l links.txt -w 8

---

Full Changelog: v1.7.3...v1.8.0

---

This discussion was created from the release v1.8.0: CLI and Abort Improvements.