[docs] [issue21760] inspect documentation describes module type inaccurately

Eric Snow report at bugs.python.org
Sat Jun 14 21:58:13 CEST 2014

New submission from Eric Snow:

In the documentation for the inspect module, the module type is described with just 2 of its potential 7 attributes.  The language reference[2] and importlib docs[3] both provide an accurate list of module attributes.

Furthermore, the description for __file__ should be fixed.  It should be clear that __file__ reflects the location from which the module was loaded, that location is not necessarily a filename, and the attribute may not exist if the module was not loaded from a specific location (e.g. builtin and frozen modules).  The same goes for __cached__

[1] https://docs.python.org/dev/library/inspect.html#types-and-members
[2] https://docs.python.org/3/reference/import.html#import-related-module-attributes
[3] https://docs.python.org/3/library/importlib.html#importlib.machinery.ModuleSpec

assignee: docs at python
components: Documentation
messages: 220576
nosy: docs at python, eric.snow
priority: normal
severity: normal
stage: needs patch
status: open
title: inspect documentation describes module type inaccurately
versions: Python 3.4, Python 3.5

Python tracker <report at bugs.python.org>

More information about the docs mailing list