[Docutils-checkins] SF.net SVN: docutils:[9486] trunk/docutils

[<mi...@us...>]

Revision: 9486
          http://sourceforge.net/p/docutils/code/9486
Author:   milde
Date:     2023-11-25 21:09:17 +0000 (Sat, 25 Nov 2023)
Log Message:
-----------
Simplify handling of legacy setting "embed_images".

Simplify code converting "embed_images" to a "image_loading" default.

Wrap deprecation message.

Modified Paths:
--------------
    trunk/docutils/docutils/writers/_html_base.py
    trunk/docutils/test/test_writers/test_html5_polyglot_misc.py

Modified: trunk/docutils/docutils/writers/_html_base.py
===================================================================
--- trunk/docutils/docutils/writers/_html_base.py	2023-11-25 21:09:05 UTC (rev 9485)
+++ trunk/docutils/docutils/writers/_html_base.py	2023-11-25 21:09:17 UTC (rev 9486)
@@ -286,22 +286,17 @@
                             settings.language_code, document.reporter)
         self.initial_header_level = int(settings.initial_header_level)
         # image_loading (only defined for HTML5 writer)
-        self.image_loading = getattr(settings, 'image_loading', None)
-        # legacy setting embed_images:
-        if getattr(settings, 'embed_images', None) is True:
-            warnings.warn('The configuration setting "embed_images" '
-                          'will be removed in Docutils 2.0. '
-                          'Use "image_loading: embed".',
+        _image_loading_default = 'link'
+        # convert legacy setting embed_images:
+        if getattr(settings, 'embed_images', None) is not None:
+            if settings.embed_images:
+                _image_loading_default = 'embed'
+            warnings.warn('The configuration setting "embed_images"\n'
+                          '  will be removed in Docutils 2.0. '
+                          f'Use "image_loading: {_image_loading_default}".',
                           FutureWarning, stacklevel=8)
-            if self.image_loading is None:
-                self.image_loading = 'embed'
-        if getattr(settings, 'embed_images', None) is False:
-            warnings.warn('The configuration setting "embed_images" '
-                          'will be removed in Docutils 2.0. '
-                          'Use "image_loading: link".',
-                          FutureWarning, stacklevel=8)
-        if self.image_loading is None:
-            self.image_loading = 'link'  # default
+        self.image_loading = getattr(settings,
+                                     'image_loading', _image_loading_default)
         self.math_output = settings.math_output.split()
         self.math_output_options = self.math_output[1:]
         self.math_output = self.math_output[0].lower()

Modified: trunk/docutils/test/test_writers/test_html5_polyglot_misc.py
===================================================================
--- trunk/docutils/test/test_writers/test_html5_polyglot_misc.py	2023-11-25 21:09:05 UTC (rev 9485)
+++ trunk/docutils/test/test_writers/test_html5_polyglot_misc.py	2023-11-25 21:09:17 UTC (rev 9486)
@@ -163,7 +163,7 @@
                        'output_encoding': 'unicode',
                        }
         with self.assertWarnsRegex(FutureWarning,
-                                   '"embed_images" will be removed'):
+                                   '"embed_images"\n  will be removed'):
             core.publish_string('warnings test', writer_name='html5',
                                 settings_overrides=my_settings)
 

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.