docutils-develop — For developer discussions of the implementation.

[Docutils-develop] [docutils:bugs] Re: #484 0.21.1: `test_writers.test_html5_polyglot_parts.Html5WriterPublishPartsTestCase` test failures

[Michał G. <mgo...@us...>]

The patch fixes the failure. Thanks!


---

**[bugs:#484] 0.21.1: `test_writers.test_html5_polyglot_parts.Html5WriterPublishPartsTestCase` test failures**

**Status:** open
**Created:** Thu Apr 11, 2024 02:44 PM UTC by Michał Górny
**Last Updated:** Thu Apr 11, 2024 04:14 PM UTC
**Owner:** nobody


0.21.1 introduced three test regressions. The two of them are specific to `test_writers.test_html5_polyglot_parts.Html5WriterPublishPartsTestCase`. The errors are:

```
$ python3.10 alltests.py 
Testing Docutils 0.21.1 with Python 3.10.14 on 2024-04-11 at 16:42:02
OS: Linux 6.8.4-gentoo-dist #1 SMP PREEMPT_DYNAMIC Fri Apr  5 12:29:35 -00 2024 (linux, Linux-6.8.4-gentoo-dist-x86_64-AMD_Ryzen_5_3600_6-Core_Processor-with-glibc2.39)
Working directory: /tmp/docutils/test
Docutils package: /tmp/docutils/docutils
.....................................................................s.................................................................................................................................................................................................................s.....................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................s..........................................................................................................EEE...........................................................................................
======================================================================
FAIL: test_publish (test_writers.test_html5_polyglot_parts.Html5WriterPublishPartsTestCase) (id="totest['syntax_highlight'][0]")
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/tmp/docutils/test/test_writers/test_html5_polyglot_parts.py", line 56, in test_publish
    self.assertEqual(case_expected, self.format_output(parts))
AssertionError: {'fra[51 chars]e>cat <span class="s"><<EOF\nHello World[24 chars]>\n'} != {'fra[51 chars]e>cat<span class="w"> </span><span class="s">&[47 chars]>\n'}
- {'fragment': '<pre class="code shell literal-block"><code>cat <span '
?                                                              -

+ {'fragment': '<pre class="code shell literal-block"><code>cat<span class="w"> '
?                                                                    +++++++++++

-              'class="s"><<EOF\n'
+              '</span><span class="s"><<EOF\n'
?               +++++++++++++

               'Hello World\n'
               'EOF</span></code></pre>\n'}

======================================================================
FAIL: test_publish (test_writers.test_html5_polyglot_parts.Html5WriterPublishPartsTestCase) (id="totest['syntax_highlight'][1]")
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/tmp/docutils/test/test_writers/test_html5_polyglot_parts.py", line 56, in test_publish
    self.assertEqual(case_expected, self.format_output(parts))
AssertionError: {'fra[30 chars]">cat <span class="s"><<EOF Hello World [20 chars]>\n'} != {'fra[30 chars]">cat<span class="w"> </span><span class="s">&[43 chars]>\n'}
- {'fragment': '<p><code class="shell">cat <span class="s"><<EOF Hello '
?                                         -             ^  ^^^^^^^^^^^^^^^^^

+ {'fragment': '<p><code class="shell">cat<span class="w"> </span><span '
?                                                      ^  ^^^^^^^^^^^^^

-              'World EOF</span></code></p>\n'}
+              'class="s"><<EOF Hello World EOF</span></code></p>\n'}
?               ++++++++++++++++++++++++++++


```

Bisected it down to:

```
commit c6abd4cdee5323630fd7ac12b425bfc3f6d23075
Author: milde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>
Date:   Fri Nov 10 13:12:16 2023 +0000

    Simplify "HTML5 parts test", add test case for bug #476.
    
    git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk/docutils@9470 929543f6-e4f2-0310-98a6-ba3bd3dd1d04

 test/test_writers/test_html5_polyglot_parts.py | 286 ++++---------------------
 1 file changed, 47 insertions(+), 239 deletions(-)
```

I can reproduce with Python 3.10.14, 3.11.9, 3.12.3; Pillow 10.3.0, Pygments 2.17.2.


---

Sent from sourceforge.net because doc...@li... is subscribed to https://sourceforge.net/p/docutils/bugs/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/docutils/admin/bugs/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.

[Docutils-develop] [docutils:bugs] Re: #485 0.21.1: `FAIL: test_publish (test_writers.test_html5_polyglot_parts.Html5WriterPublishPartsTestCase.test_publish) (id="totest['image_messages'][0]")`

[Michał G. <mgo...@us...>]

Same results with 3.9.


---

**[bugs:#485] 0.21.1: `FAIL: test_publish (test_writers.test_html5_polyglot_parts.Html5WriterPublishPartsTestCase.test_publish) (id="totest['image_messages'][0]")`**

**Status:** open
**Created:** Thu Apr 11, 2024 02:48 PM UTC by Michał Górny
**Last Updated:** Thu Apr 11, 2024 04:32 PM UTC
**Owner:** nobody


This is one more test failure, introduced by a different commit than these reported in #484:

```
======================================================================
FAIL: test_publish (test_writers.test_html5_polyglot_parts.Html5WriterPublishPartsTestCase.test_publish) (id="totest['image_messages'][0]")
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/tmp/docutils/test/test_writers/test_html5_polyglot_parts.py", line 54, in test_publish
    self.assertEqual(case_expected, self.format_output(parts))
AssertionError: {'fra[318 chars]y: \'dummy.png\'</p>\n</aside>\n<aside class="[620 chars]>\n'} != {'fra[318 chars]y: \'/tmp/docutils/test/dummy.png\'</p>\n</asi[639 chars]>\n'}
  {'fragment': '<img alt="dummy.png" src="dummy.png" />\n'
               '<aside class="system-message">\n'
               '<p class="system-message-title">System Message: WARNING/2 (<span '
               'class="docutils literal"><string></span>, line 1)</p>\n'
               '<p>Cannot scale image!\n'
               '  Could not get size from "dummy.png":\n'
-              "  [Errno 2] No such file or directory: 'dummy.png'</p>\n"
?              ^                                        -----------------

+              '  [Errno 2] No such file or directory: '
?              ^

+              "'/tmp/docutils/test/dummy.png'</p>\n"
               '</aside>\n'
               '<aside class="system-message">\n'
               '<p class="system-message-title">System Message: ERROR/3 (<span '
               'class="docutils literal"><string></span>, line 1)</p>\n'
               '<p>Cannot embed image "dummy.png":\n'
               "  [Errno 2] No such file or directory: 'dummy.png'</p>\n"
               '</aside>\n'
               '<video src="dummy.mp4" title="dummy.mp4">\n'
               '<a href="dummy.mp4">dummy.mp4</a>\n'
               '</video>\n'
               '<aside class="system-message">\n'
               '<p class="system-message-title">System Message: WARNING/2 (<span '
               'class="docutils literal"><string></span>, line 5)</p>\n'
               '<p>Cannot scale image!\n'
               '  Could not get size from "dummy.mp4":\n'
               '  PIL cannot read video images.</p>\n'
               '</aside>\n'}

```

Bisected it down to:

```
commit 2d4e66bb87aff0b62c67f3edc9792298dbadff07
Author: milde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>
Date:   Thu Dec 14 22:38:58 2023 +0000

    Refactor "_html_base" writer.
    
    Auxiliary method `HTMLTranslator.image_size()` to bring
    `HTMLTranslator.visit_image()` to a reasonable size.
    
    Improve/test error reporting when an image file cannot be read.
    
    Sort methods in `HTMLTranslator`.
    
    Small cleanups and optimizations.
    
    git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk/docutils@9501 929543f6-e4f2-0310-98a6-ba3bd3dd1d04

 docutils/writers/_html_base.py                 | 230 ++++++++++++-------------
 test/test_writers/test_html5_polyglot_misc.py  |   4 +-
 test/test_writers/test_html5_polyglot_parts.py |  72 +++++++-
 3 files changed, 181 insertions(+), 125 deletions(-)
```

I can reproduce with Python 3.10.14, 3.11.9, 3.12.3; Pillow 10.3.0, Pygments 2.17.2.


---

Sent from sourceforge.net because doc...@li... is subscribed to https://sourceforge.net/p/docutils/bugs/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/docutils/admin/bugs/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.

[Docutils-develop] [docutils:bugs] #485 0.21.1: `FAIL: test_publish (test_writers.test_html5_polyglot_parts.Html5WriterPublishPartsTestCase.test_publish) (id="totest['image_messages'][0]")`

[Günter M. <mi...@us...>]

Thank you for reporting.

The failure is in a test in improved reporting of errors/warnings by the html5 writer.
It seems like a "false positive" (i.e. just some irrelevant details differ).
Could be a change in the missing-file error message in Python 3.10.
Can you test with Python 3.9?


---

**[bugs:#485] 0.21.1: `FAIL: test_publish (test_writers.test_html5_polyglot_parts.Html5WriterPublishPartsTestCase.test_publish) (id="totest['image_messages'][0]")`**

**Status:** open
**Created:** Thu Apr 11, 2024 02:48 PM UTC by Michał Górny
**Last Updated:** Thu Apr 11, 2024 02:48 PM UTC
**Owner:** nobody


This is one more test failure, introduced by a different commit than these reported in #484:

```
======================================================================
FAIL: test_publish (test_writers.test_html5_polyglot_parts.Html5WriterPublishPartsTestCase.test_publish) (id="totest['image_messages'][0]")
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/tmp/docutils/test/test_writers/test_html5_polyglot_parts.py", line 54, in test_publish
    self.assertEqual(case_expected, self.format_output(parts))
AssertionError: {'fra[318 chars]y: \'dummy.png\'</p>\n</aside>\n<aside class="[620 chars]>\n'} != {'fra[318 chars]y: \'/tmp/docutils/test/dummy.png\'</p>\n</asi[639 chars]>\n'}
  {'fragment': '<img alt="dummy.png" src="dummy.png" />\n'
               '<aside class="system-message">\n'
               '<p class="system-message-title">System Message: WARNING/2 (<span '
               'class="docutils literal"><string></span>, line 1)</p>\n'
               '<p>Cannot scale image!\n'
               '  Could not get size from "dummy.png":\n'
-              "  [Errno 2] No such file or directory: 'dummy.png'</p>\n"
?              ^                                        -----------------

+              '  [Errno 2] No such file or directory: '
?              ^

+              "'/tmp/docutils/test/dummy.png'</p>\n"
               '</aside>\n'
               '<aside class="system-message">\n'
               '<p class="system-message-title">System Message: ERROR/3 (<span '
               'class="docutils literal"><string></span>, line 1)</p>\n'
               '<p>Cannot embed image "dummy.png":\n'
               "  [Errno 2] No such file or directory: 'dummy.png'</p>\n"
               '</aside>\n'
               '<video src="dummy.mp4" title="dummy.mp4">\n'
               '<a href="dummy.mp4">dummy.mp4</a>\n'
               '</video>\n'
               '<aside class="system-message">\n'
               '<p class="system-message-title">System Message: WARNING/2 (<span '
               'class="docutils literal"><string></span>, line 5)</p>\n'
               '<p>Cannot scale image!\n'
               '  Could not get size from "dummy.mp4":\n'
               '  PIL cannot read video images.</p>\n'
               '</aside>\n'}

```

Bisected it down to:

```
commit 2d4e66bb87aff0b62c67f3edc9792298dbadff07
Author: milde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>
Date:   Thu Dec 14 22:38:58 2023 +0000

    Refactor "_html_base" writer.
    
    Auxiliary method `HTMLTranslator.image_size()` to bring
    `HTMLTranslator.visit_image()` to a reasonable size.
    
    Improve/test error reporting when an image file cannot be read.
    
    Sort methods in `HTMLTranslator`.
    
    Small cleanups and optimizations.
    
    git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk/docutils@9501 929543f6-e4f2-0310-98a6-ba3bd3dd1d04

 docutils/writers/_html_base.py                 | 230 ++++++++++++-------------
 test/test_writers/test_html5_polyglot_misc.py  |   4 +-
 test/test_writers/test_html5_polyglot_parts.py |  72 +++++++-
 3 files changed, 181 insertions(+), 125 deletions(-)
```

I can reproduce with Python 3.10.14, 3.11.9, 3.12.3; Pillow 10.3.0, Pygments 2.17.2.


---

Sent from sourceforge.net because doc...@li... is subscribed to https://sourceforge.net/p/docutils/bugs/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/docutils/admin/bugs/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.

[Docutils-develop] [docutils:bugs] #484 0.21.1: `test_writers.test_html5_polyglot_parts.Html5WriterPublishPartsTestCase` test failures

[Günter M. <mi...@us...>]

Thank you for the report.
The reason seems to be that pygments output changed in version 2.14
Could you try the following patch?
~~~ diff
diff --git a/docutils/test/test_writers/test_html5_polyglot_parts.py b/docutils/test/test_writers/test_html5_polyglot_parts.py
index fb2792ee7..5b17492ad 100644
--- a/docutils/test/test_writers/test_html5_polyglot_parts.py
+++ b/docutils/test/test_writers/test_html5_polyglot_parts.py
@@ -14,6 +14,7 @@
 
 from pathlib import Path
 import os
+import re
 import sys
 import unittest
 
@@ -25,6 +26,12 @@
 import docutils
 import docutils.core
 from docutils.utils.code_analyzer import with_pygments
+if with_pygments:
+    import pygments
+    _pv = re.match(r'^([0-9]+)\.([0-9]*)', pygments.__version__)
+    if (int(_pv[1]), int(_pv[2])) >= (2, 14):  
+        # pygments output changed in version 2.14
+        with_pygments = False        
 
 ROOT_PREFIX = (Path(__file__).parent.parent/'functional'/'input').as_posix()
 DATA_ROOT = os.path.abspath(os.path.join(__file__, '..', '..', 'data'))
~~~


---

**[bugs:#484] 0.21.1: `test_writers.test_html5_polyglot_parts.Html5WriterPublishPartsTestCase` test failures**

**Status:** open
**Created:** Thu Apr 11, 2024 02:44 PM UTC by Michał Górny
**Last Updated:** Thu Apr 11, 2024 02:44 PM UTC
**Owner:** nobody


0.21.1 introduced three test regressions. The two of them are specific to `test_writers.test_html5_polyglot_parts.Html5WriterPublishPartsTestCase`. The errors are:

```
$ python3.10 alltests.py 
Testing Docutils 0.21.1 with Python 3.10.14 on 2024-04-11 at 16:42:02
OS: Linux 6.8.4-gentoo-dist #1 SMP PREEMPT_DYNAMIC Fri Apr  5 12:29:35 -00 2024 (linux, Linux-6.8.4-gentoo-dist-x86_64-AMD_Ryzen_5_3600_6-Core_Processor-with-glibc2.39)
Working directory: /tmp/docutils/test
Docutils package: /tmp/docutils/docutils
.....................................................................s.................................................................................................................................................................................................................s.....................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................s..........................................................................................................EEE...........................................................................................
======================================================================
FAIL: test_publish (test_writers.test_html5_polyglot_parts.Html5WriterPublishPartsTestCase) (id="totest['syntax_highlight'][0]")
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/tmp/docutils/test/test_writers/test_html5_polyglot_parts.py", line 56, in test_publish
    self.assertEqual(case_expected, self.format_output(parts))
AssertionError: {'fra[51 chars]e>cat <span class="s"><<EOF\nHello World[24 chars]>\n'} != {'fra[51 chars]e>cat<span class="w"> </span><span class="s">&[47 chars]>\n'}
- {'fragment': '<pre class="code shell literal-block"><code>cat <span '
?                                                              -

+ {'fragment': '<pre class="code shell literal-block"><code>cat<span class="w"> '
?                                                                    +++++++++++

-              'class="s"><<EOF\n'
+              '</span><span class="s"><<EOF\n'
?               +++++++++++++

               'Hello World\n'
               'EOF</span></code></pre>\n'}

======================================================================
FAIL: test_publish (test_writers.test_html5_polyglot_parts.Html5WriterPublishPartsTestCase) (id="totest['syntax_highlight'][1]")
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/tmp/docutils/test/test_writers/test_html5_polyglot_parts.py", line 56, in test_publish
    self.assertEqual(case_expected, self.format_output(parts))
AssertionError: {'fra[30 chars]">cat <span class="s"><<EOF Hello World [20 chars]>\n'} != {'fra[30 chars]">cat<span class="w"> </span><span class="s">&[43 chars]>\n'}
- {'fragment': '<p><code class="shell">cat <span class="s"><<EOF Hello '
?                                         -             ^  ^^^^^^^^^^^^^^^^^

+ {'fragment': '<p><code class="shell">cat<span class="w"> </span><span '
?                                                      ^  ^^^^^^^^^^^^^

-              'World EOF</span></code></p>\n'}
+              'class="s"><<EOF Hello World EOF</span></code></p>\n'}
?               ++++++++++++++++++++++++++++


```

Bisected it down to:

```
commit c6abd4cdee5323630fd7ac12b425bfc3f6d23075
Author: milde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>
Date:   Fri Nov 10 13:12:16 2023 +0000

    Simplify "HTML5 parts test", add test case for bug #476.
    
    git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk/docutils@9470 929543f6-e4f2-0310-98a6-ba3bd3dd1d04

 test/test_writers/test_html5_polyglot_parts.py | 286 ++++---------------------
 1 file changed, 47 insertions(+), 239 deletions(-)
```

I can reproduce with Python 3.10.14, 3.11.9, 3.12.3; Pillow 10.3.0, Pygments 2.17.2.


---

Sent from sourceforge.net because doc...@li... is subscribed to https://sourceforge.net/p/docutils/bugs/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/docutils/admin/bugs/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.

[Docutils-develop] [docutils:bugs] #485 0.21.1: `FAIL: test_publish (test_writers.test_html5_polyglot_parts.Html5WriterPublishPartsTestCase.test_publish) (id="totest['image_messages'][0]")`

[Michał G. <mgo...@us...>]

---

**[bugs:#485] 0.21.1: `FAIL: test_publish (test_writers.test_html5_polyglot_parts.Html5WriterPublishPartsTestCase.test_publish) (id="totest['image_messages'][0]")`**

**Status:** open
**Created:** Thu Apr 11, 2024 02:48 PM UTC by Michał Górny
**Last Updated:** Thu Apr 11, 2024 02:48 PM UTC
**Owner:** nobody


This is one more test failure, introduced by a different commit than these reported in #484:

```
======================================================================
FAIL: test_publish (test_writers.test_html5_polyglot_parts.Html5WriterPublishPartsTestCase.test_publish) (id="totest['image_messages'][0]")
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/tmp/docutils/test/test_writers/test_html5_polyglot_parts.py", line 54, in test_publish
    self.assertEqual(case_expected, self.format_output(parts))
AssertionError: {'fra[318 chars]y: \'dummy.png\'</p>\n</aside>\n<aside class="[620 chars]>\n'} != {'fra[318 chars]y: \'/tmp/docutils/test/dummy.png\'</p>\n</asi[639 chars]>\n'}
  {'fragment': '<img alt="dummy.png" src="dummy.png" />\n'
               '<aside class="system-message">\n'
               '<p class="system-message-title">System Message: WARNING/2 (<span '
               'class="docutils literal"><string></span>, line 1)</p>\n'
               '<p>Cannot scale image!\n'
               '  Could not get size from "dummy.png":\n'
-              "  [Errno 2] No such file or directory: 'dummy.png'</p>\n"
?              ^                                        -----------------

+              '  [Errno 2] No such file or directory: '
?              ^

+              "'/tmp/docutils/test/dummy.png'</p>\n"
               '</aside>\n'
               '<aside class="system-message">\n'
               '<p class="system-message-title">System Message: ERROR/3 (<span '
               'class="docutils literal"><string></span>, line 1)</p>\n'
               '<p>Cannot embed image "dummy.png":\n'
               "  [Errno 2] No such file or directory: 'dummy.png'</p>\n"
               '</aside>\n'
               '<video src="dummy.mp4" title="dummy.mp4">\n'
               '<a href="dummy.mp4">dummy.mp4</a>\n'
               '</video>\n'
               '<aside class="system-message">\n'
               '<p class="system-message-title">System Message: WARNING/2 (<span '
               'class="docutils literal"><string></span>, line 5)</p>\n'
               '<p>Cannot scale image!\n'
               '  Could not get size from "dummy.mp4":\n'
               '  PIL cannot read video images.</p>\n'
               '</aside>\n'}

```

Bisected it down to:

```
commit 2d4e66bb87aff0b62c67f3edc9792298dbadff07
Author: milde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>
Date:   Thu Dec 14 22:38:58 2023 +0000

    Refactor "_html_base" writer.
    
    Auxiliary method `HTMLTranslator.image_size()` to bring
    `HTMLTranslator.visit_image()` to a reasonable size.
    
    Improve/test error reporting when an image file cannot be read.
    
    Sort methods in `HTMLTranslator`.
    
    Small cleanups and optimizations.
    
    git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk/docutils@9501 929543f6-e4f2-0310-98a6-ba3bd3dd1d04

 docutils/writers/_html_base.py                 | 230 ++++++++++++-------------
 test/test_writers/test_html5_polyglot_misc.py  |   4 +-
 test/test_writers/test_html5_polyglot_parts.py |  72 +++++++-
 3 files changed, 181 insertions(+), 125 deletions(-)
```

I can reproduce with Python 3.10.14, 3.11.9, 3.12.3; Pillow 10.3.0, Pygments 2.17.2.


---

Sent from sourceforge.net because doc...@li... is subscribed to https://sourceforge.net/p/docutils/bugs/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/docutils/admin/bugs/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.

[Docutils-develop] [docutils:bugs] #484 0.21.1: `test_writers.test_html5_polyglot_parts.Html5WriterPublishPartsTestCase` test failures

[Michał G. <mgo...@us...>]

---

**[bugs:#484] 0.21.1: `test_writers.test_html5_polyglot_parts.Html5WriterPublishPartsTestCase` test failures**

**Status:** open
**Created:** Thu Apr 11, 2024 02:44 PM UTC by Michał Górny
**Last Updated:** Thu Apr 11, 2024 02:44 PM UTC
**Owner:** nobody


0.21.1 introduced three test regressions. The two of them are specific to `test_writers.test_html5_polyglot_parts.Html5WriterPublishPartsTestCase`. The errors are:

```
$ python3.10 alltests.py 
Testing Docutils 0.21.1 with Python 3.10.14 on 2024-04-11 at 16:42:02
OS: Linux 6.8.4-gentoo-dist #1 SMP PREEMPT_DYNAMIC Fri Apr  5 12:29:35 -00 2024 (linux, Linux-6.8.4-gentoo-dist-x86_64-AMD_Ryzen_5_3600_6-Core_Processor-with-glibc2.39)
Working directory: /tmp/docutils/test
Docutils package: /tmp/docutils/docutils
.....................................................................s.................................................................................................................................................................................................................s.....................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................s..........................................................................................................EEE...........................................................................................
======================================================================
FAIL: test_publish (test_writers.test_html5_polyglot_parts.Html5WriterPublishPartsTestCase) (id="totest['syntax_highlight'][0]")
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/tmp/docutils/test/test_writers/test_html5_polyglot_parts.py", line 56, in test_publish
    self.assertEqual(case_expected, self.format_output(parts))
AssertionError: {'fra[51 chars]e>cat <span class="s"><<EOF\nHello World[24 chars]>\n'} != {'fra[51 chars]e>cat<span class="w"> </span><span class="s">&[47 chars]>\n'}
- {'fragment': '<pre class="code shell literal-block"><code>cat <span '
?                                                              -

+ {'fragment': '<pre class="code shell literal-block"><code>cat<span class="w"> '
?                                                                    +++++++++++

-              'class="s"><<EOF\n'
+              '</span><span class="s"><<EOF\n'
?               +++++++++++++

               'Hello World\n'
               'EOF</span></code></pre>\n'}

======================================================================
FAIL: test_publish (test_writers.test_html5_polyglot_parts.Html5WriterPublishPartsTestCase) (id="totest['syntax_highlight'][1]")
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/tmp/docutils/test/test_writers/test_html5_polyglot_parts.py", line 56, in test_publish
    self.assertEqual(case_expected, self.format_output(parts))
AssertionError: {'fra[30 chars]">cat <span class="s"><<EOF Hello World [20 chars]>\n'} != {'fra[30 chars]">cat<span class="w"> </span><span class="s">&[43 chars]>\n'}
- {'fragment': '<p><code class="shell">cat <span class="s"><<EOF Hello '
?                                         -             ^  ^^^^^^^^^^^^^^^^^

+ {'fragment': '<p><code class="shell">cat<span class="w"> </span><span '
?                                                      ^  ^^^^^^^^^^^^^

-              'World EOF</span></code></p>\n'}
+              'class="s"><<EOF Hello World EOF</span></code></p>\n'}
?               ++++++++++++++++++++++++++++


```

Bisected it down to:

```
commit c6abd4cdee5323630fd7ac12b425bfc3f6d23075
Author: milde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>
Date:   Fri Nov 10 13:12:16 2023 +0000

    Simplify "HTML5 parts test", add test case for bug #476.
    
    git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk/docutils@9470 929543f6-e4f2-0310-98a6-ba3bd3dd1d04

 test/test_writers/test_html5_polyglot_parts.py | 286 ++++---------------------
 1 file changed, 47 insertions(+), 239 deletions(-)
```

I can reproduce with Python 3.10.14, 3.11.9, 3.12.3; Pillow 10.3.0, Pygments 2.17.2.


---

Sent from sourceforge.net because doc...@li... is subscribed to https://sourceforge.net/p/docutils/bugs/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/docutils/admin/bugs/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.

[Docutils-develop] [docutils:bugs] Re: #483 0.21 release has broken sdist

[Michał G. <mgo...@us...>]

Not, in my opinion. In fact, I personally prefer regular point versions, as they are shorter to type ;-).


---

**[bugs:#483] 0.21 release has broken sdist**

**Status:** open-fixed
**Created:** Wed Apr 10, 2024 05:58 AM UTC by Michał Górny
**Last Updated:** Thu Apr 11, 2024 02:17 PM UTC
**Owner:** nobody


The sdist for 0.21 release is versioned "0.21.post1" but the directory inside it is "0.21". Therefore, it is not installable:

```
$ pip install --no-binary docutils docutils
Collecting docutils
  Downloading docutils-0.21.post1.tar.gz (2.2 MB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 2.2/2.2 MB 6.1 MB/s eta 0:00:00
  Installing build dependencies ... done
  Getting requirements to build wheel ... done
  Preparing metadata (pyproject.toml) ... done
Discarding https://files.pythonhosted.org/packages/67/9a/ff2ff8e922f3b97c4b4864ca6c78d76ca5969bd730560001167b7054ac48/docutils-0.21.post1.tar.gz (from https://pypi.org/simple/docutils/) (requires-python:>=3.9): Requested docutils from https://files.pythonhosted.org/packages/67/9a/ff2ff8e922f3b97c4b4864ca6c78d76ca5969bd730560001167b7054ac48/docutils-0.21.post1.tar.gz has inconsistent version: expected '0.21.post1', but metadata has '0.21'
  Downloading docutils-0.20.1.tar.gz (2.1 MB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 2.1/2.1 MB 9.4 MB/s eta 0:00:00
[
```


---

Sent from sourceforge.net because doc...@li... is subscribed to https://sourceforge.net/p/docutils/bugs/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/docutils/admin/bugs/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.

[Docutils-develop] [docutils:bugs] #483 0.21 release has broken sdist

[Günter M. <mi...@us...>]

- **status**: open --> open-fixed



---

**[bugs:#483] 0.21 release has broken sdist**

**Status:** open-fixed
**Created:** Wed Apr 10, 2024 05:58 AM UTC by Michał Górny
**Last Updated:** Thu Apr 11, 2024 02:17 PM UTC
**Owner:** nobody


The sdist for 0.21 release is versioned "0.21.post1" but the directory inside it is "0.21". Therefore, it is not installable:

```
$ pip install --no-binary docutils docutils
Collecting docutils
  Downloading docutils-0.21.post1.tar.gz (2.2 MB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 2.2/2.2 MB 6.1 MB/s eta 0:00:00
  Installing build dependencies ... done
  Getting requirements to build wheel ... done
  Preparing metadata (pyproject.toml) ... done
Discarding https://files.pythonhosted.org/packages/67/9a/ff2ff8e922f3b97c4b4864ca6c78d76ca5969bd730560001167b7054ac48/docutils-0.21.post1.tar.gz (from https://pypi.org/simple/docutils/) (requires-python:>=3.9): Requested docutils from https://files.pythonhosted.org/packages/67/9a/ff2ff8e922f3b97c4b4864ca6c78d76ca5969bd730560001167b7054ac48/docutils-0.21.post1.tar.gz has inconsistent version: expected '0.21.post1', but metadata has '0.21'
  Downloading docutils-0.20.1.tar.gz (2.1 MB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 2.1/2.1 MB 9.4 MB/s eta 0:00:00
[
```


---

Sent from sourceforge.net because doc...@li... is subscribed to https://sourceforge.net/p/docutils/bugs/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/docutils/admin/bugs/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.

[Docutils-develop] [docutils:bugs] Re: #483 0.21 release has broken sdist

[Günter M. <mi...@us...>]

Currently, the [Docutils version policy](https://docutils.sourceforge.io/docs/dev/policies.html#version-identification) does not provide for a "post" element in `docutils.:__version_info__`.
Is there an advantage in using "post1" over increasing the "minor" number that makes it worth changing the policy?


---

**[bugs:#483] 0.21 release has broken sdist**

**Status:** open
**Created:** Wed Apr 10, 2024 05:58 AM UTC by Michał Górny
**Last Updated:** Thu Apr 11, 2024 03:18 AM UTC
**Owner:** nobody


The sdist for 0.21 release is versioned "0.21.post1" but the directory inside it is "0.21". Therefore, it is not installable:

```
$ pip install --no-binary docutils docutils
Collecting docutils
  Downloading docutils-0.21.post1.tar.gz (2.2 MB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 2.2/2.2 MB 6.1 MB/s eta 0:00:00
  Installing build dependencies ... done
  Getting requirements to build wheel ... done
  Preparing metadata (pyproject.toml) ... done
Discarding https://files.pythonhosted.org/packages/67/9a/ff2ff8e922f3b97c4b4864ca6c78d76ca5969bd730560001167b7054ac48/docutils-0.21.post1.tar.gz (from https://pypi.org/simple/docutils/) (requires-python:>=3.9): Requested docutils from https://files.pythonhosted.org/packages/67/9a/ff2ff8e922f3b97c4b4864ca6c78d76ca5969bd730560001167b7054ac48/docutils-0.21.post1.tar.gz has inconsistent version: expected '0.21.post1', but metadata has '0.21'
  Downloading docutils-0.20.1.tar.gz (2.1 MB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 2.1/2.1 MB 9.4 MB/s eta 0:00:00
[
```


---

Sent from sourceforge.net because doc...@li... is subscribed to https://sourceforge.net/p/docutils/bugs/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/docutils/admin/bugs/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.

[Docutils-develop] [docutils:bugs] #483 0.21 release has broken sdist

[Michał G. <mgo...@us...>]

Just for the record, doing `.post` releases is fine but you need to make sure to update the version string in metadata, and then create and upload new sdists and all wheels. You can't use `.post` to replace a subset of files.


---

**[bugs:#483] 0.21 release has broken sdist**

**Status:** open
**Created:** Wed Apr 10, 2024 05:58 AM UTC by Michał Górny
**Last Updated:** Wed Apr 10, 2024 09:55 PM UTC
**Owner:** nobody


The sdist for 0.21 release is versioned "0.21.post1" but the directory inside it is "0.21". Therefore, it is not installable:

```
$ pip install --no-binary docutils docutils
Collecting docutils
  Downloading docutils-0.21.post1.tar.gz (2.2 MB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 2.2/2.2 MB 6.1 MB/s eta 0:00:00
  Installing build dependencies ... done
  Getting requirements to build wheel ... done
  Preparing metadata (pyproject.toml) ... done
Discarding https://files.pythonhosted.org/packages/67/9a/ff2ff8e922f3b97c4b4864ca6c78d76ca5969bd730560001167b7054ac48/docutils-0.21.post1.tar.gz (from https://pypi.org/simple/docutils/) (requires-python:>=3.9): Requested docutils from https://files.pythonhosted.org/packages/67/9a/ff2ff8e922f3b97c4b4864ca6c78d76ca5969bd730560001167b7054ac48/docutils-0.21.post1.tar.gz has inconsistent version: expected '0.21.post1', but metadata has '0.21'
  Downloading docutils-0.20.1.tar.gz (2.1 MB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 2.1/2.1 MB 9.4 MB/s eta 0:00:00
[
```


---

Sent from sourceforge.net because doc...@li... is subscribed to https://sourceforge.net/p/docutils/bugs/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/docutils/admin/bugs/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.

[Docutils-develop] [docutils:bugs] #483 0.21 release has broken sdist

[engelbert g. <gr...@us...>]

0.21.1 is out.


---

**[bugs:#483] 0.21 release has broken sdist**

**Status:** open
**Created:** Wed Apr 10, 2024 05:58 AM UTC by Michał Górny
**Last Updated:** Wed Apr 10, 2024 08:19 PM UTC
**Owner:** nobody


The sdist for 0.21 release is versioned "0.21.post1" but the directory inside it is "0.21". Therefore, it is not installable:

```
$ pip install --no-binary docutils docutils
Collecting docutils
  Downloading docutils-0.21.post1.tar.gz (2.2 MB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 2.2/2.2 MB 6.1 MB/s eta 0:00:00
  Installing build dependencies ... done
  Getting requirements to build wheel ... done
  Preparing metadata (pyproject.toml) ... done
Discarding https://files.pythonhosted.org/packages/67/9a/ff2ff8e922f3b97c4b4864ca6c78d76ca5969bd730560001167b7054ac48/docutils-0.21.post1.tar.gz (from https://pypi.org/simple/docutils/) (requires-python:>=3.9): Requested docutils from https://files.pythonhosted.org/packages/67/9a/ff2ff8e922f3b97c4b4864ca6c78d76ca5969bd730560001167b7054ac48/docutils-0.21.post1.tar.gz has inconsistent version: expected '0.21.post1', but metadata has '0.21'
  Downloading docutils-0.20.1.tar.gz (2.1 MB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 2.1/2.1 MB 9.4 MB/s eta 0:00:00
[
```


---

Sent from sourceforge.net because doc...@li... is subscribed to https://sourceforge.net/p/docutils/bugs/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/docutils/admin/bugs/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.

[Docutils-develop] release 0.21.1 fix sdist package

[engelbert g. <eng...@gm...>]

Good evening

Adding a 0.21.post1 in release 0.21 did not work

This made a new release necessary.
It could have been 0.21.post2, but this might be another problem ...

This is the first time I tested --no-binary ... and it only worked from pypi
not from test.pypi, but it worked.

sorry for any inconvenience
 e

[Docutils-develop] [docutils:bugs] #483 0.21 release has broken sdist

[engelbert g. <gr...@us...>]

not the directory is wrong but 

the release .post# is for small changes, in this case no change to the code 

but if the metadata 
but i guess pypi  makes it a new release if the metadata version is different
i tried 0.21.post2 on testpypi ... it is a new release marked as micro(bial) different

but maybe it helps some people and hopefully does not break other places

asap


---

**[bugs:#483] 0.21 release has broken sdist**

**Status:** open
**Created:** Wed Apr 10, 2024 05:58 AM UTC by Michał Górny
**Last Updated:** Wed Apr 10, 2024 06:47 PM UTC
**Owner:** nobody


The sdist for 0.21 release is versioned "0.21.post1" but the directory inside it is "0.21". Therefore, it is not installable:

```
$ pip install --no-binary docutils docutils
Collecting docutils
  Downloading docutils-0.21.post1.tar.gz (2.2 MB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 2.2/2.2 MB 6.1 MB/s eta 0:00:00
  Installing build dependencies ... done
  Getting requirements to build wheel ... done
  Preparing metadata (pyproject.toml) ... done
Discarding https://files.pythonhosted.org/packages/67/9a/ff2ff8e922f3b97c4b4864ca6c78d76ca5969bd730560001167b7054ac48/docutils-0.21.post1.tar.gz (from https://pypi.org/simple/docutils/) (requires-python:>=3.9): Requested docutils from https://files.pythonhosted.org/packages/67/9a/ff2ff8e922f3b97c4b4864ca6c78d76ca5969bd730560001167b7054ac48/docutils-0.21.post1.tar.gz has inconsistent version: expected '0.21.post1', but metadata has '0.21'
  Downloading docutils-0.20.1.tar.gz (2.1 MB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 2.1/2.1 MB 9.4 MB/s eta 0:00:00
[
```


---

Sent from sourceforge.net because doc...@li... is subscribed to https://sourceforge.net/p/docutils/bugs/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/docutils/admin/bugs/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.

[Docutils-develop] [docutils:patches] #204 Add Georgian translation

[Günter M. <mi...@us...>]

The official language classifiers are updated. https://github.com/pypa/trove-classifiers/pull/176
> This may take a week or so to make its way to PyPI.org

The next Docutils release will officially support Georgian.

Thank you for the contribution.


---

**[patches:#204] Add Georgian translation**

**Status:** open-accepted
**Group:** None
**Created:** Mon Jul 24, 2023 03:54 AM UTC by Temuri Doghonadze
**Last Updated:** Wed Apr 10, 2024 10:07 AM UTC
**Owner:** nobody
**Attachments:**

- [ka.patch](https://sourceforge.net/p/docutils/patches/204/attachment/ka.patch) (7.3 kB; application/octet-stream)


Initial upload of Georgian translation.


---

Sent from sourceforge.net because doc...@li... is subscribed to https://sourceforge.net/p/docutils/patches/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/docutils/admin/patches/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.

[Docutils-develop] [docutils:patches] #203 Catalan updates

[Günter M. <mi...@us...>]

The official language classifiers are updated. https://github.com/pypa/trove-classifiers/pull/176
> This may take a week or so to make its way to PyPI.org

The next Docutils release will officially support Catalan (Valencian).

Thank you for the contribution.


---

**[patches:#203] Catalan updates**

**Status:** open-accepted
**Group:** None
**Created:** Sun Jul 23, 2023 09:38 PM UTC by Antoni Bella Pérez
**Last Updated:** Tue Apr 09, 2024 09:27 PM UTC
**Owner:** nobody
**Attachments:**

- [docutils-catalan_update.patch](https://sourceforge.net/p/docutils/patches/203/attachment/docutils-catalan_update.patch) (4.4 kB; text/x-patch)


* Has been ordered to following the source better (in English)
* All right from original translator


---

Sent from sourceforge.net because doc...@li... is subscribed to https://sourceforge.net/p/docutils/patches/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/docutils/admin/patches/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.

[Docutils-develop] [docutils:bugs] #483 0.21 release has broken sdist

[Günter M. <mi...@us...>]

 It looks like we need a 0.21.post2 asap.
 Sorry for the hassle.


---

**[bugs:#483] 0.21 release has broken sdist**

**Status:** open
**Created:** Wed Apr 10, 2024 05:58 AM UTC by Michał Górny
**Last Updated:** Wed Apr 10, 2024 07:58 AM UTC
**Owner:** nobody


The sdist for 0.21 release is versioned "0.21.post1" but the directory inside it is "0.21". Therefore, it is not installable:

```
$ pip install --no-binary docutils docutils
Collecting docutils
  Downloading docutils-0.21.post1.tar.gz (2.2 MB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 2.2/2.2 MB 6.1 MB/s eta 0:00:00
  Installing build dependencies ... done
  Getting requirements to build wheel ... done
  Preparing metadata (pyproject.toml) ... done
Discarding https://files.pythonhosted.org/packages/67/9a/ff2ff8e922f3b97c4b4864ca6c78d76ca5969bd730560001167b7054ac48/docutils-0.21.post1.tar.gz (from https://pypi.org/simple/docutils/) (requires-python:>=3.9): Requested docutils from https://files.pythonhosted.org/packages/67/9a/ff2ff8e922f3b97c4b4864ca6c78d76ca5969bd730560001167b7054ac48/docutils-0.21.post1.tar.gz has inconsistent version: expected '0.21.post1', but metadata has '0.21'
  Downloading docutils-0.20.1.tar.gz (2.1 MB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 2.1/2.1 MB 9.4 MB/s eta 0:00:00
[
```


---

Sent from sourceforge.net because doc...@li... is subscribed to https://sourceforge.net/p/docutils/bugs/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/docutils/admin/bugs/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.

[Docutils-develop] [docutils:patches] #204 Add Georgian translation

[Günter M. <mi...@us...>]

You did nothing wrong. The Georgian translations are part of the Docutils 0.21 release and should work as expected.
However, in the project metadata file [docutils/pyproject.toml](https://sourceforge.net/p/docutils/code/HEAD/tree/trunk/docutils/pyproject.toml), the line that should announce this feature to the world is currently commented out.
The reason is that the build system checks if the metadata tags belong to the set of official/canonical tags maintained at https://github.com/pypa/trove-classifiers/. Currently, Georgian is not in the set of natural languages known by Python classifiers :(

There is a page outlining what to do in this case: https://github.com/pypa/trove-classifiers/.
See also the similar case with Docutils supporting "Catalan (Valencian)", [patches:#203].


---

**[patches:#204] Add Georgian translation**

**Status:** open-accepted
**Group:** None
**Created:** Mon Jul 24, 2023 03:54 AM UTC by Temuri Doghonadze
**Last Updated:** Wed Apr 10, 2024 02:29 AM UTC
**Owner:** nobody
**Attachments:**

- [ka.patch](https://sourceforge.net/p/docutils/patches/204/attachment/ka.patch) (7.3 kB; application/octet-stream)


Initial upload of Georgian translation.


---

Sent from sourceforge.net because doc...@li... is subscribed to https://sourceforge.net/p/docutils/patches/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/docutils/admin/patches/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.

[Docutils-develop] [docutils:bugs] #483 0.21 release has broken sdist

[Michał G. <mgo...@us...>]

---

**[bugs:#483] 0.21 release has broken sdist**

**Status:** open
**Created:** Wed Apr 10, 2024 05:58 AM UTC by Michał Górny
**Last Updated:** Wed Apr 10, 2024 05:58 AM UTC
**Owner:** nobody


The sdist for 0.21 release is versioned "0.21.post1" but the directory inside it is "0.21". Therefore, it is not installable:

```
$ pip install --no-binary docutils docutils
Collecting docutils
  Downloading docutils-0.21.post1.tar.gz (2.2 MB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 2.2/2.2 MB 6.1 MB/s eta 0:00:00
  Installing build dependencies ... done
  Getting requirements to build wheel ... done
  Preparing metadata (pyproject.toml) ... done
Discarding https://files.pythonhosted.org/packages/67/9a/ff2ff8e922f3b97c4b4864ca6c78d76ca5969bd730560001167b7054ac48/docutils-0.21.post1.tar.gz (from https://pypi.org/simple/docutils/) (requires-python:>=3.9): Requested docutils from https://files.pythonhosted.org/packages/67/9a/ff2ff8e922f3b97c4b4864ca6c78d76ca5969bd730560001167b7054ac48/docutils-0.21.post1.tar.gz has inconsistent version: expected '0.21.post1', but metadata has '0.21'
  Downloading docutils-0.20.1.tar.gz (2.1 MB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 2.1/2.1 MB 9.4 MB/s eta 0:00:00
[
```


---

Sent from sourceforge.net because doc...@li... is subscribed to https://sourceforge.net/p/docutils/bugs/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/docutils/admin/bugs/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.

[Docutils-develop] [docutils:bugs] #427 Inconsistent sentence spacing in man pages using rst2man.py

[Günter M. <mi...@us...>]

- **status**: pending-works-for-me --> closed-fixed
- **Comment**:

The issue/feature is documented in Docutils 0.21.



---

**[bugs:#427] Inconsistent sentence spacing in man pages using rst2man.py**

**Status:** closed-fixed
**Labels:** manpage writer 
**Created:** Wed Oct 13, 2021 07:00 PM UTC by jei23jkfd
**Last Updated:** Sun Apr 07, 2024 05:12 PM UTC
**Owner:** nobody


## Operating system info

I'm running Docutils 0.18b2.dev r8848 with Python 3.9.

## Description of bug

The roff language has a very subtle requirement. It enforces semantic line breaks. That is, any roff document must end a sentence with a line break.

For example, this is incorrect:

~~~
This is a sentence. This is another sentence.
~~~

We have to insert a line break after each sentence:

~~~
This is a sentence.
This is another sentence.
~~~

The semantic line breaks are used to add optional sentence spacing. It uses the line breaks to detect when a period (or question or exclamation mark) represents the end of a sentence and then adds an optional extra space when displaying it. The relevant documentation for groff(1) and mandoc(1) is at

- https://www.gnu.org/software/groff/manual/groff.html#Sentences
- https://mandoc.bsd.lv/man/roff.7.html#Sentence_Spacing

## Minimal example

Here is a minimal example that shows how the reST man page writer has this bug:

~~~rst
###
mwe
###
a minimal example
#################
:Date: October 13, 2021
:Manual section: 1
:Manual group: Testing Docutils
:Version: mwe 0.1.0

Synopsis
========
| mwe [**-aq**] [**-b** *file*] [**\--long-long** *which*] *file \...*

Description
===========
To find the common attributes of a variety of objects, it is necessary
to begin, by surveying the *objects* themselves in the concrete. Let us
therefore advert successively to the various modes of action, and
arrangements of human affairs, which are classed, by universal or widely
spread opinion, as Just or as Unjust. The things well known to excite
the sentiments associated with those names, are of a very multifarious
character. I shall pass them rapidly in review, without studying any
particular arrangement.
The previous line will have been spaced with two spaces.

Options
=======
Its arguments are as follows:

-a                         Do all.
-q                         Be quiet.
-b file                    Do everything to *file*.
--long-meme which          Chooses the long named *which*.

Environment
===========
mwe is not affected by environment variables.

Exit status
===========
mwe exits 0 on success.
~~~

If you convert this with `rst2man.py mwe.rst mwe.1` and view it with `man ./mwe.1` you will notice the issue easily: some sentences in the DESCRIPTION section end with 1 space and some sentences end with 2 spaces.

## Possible solutions

The most complete solution would be to automatically detect where sentences end in the input and add line breaks as required in the man page output. This is what Pandoc does. However, it requires keeping a list of abbreviations for every language so as to not have false positives: you don't want to add a line break when someone uses "e.g.".

Another solution would be to use the `.ss` macro to remove the extra space at the end of any sentences. Then Docutils wouldn't have to conform to roff syntax. However, this would not work with mandoc(1) as the developer of that program has decided not to support `.ss`. This is what Asciidoctor does.

Please let me know if you have any questions.


---

Sent from sourceforge.net because doc...@li... is subscribed to https://sourceforge.net/p/docutils/bugs/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/docutils/admin/bugs/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.

[Docutils-develop] [docutils:patches] #203 Catalan updates

[Günter M. <mi...@us...>]

Docutils 0.21 is just released containing the Catalan update.
However, adding "Catalan (Valencian)" to the list of supported languages led to a build failure because the tag is not canonical :(
We need a volunteer to providing a PR for the "Canonical source for classifiers on PyPI" (https://github.com/pypa/trove-classifiers).


---

**[patches:#203] Catalan updates**

**Status:** open-accepted
**Group:** None
**Created:** Sun Jul 23, 2023 09:38 PM UTC by Antoni Bella Pérez
**Last Updated:** Mon Oct 02, 2023 04:29 PM UTC
**Owner:** nobody
**Attachments:**

- [docutils-catalan_update.patch](https://sourceforge.net/p/docutils/patches/203/attachment/docutils-catalan_update.patch) (4.4 kB; text/x-patch)


* Has been ordered to following the source better (in English)
* All right from original translator


---

Sent from sourceforge.net because doc...@li... is subscribed to https://sourceforge.net/p/docutils/patches/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/docutils/admin/patches/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.

[Docutils-develop] [docutils:patches] #204 Add Georgian translation

[Günter M. <mi...@us...>]

Thank you for the Georgian translation.
The patch is in Docutils 0.21. 
However, adding "Georgian" to the list of supported languages led to a build failure because the tag is not canonical :(
There is a [ticket](https://github.com/pypa/trove-classifiers/issues/151) at the " pypa/trove-classifiers" repository waiting for a volunteer to provide a PR.



---

**[patches:#204] Add Georgian translation**

**Status:** open-accepted
**Group:** None
**Created:** Mon Jul 24, 2023 03:54 AM UTC by Temuri Doghonadze
**Last Updated:** Wed Aug 23, 2023 01:00 PM UTC
**Owner:** nobody
**Attachments:**

- [ka.patch](https://sourceforge.net/p/docutils/patches/204/attachment/ka.patch) (7.3 kB; application/octet-stream)


Initial upload of Georgian translation.


---

Sent from sourceforge.net because doc...@li... is subscribed to https://sourceforge.net/p/docutils/patches/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/docutils/admin/patches/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.

[Docutils-develop] [docutils:patches] Mass edit changes by Günter Milde

[Günter M. <mi...@us...>]

Mass edit changing:

- **Status**: closed-fixed


ticket: patches:#186 Modernise packaging

- **Status**: open-fixed --> closed-fixed


ticket: patches:#202 RST parser: Add source lines to admonitions and definitionlists

- **Status**: open-fixed --> closed-fixed


ticket: patches:#206 Improve SmartQuote performance

- **Status**: open-fixed --> closed-fixed


ticket: patches:#209 manpage writer: Update manpage.txt.

- **Status**: open-fixed --> closed-fixed

[Docutils-develop] [docutils:feature-requests] Mass edit changes by Günter Milde

[Günter M. <mi...@us...>]

Mass edit changing:

- **Status**: closed-fixed


ticket: feature-requests:#40 Option to embed images as data uri in rst2html

- **Status**: open-fixed --> closed-fixed

[Docutils-develop] [docutils:feature-requests] Mass edit changes by Günter Milde

[Günter M. <mi...@us...>]

Mass edit changing:

- **Status**: closed-fixed


ticket: feature-requests:#72 rst2man: Show reference targets

- **Status**: open-fixed --> closed-fixed


ticket: feature-requests:#88 Unify Docutils CLI tools into `docutils-cli`

- **Status**: open-fixed --> closed-fixed


ticket: feature-requests:#91 Include directive path argument should support a configurable root.

- **Status**: open-fixed --> closed-fixed


ticket: feature-requests:#95 License "Python 2.1.1" doesn't exist as an SPDX identifier

- **Status**: open-fixed --> closed-fixed


ticket: feature-requests:#100 Support SVG hyperlinks and event handling

- **Status**: open-fixed --> closed-fixed

[Docutils-develop] [docutils:bugs] Mass edit changes by Günter Milde

[Günter M. <mi...@us...>]

Mass edit changing:

- **Status**: closed-fixed


ticket: bugs:#440 longtable labels in the wrong place

- **Status**: open-fixed --> closed-fixed


ticket: bugs:#473 Pip installs an incompatible version (20.1) for Python 2

- **Status**: open-fixed --> closed-fixed


ticket: bugs:#474 IndexError while parsing specially crafted option arguments

- **Status**: open-fixed --> closed-fixed


ticket: bugs:#476 Using short pygments class names with HTML5 writer results in strings being struck-out

- **Status**: open-fixed --> closed-fixed


ticket: bugs:#477 Generated man page leads to groff warning "TE macro called with TW register undefined"

- **Status**: open-fixed --> closed-fixed