Skip to content

Harmonise run() and run_with_logging() #213

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 1 commit into from
Oct 6, 2024
Merged

Harmonise run() and run_with_logging() #213

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 5 additions & 6 deletions build_docs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,6 @@
from datetime import datetime as dt, timezone
from pathlib import Path
from string import Template
from textwrap import indent
from time import perf_counter, sleep
from typing import Iterable, Literal
from urllib.parse import urljoin
Expand Down Expand Up @@ -217,7 +216,7 @@ def filter(languages, language_tags=None):

def run(cmd, cwd=None) -> subprocess.CompletedProcess:
"""Like subprocess.run, with logging before and after the command execution."""
cmd = [str(arg) for arg in cmd]
cmd = list(map(str, cmd))
cmdstring = shlex.join(cmd)
logging.debug("Run: '%s'", cmdstring)
result = subprocess.run(
Expand All @@ -233,9 +232,9 @@ def run(cmd, cwd=None) -> subprocess.CompletedProcess:
if result.returncode:
# Log last 20 lines, those are likely the interesting ones.
logging.error(
"Run: %r KO:\n%s",
"Run: '%s' KO:\n%s",
cmdstring,
indent("\n".join(result.stdout.split("\n")[-20:]), " "),
"\n".join(f" {line}" for line in result.stdout.split("\n")[-20:]),
)
result.check_returncode()
return result
Expand All @@ -244,7 +243,7 @@ def run(cmd, cwd=None) -> subprocess.CompletedProcess:
def run_with_logging(cmd, cwd=None):
"""Like subprocess.check_call, with logging before the command execution."""
cmd = list(map(str, cmd))
logging.debug("Run: %s", shlex.join(cmd))
logging.debug("Run: '%s'", shlex.join(cmd))
with subprocess.Popen(
cmd,
cwd=cwd,
Expand All @@ -255,7 +254,7 @@ def run_with_logging(cmd, cwd=None):
) as p:
try:
for line in p.stdout or ():
logging.debug(">>>> %s", line.rstrip())
logging.debug(">>>> %s", line.rstrip())
except:
p.kill()
raise
Expand Down