From 53e9e7de6359845f118431c05e2f14a96e03b757 Mon Sep 17 00:00:00 2001 From: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Date: Tue, 23 Jul 2024 13:30:06 +0100 Subject: [PATCH] GH-121970: Remove ``escape4chm`` (#122065) --- Doc/.ruff.toml | 1 - Doc/conf.py | 1 - Doc/tools/extensions/escape4chm.py | 58 ------------------------------ 3 files changed, 60 deletions(-) delete mode 100644 Doc/tools/extensions/escape4chm.py diff --git a/Doc/.ruff.toml b/Doc/.ruff.toml index 24f1c4f2ff6..111ce03b91d 100644 --- a/Doc/.ruff.toml +++ b/Doc/.ruff.toml @@ -5,7 +5,6 @@ line-length = 79 extend-exclude = [ "includes/*", # Temporary exclusions: - "tools/extensions/escape4chm.py", "tools/extensions/pyspecific.py", ] diff --git a/Doc/conf.py b/Doc/conf.py index 17e98e1a01e..4841b69e380 100644 --- a/Doc/conf.py +++ b/Doc/conf.py @@ -21,7 +21,6 @@ from pyspecific import SOURCE_URI extensions = [ 'c_annotations', - 'escape4chm', 'glossary_search', 'lexers', 'pyspecific', diff --git a/Doc/tools/extensions/escape4chm.py b/Doc/tools/extensions/escape4chm.py deleted file mode 100644 index 89970975b90..00000000000 --- a/Doc/tools/extensions/escape4chm.py +++ /dev/null @@ -1,58 +0,0 @@ -""" -Escape the `body` part of .chm source file to 7-bit ASCII, to fix visual -effect on some MBCS Windows systems. - -https://bugs.python.org/issue32174 -""" - -import pathlib -import re -from html.entities import codepoint2name - -from sphinx.util.logging import getLogger - -# escape the characters which codepoint > 0x7F -def _process(string): - def escape(matchobj): - codepoint = ord(matchobj.group(0)) - - name = codepoint2name.get(codepoint) - if name is None: - return '&#%d;' % codepoint - else: - return '&%s;' % name - - return re.sub(r'[^\x00-\x7F]', escape, string) - -def escape_for_chm(app, pagename, templatename, context, doctree): - # only works for .chm output - if getattr(app.builder, 'name', '') != 'htmlhelp': - return - - # escape the `body` part to 7-bit ASCII - body = context.get('body') - if body is not None: - context['body'] = _process(body) - -def fixup_keywords(app, exception): - # only works for .chm output - if getattr(app.builder, 'name', '') != 'htmlhelp' or exception: - return - - getLogger(__name__).info('fixing HTML escapes in keywords file...') - outdir = pathlib.Path(app.builder.outdir) - outname = app.builder.config.htmlhelp_basename - with open(outdir / (outname + '.hhk'), 'rb') as f: - index = f.read() - with open(outdir / (outname + '.hhk'), 'wb') as f: - f.write(index.replace(b''', b''')) - -def setup(app): - # `html-page-context` event emitted when the HTML builder has - # created a context dictionary to render a template with. - app.connect('html-page-context', escape_for_chm) - # `build-finished` event emitted when all the files have been - # output. - app.connect('build-finished', fixup_keywords) - - return {'version': '1.0', 'parallel_read_safe': True}