Skip to content

bpo-36896: Clarify that some types constructors are unstable#13271

Merged
encukou merged 1 commit intopython:masterfrom
Carreau:types-contrustors-unstable
Jun 3, 2019
Merged

bpo-36896: Clarify that some types constructors are unstable#13271
encukou merged 1 commit intopython:masterfrom
Carreau:types-contrustors-unstable

Conversation

@Carreau
Copy link
Contributor

@Carreau Carreau commented May 13, 2019 •
edited
Loading

At least it will represent the current state, which seem to be a
consensus; but is not explicit.

Not sure this requires a News item; it would also be good to add this
info in the constructors docstrings.

https://bugs.python.org/issue36896

@bedevere-bot bedevere-bot added docs Documentation in the Doc dir awaiting review labels May 13, 2019
csabella
csabella reviewed May 13, 2019
View reviewed changes
@encukou
Copy link
Member

encukou commented May 31, 2019

current state, which seem to be a consensus; but is not explicit

I'm trying to make the consensus explicit: https://mail.python.org/pipermail/python-dev/2019-May/157795.html
I believe "not supposed to be instantiated outside of CPython internals" is too far, with respect to how much code outside CPython is using the constructor.

@Carreau
Copy link
Contributor Author

Carreau commented May 31, 2019

Thanks @encukou I'm happy to rephrase;

I 'm just tryin to convey they are supposed to mostly be used for checking isinstance.
I believe like as for AST its unstable; but ast Nodes are undocumented and AFAICT the response is regularly the same

Would you prefer something around "stability of constructor signatures is not guaranteed between python versions, not recommend and thus not documented" ?

terryjreedy
terryjreedy previously requested changes May 31, 2019
View reviewed changes
Copy link
Member

@terryjreedy terryjreedy left a comment

Choose a reason for hiding this comment

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

Add a blurb. With very few exceptions, there should be one for every bpo issue. (If multiple PRs for an issue, there would normally still be just one blurb.)

@bedevere-bot
Copy link

bedevere-bot commented May 31, 2019

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

@Carreau Carreau force-pushed the types-contrustors-unstable branch 2 times, most recently from 90b070f to 29b5f2f Compare May 31, 2019 17:47
@Carreau
Copy link
Contributor Author

Carreau commented May 31, 2019

I have made the requested changes; please review again.

@bedevere-bot
Copy link

bedevere-bot commented May 31, 2019

Thanks for making the requested changes!

@terryjreedy: please review the changes made to this pull request.

@Carreau
bpo-36896: Clarify that some types constructors are unstable
f26a1a3 
At least it will represent the current state, which seem to be a
consensus; but is not explicit.
@Carreau Carreau force-pushed the types-contrustors-unstable branch from 29b5f2f to f26a1a3 Compare May 31, 2019 18:43
@encukou encukou dismissed terryjreedy’s stale review June 3, 2019 00:42

Blurb was added

@encukou encukou merged commit 13136e8 into python:master Jun 3, 2019
@Carreau
Copy link
Contributor Author

Carreau commented Jun 3, 2019 via email

DinoV pushed a commit to DinoV/cpython that referenced this pull request Jan 14, 2020
@Carreau @DinoV
bpo-36896: Clarify that some types constructors are unstable (pythonG…
fff8035 
…H-13271)
@Carreau Carreau mannequin mentioned this pull request Jul 3, 2022
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@pablogsal pablogsal pablogsal approved these changes

@csabella csabella csabella left review comments

@terryjreedy terryjreedy terryjreedy left review comments

Assignees

No one assigned

Labels

docs Documentation in the Doc dir

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

7 participants

@Carreau @encukou @bedevere-bot @pablogsal @terryjreedy @csabella @the-knights-who-say-ni