gh-82927: Update files related to HTML entities. (GH-92504)

This commit is contained in:
Ezio Melotti 2022-06-21 22:03:12 +02:00 committed by GitHub
parent 4e08fbcfdf
commit f28ec34c5c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 29 additions and 78 deletions

View file

@ -2,10 +2,14 @@
"""
Utility for parsing HTML5 entity definitions available from:
http://dev.w3.org/html5/spec/entities.json
https://html.spec.whatwg.org/entities.json
https://html.spec.whatwg.org/multipage/named-characters.html
The page now contains the following note:
"This list is static and will not be expanded or changed in the future."
Written by Ezio Melotti and Iuliia Proskurnia.
"""
import os
@ -14,7 +18,9 @@ import json
from urllib.request import urlopen
from html.entities import html5
entities_url = 'http://dev.w3.org/html5/spec/entities.json'
PAGE_URL = 'https://html.spec.whatwg.org/multipage/named-characters.html'
ENTITIES_URL = 'https://html.spec.whatwg.org/entities.json'
HTML5_SECTION_START = '# HTML5 named character references'
def get_json(url):
"""Download the json file from the url and returns a decoded object."""
@ -62,9 +68,15 @@ def write_items(entities, file=sys.stdout):
# be before their equivalent lowercase version.
keys = sorted(entities.keys())
keys = sorted(keys, key=str.lower)
print(HTML5_SECTION_START, file=file)
print(f'# Generated by {sys.argv[0]!r}\n'
f'# from {ENTITIES_URL} and\n'
f'# {PAGE_URL}.\n'
f'# Map HTML5 named character references to the '
f'equivalent Unicode character(s).', file=file)
print('html5 = {', file=file)
for name in keys:
print(' {!r}: {!a},'.format(name, entities[name]), file=file)
print(f' {name!r}: {entities[name]!a},', file=file)
print('}', file=file)
@ -72,11 +84,8 @@ if __name__ == '__main__':
# without args print a diff between html.entities.html5 and new_html5
# with --create print the new html5 dict
# with --patch patch the Lib/html/entities.py file
new_html5 = create_dict(get_json(entities_url))
new_html5 = create_dict(get_json(ENTITIES_URL))
if '--create' in sys.argv:
print('# map the HTML5 named character references to the '
'equivalent Unicode character(s)')
print('# Generated by {}. Do not edit manually.'.format(__file__))
write_items(new_html5)
elif '--patch' in sys.argv:
fname = 'Lib/html/entities.py'
@ -84,7 +93,7 @@ if __name__ == '__main__':
with open(fname) as f1, open(temp_fname, 'w') as f2:
skip = False
for line in f1:
if line.startswith('html5 = {'):
if line.startswith(HTML5_SECTION_START):
write_items(new_html5, file=f2)
skip = True
continue