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

Update importlib resources for 3.13 #12298

Merged
merged 68 commits into from
Sep 16, 2024
Merged

Update importlib resources for 3.13 #12298

merged 68 commits into from
Sep 16, 2024

Conversation

max-muoto
Copy link
Contributor

@max-muoto max-muoto commented Jul 9, 2024 •
edited
Loading

Update importlib.resources based on 3.13 API changes: python/cpython#116609

@max-muoto max-muoto marked this pull request as draft July 9, 2024 04:00
max-muoto
max-muoto commented Jul 9, 2024
View reviewed changes
stdlib/importlib/resources/__init__.pyi Outdated
if sys.version_info >= (3, 13):
def open_binary(anchor: Anchor, *path_names: StrPath) -> BinaryIO: ...
@overload
def open_text(anchor: Anchor, *path_names: *tuple[StrPath], encoding: str = "utf-8", errors: str = "strict") -> TextIO: ...
Copy link
Contributor Author

Choose a reason for hiding this comment

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

If one path name is provided, the encoding defaults to utf-8, otherwise it's required: https://github.com/python/cpython/blob/3.13/Lib/importlib/resources/_functional.py#L67

@max-muoto max-muoto marked this pull request as ready for review July 9, 2024 04:27
@github-actions GitHub Actions

This comment has been minimized.

Sign in to view
@srittau
Copy link
Collaborator

srittau commented Jul 10, 2024

There's a merge conflict in the allowlist now.

@github-actions GitHub Actions

This comment has been minimized.

Sign in to view
srittau
srittau reviewed Jul 10, 2024
View reviewed changes
stdlib/importlib/resources/__init__.pyi Outdated
Comment on lines 28 to 31
Package: TypeAlias = str | ModuleType

if sys.version_info >= (3, 11):
Resource: TypeAlias = str
else:
if sys.version_info >= (3, 13):
Anchor: TypeAlias = Package
Copy link
Collaborator

Choose a reason for hiding this comment

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

I'd put these into ._common, like in the implementation (introduced in Python 3.11). Or at least Anchor, since it was newly introduced.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed! 9cc4585

@github-actions GitHub Actions

This comment has been minimized.

Sign in to view
3 similar comments
@github-actions GitHub Actions

This comment has been minimized.

Sign in to view
@github-actions GitHub Actions

This comment has been minimized.

Sign in to view
@github-actions GitHub Actions

This comment has been minimized.

Sign in to view
@max-muoto
Copy link
Contributor Author

@srittau It seems we're still running stubtest on importlib.resources._functional even though it only exists on 3.13+, does this seem right to you?

@srittau
Copy link
Collaborator

srittau commented Jul 15, 2024

I've added two suggestions that will hopefully help.

max-muoto
max-muoto commented Jul 16, 2024
View reviewed changes
stdlib/@tests/stubtest_allowlists/py313.txt Outdated
@@ -204,3 +194,7 @@ codecs.namereplace_errors
codecs.replace_errors
codecs.strict_errors
codecs.xmlcharrefreplace_errors

# Runtime dynamically renames kwargs
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Runtime uses a decorator to support the leagcy kwargs: https://github.com/python/cpython/blob/2bac2b86b1486f15038fb246835e04bb1b213cd8/Lib/importlib/resources/_common.py#L4

@github-actions GitHub Actions

This comment has been minimized.

Sign in to view
@srittau
Copy link
Collaborator

srittau commented Jul 16, 2024

Looking at the code in mypy_test, it seems that we are not actually handling sub-modules at all when it comes to the VERSIONS file. I will send a PR.

@srittau srittau mentioned this pull request Jul 16, 2024
Merged
@AlexWaygood AlexWaygood mentioned this pull request Jul 16, 2024
Merged
@github-actions GitHub Actions

This comment has been minimized.

Sign in to view
@srittau
Copy link
Collaborator

srittau commented Jul 16, 2024

The mypy errors are gone now. I have some ideas about fixing the pyright test, but I need to find some time in the next few days.

@max-muoto
Copy link
Contributor Author

The mypy errors are gone now. I have some ideas about fixing the pyright test, but I need to find some time in the next few days.

Thanks!

@github-actions GitHub Actions

This comment has been minimized.

Sign in to view
@max-muoto
Copy link
Contributor Author

I think the easiest solution for now is to add stdlib/importlib/resources/_functional.pyi to the exclude list of pyrightconfig.stricter.json (with an appropriate comment).

I ended up just nesting the imports under additionally type-checking blocks. While a bit more verbose, I think it works well so we can avoid false unrelated false negatives in these files. Let me know what you think!

@github-actions GitHub Actions

This comment has been minimized.

Sign in to view
srittau
srittau requested changes Sep 16, 2024
View reviewed changes
stdlib/@tests/test_cases/check_importlib_resources.py Outdated Show resolved Hide resolved
stdlib/importlib/resources/__init__.pyi Outdated Show resolved Hide resolved
stdlib/importlib/resources/__init__.pyi Outdated Show resolved Hide resolved
stdlib/importlib/resources/__init__.pyi Outdated Show resolved Hide resolved
stdlib/importlib/resources/__init__.pyi Outdated Show resolved Hide resolved
max-muoto and others added 6 commits September 16, 2024 12:29
@max-muoto @srittau
Update stdlib/importlib/resources/__init__.pyi
db7f52c 
Co-authored-by: Sebastian Rittau <srittau@rittau.biz>
@max-muoto @srittau
Update stdlib/importlib/resources/__init__.pyi
60e7c31 
Co-authored-by: Sebastian Rittau <srittau@rittau.biz>
@max-muoto @srittau
Update stdlib/importlib/resources/__init__.pyi
51f9a42 
Co-authored-by: Sebastian Rittau <srittau@rittau.biz>
@max-muoto @srittau
Update stdlib/importlib/resources/__init__.pyi
8d16119 
Co-authored-by: Sebastian Rittau <srittau@rittau.biz>
@max-muoto @srittau
Update stdlib/@tests/test_cases/check_importlib_resources.py
751673e 
Co-authored-by: Sebastian Rittau <srittau@rittau.biz>
@max-muoto
Merge branch 'main' into importlib.resources
141a6e8
@max-muoto
Copy link
Contributor Author

@srittau Thanks, implemented your feedback.

@github-actions GitHub Actions
Copy link
Contributor

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

@srittau srittau merged commit 85121de into python:main Sep 16, 2024
63 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@srittau srittau srittau approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@max-muoto @srittau