Skip to content

gh-104050: Add basic typing to CConverter in clinic.py #104538

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 2 commits into from
May 16, 2023
Merged

gh-104050: Add basic typing to CConverter in clinic.py #104538

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3fa5ea0
gh-104050: Add basic typing to CConverter in clinic.py
erlend-aasland May 16, 2023
6c02f60
Update Tools/clinic/clinic.py
erlend-aasland May 16, 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
28 changes: 14 additions & 14 deletions Tools/clinic/clinic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2669,15 +2669,15 @@ class CConverter(metaclass=CConverterAutoRegister):
# keep in sync with self_converter.__init__!
def __init__(self,
# Positional args:
name,
py_name,
name: str,
py_name: str,
function,
default=unspecified,
*, # Keyword only args:
c_default=None,
py_default=None,
annotation=unspecified,
unused=False,
c_default: str | None = None,
py_default: str | None = None,
annotation: str | Unspecified = unspecified,
Copy link
Member

@AlexWaygood AlexWaygood May 16, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doesn't need to be done now (and you may not like the suggestion), but you could use an enum for all the sentinels that are defined in clinic.py, instead of defining three separate classes (Unspecified, Null and Unknown):

import enum
from typing import Final

class Sentinels(enum.Enum):
    unspecified = 'Unspecified'
    NULL = 'Null'
    unknown = 'Unknown'

    def __repr__(self):
        return f'<{self.value}>'


unspecified: Final = Sentinels.unspecified
NULL: Final = Sentinels.NULL
unknown: Final = Sentinels.unknown

If you did that, then you'd be able to use a typing.Literal annotation here, which would be more expressive of the fact that unspecified is a singleton:

Suggested change
annotation: str | Unspecified = unspecified,
annotation: str | Literal[Sentinels.unspecified] = unspecified,

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Neat!

unused: bool = False,
**kwargs
):
self.name = ensure_legal_c_identifier(name)
Expand Down Expand Up @@ -2713,10 +2713,10 @@ def __init__(self,
def converter_init(self):
pass

def is_optional(self):
def is_optional(self) -> bool:
return (self.default is not unspecified)

def _render_self(self, parameter, data):
def _render_self(self, parameter: str, data: CRenderData) -> None:
self.parameter = parameter
name = self.parser_name

Expand Down Expand Up @@ -2776,7 +2776,7 @@ def _render_non_self(self, parameter, data):
if cleanup:
data.cleanup.append('/* Cleanup for ' + name + ' */\n' + cleanup.rstrip() + "\n")

def render(self, parameter, data):
def render(self, parameter: str, data: CRenderData) -> None:
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks fishy. parameter should be a Parameter instance, but also str is accepted. Let's look into that in a follow-up PR.

"""
parameter is a clinic.Parameter instance.
data is a CRenderData instance.
Expand Down Expand Up @@ -2852,31 +2852,31 @@ def declaration(self, *, in_parser=False):
declaration.append(';')
return "".join(declaration)

def initialize(self):
def initialize(self) -> str:
"""
The C statements required to set up this variable before parsing.
Returns a string containing this code indented at column 0.
If no initialization is necessary, returns an empty string.
"""
return ""

def modify(self):
def modify(self) -> str:
"""
The C statements required to modify this variable after parsing.
Returns a string containing this code indented at column 0.
If no modification is necessary, returns an empty string.
"""
return ""

def post_parsing(self):
def post_parsing(self) -> str:
"""
The C statements required to do some operations after the end of parsing but before cleaning up.
Return a string containing this code indented at column 0.
If no operation is necessary, return an empty string.
"""
return ""

def cleanup(self):
def cleanup(self) -> str:
"""
The C statements required to clean up after this variable.
Returns a string containing this code indented at column 0.
Expand Down Expand Up @@ -2929,7 +2929,7 @@ def parse_arg(self, argname, displayname):
""".format(argname=argname, paramname=self.parser_name, cast=cast)
return None

def set_template_dict(self, template_dict):
def set_template_dict(self, template_dict: dict[str, str]):
pass

@property
Expand Down