[issue27505] Missing documentation for setting module __class__ attribute
New submission from Nick Coghlan: Python 3.5 added the ability to set module __class__ attributes by way of http://bugs.python.org/issue22986 However, this isn't covered in the What's New guide or anywhere else in the documentation, and even in the NEWS file it appears under the cryptic title "Issue #22986: Allow changing an object’s __class__ between a dynamic type and static type in some cases." for 3.5.0a1 This should be documented somewhere (perhaps in the data model section of the language reference?) and an example given of using the feature to emit DeprecationWarning for access to a particular module level attribute. It should also be mentioned in the Python 3.5 What's New documentation. ---------- assignee: docs@python components: Documentation messages: 270285 nosy: docs@python, ncoghlan, njs priority: normal severity: normal stage: needs patch status: open title: Missing documentation for setting module __class__ attribute type: enhancement versions: Python 3.5, Python 3.6 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue27505> _______________________________________
Changes by Nick Coghlan <ncoghlan@gmail.com>: ---------- dependencies: +Improved handling of __class__ assignment _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue27505> _______________________________________
Cheryl Sabella <chekat2@gmail.com> added the comment: Hi Nick, I started looking at this issue for documenting #22986 and then found #24912 and #24991. Has anything changed in the code since 2015 that would make these issues (this one and 24991) obsolete? It seems there were a lot of ideas flying around, but I couldn't find other tickets (and the code is still in place for 22986 and 24912). If these haven't been superseded, do you think the discussion on #24991 should be continued or should the documentation mentioned in this issue still be done? Thanks! ---------- nosy: +csabella _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue27505> _______________________________________
Nick Coghlan <ncoghlan@gmail.com> added the comment: This is still a valid docs issue, although PEP 562's module __getattr__ and __dir__ will provide a simpler alternative for most of the cases that previously required setting the __class__ attribute: https://www.python.org/dev/peps/pep-0562/ So I've added https://bugs.python.org/issue32225 as a dependency for this issue, as it will likely make sense to figure out a good docs structure for those changes first, and then see if there's any work left to do specifically for this issue: https://bugs.python.org/issue32225#msg307935 Issue #24991 is a fairly different topic - I've added an extra comment there that should help clarify the actual question/proposal. ---------- dependencies: +Implement PEP 562: module __getattr__ and __dir__ _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue27505> _______________________________________
Cheryl Sabella <chekat2@gmail.com> added the comment: Nick, It looks like #32225 took care of this documentation change, so I think this can be closed? Thanks! ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue27505> _______________________________________
Nick Coghlan <ncoghlan@gmail.com> added the comment: I think the only thing missing for the 3.7 docs now would be a pair of "versionchanged" notes indicating that __class__ has been settable since 3.5, while module level __dir__ and __getattr__ support is new in 3.7. It would also be desirable to add the __class__ docs to the 3.6 maintenance branch. ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue27505> _______________________________________
Change by Cheryl Sabella <chekat2@gmail.com>: ---------- keywords: +patch pull_requests: +5165 stage: needs patch -> patch review _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue27505> _______________________________________
Change by Cheryl Sabella <chekat2@gmail.com>: ---------- pull_requests: +5166 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue27505> _______________________________________
Cheryl Sabella <chekat2@gmail.com> added the comment: Thanks Nick. I've made the PRs for the versionadded and to add __class__ to the 3.6 docs. ---------- stage: patch review -> needs patch versions: +Python 3.7 -Python 3.5 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue27505> _______________________________________
Change by Cheryl Sabella <chekat2@gmail.com>: ---------- stage: needs patch -> patch review _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue27505> _______________________________________
Nick Coghlan <ncoghlan@gmail.com> added the comment: New changeset 85527cf50a9a4eecaca4022f7c6cb9e0bae1fa5f by Nick Coghlan (Cheryl Sabella) in branch 'master': bpo-27505: Add change notes in module attribute docs (GH-5320) https://github.com/python/cpython/commit/85527cf50a9a4eecaca4022f7c6cb9e0bae... ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue27505> _______________________________________
Nick Coghlan <ncoghlan@gmail.com> added the comment: New changeset 8f68cb7db37322cfeeb8338e78474e5f25d930c5 by Nick Coghlan (Cheryl Sabella) in branch '3.6': [3.6] bpo-27505: Retrofit module __class__ documentation from 3.7 (GH-5321) https://github.com/python/cpython/commit/8f68cb7db37322cfeeb8338e78474e5f25d... ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue27505> _______________________________________
Nick Coghlan <ncoghlan@gmail.com> added the comment: Thanks for the PRs! ---------- resolution: -> fixed stage: patch review -> resolved status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue27505> _______________________________________
participants (2)
-
Cheryl Sabella -
Nick Coghlan