Skip to content

gh-80282: Argument Clinic: Add clarifying comment about ASCII docstring limitation #107764

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
erlend-aasland merged 2 commits into from
Aug 9, 2023
+5 −0
Merged

gh-80282: Argument Clinic: Add clarifying comment about ASCII docstring limitation #107764

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1eb869c
gh-80282: Argument Clinic: Add clarifying comment about ASCII docstri…
erlend-aasland Aug 8, 2023
3bdfce2
Update Tools/clinic/clinic.py
erlend-aasland Aug 8, 2023
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
5 changes: 5 additions & 0 deletions Tools/clinic/clinic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5459,6 +5459,11 @@ def state_parameter_docstring_start(self, line: str) -> None:

def docstring_append(self, obj: Function | Parameter, line: str) -> None:
"""Add a rstripped line to the current docstring."""
# gh-80282: We filter out non-ASCII characters from the docstring,
# since historically, some compilers may balk on non-ASCII input.
# If you're using Argument Clinic in an external project,
# you may not need to support the same array of platforms as CPython,
# so you may be able to remove this restriction.
matches = re.finditer(r'[^\x00-\x7F]', line)
if offending := ", ".join([repr(m[0]) for m in matches]):
warn("Non-ascii characters are not allowed in docstrings:",
Expand Down