From f592962b8d7a5df526f451dc9e29d376bf3dcb5e Mon Sep 17 00:00:00 2001 From: Adam Turner <9087854+aa-turner@users.noreply.github.com> Date: Mon, 23 Dec 2024 20:01:28 +0000 Subject: [PATCH] Enable automatic formatting for ``sphinx/ext/imgconverter.py`` --- .ruff.toml | 1 - sphinx/ext/imgconverter.py | 51 ++++++++++++++++++++++++-------------- 2 files changed, 32 insertions(+), 20 deletions(-) diff --git a/.ruff.toml b/.ruff.toml index c9213140525..351b05a3716 100644 --- a/.ruff.toml +++ b/.ruff.toml @@ -415,7 +415,6 @@ exclude = [ "sphinx/domains/python/_object.py", "sphinx/domains/rst.py", "sphinx/domains/std/__init__.py", - "sphinx/ext/imgconverter.py", "sphinx/ext/imgmath.py", "sphinx/ext/inheritance_diagram.py", "sphinx/ext/linkcode.py", diff --git a/sphinx/ext/imgconverter.py b/sphinx/ext/imgconverter.py index e960dd28fa1..16b5967b970 100644 --- a/sphinx/ext/imgconverter.py +++ b/sphinx/ext/imgconverter.py @@ -37,18 +37,24 @@ def is_available(self) -> bool: subprocess.run(args, capture_output=True, check=True) return True except OSError as exc: - logger.warning(__( - "Unable to run the image conversion command %r. " - "'sphinx.ext.imgconverter' requires ImageMagick by default. " - "Ensure it is installed, or set the 'image_converter' option " - "to a custom conversion command.\n\n" - "Traceback: %s", - ), self.config.image_converter, exc) + logger.warning( + __( + 'Unable to run the image conversion command %r. ' + "'sphinx.ext.imgconverter' requires ImageMagick by default. " + "Ensure it is installed, or set the 'image_converter' option " + 'to a custom conversion command.\n\n' + 'Traceback: %s', + ), + self.config.image_converter, + exc, + ) return False except CalledProcessError as exc: - logger.warning(__('convert exited with error:\n' - '[stderr]\n%r\n[stdout]\n%r'), - exc.stderr, exc.stdout) + logger.warning( + __('convert exited with error:\n[stderr]\n%r\n[stdout]\n%r'), + exc.stderr, + exc.stdout, + ) return False def convert(self, _from: str, _to: str) -> bool: @@ -58,21 +64,28 @@ def convert(self, _from: str, _to: str) -> bool: # (or first page) of image (ex. Animation GIF, PDF) _from += '[0]' - args = ([ - self.config.image_converter, *self.config.image_converter_args, _from, _to, - ]) + args = [ + self.config.image_converter, + *self.config.image_converter_args, + _from, + _to, + ] logger.debug('Invoking %r ...', args) subprocess.run(args, capture_output=True, check=True) return True except OSError: - logger.warning(__('convert command %r cannot be run, ' - 'check the image_converter setting'), - self.config.image_converter) + logger.warning( + __( + 'convert command %r cannot be run, check the image_converter setting' + ), + self.config.image_converter, + ) return False except CalledProcessError as exc: - raise ExtensionError(__('convert exited with error:\n' - '[stderr]\n%r\n[stdout]\n%r') % - (exc.stderr, exc.stdout)) from exc + raise ExtensionError( + __('convert exited with error:\n[stderr]\n%r\n[stdout]\n%r') + % (exc.stderr, exc.stdout) + ) from exc def setup(app: Sphinx) -> ExtensionMetadata: