TYP: implement a `MixinColumn` `typing.Protocol` by neutrinoceros · Pull Request #17189 · astropy/astropy

neutrinoceros · 2024-10-16T12:43:03Z

Description

Extracted from, and to be used in #17051, as suggested by @eerovaher

This formalizes an already documented protocol.

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 · 2024-10-16T12:43:29Z

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.

github-actions · 2024-10-16T12:43:31Z

👋 Thank you for your draft pull request! Do you know that you can use [ci skip] or [skip ci] in your commit messages to skip running continuous integration tests until you are ready?

eerovaher · 2024-10-21T17:57:57Z

+    info: MixinInfo
+    shape: tuple[int, ...]
+
+    def __getitem__(self, key): ...


MixinColumn is clearly a generic type where the parameter must agree with the return type of __getitem__().

makes sense, though I'm not sure how well this mixes with a Protocol, but let's give it a try !

The return type of __getitem__ can be either MixinColumn or a scalar element of MixinColumn. I'm not sure how to capture that.

I think this was addressed with TypeVar + Protocol[T] + @overloading. Good to go, @eerovaher ?

Good enough for me, but its the sub-package maintainer that should do the final review.

neutrinoceros · 2024-10-25T13:24:15Z

We're hours away from astropy 7.0's feature freeze and this shouldn't be blocking in any way, so I'll bump the milestone to clear the backlog. If this happened to be merged today anyway, please revert the milestone.

neutrinoceros · 2024-12-17T10:16:36Z

Taking this one to draft for now, as I committed a partial implementation of @nstarman's suggestion but I'm now uncertain that it is the right approach. Further discussion needed in #17189 (comment)

github-actions · 2025-05-17T05:40:19Z

Hi humans 👋 - this pull request hasn't had any new commits for approximately 4 months. I plan to close this in 30 days if the pull request doesn't have any new commits by then.

In lieu of a stalled pull request, please consider closing this and open an issue instead if a reminder is needed to revisit in the future. Maintainers may also choose to add keep-open label to keep this PR open but it is discouraged unless absolutely necessary.

If this PR still needs to be reviewed, as an author, you can rebase it to reset the clock.

If you believe I commented on this pull request incorrectly, please report this here.

github-actions · 2026-10-16T05:42:47Z

Hi humans 👋 - this pull request hasn't had any new commits for approximately 1 year, 10 months. I plan to close this in a month if the pull request doesn't have any new commits by then.

In lieu of a stalled pull request, please consider closing this and open an issue instead if a reminder is needed to revisit in the future. Maintainers may also choose to add keep-open label to keep this PR open but it is discouraged unless absolutely necessary.

If this PR still needs to be reviewed, as an author, you can rebase it to reset the clock.

If you believe I commented on this pull request incorrectly, please report this here.

Co-authored-by: Nathaniel Starkman <[email protected]>

nstarman · 2026-11-08T22:43:59Z

@neutrinoceros what's the latest on this?

github-actions Bot added the table label Oct 16, 2024

neutrinoceros mentioned this pull request Oct 16, 2024

TST: re-unify a testing function previously copy-pasted (and patched) accross 4 modules (⏰ wait for #17189) #17051

Draft

1 task

neutrinoceros added this to the v7.0.0 milestone Oct 16, 2024

neutrinoceros changed the title ~~TYP: implement a MixinColumn typing.Protocol~~ TYP: implement a MixinColumn typing.Protocol Oct 16, 2024

neutrinoceros added the no-changelog-entry-needed label Oct 17, 2024

neutrinoceros marked this pull request as ready for review October 17, 2024 13:48

neutrinoceros requested a review from taldcroft as a code owner October 17, 2024 13:48

eerovaher reviewed Oct 21, 2024

View reviewed changes

neutrinoceros force-pushed the table/typing/implement_mixin_column_protocol branch from 4d3acb3 to 5a98de4 Compare October 22, 2024 07:57

neutrinoceros mentioned this pull request Oct 22, 2024

DOC: fix a misleading use of 'subclass' in docs #17229

Merged

1 task

eerovaher reviewed Oct 23, 2024

View reviewed changes