From 2d7720418008582aefe3a031b78ef4e867e75d09 Mon Sep 17 00:00:00 2001 From: Brett Cannon Date: Fri, 14 Jun 2013 19:19:57 -0400 Subject: [PATCH] Issue #17907: Document types.ModuleType's constructor and attributes, allowing for documenting imp.new_module() as deprecated. --- Doc/library/imp.rst | 3 +++ Doc/library/types.rst | 30 ++++++++++++++++++++++++++++-- Misc/NEWS | 3 +++ 3 files changed, 34 insertions(+), 2 deletions(-) diff --git a/Doc/library/imp.rst b/Doc/library/imp.rst index 890c171a15d..c6a07ca6558 100644 --- a/Doc/library/imp.rst +++ b/Doc/library/imp.rst @@ -112,6 +112,9 @@ This module provides an interface to the mechanisms used to implement the Return a new empty module object called *name*. This object is *not* inserted in ``sys.modules``. + .. deprecated:: 3.4 + Use :class:`types.ModuleType` instead. + .. function:: reload(module) diff --git a/Doc/library/types.rst b/Doc/library/types.rst index 95132e8db45..c4f57e43af3 100644 --- a/Doc/library/types.rst +++ b/Doc/library/types.rst @@ -107,9 +107,35 @@ Standard names are defined for the following types: C".) -.. data:: ModuleType +.. class:: ModuleType(name, doc=None) - The type of modules. + The type of :term:`modules `. Constructor takes the name of the + module to be created and optionally its :term:`docstring`. + + .. attribute:: __doc__ + + The :term:`docstring` of the module. Defaults to ``None``. + + .. attribute:: __loader__ + + The :term:`loader` which loaded the module. Defaults to ``None``. + + .. versionchanged:: 3.4 + Defaults to ``None``. Previously the attribute was optional. + + .. attribute:: __name__ + + The name of the module. + + .. attribute:: __package__ + + Which :term:`package` a module belongs to. If the module is top-level + (i.e. not a part of any specific package) then the attribute should be set + to ``''``, else it should be set to the name of the package (which can be + :attr:`__name__` if the module is a package itself). Defaults to ``None``. + + .. versionchanged:: 3.4 + Defaults to ``None``. Previously the attribute was optional. .. data:: TracebackType diff --git a/Misc/NEWS b/Misc/NEWS index f676dba49f1..3ebc4a8574d 100644 --- a/Misc/NEWS +++ b/Misc/NEWS @@ -123,6 +123,9 @@ Core and Builtins Library ------- +- Issue #17907: Document imp.new_module() as deprecated in favour of + types.ModuleType. + - Issue #18192: Introduce importlib.util.MAGIC_NUMBER and document as deprecated imp.get_magic().