[Python-checkins] bpo-46463: Fixes escape4chm.py script used when building the CHM documentation file (GH-30768)

miss-islington webhook-mailer at python.org
Fri Jan 21 17:15:54 EST 2022


https://github.com/python/cpython/commit/b37f3e993a978eacf05c5fddd716be2d31f18a8d
commit: b37f3e993a978eacf05c5fddd716be2d31f18a8d
branch: 3.9
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: miss-islington <31488909+miss-islington at users.noreply.github.com>
date: 2022-01-21T14:15:44-08:00
summary:

bpo-46463: Fixes escape4chm.py script used when building the CHM documentation file (GH-30768)

(cherry picked from commit 57d1855682dbeb9233ef3a531f9535c6442e9992)

Co-authored-by: Steve Dower <steve.dower at python.org>

files:
A Misc/NEWS.d/next/Documentation/2022-01-21-21-33-48.bpo-46463.fBbdTG.rst
M Doc/tools/extensions/escape4chm.py

diff --git a/Doc/tools/extensions/escape4chm.py b/Doc/tools/extensions/escape4chm.py
index e999971625173..89970975b9032 100644
--- a/Doc/tools/extensions/escape4chm.py
+++ b/Doc/tools/extensions/escape4chm.py
@@ -5,6 +5,7 @@
 https://bugs.python.org/issue32174
 """
 
+import pathlib
 import re
 from html.entities import codepoint2name
 
@@ -39,12 +40,12 @@ def fixup_keywords(app, exception):
         return
 
     getLogger(__name__).info('fixing HTML escapes in keywords file...')
-    outdir = app.builder.outdir
+    outdir = pathlib.Path(app.builder.outdir)
     outname = app.builder.config.htmlhelp_basename
-    with app.builder.open_file(outdir, outname + '.hhk', 'r') as f:
+    with open(outdir / (outname + '.hhk'), 'rb') as f:
         index = f.read()
-    with app.builder.open_file(outdir, outname + '.hhk', 'w') as f:
-        f.write(index.replace('&#x27;', '''))
+    with open(outdir / (outname + '.hhk'), 'wb') as f:
+        f.write(index.replace(b'&#x27;', b'''))
 
 def setup(app):
     # `html-page-context` event emitted when the HTML builder has
diff --git a/Misc/NEWS.d/next/Documentation/2022-01-21-21-33-48.bpo-46463.fBbdTG.rst b/Misc/NEWS.d/next/Documentation/2022-01-21-21-33-48.bpo-46463.fBbdTG.rst
new file mode 100644
index 0000000000000..d418190bb8fc8
--- /dev/null
+++ b/Misc/NEWS.d/next/Documentation/2022-01-21-21-33-48.bpo-46463.fBbdTG.rst
@@ -0,0 +1,2 @@
+Fixes :file:`escape4chm.py` script used when building the CHM documentation
+file



More information about the Python-checkins mailing list