Skip to content

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

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
merged 19 commits into from
Jul 3, 2023
Merged

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

Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
15d4b03
gh-104050: Add more type hints to Argument Clinic DSLParser()
erlend-aasland Jul 3, 2023
4744bd9
Fix shadowing post partition
erlend-aasland Jul 3, 2023
7df949b
Tighten up parse_converter() return annotation
erlend-aasland Jul 3, 2023
7667704
Loosen up state_parameters_start()
erlend-aasland Jul 3, 2023
0480ed2
ast.expr is not str
erlend-aasland Jul 3, 2023
ec7c1d8
Annotate Parameter 'kind' param as inspect._ParameterKind
erlend-aasland Jul 3, 2023
ec38c62
Annotate DSLParser 'function' attr as 'Function | None'
erlend-aasland Jul 3, 2023
b1bd72a
Make sure Parameter() gets name as str
erlend-aasland Jul 3, 2023
3f1a0c0
Function param self_converter is CConverter or None
erlend-aasland Jul 3, 2023
d694f04
Make sure str is used as key in parameter dict
erlend-aasland Jul 3, 2023
f116de8
Merge branch 'main' into clinic/even-more-typing
AlexWaygood Jul 3, 2023
e587ba4
Annotation for c_basename
erlend-aasland Jul 3, 2023
cd5d675
More accurate type for self.self_converter
erlend-aasland Jul 3, 2023
f25dd99
Address review: fix return_converter type
erlend-aasland Jul 3, 2023
dcd5d32
from __future__ imports must occur at the beginning of the file!
erlend-aasland Jul 3, 2023
4c3844e
Pull in main
erlend-aasland Jul 3, 2023
89ba85a
Pull in main
erlend-aasland Jul 3, 2023
140bafc
Wrap touched lines at 79 chars
erlend-aasland Jul 3, 2023
4a7edf9
Apply suggestions from code review
erlend-aasland Jul 3, 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
19 changes: 11 additions & 8 deletions Tools/clinic/clinic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
# Copyright 2012-2013 by Larry Hastings.
# Licensed to the PSF under a contributor agreement.
#
from __future__ import annotations

import abc
import ast
Expand Down Expand Up @@ -2448,7 +2449,7 @@ def __init__(
cls: Class | None = None,
c_basename: str | None = None,
full_name: str | None = None,
return_converter: ReturnConverterType,
return_converter: CReturnConverter,
return_annotation = inspect.Signature.empty,
docstring: str | None = None,
kind: str = CALLABLE,
Expand All @@ -2467,7 +2468,7 @@ def __init__(
self.docstring = docstring or ''
self.kind = kind
self.coexist = coexist
self.self_converter = None
self.self_converter: self_converter | None = None
# docstring_only means "don't generate a machine-readable
# signature, just a normal docstring". it's True for
# functions with optional groups because we can't represent
Expand Down Expand Up @@ -2531,7 +2532,7 @@ class Parameter:
def __init__(
self,
name: str,
kind: str,
kind: inspect._ParameterKind,
*,
default = inspect.Parameter.empty,
function: Function,
Expand Down Expand Up @@ -4539,7 +4540,7 @@ def state_dsl_start(self, line: str | None) -> None:

self.next(self.state_modulename_name, line)

def state_modulename_name(self, line):
def state_modulename_name(self, line: str | None) -> None:
# looking for declaration, which establishes the leftmost column
# line should be
# modulename.fnname [as c_basename] [-> return annotation]
Expand All @@ -4556,13 +4557,14 @@ def state_modulename_name(self, line):
# this line is permitted to start with whitespace.
# we'll call this number of spaces F (for "function").

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

self.indent.infer(line)

# are we cloning?
before, equals, existing = line.rpartition('=')
c_basename: str | None
if equals:
full_name, _, c_basename = before.partition(' as ')
full_name = full_name.strip()
Expand Down Expand Up @@ -4665,8 +4667,9 @@ def state_modulename_name(self, line):
if cls and type == "PyObject *":
kwargs['type'] = cls.typedef
sc = self.function.self_converter = self_converter(name, name, self.function, **kwargs)
p_self = Parameter(sc.name, inspect.Parameter.POSITIONAL_ONLY, function=self.function, converter=sc)
self.function.parameters[sc.name] = p_self
p_self = Parameter(name, inspect.Parameter.POSITIONAL_ONLY,
function=self.function, converter=sc)
self.function.parameters[name] = p_self

(cls or module).functions.append(self.function)
self.next(self.state_parameters_start)
Expand Down Expand Up @@ -4740,7 +4743,7 @@ 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: str) -> None:
def state_parameters_start(self, line: str | None) -> None:
if not self.valid_line(line):
return

Expand Down