This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: Add more documentation for ModuleSpec.loader_state.
Type: Stage: needs patch
Components: Documentation Versions: Python 3.11, Python 3.10, Python 3.9
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: docs@python Nosy List: FFY00, barry, brett.cannon, docs@python, eric.snow, ncoghlan
Priority: normal Keywords:

Created on 2021-10-04 14:51 by eric.snow, last changed 2022-04-11 14:59 by admin.

Messages (1)
msg403141 - (view) Author: Eric Snow (eric.snow) * (Python committer) Date: 2021-10-04 14:51
Currently ModuleSpec.loader_state is documented briefly once in the importlib docs. [1]  It should have more explanation, e.g. about when/why it should be used.  It should also be mentioned meaningfully in the MetapathFinder [2] and Loader [3] docs, as well as in the language reference [4].

Also see https://github.com/python/cpython/pull/28633#discussion_r720865971.

Note that ModuleSpec (and loader_state) were added in 3.4, so this documentation-only change would be helpful all the way back.  At the least we should update the docs back to 3.9, the current bug-fix release.


[1] https://docs.python.org/3/library/importlib.html#importlib.machinery.ModuleSpec.loader_state
[2] https://docs.python.org/3/library/importlib.html#importlib.abc.MetaPathFinder
[3] https://docs.python.org/3/library/importlib.html#importlib.abc.Loader
[4] https://docs.python.org/3/reference/import.html#loaders or https://docs.python.org/3/reference/import.html#module-spec
History
Date User Action Args
2022-04-11 14:59:50adminsetgithub: 89527
2021-10-23 17:03:40FFY00setnosy: + FFY00
2021-10-04 14:51:53eric.snowcreate