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.

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

Jump to bottom

Create an APE that describes the extent to which Astropy should be typed and the process for doing so #92

Open
namurphy opened this issue Dec 29, 2023 · 1 comment · May be fixed by #94
Open

Create an APE that describes the extent to which Astropy should be typed and the process for doing so #92

namurphy opened this issue Dec 29, 2023 · 1 comment · May be fixed by #94

Comments

@namurphy
Copy link
Contributor

There has been a fantastic discussion in astropy/astropy#15170 about the adding type hint annotations to Astropy. Given the magnitude of this change, we would probably benefit from an APE that answers questions like:

  • To what extent should Astropy be typed? Should we strive for mypy regular mode or aim for mypy strict mode?
  • How do we deal with existing mypy errors?
  • What is the process for adding type hint annotations to Astropy?
  • How would we go about adding mypy to the suite of continuous integration checks?
  • How do we ensure that new code is typed?
  • Should we require mypy strict mode for all new code or modules?
  • How do we deal with dynamically created content? For example, do we add a .pyi type stub file for the individual units in astropy.units?

We could also add some helpful information, like which tools we could start off using. We probably don't want to be overly prescriptive, since the tooling landscape will probably change significantly in a few years.
@namurphy namurphy mentioned this issue Dec 29, 2023
Closed
1 task
@namurphy
Copy link
Contributor Author

For the moment, I'd suggest continuing the general discussion about typing in astropy/astropy#15170 to keep it all in one place.

We could perhaps use this issue to discuss things that are more specific to writing an APE.

@namurphy namurphy linked a pull request Jan 19, 2024 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

APE 25ish: An initial roadmap for static type checking namurphy/astropy-APEs
1 participant
@namurphy