Skip to content

3 regex's (STDERR, STDIN, Python) to parse yt-dlp download progress, for live display in "Tasks" view #93

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jan 12, 2024
Merged

3 regex's (STDERR, STDIN, Python) to parse yt-dlp download progress, for live display in "Tasks" view #93

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4818439
3 regex's (STDERR, STDIN, Python) to parse yt-dlp download progress
holta Jan 12, 2024
67339be
download.py: Clarify regex alternatives
holta Jan 12, 2024
72ef717
scripts/lb-wrapper: Fix date typo
holta Jan 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions cps/tasks/download.py
View file
Open in desktop
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me

Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ def run(self, worker_thread):
"""Run the download task"""
self.worker_thread = worker_thread
log.info("Starting download task for URL: %s", self.media_url)
self.start_time = self.end_time = datetime.now()
self.start_time = self.end_time = datetime.now()
self.stat = STAT_STARTED
self.progress = 0

Expand All @@ -48,7 +48,9 @@ def run(self, worker_thread):
while p.poll() is None:
line = p.stdout.readline()
if line:
if pattern_progress in line:
#if "downloading" in line:
#if line.startswith("downloading"):
if re.search(pattern_progress, line):
percentage = int(re.search(r'\d+', line).group())
# 2024-01-10: 99% (a bit arbitrary) is explained here...
# https://github.com/iiab/calibre-web/pull/88#issuecomment-1885916421
Expand Down
20 changes: 12 additions & 8 deletions scripts/lb-wrapper
View file
Open in desktop
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Elegant routing!

Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,7 @@ mkdir -p ${TMP_DOWNLOADS_DIR}
log() {
local level=$1
local message=$2
if [[ $message == downloading* ]]; then
echo "$message"
else
echo "$(date +'%Y-%m-%d %H:%M:%S') - [$level] $message" | tee -a ${LOG_FILE}
fi
echo "$(date +'%Y-%m-%d %H:%M:%S') - [$level] $message" | tee -a ${LOG_FILE}
}

if [ $# -eq 0 ]; then
Expand Down Expand Up @@ -58,10 +54,18 @@ fi
log "Info" "Running xklb commands: ${XKLB_FULL_CMD}"

# >(...) "process substitution" explained at https://unix.stackexchange.com/a/324170
# 1>&2 redirect back-to-STDERR explained at https://stackoverflow.com/a/15936384
# 1>&2 redirect back-to-STDERR to avoid nested (repeat) logging, explained at https://stackoverflow.com/a/15936384
eval "${XKLB_FULL_CMD}" \
> >(while read -r line; do log "Info" "$line"; done) \
2> >(while read -r line; do log "Warning" "$line" 1>&2; done) &
> >(while read -r line; do if [[ $line == downloading* ]]; then echo "$line"; else log "Info" "$line"; fi; done) \
2> >(while read -r line; do if [[ $line == downloading* ]]; then echo "$line"; else log "Debug" "$line" 1>&2; fi; done) &
# 2024-01-11: HOW THIS WORKS...
# 0) xklb sends a flood of yt-dlp status message lines like "downloading 59.8% 2.29MiB/s" to STDERR.
# 1) Then, "2> >(...)" reroutes (only those raw lines!) to STDIN, instead of logging them (as "Debug" lines).
# 2) Then, upon receiving them at STDIN, "> >(...)" again prevents (only those raw lines!) from being logged (as "Info" messages).
# 3) Then, cps/tasks/download.py uses an equivalent Python REGEX to flag (only these raw lines! yes a 3rd time!)
# parsing them to send "percentage download progress" info along to the "Tasks" view in the web front-end:
# https://github.com/iiab/calibre-web/blob/d594aeba06ab91e684122ca03062564d71f012e5/cps/tasks/download.py#L46

pid=$!

# Wait for background process to complete
Expand Down