| FazBrowse GitHub Viewer | Trending | | Home |
| Tools: [Download Repo ZIP] [Original HTTPS Page] |
Sorry, something went wrong.
…() docs Co-authored-by: Carol Willing <carolcode@willingconsulting.com> Co-authored-by: Gregory P. Smith <greg@krypto.org> Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
|
I disapprove of this way of solving the issue. @ethanfurman did not explain the rationale for changing the inspect module this way for the sole benefit of enum where it would have been just as easy not to (as #115984 shows). The use of __signature__ as a cache - or as a lie to hide undocumented parameters - is too useful a feature to be undocumented. |
Sorry, something went wrong.
There was a problem hiding this comment.
I'd leave the "Consult the source code for current semantics." bit off as that feels implied to be when calling something "an implementation detail". But no big deal either way as it is true.
I do understand the Python user desire for officially describing and documenting __signature__ behavior as a public API people can rely on. That's outside the scope of this specific issue as this doc update is just trying to set expectations anywhere the existing implementation detail is mentioned.
Sorry, something went wrong.
There was a problem hiding this comment.
@erlend-aasland I think this documentation change with the implementation detail directive accurately reflects the current status of the underlying source code.
Sorry, something went wrong.
@Gouvernathor As @gpshead mentions, I think having a separate (from documentation) discussion about behavior as a public API makes good sense. Also, I see you maintain ren'py, thanks for doing so. For years, my daughter used it to create interactive game scenarios (she is now a game developer). |
Sorry, something went wrong.
|
Should I close #115984 in favor of this approach? |
Sorry, something went wrong.
Yes, please. |
Sorry, something went wrong.
|
Thanks for the reviews! |
Sorry, something went wrong.
…() docs (pythonGH-116086) (cherry picked from commit fb2e17b) Co-authored-by: Erlend E. Aasland <erlend@python.org> Co-authored-by: Carol Willing <carolcode@willingconsulting.com> Co-authored-by: Gregory P. Smith <greg@krypto.org> Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
…() docs (pythonGH-116086) (cherry picked from commit fb2e17b) Co-authored-by: Erlend E. Aasland <erlend@python.org> Co-authored-by: Carol Willing <carolcode@willingconsulting.com> Co-authored-by: Gregory P. Smith <greg@krypto.org> Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
|
GH-116106 is a backport of this pull request to the 3.12 branch. |
Sorry, something went wrong.
|
GH-116107 is a backport of this pull request to the 3.11 branch. |
Sorry, something went wrong.
…e() docs (GH-116086) (#116106) gh-115937: Remove implementation details from inspect.signature() docs (GH-116086) (cherry picked from commit fb2e17b) Co-authored-by: Erlend E. Aasland <erlend@python.org> Co-authored-by: Carol Willing <carolcode@willingconsulting.com> Co-authored-by: Gregory P. Smith <greg@krypto.org> Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
…e() docs (GH-116086) (#116107) gh-115937: Remove implementation details from inspect.signature() docs (GH-116086) (cherry picked from commit fb2e17b) Co-authored-by: Erlend E. Aasland <erlend@python.org> Co-authored-by: Carol Willing <carolcode@willingconsulting.com> Co-authored-by: Gregory P. Smith <greg@krypto.org> Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
Following this, I think I will open a non-doc issue about reverting what #100039 changed about signatures. But aside from that, and contrary to my first impression, that Enum PR didn't actually introduce an incompatible change. The __signature__ field accepted a Signature|None object since around 2014 (raising a TypeError for other types) and now accepts Signature|str|Callable[[], Signature]|None which is wider.
You're very welcome. All the best to your daughter. |
Sorry, something went wrong.
…() docs (python#116086) Co-authored-by: Carol Willing <carolcode@willingconsulting.com> Co-authored-by: Gregory P. Smith <greg@krypto.org> Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
…() docs (python#116086) Co-authored-by: Carol Willing <carolcode@willingconsulting.com> Co-authored-by: Gregory P. Smith <greg@krypto.org> Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
…() docs (python#116086) Co-authored-by: Carol Willing <carolcode@willingconsulting.com> Co-authored-by: Gregory P. Smith <greg@krypto.org> Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
| Back | FazBrowse Home | New Git URL |
Co-authored-by: Carol Willing carolcode@willingconsulting.com
Co-authored-by: Gregory P. Smith greg@krypto.org
Co-authored-by: Jelle Zijlstra jelle.zijlstra@gmail.com
📚 Documentation preview 📚: https://cpython-previews--116086.org.readthedocs.build/