Skip to content

gh-66783: Automate update of Unicode data version in documentation #17748

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed

gh-66783: Automate update of Unicode data version in documentation #17748

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
aadb75c
bpo-22593: Automate update of unicode data version in documentation
nmassman Dec 30, 2019
70e3c28
Fix whitespace in makeunicodedata.py
nmassman Dec 30, 2019
2cdcc44
Cleaned up variable names and switched to modifying Doc/conf.py directly
nmassman Dec 31, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion Doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
# ---------------------

extensions = ['sphinx.ext.coverage', 'sphinx.ext.doctest',
'pyspecific', 'c_annotations', 'escape4chm']
'pyspecific', 'c_annotations', 'escape4chm', 'unidata_version']


doctest_global_setup = '''
Expand Down Expand Up @@ -226,3 +226,7 @@

# Relative filename of the reference count data file.
refcount_file = 'data/refcounts.dat'

# Unicode data version for unidata_version extension.
# Managed by Tools/unicode/makeunicodedata.py
UNIDATA_VERSION = "12.1.0"
2 changes: 1 addition & 1 deletion Doc/library/stdtypes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -350,7 +350,7 @@ Notes:
The numeric literals accepted include the digits ``0`` to ``9`` or any
Unicode equivalent (code points with the ``Nd`` property).

See http://www.unicode.org/Public/12.1.0/ucd/extracted/DerivedNumericType.txt
See http://www.unicode.org/Public/|UNIDATA_VERSION|/ucd/extracted/DerivedNumericType.txt
for a complete list of code points with the ``Nd`` property.


Expand Down
8 changes: 4 additions & 4 deletions Doc/library/unicodedata.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@

This module provides access to the Unicode Character Database (UCD) which
defines character properties for all Unicode characters. The data contained in
this database is compiled from the `UCD version 12.1.0
<http://www.unicode.org/Public/12.1.0/ucd>`_.
this database is compiled from the `UCD version |UNIDATA_VERSION|
<http://www.unicode.org/Public/|UNIDATA_VERSION|/ucd>`_.

The module uses the same names and symbols as defined by Unicode
Standard Annex #44, `"Unicode Character Database"
Expand Down Expand Up @@ -175,6 +175,6 @@ Examples:

.. rubric:: Footnotes

.. [#] http://www.unicode.org/Public/12.1.0/ucd/NameAliases.txt
.. [#] http://www.unicode.org/Public/|UNIDATA_VERSION|/ucd/NameAliases.txt

.. [#] http://www.unicode.org/Public/12.1.0/ucd/NamedSequences.txt
.. [#] http://www.unicode.org/Public/|UNIDATA_VERSION|/ucd/NamedSequences.txt
4 changes: 2 additions & 2 deletions Doc/reference/lexical_analysis.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -316,7 +316,7 @@ The Unicode category codes mentioned above stand for:
* *Nd* - decimal numbers
* *Pc* - connector punctuations
* *Other_ID_Start* - explicit list of characters in `PropList.txt
<http://www.unicode.org/Public/12.1.0/ucd/PropList.txt>`_ to support backwards
<http://www.unicode.org/Public/|UNIDATA_VERSION|/ucd/PropList.txt>`_ to support backwards
compatibility
* *Other_ID_Continue* - likewise

Expand Down Expand Up @@ -929,4 +929,4 @@ occurrence outside string literals and comments is an unconditional error:

.. rubric:: Footnotes

.. [#] http://www.unicode.org/Public/11.0.0/ucd/NameAliases.txt
.. [#] http://www.unicode.org/Public/|UNIDATA_VERSION|/ucd/NameAliases.txt
18 changes: 18 additions & 0 deletions Doc/tools/extensions/unidata_version.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
"""
unidata_version.py
~~~~~~~~~~~~~

Sphinx extension to handle updating the Unicode data version in docs.

https://bugs.python.org/issue22593
"""
import re

def parse_UNIDATA_VERSION(app, docname, source):
parsed = re.sub(r'\|UNIDATA_VERSION\|', app.config.UNIDATA_VERSION, source[0])
source[0] = parsed

def setup(app):
app.add_config_value('UNIDATA_VERSION', '0.0.0', 'env')
app.connect('source-read', parse_UNIDATA_VERSION)
return {'version': '1.0', 'parallel_read_safe': True}
3 changes: 3 additions & 0 deletions Misc/NEWS.d/next/Documentation/2019-12-29-21-52-00.bpo-22593.97jKwb.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Automated updating of Unicode data version in documentation. Any reference in docs
to ``|UNIDATA_VERSION|`` will be replaced with the current Unicode data version.
Contributed by Noah Massman-Hall
16 changes: 15 additions & 1 deletion Tools/unicode/makeunicodedata.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
# 2008-06-11 gb add PRINTABLE_MASK for Atsuo Ishimoto's ascii() patch
# 2011-10-21 ezio add support for name aliases and named sequences
# 2012-01 benjamin add full case mappings
# 2019-12-29 nmassman address bpo-22593 to automate doc updates
#
# written by Fredrik Lundh (fredrik@pythonware.com)
#
Expand All @@ -30,6 +31,7 @@
import os
import sys
import zipfile
import re

from functools import partial
from textwrap import dedent
Expand All @@ -40,7 +42,9 @@

# The Unicode Database
# --------------------
# When changing UCD version please update
# References in documentation to '|UNIDATA_VERSION|' will be set
# to the version below.
# Current references:
# * Doc/library/stdtypes.rst, and
# * Doc/library/unicodedata.rst
# * Doc/reference/lexical_analysis.rst (two occurrences)
Expand Down Expand Up @@ -128,6 +132,16 @@ def maketables(trace=0):
makeunicodedata(unicode, trace)
makeunicodetype(unicode, trace)

# Write the unicode version for inclusion in documentation.
print("--- Writing UNIDATA_VERSION", UNIDATA_VERSION, "to Doc/conf.py ...")
with open('Doc/conf.py', 'r') as fin:
newconf = re.sub(r'(?<=UNIDATA_VERSION = )".*?"',
f'"{UNIDATA_VERSION}"',
fin.read())
with open('Doc/conf.py', 'w') as fout:
fout.write(newconf)



# --------------------------------------------------------------------
# unicode character properties
Expand Down