Skip to content

STY: disallow typing.Any and allow missing type annotations - #20451

Draft
neutrinoceros wants to merge 3 commits into
astropy:mainfrom
neutrinoceros:typ/no-any
Draft

neutrinoceros wants to merge 3 commits into
astropy:mainfrom
neutrinoceros:typ/no-any

Conversation

@neutrinoceros

Copy link
Copy Markdown
Contributor

Description

I propose tweaking our linting rules to allow partially typed signatures rather than only allowing all-or-nothings. Also dissallow typing.Any as it's basically useless and there is no reason to keep it around if we allow gradual typing.

AI Disclosure

N/A

  • I certify that I am human and that I take full responsibility for this pull request including all interactions with reviewers.

Merge method

  • By checking this box, the PR author has requested that maintainers do NOT use the "Squash and Merge" button. Maintainers should respect this when possible; however, the final decision is at the discretion of the maintainer that merges the PR.

@github-actions

Copy link
Copy Markdown
Contributor

Thank you for your contribution to Astropy! 🌌 This checklist is meant to remind the package maintainers who will review this pull request of some common things to look for.

  • Do the proposed changes actually accomplish desired goals?
  • Do the proposed changes follow the Astropy coding guidelines?
  • Are tests added/updated as required? If so, do they follow the Astropy testing guidelines?
  • Are docs added/updated as required? If so, do they follow the Astropy documentation guidelines?
  • Is rebase and/or squash necessary? If so, please provide the author with appropriate instructions. Also see instructions for rebase and squash.
  • Did the CI pass? If no, are the failures related? If you need to run daily and weekly cron jobs as part of the PR, please apply the "Extra CI" label. Codestyle issues can be fixed by the bot.
  • Is a change log needed? If yes, did the change log check pass? If no, add the "no-changelog-entry-needed" label. If this is a manual backport, use the "skip-changelog-checks" label unless special changelog handling is necessary.
  • Is this a big PR that makes a "What's new?" entry worthwhile and if so, is (1) a "what's new" entry included in this PR and (2) the "whatsnew-needed" label applied?
  • At the time of adding the milestone, if the milestone set requires a backport to release branch(es), apply the appropriate "backport-X.Y.x" label(s) before merge.

@neutrinoceros

Copy link
Copy Markdown
Contributor Author

I broke runtime so I expect some obvious mistake slipped in.

@neutrinoceros

This comment was marked as outdated.

@taldcroft

Copy link
Copy Markdown
Member

There are valid reasons for using Any and I think that globally disallowing it is going too far. The fact that the standard library does indeed use it and it exists as a construct in typing seems reason enough to let the humans decide if/when Any is OK on a case-by-case basis.

https://adamj.eu/tech/2021/06/14/python-type-hints-3-somewhat-unexpected-uses-of-typing-any-in-pythons-standard-library/

@neutrinoceros

Copy link
Copy Markdown
Contributor Author

I'll split this PR in two parts. My actual goal is to pertain usage of Any as a way to satisfy ANN001 et al.

@neutrinoceros

Copy link
Copy Markdown
Contributor Author

I'm keeping this PR around as a reminder but my goal is now to re-open a cosmology-focused version of it to remove Any where it makes sense to.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: Triage

Development

Successfully merging this pull request may close these issues.

2 participants