diff options
author | Ethan Furman <ethan@stoneleaf.us> | 2015-01-15 05:56:49 (GMT) |
---|---|---|
committer | Ethan Furman <ethan@stoneleaf.us> | 2015-01-15 05:56:49 (GMT) |
commit | 845d33c526b6e6408cb75a4a66488d4c87200716 (patch) | |
tree | 09a663144262d180eeb0faec6019aa4be2cefb11 | |
parent | 562b7cbff9ec2a69694aabfb4845208c851bd08e (diff) | |
parent | 119479f70550cf4323ba1eb8cdda88a47681362b (diff) | |
download | cpython-845d33c526b6e6408cb75a4a66488d4c87200716.zip cpython-845d33c526b6e6408cb75a4a66488d4c87200716.tar.gz cpython-845d33c526b6e6408cb75a4a66488d4c87200716.tar.bz2 |
Issue20467: clarify __init__'s role
-rw-r--r-- | Doc/reference/datamodel.rst | 18 |
1 files changed, 11 insertions, 7 deletions
diff --git a/Doc/reference/datamodel.rst b/Doc/reference/datamodel.rst index d0eede7..e3646f8 100644 --- a/Doc/reference/datamodel.rst +++ b/Doc/reference/datamodel.rst @@ -1100,13 +1100,17 @@ Basic customization .. index:: pair: class; constructor - Called when the instance is created. The arguments are those passed to the - class constructor expression. If a base class has an :meth:`__init__` method, - the derived class's :meth:`__init__` method, if any, must explicitly call it to - ensure proper initialization of the base class part of the instance; for - example: ``BaseClass.__init__(self, [args...])``. As a special constraint on - constructors, no value may be returned; doing so will cause a :exc:`TypeError` - to be raised at runtime. + Called after the instance has been created (by :meth:`__new__`), but before + it is returned to the caller. The arguments are those passed to the + class constructor expression. If a base class has an :meth:`__init__` + method, the derived class's :meth:`__init__` method, if any, must explicitly + call it to ensure proper initialization of the base class part of the + instance; for example: ``BaseClass.__init__(self, [args...])``. + + Because :meth:`__new__` and :meth:`__init__` work together in constructing + objects (:meth:`__new__` to create it, and :meth:`__init__` to customise it), + no non-``None`` value may be returned by :meth:`__init__`; doing so will + cause a :exc:`TypeError` to be raised at runtime. .. method:: object.__del__(self) |