[Python-checkins] gh-82530: Create blank function instead of invalid import for email example (GH-97529)

[miss-islington]

https://github.com/python/cpython/commit/8bdaf9bf8e39b2ea374ee01a36b3c1bdaed01b23
commit: 8bdaf9bf8e39b2ea374ee01a36b3c1bdaed01b23
branch: 3.10
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-09-25T21:13:04-07:00
summary:

gh-82530: Create blank function instead of invalid import for email example (GH-97529)


Co-authored-by: Terry Jan Reedy <tjreedy at udel.edu>
(cherry picked from commit 2b428a1faed88f148ede131e3b86ab6227c6c3f0)

Co-authored-by: Stanley <46876382+slateny at users.noreply.github.com>

files:
M Doc/includes/email-read-alternative.py

diff --git a/Doc/includes/email-read-alternative.py b/Doc/includes/email-read-alternative.py
index 5ea84e62584a..8d0b4e6eb6b6 100644
--- a/Doc/includes/email-read-alternative.py
+++ b/Doc/includes/email-read-alternative.py
@@ -8,8 +8,15 @@
 from email import policy
 from email.parser import BytesParser
 
-# An imaginary module that would make this work and be safe.
-from imaginary import magic_html_parser
+
+def magic_html_parser(html_text, partfiles):
+    """Return safety-sanitized html linked to partfiles.
+
+    Rewrite the href="cid:...." attributes to point to the filenames in partfiles.
+    Though not trivial, this should be possible using html.parser.
+    """
+    raise NotImplementedError("Add the magic needed")
+
 
 # In a real program you'd get the filename from the arguments.
 with open('outgoing.msg', 'rb') as fp:
@@ -62,9 +69,6 @@
     print("Don't know how to display {}".format(richest.get_content_type()))
     sys.exit()
 with tempfile.NamedTemporaryFile(mode='w', delete=False) as f:
-    # The magic_html_parser has to rewrite the href="cid:...." attributes to
-    # point to the filenames in partfiles.  It also has to do a safety-sanitize
-    # of the html.  It could be written using html.parser.
     f.write(magic_html_parser(body.get_content(), partfiles))
 webbrowser.open(f.name)
 os.remove(f.name)