FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Clarify error message for non `@runtime_checkable` decorated protocols by XuehaiPan · Pull Request #178 · python/typing_extensions · GitHub

/ typing_extensions Public

Clarify error message for non @runtime_checkable decorated protocols - #178

Merged
srittau merged 2 commits into
python:mainfrom
XuehaiPan:runtime-checkable-protocol
May 23, 2023
ConversationCommits (2)ChecksFiles changed
Merged

Clarify error message for non @runtime_checkable decorated protocols#178
srittau merged 2 commits into
python:mainfrom
XuehaiPan:runtime-checkable-protocol

Conversation

XuehaiPan commented May 23, 2023

Copy link
Copy Markdown
Contributor

Hi typing-extension team. typing-extension version 4.6.0 just came out. It has caused some of the CI failures on our side (https://github.com/metaopt/optree/actions/runs/5054617196/jobs/9069750456). We are going to fix this misusage as a bug on our side (as the new behavior will be the standard API in future Python releases). But I found the error message that was raised is not very clear.

typing_extensions/src/typing_extensions.py

Lines 703 to 704 in 356934c

raise TypeError("Instance and class checks can only be used with"
" @runtime protocols")

typing_extensions/src/typing_extensions.py

Lines 759 to 760 in 356934c

# Exists for backwards compatibility.
runtime = runtime_checkable

This PR changes deprecated @runtime to formal API @runtime_checkable in the error message.

The error in https://github.com/metaopt/optree/actions/runs/5054617196/jobs/9069750456 was raised by:

class MyProtocol(Protocol[T]):
    ...

class MyClass(MyProtocal[T]):
    ...

MyProtocal.register(MyClass)  # raises TypeError for `MyProtocol` is not `runtime_checkable`

Refs:

XuehaiPan mentioned this pull request May 23, 2023
Merged
12 tasks
AlexWaygood approved these changes May 23, 2023
View reviewed changes

AlexWaygood left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

LGTM! This matches the error message that CPython uses

srittau requested changes May 23, 2023
View reviewed changes

srittau left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Actually, could you add a CHANGELOG entry under a new # Unreleased header?

srittau merged commit b306e56 into python:main May 23, 2023
XuehaiPan deleted the runtime-checkable-protocol branch May 23, 2023 10:46
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

srittau srittau approved these changes
AlexWaygood AlexWaygood 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.

3 participants

Back | FazBrowse Home | New Git URL