Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
C
cython
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Kirill Smelkov
cython
Commits
2f837e12
Commit
2f837e12
authored
Sep 07, 2017
by
Stefan Behnel
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Clarify object initialisation behaviour and the safety of "__cinit__()".
Closes #1859.
parent
af0cbdba
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
11 additions
and
3 deletions
+11
-3
docs/src/reference/extension_types.rst
docs/src/reference/extension_types.rst
+11
-3
No files found.
docs/src/reference/extension_types.rst
View file @
2f837e12
...
@@ -186,6 +186,12 @@ Docstrings
...
@@ -186,6 +186,12 @@ Docstrings
Initialization: ``__cinit__()`` and ``__init__()``
Initialization: ``__cinit__()`` and ``__init__()``
==================================================
==================================================
* The object initialisation follows (mainly) three steps:
* (Internal) allocation, recursively going from subclass to base class.
* Low-level initialisation along the way back, calling ``__cinit__()`` at each level.
* Python initialisation, explicitly calling ``__init__()`` recursively from subclass to base class.
* Any arguments passed to the extension type's constructor
* Any arguments passed to the extension type's constructor
will be passed to both initialization methods.
will be passed to both initialization methods.
...
@@ -194,20 +200,22 @@ Initialization: ``__cinit__()`` and ``__init__()``
...
@@ -194,20 +200,22 @@ Initialization: ``__cinit__()`` and ``__init__()``
* This includes any allocation of C data structures.
* This includes any allocation of C data structures.
* **Caution** is warranted as to what you do in this method.
* **Caution** is warranted as to what you do in this method.
* The object may not be fully valid Python object when it is called.
* The object may not be
a
fully valid Python object when it is called.
* Calling Python objects, including the extensions own methods, may be hazardous.
* Calling Python objects, including the extensions own methods, may be hazardous.
* By the time ``__cinit__()`` is called...
* By the time ``__cinit__()`` is called...
* Memory has been allocated for the object.
* Memory has been allocated for the object.
* All C-level attributes have been initialized to 0 or null.
* All C-level attributes have been initialized to 0 or null.
* Python have been initialized to ``None``, but you can not rely on that for each occasion.
* The ``__cinit__()`` methods of all base types have been called, starting with the top-most one.
* Subtypes are not fully initialised yet.
* Python object attributes of the type itself have been initialized to ``None``.
* This initialization method is guaranteed to be called exactly once.
* This initialization method is guaranteed to be called exactly once.
* For Extensions types that inherit a base type:
* For Extensions types that inherit a base type:
* The ``__cinit__()`` method of the base type is automatically called before this one.
* The ``__cinit__()`` method of the base type is automatically called before this one.
* The inherited ``__cinit__()`` method can
not be called explicitly.
* The inherited ``__cinit__()`` method cannot be called explicitly.
* Passing modified argument lists to the base type must be done through ``__init__()``.
* Passing modified argument lists to the base type must be done through ``__init__()``.
* It may be wise to give the ``__cinit__()`` method both ``"*"`` and ``"**"`` arguments.
* It may be wise to give the ``__cinit__()`` method both ``"*"`` and ``"**"`` arguments.
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment