Skip to content

gh-104050: Add more type hints to Argument Clinic DSLParser() #106343

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
Jul 2, 2023
Merged

gh-104050: Add more type hints to Argument Clinic DSLParser() #106343

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
02a872b
gh-104050: Add more type hints to Argument Clinic DSLParser()
erlend-aasland Jul 2, 2023
d9bbf58
Address review
erlend-aasland Jul 2, 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
Next Next commit
gh-104050: Add more type hints to Argument Clinic DSLParser() 
Annotate the following method signatures:

- state_dsl_start()
- state_parameter_docstring_start()
- state_parameters_start()

Inverting ignore_line() logic, add type hints (including type guard) to
it, and rename to valid_line().
  • Loading branch information
@erlend-aasland
erlend-aasland committed Jul 2, 2023
commit 02a872b3850b125588c5bc9df5a7122b5e2e15c8
33 changes: 22 additions & 11 deletions Tools/clinic/clinic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,15 @@

from collections.abc import Callable
from types import FunctionType, NoneType
from typing import Any, Final, NamedTuple, NoReturn, Literal, overload
from typing import (
Any,
Final,
Literal,
NamedTuple,
NoReturn,
TypeGuard,
overload,
)

# TODO:
#
Expand Down Expand Up @@ -4471,17 +4479,20 @@ def parse(self, block: Block) -> None:
block.output = self.saved_output

@staticmethod
def ignore_line(line):
def valid_line(line: str | None) -> TypeGuard[str]:
if line is None:
return False

# ignore comment-only lines
if line.lstrip().startswith('#'):
return True
return False

# Ignore empty lines too
# (but not in docstring sections!)
if not line.strip():
return True
return False

return False
return True

@staticmethod
def calculate_indent(line: str) -> int:
Expand All @@ -4497,9 +4508,9 @@ def next(
if line is not None:
self.state(line)

def state_dsl_start(self, line):
def state_dsl_start(self, line: str | None):
Comment thread
erlend-aasland marked this conversation as resolved.
Outdated
# self.block = self.ClinicOutputBlock(self)
if self.ignore_line(line):
if not self.valid_line(line):
Comment thread
erlend-aasland marked this conversation as resolved.
return

# is it a directive?
Expand Down Expand Up @@ -4716,8 +4727,8 @@ def state_modulename_name(self, line):
ps_start, ps_left_square_before, ps_group_before, ps_required, \
ps_optional, ps_group_after, ps_right_square_after = range(7)

def state_parameters_start(self, line):
if self.ignore_line(line):
def state_parameters_start(self, line: str) -> None:
if not self.valid_line(line):
return

# if this line is not indented, we have no parameters
Expand All @@ -4742,7 +4753,7 @@ def state_parameter(self, line):
line = self.parameter_continuation + ' ' + line.lstrip()
self.parameter_continuation = ''

if self.ignore_line(line):
if not self.valid_line(line):
return

assert self.indent.depth == 2
Expand Down Expand Up @@ -5075,7 +5086,7 @@ def parse_special_symbol(self, symbol):
fail("Function " + self.function.name + " mixes keyword-only and positional-only parameters, which is unsupported.")
p.kind = inspect.Parameter.POSITIONAL_ONLY

def state_parameter_docstring_start(self, line):
def state_parameter_docstring_start(self, line: str) -> None:
self.parameter_docstring_indent = len(self.indent.margin)
assert self.indent.depth == 3
return self.next(self.state_parameter_docstring, line)
Expand Down