bpo-42238: Check Misc/NEWS.d/next/ for reStructuredText issues. (GH-23802)
This commit is contained in:
parent
886b2e5c7a
commit
b9735420aa
|
@ -202,6 +202,7 @@ dist:
|
||||||
|
|
||||||
check:
|
check:
|
||||||
$(PYTHON) tools/rstlint.py -i tools -i $(VENVDIR) -i README.rst
|
$(PYTHON) tools/rstlint.py -i tools -i $(VENVDIR) -i README.rst
|
||||||
|
$(PYTHON) tools/rstlint.py ../Misc/NEWS.d/next/
|
||||||
|
|
||||||
serve:
|
serve:
|
||||||
$(PYTHON) ../Tools/scripts/serve.py build/html
|
$(PYTHON) ../Tools/scripts/serve.py build/html
|
||||||
|
|
|
@ -13,6 +13,7 @@ import os
|
||||||
import re
|
import re
|
||||||
import sys
|
import sys
|
||||||
import getopt
|
import getopt
|
||||||
|
from string import ascii_letters
|
||||||
from os.path import join, splitext, abspath, exists
|
from os.path import join, splitext, abspath, exists
|
||||||
from collections import defaultdict
|
from collections import defaultdict
|
||||||
|
|
||||||
|
@ -128,6 +129,81 @@ def check_leaked_markup(fn, lines):
|
||||||
yield lno+1, 'possibly leaked markup: %r' % line
|
yield lno+1, 'possibly leaked markup: %r' % line
|
||||||
|
|
||||||
|
|
||||||
|
def hide_literal_blocks(lines):
|
||||||
|
"""Tool to remove literal blocks from given lines.
|
||||||
|
|
||||||
|
It yields empty lines in place of blocks, so line numbers are
|
||||||
|
still meaningful.
|
||||||
|
"""
|
||||||
|
in_block = False
|
||||||
|
for line in lines:
|
||||||
|
if line.endswith("::\n"):
|
||||||
|
in_block = True
|
||||||
|
elif in_block:
|
||||||
|
if line == "\n" or line.startswith(" "):
|
||||||
|
line = "\n"
|
||||||
|
else:
|
||||||
|
in_block = False
|
||||||
|
yield line
|
||||||
|
|
||||||
|
|
||||||
|
def type_of_explicit_markup(line):
|
||||||
|
if re.match(fr'\.\. {all_directives}::', line):
|
||||||
|
return 'directive'
|
||||||
|
if re.match(r'\.\. \[[0-9]+\] ', line):
|
||||||
|
return 'footnote'
|
||||||
|
if re.match(r'\.\. \[[^\]]+\] ', line):
|
||||||
|
return 'citation'
|
||||||
|
if re.match(r'\.\. _.*[^_]: ', line):
|
||||||
|
return 'target'
|
||||||
|
if re.match(r'\.\. \|[^\|]*\| ', line):
|
||||||
|
return 'substitution_definition'
|
||||||
|
return 'comment'
|
||||||
|
|
||||||
|
|
||||||
|
def hide_comments(lines):
|
||||||
|
"""Tool to remove comments from given lines.
|
||||||
|
|
||||||
|
It yields empty lines in place of comments, so line numbers are
|
||||||
|
still meaningfull.
|
||||||
|
"""
|
||||||
|
in_multiline_comment = False
|
||||||
|
for line in lines:
|
||||||
|
if line == "..\n":
|
||||||
|
in_multiline_comment = True
|
||||||
|
elif in_multiline_comment:
|
||||||
|
if line == "\n" or line.startswith(" "):
|
||||||
|
line = "\n"
|
||||||
|
else:
|
||||||
|
in_multiline_comment = False
|
||||||
|
if line.startswith(".. ") and type_of_explicit_markup(line) == 'comment':
|
||||||
|
line = "\n"
|
||||||
|
yield line
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
@checker(".rst", severity=2)
|
||||||
|
def check_missing_surrogate_space_on_plural(fn, lines):
|
||||||
|
r"""Check for missing 'backslash-space' between a code sample a letter.
|
||||||
|
|
||||||
|
Good: ``Point``\ s
|
||||||
|
Bad: ``Point``s
|
||||||
|
"""
|
||||||
|
in_code_sample = False
|
||||||
|
check_next_one = False
|
||||||
|
for lno, line in enumerate(hide_comments(hide_literal_blocks(lines))):
|
||||||
|
tokens = line.split("``")
|
||||||
|
for token_no, token in enumerate(tokens):
|
||||||
|
if check_next_one:
|
||||||
|
if token[0] in ascii_letters:
|
||||||
|
yield lno + 1, f"Missing backslash-space between code sample and {token!r}."
|
||||||
|
check_next_one = False
|
||||||
|
if token_no == len(tokens) - 1:
|
||||||
|
continue
|
||||||
|
if in_code_sample:
|
||||||
|
check_next_one = True
|
||||||
|
in_code_sample = not in_code_sample
|
||||||
|
|
||||||
def main(argv):
|
def main(argv):
|
||||||
usage = '''\
|
usage = '''\
|
||||||
Usage: %s [-v] [-f] [-s sev] [-i path]* [path]
|
Usage: %s [-v] [-f] [-s sev] [-i path]* [path]
|
||||||
|
|
|
@ -8,4 +8,3 @@ of ``types.GenericAlias``. Tests for typing were also updated to not subclass
|
||||||
things like ``Callable[..., T]`` as that is not a valid base class. Finally,
|
things like ``Callable[..., T]`` as that is not a valid base class. Finally,
|
||||||
both ``Callable``\ s no longer validate their ``argtypes``, in
|
both ``Callable``\ s no longer validate their ``argtypes``, in
|
||||||
``Callable[[argtypes], resulttype]`` to prepare for :pep:`612`. Patch by Ken Jin.
|
``Callable[[argtypes], resulttype]`` to prepare for :pep:`612`. Patch by Ken Jin.
|
||||||
|
|
||||||
|
|
|
@ -1 +1 @@
|
||||||
fix `format()` behavior for `IntFlag`
|
fix ``format()`` behavior for ``IntFlag``
|
||||||
|
|
|
@ -1 +1 @@
|
||||||
`Enum`: call `__init_subclass__` after members have been added
|
``Enum``: call ``__init_subclass__`` after members have been added
|
||||||
|
|
|
@ -1 +1 @@
|
||||||
[tarfile] update nested exception raising to use `from None` or `from e`
|
[tarfile] update nested exception raising to use ``from None`` or ``from e``
|
||||||
|
|
|
@ -1,3 +1,3 @@
|
||||||
`logging.disable` will now validate the types and value of its parameter. It
|
``logging.disable`` will now validate the types and value of its parameter. It
|
||||||
also now accepts strings representing the levels (as does `loging.setLevel`)
|
also now accepts strings representing the levels (as does ``loging.setLevel``)
|
||||||
instead of only the numerical values.
|
instead of only the numerical values.
|
||||||
|
|
Loading…
Reference in New Issue