Skip to content

gh-107614: Normalise Argument Clinic error messages #107615

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 10 commits into from
Aug 4, 2023
Merged

gh-107614: Normalise Argument Clinic error messages #107615

Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
c66a492
gh-107614: Normalise Argument Clinic error messages
erlend-aasland Aug 4, 2023
f80a8e5
Enclose 'preserve' directive in quotes
erlend-aasland Aug 4, 2023
6430805
Pull in main
erlend-aasland Aug 4, 2023
42a900a
Adapt tests
erlend-aasland Aug 4, 2023
feb6aec
Use line breaks FTW in output directive error message
erlend-aasland Aug 4, 2023
29efe7b
Address review
erlend-aasland Aug 4, 2023
015dea8
Apply suggestions from code review
erlend-aasland Aug 4, 2023
31f1e22
Apply suggestions from code review
AlexWaygood Aug 4, 2023
d681648
Final touch
erlend-aasland Aug 4, 2023
882fe9d
Add test for dest clear
erlend-aasland Aug 4, 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
Prev Previous commit
Next Next commit
Apply suggestions from code review 
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
  • Loading branch information
@erlend-aasland @AlexWaygood
erlend-aasland and AlexWaygood authored Aug 4, 2023
commit 015dea81eb27f41ce167225db9f547154b197767
30 changes: 20 additions & 10 deletions Tools/clinic/clinic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -290,9 +290,11 @@ def linear_format(s: str, **kwargs: str) -> str:
continue

if trailing:
fail(f"Text found after {{{name}}} block marker! It must be on a line by itself.")
fail(f"Text found after {{{name}}} block marker! "
"It must be on a line by itself.")
if indent.strip():
fail(f"Non-whitespace characters found before {{{name}}} block marker! It must be on a line by itself.")
fail(f"Non-whitespace characters found before {{{name}}} block marker! "
"It must be on a line by itself.")

value = kwargs[name]
if not value:
Expand Down Expand Up @@ -2017,7 +2019,8 @@ def __post_init__(self, args: tuple[str, ...]) -> None:
)
extra_arguments = 1 if self.type == "file" else 0
if len(args) < extra_arguments:
fail(f"Not enough arguments for destination {self.name!r} new {self.type!r}")
fail(f"Not enough arguments for destination "
f"{self.name!r} new {self.type!r}")
if len(args) > extra_arguments:
fail(f"Too many arguments for destination {self.name!r} new {self.type!r}")
if self.type =='file':
Expand Down Expand Up @@ -2273,14 +2276,16 @@ def parse(self, input: str) -> str:
os.makedirs(dirname)
except FileExistsError:
if not os.path.isdir(dirname):
fail(f"Can't write to destination {destination.filename!r}, "
fail(f"Can't write to destination "
f"{destination.filename!r}, "
Comment thread
erlend-aasland marked this conversation as resolved.
Outdated
f"can't make directory {dirname!r}!")
if self.verify:
with open(destination.filename) as f:
parser_2 = BlockParser(f.read(), language=self.language)
blocks = list(parser_2)
if (len(blocks) != 1) or (blocks[0].input != 'preserve\n'):
fail(f"Modified destination file {destination.filename!r}, not overwriting!")
fail(f"Modified destination file "
f"{destination.filename!r}, not overwriting!")
Comment thread
erlend-aasland marked this conversation as resolved.
Outdated
except FileNotFoundError:
pass

Expand Down Expand Up @@ -4720,7 +4725,8 @@ def state_modulename_name(self, line: str) -> None:
module, cls = self.clinic._module_and_class(fields)

if not (existing_function.kind is self.kind and existing_function.coexist == self.coexist):
fail("'kind' of function and cloned function don't match! (@classmethod/@staticmethod/@coexist)")
fail("'kind' of function and cloned function don't match! "
"(@classmethod/@staticmethod/@coexist)")
function = existing_function.copy(
name=function_name, full_name=full_name, module=module,
cls=cls, c_basename=c_basename, docstring=''
Expand Down Expand Up @@ -5082,7 +5088,8 @@ def bad_node(self, node: ast.AST) -> None:
c_default = kwargs.get("c_default")
if not (isinstance(c_default, str) and c_default):
fail(f"When you specify an expression ({default!r}) "
f"as your default value, you MUST specify a valid c_default.",
f"as your default value, "
f"you MUST specify a valid c_default.",
ast.dump(expr))
py_default = default
value = unknown
Expand All @@ -5101,7 +5108,8 @@ def bad_node(self, node: ast.AST) -> None:
c_default = kwargs.get("c_default")
if not (isinstance(c_default, str) and c_default):
fail(f"When you specify a named constant ({py_default!r}) "
"as your default value, you MUST specify a valid c_default.")
"as your default value, "
"you MUST specify a valid c_default.")

try:
value = eval(py_default)
Expand Down Expand Up @@ -5224,7 +5232,8 @@ def parse_opening_square_bracket(self, function: Function) -> None:
case ParamState.REQUIRED | ParamState.GROUP_AFTER:
self.parameter_state = ParamState.GROUP_AFTER
case st:
fail(f"Function {function.name!r} has an unsupported group configuration. "
fail(f"Function {function.name!r} "
f"has an unsupported group configuration. "
f"(Unexpected state {st}.b)")
self.group += 1
function.docstring_only = True
Expand All @@ -5243,7 +5252,8 @@ def parse_closing_square_bracket(self, function: Function) -> None:
case ParamState.GROUP_AFTER | ParamState.RIGHT_SQUARE_AFTER:
self.parameter_state = ParamState.RIGHT_SQUARE_AFTER
case st:
fail(f"Function {function.name!r} has an unsupported group configuration. "
fail(f"Function {function.name!r} "
f"has an unsupported group configuration. "
f"(Unexpected state {st}.c)")

def parse_slash(self, function: Function) -> None:
Expand Down