From c35d57d3ca7fe100448d2a447a68e4b07646494e Mon Sep 17 00:00:00 2001 From: Arnaud Degroote Date: Wed, 17 Jan 2024 10:33:43 +0100 Subject: [PATCH] Fix deprecation warning during batch processing Since Sphinx 6.1, sphinx.util.progress_message is deprecated in favor of sphinx.util.display.progress_message. The former should dissapear in Sphinx 8.0. Adapt the code to use the right API depending the Sphinx version. --- sphinxcontrib/plantuml.py | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/sphinxcontrib/plantuml.py b/sphinxcontrib/plantuml.py index e813ca6..e2b3724 100644 --- a/sphinxcontrib/plantuml.py +++ b/sphinxcontrib/plantuml.py @@ -24,7 +24,7 @@ from docutils.parsers.rst import directives from docutils.parsers.rst import Directive -from sphinx import util +import sphinx from sphinx.errors import SphinxError from sphinx.util import ( i18n, @@ -327,11 +327,17 @@ def collect_nodes(self, doctree): self._pending_keys.append(key) def render_batches(self): + if sphinx.version_info[:2] >= (6, 1): + from sphinx.util.display import progress_message + else: + from sphinx.util import progress_message + pending_keys = sorted(self._pending_keys) for fileformat in self.image_formats: for i in range(0, len(pending_keys), self.batch_size): keys = pending_keys[i : i + self.batch_size] - with util.progress_message( + + with progress_message( 'rendering plantuml diagrams [%d..%d/%d]' % (i, i + len(keys), len(pending_keys)) ):