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

Merge openpyxl stubs from microsoft/python-type-stubs #9511

Draft

Avasam wants to merge 91 commits into python:main from Avasam:openpyxl-from-microsoft-python-type-stubs

Sponsor Collaborator

Avasam commented Jan 12, 2023 •

edited

Loading

Bring openpyxl stubs at least up to par with https://github.com/microsoft/python-type-stubs/tree/main/openpyxl

Add class variable types and descriptors for affected classes.
For a bit of context: "descriptor" types are assigned to class variables. Those become property-like with getters that type-check on assignment.
There's also "Convertible" descriptors that do type coercion.

This is not meant to complete the stub, far from there. Only to make it good enough to upstream. And a few other things here and there.

There's overlap with ~~#9487~~ #9764, I'd suggest finishing that PR first, then I'll double check any conflict that arise.
I'll look at primer results after that as well.

Avasam added 5 commits

January 10, 2023 05:33


          Bring openpyxl stubs at least up to par with microsoft/python-type-stubs

e371358


          Merge branch 'main' of https://github.com/python/typeshed into openpy…

f47d473

…xl-from-microsoft-python-type-stubs


          Merge branch 'main' of https://github.com/python/typeshed into openpy…

e08d3ea

…xl-from-microsoft-python-type-stubs


          Include numpy

9c14076


          Convertible Descriptors

4e7fc09

Avasam commented

View reviewed changes

stubs/openpyxl/@tests/stubtest_allowlist.txt Outdated Show resolved Hide resolved

Avasam commented

View reviewed changes

stubs/openpyxl/@tests/stubtest_allowlist.txt Outdated Show resolved Hide resolved

Avasam commented

View reviewed changes

stubs/openpyxl/openpyxl/drawing/image.pyi Outdated Show resolved Hide resolved

Avasam commented

View reviewed changes

stubs/openpyxl/openpyxl/styles/colors.pyi Outdated Show resolved Hide resolved

This comment has been minimized.

Sign in to view

Member

AlexWaygood commented Jan 12, 2023

(Adding DO-NOT-MERGE for now, as I agree we should resolve #9487 first before tackling this :)

AlexWaygood added the status: DO NOT MERGE label

Avasam commented

View reviewed changes

stubs/openpyxl/openpyxl/xml/functions.pyi Outdated Show resolved Hide resolved

Avasam commented

View reviewed changes

stubs/openpyxl/openpyxl/xml/_functions.pyi Outdated Show resolved Hide resolved

Sponsor Collaborator Author

Avasam commented Jan 12, 2023

In the meantime, @AlexWaygood , can we consider allowing lxml-stubs in the stubuploader?

Also, is there a list somewhere of those "stubs taken out of typeshed because incomplete"? I feel it shouldn't be too hard to add 'em back with modern stubgen.

Member

AlexWaygood commented Jan 12, 2023

In the meantime, @AlexWaygood , can we consider allowing lxml-stubs in the stubuploader?

SGTM but I'm not a stub-uploader maintainer :)

Member

AlexWaygood commented Jan 12, 2023 •

edited

Loading

Also, is there a list somewhere of those "stubs taken out of typeshed because incomplete"? I feel it shouldn't be too hard to add 'em back with modern stubgen.

Not sure I understand, sorry -- what's this a reference to?

Sponsor Collaborator Author

Avasam commented Jan 12, 2023

Not sure I understand, sorry -- what's this a reference to?

https://pypi.org/project/lxml-stubs/

These type annotations were initially included in typeshed, but lxml's annotations are still incomplete and have therefore been extracted from typeshed to avoid unintentional false positive results.

I feel it's not the first time I see that. Or maybe it is and I just read it twice on the same page.

Member

AlexWaygood commented Jan 12, 2023

You'll have to ask one of the other maintainers -- sounds like that all happened before I arrived on the typeshed scene!


          Update after self-review

8a9de85

This comment has been minimized.

Sign in to view

Member

AlexWaygood commented Jan 12, 2023

In the meantime, @AlexWaygood , can we consider allowing lxml-stubs in the stubuploader?

SGTM but I'm not a stub-uploader maintainer :)

On second thought -- with our current setup, I think you'll be unable to use lxml-stubs even if wwe add them to the stub-uploader allowlist :( The current rules on the stub-uploader are that non-types dependencies must be explicitly included in the "non-types allowlist", and also be specified as a requirement of the runtime package. But the runtime package doesn't declare lxml-stubs as a dependency, so the stub-uploader tests will fail even if we add lxml-stubs in the stub-uploader :/

This is an annoying situation but I'm not sure what the solution might be.

parched mentioned this pull request

openpyxl: add a few type annotations #9681

Closed

Avasam added 2 commits

February 8, 2023 10:43


          Merge branch 'main' of https://github.com/python/typeshed into openpy…

704399f

…xl-from-microsoft-python-type-stubs


          Update tests

dd5a152

This comment has been minimized.

Sign in to view


          Fix pytype errors

f11292d

This comment has been minimized.

Sign in to view

This was referenced Feb 19, 2023

Additional type hints added to stub openpyxl #9487

Closed

Allowing more external dependencies for stubs typeshed-internal/stub_uploader#90

Open


          Merge branch 'main' of https://github.com/python/typeshed into openpy…

fd5a9a9

…xl-from-microsoft-python-type-stubs

Contributor

github-actions bot commented Dec 4, 2023

According to mypy_primer, this change has no effect on the checked open source code. 🤖🎉

Avasam mentioned this pull request

openpyxl: Type styleable descriptors #11103

Merged


          Merge branch 'main' of https://github.com/python/typeshed into openpy…

333054d

…xl-from-microsoft-python-type-stubs

Contributor

github-actions bot commented Dec 6, 2023

According to mypy_primer, this change has no effect on the checked open source code. 🤖🎉


          Merge branch 'main' of https://github.com/python/typeshed into openpy…

b35695d

…xl-from-microsoft-python-type-stubs

Contributor

github-actions bot commented Mar 6, 2024

According to mypy_primer, this change has no effect on the checked open source code. 🤖🎉

Avasam commented

View reviewed changes

stubs/openpyxl/openpyxl/worksheet/_reader.pyi Outdated Show resolved Hide resolved


          Update stubs/openpyxl/openpyxl/worksheet/_reader.pyi

3b0034b

Contributor

github-actions bot commented Mar 6, 2024

According to mypy_primer, this change has no effect on the checked open source code. 🤖🎉

Avasam added a commit to Avasam/typeshed that referenced this pull request


          Simpler leftover changes from python#9511

10e03fd

Avasam mentioned this pull request

openpyxl: Simpler leftover changes from the microsoft/python-type-stubs merge #11534

Merged

Avasam added 2 commits

March 11, 2024 13:23


          Merge branch 'main' of https://github.com/python/typeshed into openpy…

6290b35

…xl-from-microsoft-python-type-stubs


          Merge branch 'openpyxl-from-microsoft-python-type-stubs' of https://g…

08e4e91

…ithub.com/Avasam/typeshed into openpyxl-from-microsoft-python-type-stubs

Contributor

github-actions bot commented Mar 11, 2024

According to mypy_primer, this change has no effect on the checked open source code. 🤖🎉

Avasam mentioned this pull request

Policy for stale PRs #11583

Closed


          Merge branch 'main' of https://github.com/python/typeshed into openpy…

a9021fc

…xl-from-microsoft-python-type-stubs

Contributor

github-actions bot commented Mar 13, 2024

According to mypy_primer, this change has no effect on the checked open source code. 🤖🎉

Avasam mentioned this pull request

openpyxl: Add _WorkbookChild / ReadOnlyWorksheet / Workbook annotations #11677

Merged


          Merge branch 'main' of https://github.com/python/typeshed into openpy…

2bf8906

…xl-from-microsoft-python-type-stubs

Contributor

github-actions bot commented Apr 1, 2024

According to mypy_primer, this change has no effect on the checked open source code. 🤖🎉


          Merge branch 'main' of https://github.com/python/typeshed into openpy…

8db96b3

…xl-from-microsoft-python-type-stubs

Contributor

github-actions bot commented Apr 8, 2024

According to mypy_primer, this change has no effect on the checked open source code. 🤖🎉


          Merge branch 'main' into openpyxl-from-microsoft-python-type-stubs

e2f2720

Contributor

github-actions bot commented Aug 18, 2024

According to mypy_primer, this change has no effect on the checked open source code. 🤖🎉


          Merge branch 'main' into openpyxl-from-microsoft-python-type-stubs

Contributor

github-actions bot commented Sep 23, 2024

According to mypy_primer, this change has no effect on the checked open source code. 🤖🎉

Member

JelleZijlstra commented Oct 2, 2024

@Avasam this is now the oldest open PR and CI is green, but it's still in draft. Is it ready now? If not, what is the plan for this PR?

Sponsor Collaborator Author

Avasam commented Oct 2, 2024 •

edited

Loading

I've been extracting changes by scope and concepts they relate to, which allowed me to validate the changes actually made sense and fix entire sections of openpyxl stubs at once. (this PR started with over 80 files changed)

The only thing left here would be a PR that covers adding annotations for openpyxl Cell Values and that should close this PR.

Avasam added the status: DO NOT MERGE label

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

Labels

status: DO NOT MERGE