Capsule-related changes:

larryhastings · larryhastings · commit 5ac006dfd3aa · 2010-04-02T11:01:35.000Z
* PyCObject_AsVoidPtr() can now open capsules.  This addresses
  most of the remaining backwards-compatibility concerns about
  the conversion of Python 2.7 from CObjects to capsules.
* CObjects were marked Pending Deprecation.
* Documentation about this pending deprecation was added to
  cobject.h.
* The capsule source files were added to the legacy PC build
  processes.
diff --git a/Include/cobject.h b/Include/cobject.h
@@ -1,3 +1,29 @@
+/*
+   CObjects are marked Pending Deprecation as of Python 2.7.
+   The full schedule for 2.x is as follows:
+     - CObjects are marked Pending Deprecation in Python 2.7.
+     - CObjects will be marked Deprecated in Python 2.8
+       (if there is one).
+     - CObjects will be removed in Python 2.9 (if there is one).
+
+   Additionally, for the Python 3.x series:
+     - CObjects were marked Deprecated in Python 3.1.
+     - CObjects will be removed in Python 3.2.
+
+   You should switch all use of CObjects to capsules.  Capsules
+   have a safer and more consistent API.  For more information,
+   see Include/pycapsule.h, or read the "Capsules" topic in
+   the "Python/C API Reference Manual".
+
+   Python 2.7 no longer uses CObjects itself; all objects which
+   were formerly CObjects are now capsules.  Note that this change
+   does not by itself break binary compatibility with extensions
+   built for previous versions of Python--PyCObject_AsVoidPtr()
+   has been changed to also understand capsules.
+
+*/
+
+/* original file header comment follows: */
 
 /* C objects to be exported from one extension module to another.
  
@@ -6,8 +32,6 @@
    to other extension modules, so that extension modules can use the
    Python import mechanism to link to one another.
 
-   DEPRECATED - Use PyCapsule objects instead.
-                CObject will be removed in 2.8 (if there is one).
 */
 
 #ifndef Py_COBJECT_H
diff --git a/Misc/NEWS b/Misc/NEWS
@@ -184,7 +184,9 @@ C-API
   is now removed (the macro was introduced in 1997!).
 
 - Issue #7992: A replacement PyCObject API, PyCapsule, has been backported
-  from Python 3.1.
+  from Python 3.1.  All existing Python CObjects in the main distribution
+  have been converted to capsules.  To address backwards-compatibility
+  concerns, PyCObject_AsVoidPtr() was changed to understand capsules.
 
 Tests
 -----
diff --git a/Objects/cobject.c b/Objects/cobject.c
@@ -9,11 +9,23 @@
 typedef void (*destructor1)(void *);
 typedef void (*destructor2)(void *, void*);
 
+static int cobject_deprecation_warning(void)
+{
+    return PyErr_WarnEx(PyExc_PendingDeprecationWarning,
+        "The CObject type is marked Pending Deprecation in Python 2.7.  "
+        "Please use capsule objects instead.", 1);
+}
+
+
 PyObject *
 PyCObject_FromVoidPtr(void *cobj, void (*destr)(void *))
 {
     PyCObject *self;
 
+    if (cobject_deprecation_warning()) {
+        return NULL;
+    }
+
     self = PyObject_NEW(PyCObject, &PyCObject_Type);
     if (self == NULL)
         return NULL;
@@ -30,6 +42,10 @@ PyCObject_FromVoidPtrAndDesc(void *cobj, void *desc,
 {
     PyCObject *self;
 
+    if (cobject_deprecation_warning()) {
+        return NULL;
+    }
+
     if (!desc) {
         PyErr_SetString(PyExc_TypeError,
                         "PyCObject_FromVoidPtrAndDesc called with null"
@@ -50,6 +66,10 @@ void *
 PyCObject_AsVoidPtr(PyObject *self)
 {
     if (self) {
+        if (PyCapsule_CheckExact(self)) {
+            const char *name = PyCapsule_GetName(self);
+            return (void *)PyCapsule_GetPointer(self, name);
+        }
         if (self->ob_type == &PyCObject_Type)
             return ((PyCObject *)self)->cobject;
         PyErr_SetString(PyExc_TypeError,
diff --git a/PC/VC6/pythoncore.dsp b/PC/VC6/pythoncore.dsp
diff --git a/PC/os2emx/Makefile b/PC/os2emx/Makefile
@@ -384,6 +384,7 @@ SRC.OBJECT=	$(addprefix $(TOP), \
 		Objects/bytes_methods.c \
 		Objects/cellobject.c \
 		Objects/classobject.c \
+		Objects/capsule.c \
 		Objects/cobject.c \
 		Objects/codeobject.c \
 		Objects/complexobject.c \
diff --git a/PCbuild/pythoncore.vcproj b/PCbuild/pythoncore.vcproj
@@ -854,6 +854,10 @@
 				RelativePath="..\Include\pyarena.h"
 				>
 			</File>
+			<File
+				RelativePath="..\Include\pycapsule.h"
+				>
+			</File>
 			<File
 				RelativePath="..\Include\pyctype.h"
 				>
@@ -1422,6 +1426,10 @@
 				RelativePath="..\Objects\stringobject.c"
 				>
 			</File>
+			<File
+				RelativePath="..\Objects\capsule.c"
+				>
+			</File>
 			<File
 				RelativePath="..\Objects\cellobject.c"
 				>

Original file line number	Diff line number	Diff line change
`@@ -854,6 +854,10 @@`
`854`	`854`	`RelativePath="..\Include\pyarena.h"`
`855`	`855`	`>`
`856`	`856`	`</File>`
	`857`	`+ <File`
	`858`	`+ RelativePath="..\Include\pycapsule.h"`
	`859`	`+ >`
	`860`	`+ </File>`
`857`	`861`	`<File`
`858`	`862`	`RelativePath="..\Include\pyctype.h"`
`859`	`863`	`>`
`@@ -1422,6 +1426,10 @@`
`1422`	`1426`	`RelativePath="..\Objects\stringobject.c"`
`1423`	`1427`	`>`
`1424`	`1428`	`</File>`
	`1429`	`+ <File`
	`1430`	`+ RelativePath="..\Objects\capsule.c"`
	`1431`	`+ >`
	`1432`	`+ </File>`
`1425`	`1433`	`<File`
`1426`	`1434`	`RelativePath="..\Objects\cellobject.c"`
`1427`	`1435`	`>`