diff options
| -rw-r--r-- | tools/docs/lib/python_version.py | 28 | ||||
| -rwxr-xr-x | tools/docs/sphinx-build-wrapper | 3 | ||||
| -rwxr-xr-x | tools/docs/sphinx-pre-install | 3 |
3 files changed, 28 insertions, 6 deletions
diff --git a/tools/docs/lib/python_version.py b/tools/docs/lib/python_version.py index a9fda2470a26..4fde1b882164 100644 --- a/tools/docs/lib/python_version.py +++ b/tools/docs/lib/python_version.py @@ -20,9 +20,11 @@ Python version if present. import os import re import subprocess +import shlex import sys from glob import glob +from textwrap import indent class PythonVersion: """ @@ -44,6 +46,25 @@ class PythonVersion: """Returns a version tuple as major.minor.patch""" return ".".join([str(x) for x in version]) + @staticmethod + def cmd_print(cmd, max_len=80): + cmd_line = [] + + for w in cmd: + w = shlex.quote(w) + + if cmd_line: + if not max_len or len(cmd_line[-1]) + len(w) < max_len: + cmd_line[-1] += " " + w + continue + else: + cmd_line[-1] += " \\" + cmd_line.append(w) + else: + cmd_line.append(w) + + return "\n ".join(cmd_line) + def __str__(self): """Returns a version tuple as major.minor.patch from self.version""" return self.ver_str(self.version) @@ -130,14 +151,13 @@ class PythonVersion: else: new_python_cmd = None - if show_alternatives: + if show_alternatives and available_versions: print("You could run, instead:") for _, cmd in available_versions: args = [cmd, script_path] + sys.argv[1:] - cmd_str = " ".join(args) - print(f" {cmd_str}") - print() + cmd_str = indent(PythonVersion.cmd_print(args), " ") + print(f"{cmd_str}\n") if bail_out: msg = f"Python {python_ver} not supported. Bailing out" diff --git a/tools/docs/sphinx-build-wrapper b/tools/docs/sphinx-build-wrapper index e24486dede76..103b0044bb0b 100755 --- a/tools/docs/sphinx-build-wrapper +++ b/tools/docs/sphinx-build-wrapper @@ -774,7 +774,8 @@ def main(): args = parser.parse_args() - PythonVersion.check_python(MIN_PYTHON_VERSION) + PythonVersion.check_python(MIN_PYTHON_VERSION, show_alternatives=True, + bail_out=True) builder = SphinxBuilder(builddir=args.builddir, verbose=args.verbose, n_jobs=args.jobs, diff --git a/tools/docs/sphinx-pre-install b/tools/docs/sphinx-pre-install index 663d4e2a3f57..698989584b6a 100755 --- a/tools/docs/sphinx-pre-install +++ b/tools/docs/sphinx-pre-install @@ -1531,7 +1531,8 @@ def main(): checker = SphinxDependencyChecker(args) - PythonVersion.check_python(MIN_PYTHON_VERSION) + PythonVersion.check_python(MIN_PYTHON_VERSION, + bail_out=True, success_on_error=True) checker.check_needs() # Call main if not used as module |