Use config.verbosity (#13650)

Author: AA-Turner

sphinx/application.py

@@ -239,7 +239,7 @@ def __init__(
         self._fail_on_warnings = bool(warningiserror)
         self.pdb = pdb
         self._exception_on_warning = exception_on_warning
-        logging.setup(self, self._status, self._warning)
+        logging.setup(self, self._status, self._warning, verbosity=verbosity)
 
         self.events = EventManager(self)
 

sphinx/builders/__init__.py

@@ -269,7 +269,7 @@ def cat2relpath(cat: CatalogInfo, srcdir: Path = self.srcdir) -> str:
             __('writing output... '),
             'darkgreen',
             len(catalogs),
-            self._app.verbosity,
+            self.config.verbosity,
             stringify_func=cat2relpath,
         ):
             catalog.write_mo(
@@ -587,7 +587,7 @@ def _read_serial(self, docnames: list[str]) -> None:
             __('reading sources... '),
             'purple',
             len(docnames),
-            self._app.verbosity,
+            self.config.verbosity,
         ):
             # remove all inventory entries for that file
             self.events.emit('env-purge-doc', self.env, docname)
@@ -604,7 +604,7 @@ def _read_parallel(self, docnames: list[str], nproc: int) -> None:
             __('reading sources... '),
             'purple',
             len(chunks),
-            self._app.verbosity,
+            self.config.verbosity,
         )
 
         # clear all outdated docs at once
@@ -776,7 +776,7 @@ def _write_serial(self, docnames: Sequence[str]) -> None:
                 __('writing output... '),
                 'darkgreen',
                 len(docnames),
-                self._app.verbosity,
+                self.config.verbosity,
             ):
                 _write_docname(docname, env=self.env, builder=self, tags=self.tags)
 
@@ -800,7 +800,7 @@ def write_process(docs: list[tuple[str, nodes.document]]) -> None:
             __('writing output... '),
             'darkgreen',
             len(chunks),
-            self._app.verbosity,
+            self.config.verbosity,
         )
 
         def on_chunk_done(args: list[tuple[str, nodes.document]], result: None) -> None:

sphinx/environment/__init__.py

@@ -281,7 +281,9 @@ def setup(self, app: Sphinx) -> None:
         # The old config is self.config, restored from the pickled environment.
         # The new config is app.config, always recreated from ``conf.py``
         self.config_status, self.config_status_extra = self._config_status(
-            old_config=self.config, new_config=app.config, verbosity=app.verbosity
+            old_config=self.config,
+            new_config=app.config,
+            verbosity=app.config.verbosity,
         )
         self.config = app.config
 

sphinx/ext/viewcode.py

@@ -295,7 +295,7 @@ def collect_pages(app: Sphinx) -> Iterator[tuple[str, dict[str, Any], str]]:
         __('highlighting module code... '),
         'blue',
         len(env._viewcode_modules),
-        app.verbosity,
+        app.config.verbosity,
         operator.itemgetter(0),
     ):
         if not entry:

sphinx/util/logging.py

@@ -608,8 +608,12 @@ def write(self, data: str) -> None:
         self._app.messagelog.append(data)
 
 
-def setup(app: Sphinx, status: IO[str], warning: IO[str]) -> None:
+def setup(
+    app: Sphinx, status: IO[str], warning: IO[str], *, verbosity: int = 0
+) -> None:
     """Setup root logger for Sphinx"""
+    log_level = VERBOSITY_MAP[max(verbosity, 0)]
+
     logger = logging.getLogger(NAMESPACE)
     logger.setLevel(logging.DEBUG)
     logger.propagate = False
@@ -621,7 +625,7 @@ def setup(app: Sphinx, status: IO[str], warning: IO[str]) -> None:
     info_handler = NewLineStreamHandler(SafeEncodingWriter(status))
     info_handler.addFilter(InfoFilter())
     info_handler.addFilter(InfoLogRecordTranslator(app))
-    info_handler.setLevel(VERBOSITY_MAP[app.verbosity])
+    info_handler.setLevel(log_level)
     info_handler.setFormatter(ColorizeFormatter())
 
     warning_handler = WarningStreamHandler(SafeEncodingWriter(warning))
@@ -635,7 +639,7 @@ def setup(app: Sphinx, status: IO[str], warning: IO[str]) -> None:
 
     messagelog_handler = logging.StreamHandler(LastMessagesWriter(app, status))
     messagelog_handler.addFilter(InfoFilter())
-    messagelog_handler.setLevel(VERBOSITY_MAP[app.verbosity])
+    messagelog_handler.setLevel(log_level)
 
     logger.addHandler(info_handler)
     logger.addHandler(warning_handler)

tests/test_util/test_util_logging.py

@@ -26,8 +26,7 @@
 
 @pytest.mark.sphinx('html', testroot='root')
 def test_info_and_warning(app: SphinxTestApp) -> None:
-    app.verbosity = 2
-    logging.setup(app, app.status, app.warning)
+    logging.setup(app, app.status, app.warning, verbosity=2)
     logger = logging.getLogger(__name__)
 
     logger.debug('message1')
@@ -61,8 +60,7 @@ def test_Exception(app: SphinxTestApp) -> None:
 @pytest.mark.sphinx('html', testroot='root')
 def test_verbosity_filter(app: SphinxTestApp) -> None:
     # verbosity = 0: INFO
-    app.verbosity = 0
-    logging.setup(app, app.status, app.warning)
+    logging.setup(app, app.status, app.warning, verbosity=0)
     logger = logging.getLogger(__name__)
 
     logger.info('message1')
@@ -75,8 +73,7 @@ def test_verbosity_filter(app: SphinxTestApp) -> None:
     assert 'message4' not in app.status.getvalue()
 
     # verbosity = 1: VERBOSE
-    app.verbosity = 1
-    logging.setup(app, app.status, app.warning)
+    logging.setup(app, app.status, app.warning, verbosity=1)
     logger = logging.getLogger(__name__)
 
     logger.info('message1')
@@ -89,8 +86,7 @@ def test_verbosity_filter(app: SphinxTestApp) -> None:
     assert 'message4' not in app.status.getvalue()
 
     # verbosity = 2: DEBUG
-    app.verbosity = 2
-    logging.setup(app, app.status, app.warning)
+    logging.setup(app, app.status, app.warning, verbosity=2)
     logger = logging.getLogger(__name__)
 
     logger.info('message1')
@@ -312,8 +308,7 @@ def test_log_no_ansi_colors(tmp_path):
 
 @pytest.mark.sphinx('html', testroot='root')
 def test_colored_logs(app: SphinxTestApp) -> None:
-    app.verbosity = 2
-    logging.setup(app, app.status, app.warning)
+    logging.setup(app, app.status, app.warning, verbosity=2)
     logger = logging.getLogger(__name__)
 
     # default colors
@@ -363,7 +358,7 @@ class StreamWriter(codecs.StreamWriter):
         def write(self, object):
             self.stream.write(object.encode('cp1252').decode('cp1252'))
 
-    logging.setup(app, StreamWriter(app.status), app.warning)
+    logging.setup(app, StreamWriter(app.status), app.warning, verbosity=0)
     logger = logging.getLogger(__name__)
 
     # info with UnicodeEncodeError