Switch to _cli.util

AA-Turner · AA-Turner · commit e7f4181704ba · 2023-03-30T20:03:17.000+01:00
diff --git a/sphinx/application.py b/sphinx/application.py
@@ -22,6 +22,7 @@
 
 import sphinx
 from sphinx import locale, package_dir
+from sphinx._cli.util.colour import bold  # type: ignore
 from sphinx.config import Config
 from sphinx.domains import Domain, Index
 from sphinx.environment import BuildEnvironment
@@ -37,7 +38,6 @@
 from sphinx.theming import Theme
 from sphinx.util import docutils, logging
 from sphinx.util.build_phase import BuildPhase
-from sphinx.util.console import bold  # type: ignore
 from sphinx.util.display import progress_message
 from sphinx.util.i18n import CatalogRepository
 from sphinx.util.logging import prefixed_warnings
diff --git a/sphinx/builders/__init__.py b/sphinx/builders/__init__.py
@@ -13,6 +13,7 @@
 from docutils.nodes import Node
 from docutils.utils import DependencyList
 
+from sphinx._cli.util.colour import bold  # type: ignore
 from sphinx.config import Config
 from sphinx.deprecation import RemovedInSphinx70Warning
 from sphinx.environment import CONFIG_CHANGED_REASON, CONFIG_OK, BuildEnvironment
@@ -22,7 +23,6 @@
 from sphinx.locale import __
 from sphinx.util import UnicodeDecodeErrorHandler, get_filetype, import_object, logging, rst
 from sphinx.util.build_phase import BuildPhase
-from sphinx.util.console import bold  # type: ignore
 from sphinx.util.display import progress_message, status_iterator
 from sphinx.util.docutils import sphinx_domains
 from sphinx.util.i18n import CatalogInfo, CatalogRepository, docname_to_domain
diff --git a/sphinx/builders/changes.py b/sphinx/builders/changes.py
@@ -7,13 +7,13 @@
 from typing import Any, cast
 
 from sphinx import package_dir
+from sphinx._cli.util.colour import bold  # type: ignore
 from sphinx.application import Sphinx
 from sphinx.builders import Builder
 from sphinx.domains.changeset import ChangeSetDomain
 from sphinx.locale import _, __
 from sphinx.theming import HTMLThemeFactory
 from sphinx.util import logging
-from sphinx.util.console import bold  # type: ignore
 from sphinx.util.fileutil import copy_asset_file
 from sphinx.util.osutil import ensuredir, os_path
 
diff --git a/sphinx/builders/gettext.py b/sphinx/builders/gettext.py
@@ -14,13 +14,13 @@
 from docutils.nodes import Element
 
 from sphinx import addnodes, package_dir
+from sphinx._cli.util.colour import bold  # type: ignore
 from sphinx.application import Sphinx
 from sphinx.builders import Builder
 from sphinx.domains.python import pairindextypes
 from sphinx.errors import ThemeError
 from sphinx.locale import __
 from sphinx.util import logging, split_index_msg
-from sphinx.util.console import bold  # type: ignore
 from sphinx.util.display import status_iterator
 from sphinx.util.i18n import CatalogInfo, docname_to_domain
 from sphinx.util.nodes import extract_messages, traverse_translatable_index
diff --git a/sphinx/builders/latex/__init__.py b/sphinx/builders/latex/__init__.py
@@ -12,6 +12,7 @@
 
 import sphinx.builders.latex.nodes  # noqa: F401,E501  # Workaround: import this before writer to avoid ImportError
 from sphinx import addnodes, highlighting, package_dir
+from sphinx._cli.util.colour import bold, darkgreen  # type: ignore
 from sphinx.application import Sphinx
 from sphinx.builders import Builder
 from sphinx.builders.latex.constants import ADDITIONAL_SETTINGS, DEFAULT_SETTINGS, SHORTHANDOFF
@@ -22,7 +23,6 @@
 from sphinx.errors import NoUri, SphinxError
 from sphinx.locale import _, __
 from sphinx.util import logging, texescape
-from sphinx.util.console import bold, darkgreen  # type: ignore
 from sphinx.util.display import progress_message, status_iterator
 from sphinx.util.docutils import SphinxFileOutput, new_document
 from sphinx.util.fileutil import copy_asset_file
diff --git a/sphinx/builders/linkcheck.py b/sphinx/builders/linkcheck.py
@@ -20,14 +20,20 @@
 from requests import Response
 from requests.exceptions import ConnectionError, HTTPError, TooManyRedirects
 
+from sphinx._cli.util.colour import (  # type: ignore
+    darkgray,
+    darkgreen,
+    purple,
+    red,
+    turquoise,
+)
 from sphinx.application import Sphinx
 from sphinx.builders.dummy import DummyBuilder
 from sphinx.config import Config
 from sphinx.environment import BuildEnvironment
 from sphinx.locale import __
 from sphinx.transforms.post_transforms import SphinxPostTransform
 from sphinx.util import encode_uri, logging, requests
-from sphinx.util.console import darkgray, darkgreen, purple, red, turquoise  # type: ignore
 from sphinx.util.nodes import get_node_line
 
 logger = logging.getLogger(__name__)
diff --git a/sphinx/builders/manpage.py b/sphinx/builders/manpage.py
@@ -10,12 +10,12 @@
 from docutils.io import FileOutput
 
 from sphinx import addnodes
+from sphinx._cli.util.colour import darkgreen  # type: ignore
 from sphinx.application import Sphinx
 from sphinx.builders import Builder
 from sphinx.config import Config
 from sphinx.locale import __
 from sphinx.util import logging
-from sphinx.util.console import darkgreen  # type: ignore
 from sphinx.util.display import progress_message
 from sphinx.util.nodes import inline_all_toctrees
 from sphinx.util.osutil import ensuredir, make_filename_from_project
diff --git a/sphinx/builders/singlehtml.py b/sphinx/builders/singlehtml.py
@@ -8,12 +8,12 @@
 from docutils import nodes
 from docutils.nodes import Node
 
+from sphinx._cli.util.colour import darkgreen  # type: ignore
 from sphinx.application import Sphinx
 from sphinx.builders.html import StandaloneHTMLBuilder
 from sphinx.environment.adapters.toctree import TocTree
 from sphinx.locale import __
 from sphinx.util import logging
-from sphinx.util.console import darkgreen  # type: ignore
 from sphinx.util.display import progress_message
 from sphinx.util.nodes import inline_all_toctrees
 
diff --git a/sphinx/builders/texinfo.py b/sphinx/builders/texinfo.py
@@ -13,14 +13,14 @@
 from docutils.nodes import Node
 
 from sphinx import addnodes, package_dir
+from sphinx._cli.util.colour import darkgreen  # type: ignore
 from sphinx.application import Sphinx
 from sphinx.builders import Builder
 from sphinx.config import Config
 from sphinx.environment.adapters.asset import ImageAdapter
 from sphinx.errors import NoUri
 from sphinx.locale import _, __
 from sphinx.util import logging
-from sphinx.util.console import darkgreen  # type: ignore
 from sphinx.util.display import progress_message, status_iterator
 from sphinx.util.docutils import new_document
 from sphinx.util.fileutil import copy_asset_file
diff --git a/sphinx/cmd/build.py b/sphinx/cmd/build.py
@@ -17,11 +17,16 @@
 
 import sphinx.locale
 from sphinx import __display_version__
+from sphinx._cli.util.colour import (  # type: ignore
+    color_terminal,
+    nocolor,
+    red,
+    terminal_safe,
+)
 from sphinx.application import Sphinx
 from sphinx.errors import SphinxError
 from sphinx.locale import __
 from sphinx.util import Tee
-from sphinx.util.console import color_terminal, nocolor, red, terminal_safe  # type: ignore
 from sphinx.util.docutils import docutils_namespace, patch_docutils
 from sphinx.util.exceptions import format_exception_cut_frames, save_traceback
 from sphinx.util.osutil import abspath, ensuredir
diff --git a/sphinx/cmd/make_mode.py b/sphinx/cmd/make_mode.py
@@ -15,8 +15,8 @@
 from os import path
 
 import sphinx
+from sphinx._cli.util.colour import blue, bold, color_terminal, nocolor  # type: ignore
 from sphinx.cmd.build import build_main
-from sphinx.util.console import blue, bold, color_terminal, nocolor  # type: ignore
 from sphinx.util.osutil import rmtree
 
 try:
diff --git a/sphinx/cmd/quickstart.py b/sphinx/cmd/quickstart.py
@@ -30,8 +30,14 @@
 
 import sphinx.locale
 from sphinx import __display_version__, package_dir
+from sphinx._cli.util.colour import (  # type: ignore
+    bold,
+    color_terminal,
+    colorize,
+    nocolor,
+    red,
+)
 from sphinx.locale import __
-from sphinx.util.console import bold, color_terminal, colorize, nocolor, red  # type: ignore
 from sphinx.util.osutil import ensuredir
 from sphinx.util.template import SphinxRenderer
 
diff --git a/sphinx/ext/coverage.py b/sphinx/ext/coverage.py
@@ -15,11 +15,11 @@
 from typing import IO, Any
 
 import sphinx
+from sphinx._cli.util.colour import red  # type: ignore
 from sphinx.application import Sphinx
 from sphinx.builders import Builder
 from sphinx.locale import __
 from sphinx.util import logging
-from sphinx.util.console import red  # type: ignore
 from sphinx.util.inspect import safe_getattr
 
 logger = logging.getLogger(__name__)
diff --git a/sphinx/ext/doctest.py b/sphinx/ext/doctest.py
@@ -20,10 +20,10 @@
 from packaging.version import Version
 
 import sphinx
+from sphinx._cli.util.colour import bold  # type: ignore
 from sphinx.builders import Builder
 from sphinx.locale import __
 from sphinx.util import logging
-from sphinx.util.console import bold  # type: ignore
 from sphinx.util.docutils import SphinxDirective
 from sphinx.util.osutil import relpath
 from sphinx.util.typing import OptionSpec
diff --git a/sphinx/setup_command.py b/sphinx/setup_command.py
@@ -11,10 +11,10 @@
 from io import StringIO
 from typing import Any
 
+from sphinx._cli.util.colour import color_terminal, nocolor
 from sphinx.application import Sphinx
 from sphinx.cmd.build import handle_exception
 from sphinx.deprecation import RemovedInSphinx70Warning
-from sphinx.util.console import color_terminal, nocolor
 from sphinx.util.docutils import docutils_namespace, patch_docutils
 from sphinx.util.osutil import abspath
 
diff --git a/sphinx/util/__init__.py b/sphinx/util/__init__.py
@@ -13,6 +13,7 @@
 from typing import IO, Any, Iterable
 from urllib.parse import parse_qsl, quote_plus, urlencode, urlsplit, urlunsplit
 
+from sphinx._cli.util.colour import strip_colors  # NoQA: F401
 from sphinx.deprecation import RemovedInSphinx70Warning
 from sphinx.errors import ExtensionError, FiletypeNotFoundError
 from sphinx.locale import __
@@ -21,7 +22,6 @@
 from sphinx.util import http_date as _http_date
 from sphinx.util import logging
 from sphinx.util import osutil as _osutil
-from sphinx.util.console import strip_colors  # NoQA: F401
 from sphinx.util.matching import patfilter  # noqa: F401
 from sphinx.util.nodes import (  # noqa: F401
     caption_ref_re,
diff --git a/sphinx/util/display.py b/sphinx/util/display.py
@@ -3,9 +3,10 @@
 import functools
 from typing import Any, Callable, Iterable, Iterator, TypeVar
 
+from sphinx._cli.util.colour import bold, colorize  # type: ignore
+from sphinx._cli.util.terminal_width import term_width_line  # type: ignore
 from sphinx.locale import __
 from sphinx.util import logging
-from sphinx.util.console import bold, colorize, term_width_line  # type: ignore
 
 if False:
     from types import TracebackType
@@ -35,16 +36,18 @@ def status_iterator(
     if length == 0:
         logger.info(bold(summary), nonl=True)
     for i, item in enumerate(iterable, start=1):
-        item_str = colorize(color, stringify_func(item))
+        item_str = stringify_func(item)
         if length == 0:
-            logger.info(item_str, nonl=True)
+            logger.info(colorize(color, item_str), nonl=True)
             logger.info(' ', nonl=True)
         else:
-            s = f'{bold(summary)}[{int(100 * i / length): >3d}%] {item_str}'
+            template = f'{{0}}[{int(100 * i / length): >3d}%] {{1}}'
+            formatted = template.format(bold(summary), colorize(color, item_str))
             if verbosity:
-                logger.info(s + '\n', nonl=True)
+                logger.info(formatted + '\n', nonl=True)
             else:
-                logger.info(term_width_line(s), nonl=True)
+                raw = template.format(summary, item_str)
+                logger.info(term_width_line(formatted, raw), nonl=True)
         yield item
     logger.info('')
 
diff --git a/sphinx/util/exceptions.py b/sphinx/util/exceptions.py
@@ -2,58 +2,9 @@
 
 import sys
 import traceback
-from tempfile import NamedTemporaryFile
-from typing import TYPE_CHECKING
 
-from sphinx.errors import SphinxParallelError
-from sphinx.util.console import strip_colors
-
-if TYPE_CHECKING:
-    from sphinx.application import Sphinx
-
-
-def save_traceback(app: Sphinx | None, exc: BaseException) -> str:
-    """Save the given exception's traceback in a temporary file."""
-    import platform
-
-    import docutils
-    import jinja2
-    import pygments
-
-    import sphinx
-
-    if isinstance(exc, SphinxParallelError):
-        exc_format = '(Error in parallel process)\n' + exc.traceback
-    else:
-        exc_format = traceback.format_exc()
-
-    if app is None:
-        last_msgs = exts_list = ''
-    else:
-        extensions = app.extensions.values()
-        last_msgs = '\n'.join(f'#   {strip_colors(s).strip()}' for s in app.messagelog)
-        exts_list = '\n'.join(f'#   {ext.name} ({ext.version})' for ext in extensions
-                              if ext.version != 'builtin')
-
-    with NamedTemporaryFile('w', suffix='.log', prefix='sphinx-err-', delete=False) as f:
-        f.write(f"""\
-# Platform:         {sys.platform}; ({platform.platform()})
-# Sphinx version:   {sphinx.__display_version__}
-# Python version:   {platform.python_version()} ({platform.python_implementation()})
-# Docutils version: {docutils.__version__}
-# Jinja2 version:   {jinja2.__version__}
-# Pygments version: {pygments.__version__}
-
-# Last messages:
-{last_msgs}
-
-# Loaded extensions:
-{exts_list}
-
-# Traceback:
-{exc_format}
-""")
-    return f.name
+# re-export
+from sphinx._cli.util.errors import save_traceback  # NoQA: F401
 
 
 def format_exception_cut_frames(x: int = 1) -> str:
diff --git a/sphinx/util/logging.py b/sphinx/util/logging.py
@@ -6,14 +6,14 @@
 import logging.handlers
 from collections import defaultdict
 from contextlib import contextmanager
-from typing import IO, TYPE_CHECKING, Any, Generator
+from typing import IO, TYPE_CHECKING, Any, Callable, Generator
 
 from docutils import nodes
 from docutils.nodes import Node
 from docutils.utils import get_source_line
 
+from sphinx._cli.util.colour import blue, darkgray, darkred, red
 from sphinx.errors import SphinxWarning
-from sphinx.util.console import colorize
 from sphinx.util.osutil import abspath
 
 if TYPE_CHECKING:
@@ -39,10 +39,10 @@
     2: logging.DEBUG,
 })
 
-COLOR_MAP: defaultdict[int, str] = defaultdict(lambda: 'blue', {
-    logging.ERROR: 'darkred',
-    logging.WARNING: 'red',
-    logging.DEBUG: 'darkgray',
+COLOR_MAP: defaultdict[int, Callable[[str], str]] = defaultdict(lambda: blue, {
+    logging.ERROR: darkred,
+    logging.WARNING: red,
+    logging.DEBUG: darkgray,
 })
 
 
@@ -528,12 +528,12 @@ def get_node_location(node: Node) -> str | None:
 class ColorizeFormatter(logging.Formatter):
     def format(self, record: logging.LogRecord) -> str:
         message = super().format(record)
-        color = getattr(record, 'color', None)
+        color: Callable[[str], str] = getattr(record, 'color', None)
         if color is None:
             color = COLOR_MAP.get(record.levelno)
 
         if color:
-            return colorize(color, message)
+            return color(message)
         else:
             return message
 
@@ -593,7 +593,6 @@ def setup(app: Sphinx, status: IO, warning: IO) -> None:
     messagelog_handler = logging.StreamHandler(LastMessagesWriter(app, status))
     messagelog_handler.addFilter(InfoFilter())
     messagelog_handler.setLevel(VERBOSITY_MAP[app.verbosity])
-    messagelog_handler.setFormatter(ColorizeFormatter())
 
     logger.addHandler(info_handler)
     logger.addHandler(warning_handler)
diff --git a/tests/test_build_linkcheck.py b/tests/test_build_linkcheck.py
diff --git a/tests/test_quickstart.py b/tests/test_quickstart.py
diff --git a/tests/test_util_display.py b/tests/test_util_display.py
diff --git a/tests/test_util_logging.py b/tests/test_util_logging.py
