bpo-31799: Make module.__spec__ more discoverable #4010
Conversation
Doc/library/importlib.rst
Outdated
| typically exposed as the module's ``__spec__`` attribute. In the | ||
| descriptions below, the parenthetical "dunder" version names the equivalent | ||
| attribute available directly on the module object. | ||
| E.g. ``module.__spec__.name == module.__name__``. |
There was a problem hiding this comment.
This isn't quite true, since some of the names are different.
PEP 451 has the equivalence table, but we should probably move that into the library reference somewhere: https://www.python.org/dev/peps/pep-0451/#attributes
(Perhaps here?)
There was a problem hiding this comment.
Then what exactly are those parenthetical names supposed to describe?
There was a problem hiding this comment.
Maybe @brettcannon can shed some light on what those parenthetical names are supposed to mean?
There was a problem hiding this comment.
https://docs.python.org/3/library/importlib.html#importlib.machinery.ModuleSpec has the name equivalence in parentheses from dunder name to spec name.
There was a problem hiding this comment.
@brettcannon I think when you say "the name equivalence in parentheses from dunder name to spec name", you're agreeing with what I wrote in the doc change. But then I'm confused about what @ncoghlan is saying that "some of the names are different". It's true that the names in the spec are not the same as the dunder names on the module object, but that's not what I'm saying in the new docs. At least I'm trying to say what @brettcannon is saying. :) Is my wording too confusing?
There was a problem hiding this comment.
I think using the dunder jargon is what confused me, when combined with the use of an example where they are the same. (The fact I was looking at the change in isolation without any of the attribute descriptions in front of me didn't help).
I'd find this clearer:
In the descriptions below, the name given in parentheses is the corresponding attribute available directly on the module object. These values are equivalent in most cases (e.g.
module.__file__ == module.__spec__.origin), but may differ if the module attribute has been modified at runtime (e.g. when overriding__name__or updating__path__).
There was a problem hiding this comment.
Thanks @ncoghlan that was helpful clarification. I pushed an update to this section.
|
Thanks @warsaw for the PR 🌮🎉.. I'm working now to backport this PR to: 3.6. |
bpo-31799: Make module.__spec__ more discoverable (cherry picked from commit 191e313)
|
GH-4021 is a backport of this pull request to the 3.6 branch. |
This should be backported to Python 3.6
https://bugs.python.org/issue31799