Skip to content

GH-137623: Begin enforcing docstring length in Argument Clinic #137624

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

Merged
AA-Turner merged 9 commits into from
Aug 12, 2025
Merged

GH-137623: Begin enforcing docstring length in Argument Clinic #137624

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
20a6a43
Begin enforcing docstring length in Argument Clinic
AA-Turner Aug 11, 2025
5803939
Set to 72 chars and check body lines
AA-Turner Aug 11, 2025
48b617b
Fix tests
AA-Turner Aug 12, 2025
cac9891
Use 68 characters for methods
AA-Turner Aug 12, 2025
b3acb91
Revert repr change
AA-Turner Aug 12, 2025
223dc29
Merge branch 'main' into clinic/overlong-docstrings
AA-Turner Aug 12, 2025
980b95a
post-merge
AA-Turner Aug 12, 2025
3bc4f20
72/76
AA-Turner Aug 12, 2025
2216db9
Update docstring_line_width docstring
AA-Turner Aug 12, 2025
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
Next Next commit
Begin enforcing docstring length in Argument Clinic
  • Loading branch information
@AA-Turner
AA-Turner committed Aug 11, 2025
commit 20a6a438bb1b5a0fc8111b5da993f1d14edfb070
70 changes: 70 additions & 0 deletions Tools/clinic/libclinic/_overlong_docstrings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
OVERLONG_DOCSTRINGS = frozenset((
'_abc._abc_instancecheck',
'_abc._abc_register',
'_abc._abc_subclasscheck',
'_codecs.lookup',
'_functools.reduce',
'_hashlib.pbkdf2_hmac',
'_io._BufferedIOBase.read1',
'_jit.is_active',
'_jit.is_available',
'_jit.is_enabled',
'_lzma._decode_filter_properties',
'_remote_debugging.RemoteUnwinder.get_async_stack_trace',
'_socket.inet_aton',
'_sre.SRE_Match.expand',
'_sre.SRE_Match.groupdict',
'_sre.SRE_Pattern.finditer',
'_sre.SRE_Pattern.search',
'_sre.SRE_Pattern.sub',
'_sre.SRE_Pattern.subn',
'_ssl._SSLContext.sni_callback',
'_ssl._SSLSocket.pending',
'_ssl.get_default_verify_paths',
'_ssl.RAND_status',
'_sysconfig.config_vars',
'_testcapi.make_exception_with_doc',
'_tkinter.getbusywaitinterval',
'_tkinter.setbusywaitinterval',
'array.array.buffer_info',
'array.array.frombytes',
'array.array.tobytes',
'bytearray.count',
'bytearray.find',
'bytearray.index',
'bytearray.rfind',
'bytearray.rindex',
'bytes.count',
'bytes.find',
'bytes.index',
'bytes.rfind',
'bytes.rindex',
'itertools.chain.from_iterable',
'itertools.combinations_with_replacement.__new__',
'itertools.cycle.__new__',
'itertools.starmap.__new__',
'itertools.takewhile.__new__',
'math.comb',
'msvcrt.kbhit',
'OrderedDict.pop',
'os.pwritev',
'os.sched_getaffinity',
'os.timerfd_gettime',
'os.timerfd_gettime_ns',
'pyexpat.xmlparser.ExternalEntityParserCreate',
'pyexpat.xmlparser.GetReparseDeferralEnabled',
'pyexpat.xmlparser.UseForeignDTD',
'str.count',
'str.find',
'str.index',
'str.rfind',
'str.rindex',
'str.rsplit',
'str.split',
'sys._setprofileallthreads',
'sys._settraceallthreads',
'unicodedata.UCD.decomposition',
'zoneinfo.ZoneInfo.dst',
'zoneinfo.ZoneInfo.tzname',
'zoneinfo.ZoneInfo.utcoffset',
))
4 changes: 4 additions & 0 deletions Tools/clinic/libclinic/dsl_parser.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
from libclinic import (
ClinicError, VersionTuple,
fail, warn, unspecified, unknown, NULL)
from libclinic._overlong_docstrings import OVERLONG_DOCSTRINGS
from libclinic.function import (
Module, Class, Function, Parameter,
FunctionKind,
Expand Down Expand Up @@ -1509,6 +1510,9 @@ def format_docstring(self) -> str:
fail(f"Docstring for {f.full_name!r} does not have a summary line!\n"
"Every non-blank function docstring must start with "
"a single line summary followed by an empty line.")
if len(lines[0]) > 80 and f.full_name not in OVERLONG_DOCSTRINGS:
fail(f"Summary line {f.full_name!r} is too long!\n"
"The summary line must be no longer than 80 characters.")
elif len(lines) == 1:
# the docstring is only one line right now--the summary line.
# add an empty line after the summary line so we have space
Expand Down
2 changes: 1 addition & 1 deletion Tools/clinic/libclinic/errors.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ def __post_init__(self) -> None:
def report(self, *, warn_only: bool = False) -> str:
msg = "Warning" if warn_only else "Error"
if self.filename is not None:
msg += f" in file {self.filename!r}"
msg += f" in file '{self.filename}'"
Comment thread
AA-Turner marked this conversation as resolved.
Outdated
if self.lineno is not None:
msg += f" on line {self.lineno}"
msg += ":\n"
Expand Down