Menu
▾
▴
[Docutils-checkins] SF.net SVN: docutils:[9353] trunk/docutils
|
From: <mi...@us...> - 2023-04-17 20:26:53
|
Revision: 9353
http://sourceforge.net/p/docutils/code/9353
Author: milde
Date: 2023-04-17 20:26:50 +0000 (Mon, 17 Apr 2023)
Log Message:
-----------
Raise ValueError if StringOutput.write() gets data of unsupported type
... instead of returning/storing an "informal string representation".
Replaces the test for the "odt" writers" with binary output in
`core.publish_programmatically()` with a generic alternative
(that also catches the case of the "null" writer instead of writing
the string "None").
Modified Paths:
--------------
trunk/docutils/docutils/core.py
trunk/docutils/docutils/io.py
trunk/docutils/test/test_publisher.py
Modified: trunk/docutils/docutils/core.py
===================================================================
--- trunk/docutils/docutils/core.py 2023-04-17 20:26:41 UTC (rev 9352)
+++ trunk/docutils/docutils/core.py 2023-04-17 20:26:50 UTC (rev 9353)
@@ -23,7 +23,6 @@
from docutils import (__version__, __version_details__, SettingsSpec,
io, utils, readers, writers)
-import docutils.writers.odf_odt # noqa:F401
from docutils.frontend import OptionParser
from docutils.readers import doctree
@@ -725,10 +724,6 @@
source_class=source_class,
destination_class=destination_class)
publisher.set_components(reader_name, parser_name, writer_name)
- if isinstance(publisher.writer,
- writers.odf_odt.Writer) and not auto_encode:
- raise ValueError('The ODT writer generates binary output and cannot '
- 'be used with `auto_encode=False`')
publisher.process_programmatic_settings(
settings_spec, settings_overrides, config_section)
publisher.set_source(source, source_path)
Modified: trunk/docutils/docutils/io.py
===================================================================
--- trunk/docutils/docutils/io.py 2023-04-17 20:26:41 UTC (rev 9352)
+++ trunk/docutils/docutils/io.py 2023-04-17 20:26:50 UTC (rev 9353)
@@ -321,8 +321,8 @@
If `data` is a `bytes` instance, it is returned unchanged.
Otherwise it is encoded with `self.encoding`.
- If `self.encoding` is set to the pseudo encoding name "unicode",
- `data` must be a `str` instance and is returned unchanged.
+ Provisional: If `self.encoding` is set to the pseudo encoding name
+ "unicode", `data` must be a `str` instance and is returned unchanged.
"""
if self.encoding and self.encoding.lower() == 'unicode':
assert isinstance(data, str), ('output encoding is "unicode" '
@@ -649,6 +649,13 @@
def __init__(self, destination=None, destination_path=None,
encoding=None, error_handler='strict', auto_encode=True):
+ """Initialize self.
+
+ `auto_encode` determines the return type of `self.write()`.
+ Its default value will change to False in Docutils 0.22.
+ Other attributes are passed to `Output.__init__()`.
+ """
+
self.auto_encode = auto_encode
"""Let `write()` encode the output document and return `bytes`."""
super().__init__(destination, destination_path,
@@ -657,17 +664,19 @@
def write(self, data):
"""Store `data` in `self.destination`, and return it.
- If `self.auto_encode` is False, store and return a `str`
- sub-class instance with "encoding" and "errors" attributes
- set to `self.encoding` and `self.error_handler`.
+ If `self.auto_encode` is False, `data` must be a `str` instance
+ and is stored/returned as `str` sub-class `OutString` with
+ attributes "encoding" and "errors" set to `self.encoding`
+ and `self.error_handler` respectively.
- If `self.auto_encode` is True, encode `data` with `self.encoding`
- and `self.error_handler` and store/return a `bytes` instance.
- Exception:
- If `self.encoding` is set to the pseudo encoding name "unicode",
- `data` must be a `str` instance and is returned unchanged
- (cf. `Output.encode`).
- Beware that the `output_encoding`_ setting may affect the content
+ If `self.auto_encode` is True, `data` can be a `bytes` or `str`
+ instance and is stored/returned as a `bytes` instance
+ (`str` data is encoded with `self.encode()`).
+ Exception (provisional): If `self.encoding` is set to the pseudo
+ encoding name "unicode", `data` must be a `str` instance and is
+ stored/returned unchanged (cf. `Output.encode`).
+
+ Attention: the `output_encoding`_ setting may affect the content
of the output (e.g. an encoding declaration in HTML or XML or the
representation of characters as LaTeX macro vs. literal character).
"""
@@ -674,11 +683,12 @@
if self.auto_encode:
self.destination = self.encode(data)
return self.destination
-
- if not self.encoding or self.encoding.lower() == 'unicode':
+ if not isinstance(data, str):
+ raise ValueError('StringOutput.write() expects `str` instance, '
+ f'not {type(data)}.')
+ encoding = self.encoding
+ if not encoding or encoding.lower() == 'unicode':
encoding = None
- else:
- encoding = self.encoding
self.destination = OutString(data, encoding, self.error_handler)
return self.destination
Modified: trunk/docutils/test/test_publisher.py
===================================================================
--- trunk/docutils/test/test_publisher.py 2023-04-17 20:26:41 UTC (rev 9352)
+++ trunk/docutils/test/test_publisher.py 2023-04-17 20:26:50 UTC (rev 9353)
@@ -150,10 +150,8 @@
TODO: return `str` with document as "flat XML" (.fodt).
"""
with self.assertRaises(ValueError) as cm:
- core.publish_string('test',
- writer_name='odt',
- auto_encode=False)
- self.assertIn('ODT writer generates binary output', str(cm.exception))
+ core.publish_string('test', writer_name='odt', auto_encode=False)
+ self.assertIn('expects `str` instance', str(cm.exception))
class PublishDoctreeTestCase(unittest.TestCase, docutils.SettingsSpec):
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
