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
Gwenaël Samain
cython
Commits
b27baf04
Commit
b27baf04
authored
Sep 25, 2018
by
mattip
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
DOC: document the new check_size clause
parent
14387ec8
Changes
2
Show whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
28 additions
and
4 deletions
+28
-4
CHANGES.rst
CHANGES.rst
+4
-0
docs/src/userguide/extension_types.rst
docs/src/userguide/extension_types.rst
+24
-4
No files found.
CHANGES.rst
View file @
b27baf04
...
@@ -80,6 +80,10 @@ Features added
...
@@ -80,6 +80,10 @@ Features added
*
Constants
in
``
libc
.
math
``
are
now
declared
as
``
const
``
to
simplify
their
handling
.
*
Constants
in
``
libc
.
math
``
are
now
declared
as
``
const
``
to
simplify
their
handling
.
*
An
additional
``
check_size
``
clause
was
added
to
the
``
ctypedef
class
``
name
specification
to
allow
suppressing
warnings
when
importing
modules
with
backward
-
compatible
`
PyTypeObject
``
size
changes
.
Bugs
fixed
Bugs
fixed
----------
----------
...
...
docs/src/userguide/extension_types.rst
View file @
b27baf04
...
@@ -736,6 +736,14 @@ built-in complex object.::
...
@@ -736,6 +736,14 @@ built-in complex object.::
...
...
} PyComplexObject;
} PyComplexObject;
At runtime, a check will be performed when importing the cython
c-extension module that ``__builtin__.complex``'s ``tp_basicsize``
matches ``sizeof(`PyComplexObject)``. This check can fail if in the cython
c-extension module was compiled with one version of the
``complexobject.h`` header but imported into a python with a changed
header. This check can be tweaked by using ``check_size`` in the name
specification clause.
2. As well as the name of the extension type, the module in which its type
2. As well as the name of the extension type, the module in which its type
object can be found is also specified. See the implicit importing section
object can be found is also specified. See the implicit importing section
below.
below.
...
@@ -756,11 +764,23 @@ The part of the class declaration in square brackets is a special feature only
...
@@ -756,11 +764,23 @@ The part of the class declaration in square brackets is a special feature only
available for extern or public extension types. The full form of this clause
available for extern or public extension types. The full form of this clause
is::
is::
[object object_struct_name, type type_object_name ]
[object object_struct_name, type type_object_name, check_size cs_option]
Where:
- ``object_struct_name`` is the name to assume for the type's C struct.
- ``type_object_name`` is the name to assume for the type's statically
declared type object.
- ``cs_option`` is ``'min'`` (the default), ``True``, or ``False`` and is only
used for external extension types. If ``True``, ``sizeof(object_struct)`` must
match the type's ``tp_basicsize``. If ``False``, or ``min``, the
``object_struct`` may be smaller than the type's ``tp_basicsize``, which
indicates the type allocated at runtime may be part of an updated module, and
that the external module's developers extended the object in a
backward-compatible fashion (only adding new fields to the end of the
object). If ``min``, a warning will be emitted.
where ``object_struct_name`` is the name to assume for the type's C struct,
The clauses can be written in any order.
and type_object_name is the name to assume for the type's statically declared
type object. (The object and type clauses can be written in either order.)
If the extension type declaration is inside a :keyword:`cdef` extern from
If the extension type declaration is inside a :keyword:`cdef` extern from
block, the object clause is required, because Cython must be able to generate
block, the object clause is required, because Cython must be able to generate
...
...
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