Skip to content
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.

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

Gradual typing #1217

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Gradual typing #1217

wants to merge 6 commits into from

Conversation

akaihola
Copy link
Contributor

@akaihola akaihola commented Aug 29, 2024

Here's another stab at adding typing since #639 was closed.

I acknowledge that Paul has expressed that he isn't currently planning to add type hints, and that reviewing type hints would be a burden.

However, I believe this extremely minimal Mypy configuration and a minimal set of changes not only make Mypy pass, but also enable to use it to check some types, and allow development to continue without requiring full type hints everywhere.

Mypy takes over the burden of reviewing type annotations from humans.

Most notably, functions with no type hints are not checked by Mypy at all with this configuration. This allows adding type hints just only to select sections of the code base. It is still of course possible to gradually add typing overall and increase Mypy's strictness if desired.

See Using mypy with an existing codebase for more information.

@@ -35,7 +38,7 @@ class CoderPrompts:
" stop and wait for your approval."
)

repo_content_prefix = """Here are summaries of some files present in my git repository.
repo_content_prefix: str | None = """Here are summaries of some files present in my git repository.

Choose a reason for hiding this comment

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

The type union syntax X | Y is only available in Python 3.10, but Aider still supports Python 3.9.
Instead, this should be

Suggested change
repo_content_prefix: str | None = """Here are summaries of some files present in my git repository.
repo_content_prefix: typing.Optional[str] = """Here are summaries of some files present in my git repository.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

On line 1 of this file, I've added

from __future__ import annotations

which makes sure X | Y is supported on Python 3.9.

@nedtwigg
Copy link

I would think that typing an untyped python codebase is exactly the kind of thing that Aider itself would be great at. Typing the edges is trivial, that leads to type errors, fix those, that leads to new type errors, fix those, etc.

I also think if it's worth adding type annotations at all, then it's worth bumping to a Python version that supports the latest / greatest versions of them. Aider seems like more of an end-user thing than infrastructure library, seems okay for it to be more aggressive in bumping requirements than a typical library.

@Faolain
Copy link

Faolain commented Sep 22, 2024

Amazing work as this will make aider improving itself even better (from experience llms do quite well with typed code)

@akaihola akaihola force-pushed the gradual-typing branch 3 times, most recently from 26f0d2a to 0f49a3d Compare September 30, 2024 13:29
@CLAassistant
Copy link

CLAassistant commented Oct 16, 2024

CLA assistant check
All committers have signed the CLA.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants