Python Module Internal Representation and Introspection: Difference between revisions
Line 29: | Line 29: | ||
The directory portion of <code>__file__</code> should be one of the directories in <code>[[Python_Language_Modularization#sys.path|sys.path]]</code>. | The directory portion of <code>__file__</code> should be one of the directories in <code>[[Python_Language_Modularization#sys.path|sys.path]]</code>. | ||
===<tt>__doc__</tt>=== | ===<tt>__doc__</tt>=== | ||
The content of the [[Python_Language_Modularization#Module_Docstring|module docstring]], if declared, otherwise None. | The content of the [[Python_Language_Modularization#Module_Docstring|module docstring]], if declared, otherwise <code>None</code>. | ||
===<tt>__cached__</tt>=== | ===<tt>__cached__</tt>=== |
Revision as of 03:51, 4 January 2023
Internal
Overview
The module Class
All module and package instances are represented internally as instances of the module
class.
Attributes
All object instances declared in the module (variables, functions, etc.) become attributes of the module instance and they are accessible with inspect.getmembers()
. Additionally, the following special attributes are present:
__name__
The name of the module, as string.
import mymodule
assert mymodule.__name__ == 'mymodule'
__file__
Once imported, the file associated with the module can be determined using the module object's __file__
attribute, as string:
import mymodule
[...]
print(mymodule.__file__)
The directory portion of __file__
should be one of the directories in sys.path
.
__doc__
The content of the module docstring, if declared, otherwise None
.
__cached__
__loader__
__path__
The __path__
attribute exists only for module
instances that represent packages, not for those instances that represent ordinary modules.
__path__
contains the path of the package root directory, where the component modules, subpackages, __init__.py
and __main__.py
live.