gh-104050: Argument Clinic: Annotate BlockParser (#106750)

This commit is contained in:
Erlend E. Aasland 2023-07-15 12:11:32 +02:00 committed by GitHub
parent 2d7d1aa4bc
commit bbf6297985
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 19 additions and 11 deletions

View File

@ -1712,7 +1712,13 @@ class BlockParser:
Iterator, yields Block objects.
"""
def __init__(self, input, language, *, verify=True):
def __init__(
self,
input: str,
language: Language,
*,
verify: bool = True
) -> None:
"""
"input" should be a str object
with embedded \n characters.
@ -1730,15 +1736,15 @@ class BlockParser:
self.find_start_re = create_regex(before, after, whole_line=False)
self.start_re = create_regex(before, after)
self.verify = verify
self.last_checksum_re = None
self.last_dsl_name = None
self.dsl_name = None
self.last_checksum_re: re.Pattern[str] | None = None
self.last_dsl_name: str | None = None
self.dsl_name: str | None = None
self.first_block = True
def __iter__(self):
def __iter__(self) -> BlockParser:
return self
def __next__(self):
def __next__(self) -> Block:
while True:
if not self.input:
raise StopIteration
@ -1755,18 +1761,18 @@ class BlockParser:
return block
def is_start_line(self, line):
def is_start_line(self, line: str) -> str | None:
match = self.start_re.match(line.lstrip())
return match.group(1) if match else None
def _line(self, lookahead=False):
def _line(self, lookahead: bool = False) -> str:
self.line_number += 1
line = self.input.pop()
if not lookahead:
self.language.parse_line(line)
return line
def parse_verbatim_block(self):
def parse_verbatim_block(self) -> Block:
add, output = text_accumulator()
self.block_start_line_number = self.line_number
@ -1780,13 +1786,13 @@ class BlockParser:
return Block(output())
def parse_clinic_block(self, dsl_name):
def parse_clinic_block(self, dsl_name: str) -> Block:
input_add, input_output = text_accumulator()
self.block_start_line_number = self.line_number + 1
stop_line = self.language.stop_line.format(dsl_name=dsl_name)
body_prefix = self.language.body_prefix.format(dsl_name=dsl_name)
def is_stop_line(line):
def is_stop_line(line: str) -> bool:
# make sure to recognize stop line even if it
# doesn't end with EOL (it could be the very end of the file)
if line.startswith(stop_line):
@ -1820,6 +1826,7 @@ class BlockParser:
checksum_re = create_regex(before, after, word=False)
self.last_dsl_name = dsl_name
self.last_checksum_re = checksum_re
assert checksum_re is not None
# scan forward for checksum line
output_add, output_output = text_accumulator()
@ -1834,6 +1841,7 @@ class BlockParser:
if self.is_start_line(line):
break
output: str | None
output = output_output()
if arguments:
d = {}