Merge pull request #6055 from tk0miya/progress_message2

refactoring with progress_message()

sphinx/builders/__init__.py

@@ -19,7 +19,7 @@ from sphinx.environment.adapters.asset import ImageAdapter
 from sphinx.errors import SphinxError
 from sphinx.io import read_doc
 from sphinx.locale import __
-from sphinx.util import i18n, import_object, logging, rst, status_iterator
+from sphinx.util import i18n, import_object, logging, rst, progress_message, status_iterator
 from sphinx.util.build_phase import BuildPhase
 from sphinx.util.console import bold  # type: ignore
 from sphinx.util.docutils import sphinx_domains
@@ -351,16 +351,14 @@ class Builder:
         if updated_docnames:
             # save the environment
             from sphinx.application import ENV_PICKLE_FILENAME
-            logger.info(bold(__('pickling environment... ')), nonl=True)
-            with open(path.join(self.doctreedir, ENV_PICKLE_FILENAME), 'wb') as f:
-                pickle.dump(self.env, f, pickle.HIGHEST_PROTOCOL)
-            logger.info(__('done'))
+            with progress_message(__('pickling environment')):
+                with open(path.join(self.doctreedir, ENV_PICKLE_FILENAME), 'wb') as f:
+                    pickle.dump(self.env, f, pickle.HIGHEST_PROTOCOL)
 
             # global actions
             self.app.phase = BuildPhase.CONSISTENCY_CHECK
-            logger.info(bold(__('checking consistency... ')), nonl=True)
-            self.env.check_consistency()
-            logger.info(__('done'))
+            with progress_message(__('checking consistency')):
+                self.env.check_consistency()
         else:
             if method == 'update' and not docnames:
                 logger.info(bold(__('no targets are out of date.')))
@@ -559,9 +557,8 @@ class Builder:
                     docnames.add(tocdocname)
         docnames.add(self.config.master_doc)
 
-        logger.info(bold(__('preparing documents... ')), nonl=True)
-        self.prepare_writing(docnames)
-        logger.info(__('done'))
+        with progress_message(__('preparing documents')):
+            self.prepare_writing(docnames)
 
         if self.parallel_ok:
             # number of subprocesses is parallel-1 because the main process

sphinx/builders/latex/__init__.py

@@ -28,7 +28,7 @@ from sphinx.environment.adapters.asset import ImageAdapter
 from sphinx.errors import SphinxError
 from sphinx.locale import _, __
 from sphinx.transforms import SphinxTransformer
-from sphinx.util import texescape, logging, status_iterator
+from sphinx.util import texescape, logging, progress_message, status_iterator
 from sphinx.util.console import bold, darkgreen  # type: ignore
 from sphinx.util.docutils import SphinxFileOutput, new_document
 from sphinx.util.fileutil import copy_asset_file
@@ -250,33 +250,32 @@ class LaTeXBuilder(Builder):
                 toctree_only = entry[5]
             destination = SphinxFileOutput(destination_path=path.join(self.outdir, targetname),
                                            encoding='utf-8', overwrite_if_changed=True)
-            logger.info(__("processing %s..."), targetname, nonl=True)
-            toctrees = self.env.get_doctree(docname).traverse(addnodes.toctree)
-            if toctrees:
-                if toctrees[0].get('maxdepth') > 0:
-                    tocdepth = toctrees[0].get('maxdepth')
+            with progress_message(__("processing %s") % targetname):
+                toctrees = self.env.get_doctree(docname).traverse(addnodes.toctree)
+                if toctrees:
+                    if toctrees[0].get('maxdepth') > 0:
+                        tocdepth = toctrees[0].get('maxdepth')
+                    else:
+                        tocdepth = None
                 else:
                     tocdepth = None
-            else:
-                tocdepth = None
-            doctree = self.assemble_doctree(
-                docname, toctree_only,
-                appendices=((docclass != 'howto') and self.config.latex_appendices or []))
-            doctree['tocdepth'] = tocdepth
-            self.apply_transforms(doctree)
-            self.post_process_images(doctree)
-            self.update_doc_context(title, author)
+                doctree = self.assemble_doctree(
+                    docname, toctree_only,
+                    appendices=((docclass != 'howto') and self.config.latex_appendices or []))
+                doctree['tocdepth'] = tocdepth
+                self.apply_transforms(doctree)
+                self.post_process_images(doctree)
+                self.update_doc_context(title, author)
 
-            logger.info(__("writing... "), nonl=True)
-            docsettings.author = author
-            docsettings.title = title
-            docsettings.contentsname = self.get_contentsname(docname)
-            docsettings.docname = docname
-            docsettings.docclass = docclass
+            with progress_message(__("writing")):
+                docsettings.author = author
+                docsettings.title = title
+                docsettings.contentsname = self.get_contentsname(docname)
+                docsettings.docname = docname
+                docsettings.docclass = docclass
 
-            doctree.settings = docsettings
-            docwriter.write(doctree, destination)
-            logger.info(__("done"))
+                doctree.settings = docsettings
+                docwriter.write(doctree, destination)
 
     def get_contentsname(self, indexfile):
         # type: (str) -> str
@@ -354,8 +353,15 @@ class LaTeXBuilder(Builder):
         # type: () -> None
         self.copy_image_files()
         self.write_message_catalog()
+        self.copy_support_files()
 
-        # copy TeX support files from texinputs
+        if self.config.latex_additional_files:
+            self.copy_latex_additional_files()
+
+    @progress_message(__('copying TeX support files'))
+    def copy_support_files(self):
+        # type: () -> None
+        """copy TeX support files from texinputs."""
         # configure usage of xindy (impacts Makefile and latexmkrc)
         # FIXME: convert this rather to a confval with suitable default
         #        according to language ? but would require extra documentation
@@ -386,21 +392,19 @@ class LaTeXBuilder(Builder):
             copy_asset_file(path.join(staticdirname, 'Makefile_t'),
                             self.outdir, context=context)
 
-        # copy additional files
-        if self.config.latex_additional_files:
-            logger.info(bold(__('copying additional files...')), nonl=True)
-            for filename in self.config.latex_additional_files:
-                logger.info(' ' + filename, nonl=True)
-                copy_asset_file(path.join(self.confdir, filename), self.outdir)
-            logger.info('')
-
         # the logo is handled differently
         if self.config.latex_logo:
             if not path.isfile(path.join(self.confdir, self.config.latex_logo)):
                 raise SphinxError(__('logo file %r does not exist') % self.config.latex_logo)
             else:
                 copy_asset_file(path.join(self.confdir, self.config.latex_logo), self.outdir)
-        logger.info(__('done'))
+
+    @progress_message(__('copying additional files'))
+    def copy_latex_additional_files(self):
+        # type: () -> None
+        for filename in self.config.latex_additional_files:
+            logger.info(' ' + filename, nonl=True)
+            copy_asset_file(path.join(self.confdir, filename), self.outdir)
 
     def copy_image_files(self):
         # type: () -> None

sphinx/builders/manpage.py

@@ -18,7 +18,8 @@ from sphinx.builders import Builder
 from sphinx.environment import NoUri
 from sphinx.locale import __
 from sphinx.util import logging
-from sphinx.util.console import bold, darkgreen  # type: ignore
+from sphinx.util import progress_message
+from sphinx.util.console import darkgreen  # type: ignore
 from sphinx.util.nodes import inline_all_toctrees
 from sphinx.util.osutil import make_filename_from_project
 from sphinx.writers.manpage import ManualPageWriter, ManualPageTranslator
@@ -60,6 +61,7 @@ class ManualPageBuilder(Builder):
             return ''
         raise NoUri
 
+    @progress_message(__('writing'))
     def write(self, *ignored):
         # type: (Any) -> None
         docwriter = ManualPageWriter(self)
@@ -68,8 +70,6 @@ class ManualPageBuilder(Builder):
             components=(docwriter,),
             read_config_files=True).get_default_values()  # type: Any
 
-        logger.info(bold(__('writing... ')), nonl=True)
-
         for info in self.config.man_pages:
             docname, name, description, authors, section = info
             if docname not in self.env.all_docs:
@@ -105,7 +105,6 @@ class ManualPageBuilder(Builder):
                 pendingnode.replace_self(pendingnode.children)
 
             docwriter.write(largetree, destination)
-        logger.info('')
 
     def finish(self):
         # type: () -> None

sphinx/builders/singlehtml.py

@@ -16,7 +16,8 @@ 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 bold, darkgreen  # type: ignore
+from sphinx.util import progress_message
+from sphinx.util.console import darkgreen  # type: ignore
 from sphinx.util.nodes import inline_all_toctrees
 
 if False:
@@ -162,24 +163,32 @@ class SingleFileHTMLBuilder(StandaloneHTMLBuilder):
         # type: (Any) -> None
         docnames = self.env.all_docs
 
-        logger.info(bold(__('preparing documents... ')), nonl=True)
-        self.prepare_writing(docnames)  # type: ignore
-        logger.info(__('done'))
+        with progress_message(__('preparing documents')):
+            self.prepare_writing(docnames)  # type: ignore
 
-        logger.info(bold(__('assembling single document... ')), nonl=True)
-        doctree = self.assemble_doctree()
-        self.env.toc_secnumbers = self.assemble_toc_secnumbers()
-        self.env.toc_fignumbers = self.assemble_toc_fignumbers()
-        logger.info('')
-        logger.info(bold(__('writing... ')), nonl=True)
-        self.write_doc_serialized(self.config.master_doc, doctree)
-        self.write_doc(self.config.master_doc, doctree)
-        logger.info(__('done'))
+        with progress_message(__('assembling single document')):
+            doctree = self.assemble_doctree()
+            self.env.toc_secnumbers = self.assemble_toc_secnumbers()
+            self.env.toc_fignumbers = self.assemble_toc_fignumbers()
+
+        with progress_message(__('writing')):
+            self.write_doc_serialized(self.config.master_doc, doctree)
+            self.write_doc(self.config.master_doc, doctree)
 
     def finish(self):
+        # type: () -> None
+        self.write_additional_files()
+        self.copy_image_files()
+        self.copy_download_files()
+        self.copy_static_files()
+        self.copy_extra_files()
+        self.write_buildinfo()
+        self.dump_inventory()
+
+    @progress_message(__('writing additional files'))
+    def write_additional_files(self):
         # type: () -> None
         # no indices or search pages are supported
-        logger.info(bold(__('writing additional files...')), nonl=True)
 
         # additional pages from conf.py
         for pagename, template in self.config.html_additional_pages.items():
@@ -191,15 +200,6 @@ class SingleFileHTMLBuilder(StandaloneHTMLBuilder):
             fn = path.join(self.outdir, '_static', 'opensearch.xml')
             self.handle_page('opensearch', {}, 'opensearch.xml', outfilename=fn)
 
-        logger.info('')
-
-        self.copy_image_files()
-        self.copy_download_files()
-        self.copy_static_files()
-        self.copy_extra_files()
-        self.write_buildinfo()
-        self.dump_inventory()
-
 
 def setup(app):
     # type: (Sphinx) -> Dict[str, Any]

sphinx/builders/texinfo.py

@@ -22,8 +22,8 @@ from sphinx.environment import NoUri
 from sphinx.environment.adapters.asset import ImageAdapter
 from sphinx.locale import _, __
 from sphinx.util import logging
-from sphinx.util import status_iterator
-from sphinx.util.console import bold, darkgreen  # type: ignore
+from sphinx.util import progress_message, status_iterator
+from sphinx.util.console import darkgreen  # type: ignore
 from sphinx.util.docutils import new_document
 from sphinx.util.fileutil import copy_asset_file
 from sphinx.util.nodes import inline_all_toctrees
@@ -113,28 +113,27 @@ class TexinfoBuilder(Builder):
             destination = FileOutput(
                 destination_path=path.join(self.outdir, targetname),
                 encoding='utf-8')
-            logger.info(__("processing %s..."), targetname, nonl=True)
-            doctree = self.assemble_doctree(
-                docname, toctree_only,
-                appendices=(self.config.texinfo_appendices or []))
-            logger.info(__("writing... "), nonl=True)
-            self.post_process_images(doctree)
-            docwriter = TexinfoWriter(self)
-            settings = OptionParser(
-                defaults=self.env.settings,
-                components=(docwriter,),
-                read_config_files=True).get_default_values()  # type: Any
-            settings.author = author
-            settings.title = title
-            settings.texinfo_filename = targetname[:-5] + '.info'
-            settings.texinfo_elements = self.config.texinfo_elements
-            settings.texinfo_dir_entry = direntry or ''
-            settings.texinfo_dir_category = category or ''
-            settings.texinfo_dir_description = description or ''
-            settings.docname = docname
-            doctree.settings = settings
-            docwriter.write(doctree, destination)
-            logger.info(__("done"))
+            with progress_message(__("processing %s") % targetname):
+                appendices = self.config.texinfo_appendices or []
+                doctree = self.assemble_doctree(docname, toctree_only, appendices=appendices)
+
+            with progress_message(__("writing")):
+                self.post_process_images(doctree)
+                docwriter = TexinfoWriter(self)
+                settings = OptionParser(
+                    defaults=self.env.settings,
+                    components=(docwriter,),
+                    read_config_files=True).get_default_values()  # type: Any
+                settings.author = author
+                settings.title = title
+                settings.texinfo_filename = targetname[:-5] + '.info'
+                settings.texinfo_elements = self.config.texinfo_elements
+                settings.texinfo_dir_entry = direntry or ''
+                settings.texinfo_dir_category = category or ''
+                settings.texinfo_dir_description = description or ''
+                settings.docname = docname
+                doctree.settings = settings
+                docwriter.write(doctree, destination)
 
     def assemble_doctree(self, indexfile, toctree_only, appendices):
         # type: (str, bool, List[str]) -> nodes.document
@@ -182,16 +181,7 @@ class TexinfoBuilder(Builder):
     def finish(self):
         # type: () -> None
         self.copy_image_files()
-
-        logger.info(bold(__('copying Texinfo support files... ')), nonl=True)
-        # copy Makefile
-        fn = path.join(self.outdir, 'Makefile')
-        logger.info(fn, nonl=True)
-        try:
-            copy_asset_file(os.path.join(template_dir, 'Makefile'), fn)
-        except OSError as err:
-            logger.warning(__("error writing file %s: %s"), fn, err)
-        logger.info(__(' done'))
+        self.copy_support_files()
 
     def copy_image_files(self):
         # type: () -> None
@@ -208,6 +198,15 @@ class TexinfoBuilder(Builder):
                     logger.warning(__('cannot copy image file %r: %s'),
                                    path.join(self.srcdir, src), err)
 
+    def copy_support_files(self):
+        # type: () -> None
+        try:
+            with progress_message(__('copying Texinfo support files')):
+                logger.info('Makefile ', nonl=True)
+                copy_asset_file(os.path.join(template_dir, 'Makefile'), self.outdir)
+        except OSError as err:
+            logger.warning(__("error writing file Makefile: %s"), err)
+
 
 def default_texinfo_documents(config):
     # type: (Config) -> List[Tuple[str, str, str, str, str, str, str]]