1993-07-28 17:05:47 +08:00
|
|
|
#ifndef Py_OBJECT_H
|
|
|
|
#define Py_OBJECT_H
|
2018-10-25 21:54:13 +08:00
|
|
|
|
1993-07-28 17:05:47 +08:00
|
|
|
#ifdef __cplusplus
|
|
|
|
extern "C" {
|
|
|
|
#endif
|
|
|
|
|
1991-02-19 20:39:46 +08:00
|
|
|
|
1990-10-14 20:07:46 +08:00
|
|
|
/* Object and type object interface */
|
|
|
|
|
|
|
|
/*
|
|
|
|
Objects are structures allocated on the heap. Special rules apply to
|
|
|
|
the use of objects to ensure they are properly garbage-collected.
|
|
|
|
Objects are never allocated statically or on the stack; they must be
|
|
|
|
accessed through special macros and functions only. (Type objects are
|
|
|
|
exceptions to the first rule; the standard types are represented by
|
2002-07-08 03:59:50 +08:00
|
|
|
statically initialized type objects, although work on type/class unification
|
|
|
|
for Python 2.2 made it possible to have heap-allocated type objects too).
|
1990-10-14 20:07:46 +08:00
|
|
|
|
|
|
|
An object has a 'reference count' that is increased or decreased when a
|
|
|
|
pointer to the object is copied or deleted; when the reference count
|
|
|
|
reaches zero there are no references to the object left and it can be
|
|
|
|
removed from the heap.
|
|
|
|
|
|
|
|
An object has a 'type' that determines what it represents and what kind
|
|
|
|
of data it contains. An object's type is fixed when it is created.
|
|
|
|
Types themselves are represented as objects; an object contains a
|
|
|
|
pointer to the corresponding type object. The type itself has a type
|
|
|
|
pointer pointing to the object representing the type 'type', which
|
|
|
|
contains a pointer to itself!).
|
|
|
|
|
|
|
|
Objects do not float around in memory; once allocated an object keeps
|
|
|
|
the same size and address. Objects that must hold variable-size data
|
|
|
|
can contain pointers to variable-size parts of the object. Not all
|
|
|
|
objects of the same type have the same size; but the size cannot change
|
|
|
|
after allocation. (These restrictions are made so a reference to an
|
|
|
|
object can be simply a pointer -- moving an object would require
|
|
|
|
updating all the pointers, and changing an object's size would require
|
|
|
|
moving it if there was another object right next to it.)
|
|
|
|
|
1995-01-12 19:45:45 +08:00
|
|
|
Objects are always accessed through pointers of the type 'PyObject *'.
|
|
|
|
The type 'PyObject' is a structure that only contains the reference count
|
1990-10-14 20:07:46 +08:00
|
|
|
and the type pointer. The actual memory allocated for an object
|
|
|
|
contains other data that can only be accessed after casting the pointer
|
|
|
|
to a pointer to a longer structure type. This longer type must start
|
1995-01-12 19:45:45 +08:00
|
|
|
with the reference count and type fields; the macro PyObject_HEAD should be
|
2000-07-16 20:04:32 +08:00
|
|
|
used for this (to accommodate for future changes). The implementation
|
1990-10-14 20:07:46 +08:00
|
|
|
of a particular object type can cast the object pointer to the proper
|
|
|
|
type and back.
|
|
|
|
|
|
|
|
A standard interface exists for objects that contain an array of items
|
|
|
|
whose size is determined when the object is allocated.
|
|
|
|
*/
|
|
|
|
|
2019-04-25 06:56:28 +08:00
|
|
|
/* Py_DEBUG implies Py_REF_DEBUG. */
|
|
|
|
#if defined(Py_DEBUG) && !defined(Py_REF_DEBUG)
|
1995-01-12 19:45:45 +08:00
|
|
|
#define Py_REF_DEBUG
|
2002-07-08 03:59:50 +08:00
|
|
|
#endif
|
1990-10-14 20:07:46 +08:00
|
|
|
|
2010-12-04 04:14:31 +08:00
|
|
|
#if defined(Py_LIMITED_API) && defined(Py_REF_DEBUG)
|
|
|
|
#error Py_LIMITED_API is incompatible with Py_DEBUG, Py_TRACE_REFS, and Py_REF_DEBUG
|
|
|
|
#endif
|
|
|
|
|
2020-02-05 22:10:39 +08:00
|
|
|
/* PyTypeObject structure is defined in cpython/object.h.
|
|
|
|
In Py_LIMITED_API, PyTypeObject is an opaque structure. */
|
|
|
|
typedef struct _typeobject PyTypeObject;
|
2014-11-20 19:39:37 +08:00
|
|
|
|
1995-01-12 19:45:45 +08:00
|
|
|
#ifdef Py_TRACE_REFS
|
2002-07-08 03:59:50 +08:00
|
|
|
/* Define pointers to support a doubly-linked list of all live heap objects. */
|
2010-05-09 23:52:27 +08:00
|
|
|
#define _PyObject_HEAD_EXTRA \
|
|
|
|
struct _object *_ob_next; \
|
|
|
|
struct _object *_ob_prev;
|
2002-07-08 03:59:50 +08:00
|
|
|
|
|
|
|
#define _PyObject_EXTRA_INIT 0, 0,
|
|
|
|
|
|
|
|
#else
|
|
|
|
#define _PyObject_HEAD_EXTRA
|
|
|
|
#define _PyObject_EXTRA_INIT
|
|
|
|
#endif
|
|
|
|
|
|
|
|
/* PyObject_HEAD defines the initial segment of every PyObject. */
|
2010-05-09 23:52:27 +08:00
|
|
|
#define PyObject_HEAD PyObject ob_base;
|
1990-10-14 20:07:46 +08:00
|
|
|
|
2010-05-09 23:52:27 +08:00
|
|
|
#define PyObject_HEAD_INIT(type) \
|
|
|
|
{ _PyObject_EXTRA_INIT \
|
|
|
|
1, type },
|
Merged revisions 56467-56482 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/branches/p3yk
................
r56477 | martin.v.loewis | 2007-07-21 09:04:38 +0200 (Sa, 21 Jul 2007) | 11 lines
Merged revisions 56466-56476 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk
........
r56476 | martin.v.loewis | 2007-07-21 08:55:02 +0200 (Sa, 21 Jul 2007) | 4 lines
PEP 3123: Provide forward compatibility with Python 3.0, while keeping
backwards compatibility. Add Py_Refcnt, Py_Type, Py_Size, and
PyVarObject_HEAD_INIT.
........
................
r56478 | martin.v.loewis | 2007-07-21 09:47:23 +0200 (Sa, 21 Jul 2007) | 2 lines
PEP 3123: Use proper C inheritance for PyObject.
................
r56479 | martin.v.loewis | 2007-07-21 10:06:55 +0200 (Sa, 21 Jul 2007) | 3 lines
Add longintrepr.h to Python.h, so that the compiler can
see that PyFalse is really some kind of PyObject*.
................
r56480 | martin.v.loewis | 2007-07-21 10:47:18 +0200 (Sa, 21 Jul 2007) | 2 lines
Qualify SHIFT, MASK, BASE.
................
r56482 | martin.v.loewis | 2007-07-21 19:10:57 +0200 (Sa, 21 Jul 2007) | 2 lines
Correctly refer to _ob_next.
................
2007-07-22 01:22:18 +08:00
|
|
|
|
2010-05-09 23:52:27 +08:00
|
|
|
#define PyVarObject_HEAD_INIT(type, size) \
|
|
|
|
{ PyObject_HEAD_INIT(type) size },
|
2002-07-08 03:59:50 +08:00
|
|
|
|
|
|
|
/* PyObject_VAR_HEAD defines the initial segment of all variable-size
|
|
|
|
* container objects. These end with a declaration of an array with 1
|
|
|
|
* element, but enough space is malloc'ed so that the array actually
|
|
|
|
* has room for ob_size elements. Note that ob_size is an element count,
|
|
|
|
* not necessarily a byte count.
|
|
|
|
*/
|
Merged revisions 56467-56482 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/branches/p3yk
................
r56477 | martin.v.loewis | 2007-07-21 09:04:38 +0200 (Sa, 21 Jul 2007) | 11 lines
Merged revisions 56466-56476 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk
........
r56476 | martin.v.loewis | 2007-07-21 08:55:02 +0200 (Sa, 21 Jul 2007) | 4 lines
PEP 3123: Provide forward compatibility with Python 3.0, while keeping
backwards compatibility. Add Py_Refcnt, Py_Type, Py_Size, and
PyVarObject_HEAD_INIT.
........
................
r56478 | martin.v.loewis | 2007-07-21 09:47:23 +0200 (Sa, 21 Jul 2007) | 2 lines
PEP 3123: Use proper C inheritance for PyObject.
................
r56479 | martin.v.loewis | 2007-07-21 10:06:55 +0200 (Sa, 21 Jul 2007) | 3 lines
Add longintrepr.h to Python.h, so that the compiler can
see that PyFalse is really some kind of PyObject*.
................
r56480 | martin.v.loewis | 2007-07-21 10:47:18 +0200 (Sa, 21 Jul 2007) | 2 lines
Qualify SHIFT, MASK, BASE.
................
r56482 | martin.v.loewis | 2007-07-21 19:10:57 +0200 (Sa, 21 Jul 2007) | 2 lines
Correctly refer to _ob_next.
................
2007-07-22 01:22:18 +08:00
|
|
|
#define PyObject_VAR_HEAD PyVarObject ob_base;
|
2006-02-16 01:27:45 +08:00
|
|
|
#define Py_INVALID_SIZE (Py_ssize_t)-1
|
2002-07-07 13:13:56 +08:00
|
|
|
|
2002-07-08 03:59:50 +08:00
|
|
|
/* Nothing is actually declared to be a PyObject, but every pointer to
|
|
|
|
* a Python object can be cast to a PyObject*. This is inheritance built
|
|
|
|
* by hand. Similarly every pointer to a variable-size Python object can,
|
|
|
|
* in addition, be cast to PyVarObject*.
|
|
|
|
*/
|
1990-10-14 20:07:46 +08:00
|
|
|
typedef struct _object {
|
2010-05-09 23:52:27 +08:00
|
|
|
_PyObject_HEAD_EXTRA
|
|
|
|
Py_ssize_t ob_refcnt;
|
2020-02-05 22:10:39 +08:00
|
|
|
PyTypeObject *ob_type;
|
1995-01-12 19:45:45 +08:00
|
|
|
} PyObject;
|
1990-10-14 20:07:46 +08:00
|
|
|
|
2018-11-22 09:57:29 +08:00
|
|
|
/* Cast argument to PyObject* type. */
|
|
|
|
#define _PyObject_CAST(op) ((PyObject*)(op))
|
|
|
|
|
1990-10-14 20:07:46 +08:00
|
|
|
typedef struct {
|
2010-05-09 23:52:27 +08:00
|
|
|
PyObject ob_base;
|
|
|
|
Py_ssize_t ob_size; /* Number of items in variable part */
|
1997-05-16 05:31:03 +08:00
|
|
|
} PyVarObject;
|
1990-10-14 20:07:46 +08:00
|
|
|
|
2018-11-22 09:57:29 +08:00
|
|
|
/* Cast argument to PyVarObject* type. */
|
|
|
|
#define _PyVarObject_CAST(op) ((PyVarObject*)(op))
|
|
|
|
|
|
|
|
#define Py_REFCNT(ob) (_PyObject_CAST(ob)->ob_refcnt)
|
|
|
|
#define Py_TYPE(ob) (_PyObject_CAST(ob)->ob_type)
|
|
|
|
#define Py_SIZE(ob) (_PyVarObject_CAST(ob)->ob_size)
|
1990-10-14 20:07:46 +08:00
|
|
|
|
|
|
|
/*
|
|
|
|
Type objects contain a string containing the type name (to help somewhat
|
2002-07-08 03:59:50 +08:00
|
|
|
in debugging), the allocation parameters (see PyObject_New() and
|
|
|
|
PyObject_NewVar()),
|
|
|
|
and methods for accessing objects of the type. Methods are optional, a
|
1990-10-14 20:07:46 +08:00
|
|
|
nil pointer meaning that particular kind of access is not available for
|
1995-01-12 19:45:45 +08:00
|
|
|
this type. The Py_DECREF() macro uses the tp_dealloc method without
|
1990-10-14 20:07:46 +08:00
|
|
|
checking for a nil pointer; it should always be implemented except if
|
|
|
|
the implementation can guarantee that the reference count will never
|
2002-07-08 03:59:50 +08:00
|
|
|
reach zero (e.g., for statically allocated type objects).
|
1990-10-14 20:07:46 +08:00
|
|
|
|
|
|
|
NB: the methods for certain type groups are now contained in separate
|
|
|
|
method blocks.
|
|
|
|
*/
|
|
|
|
|
2000-07-08 08:32:04 +08:00
|
|
|
typedef PyObject * (*unaryfunc)(PyObject *);
|
|
|
|
typedef PyObject * (*binaryfunc)(PyObject *, PyObject *);
|
|
|
|
typedef PyObject * (*ternaryfunc)(PyObject *, PyObject *, PyObject *);
|
|
|
|
typedef int (*inquiry)(PyObject *);
|
2006-02-16 01:27:45 +08:00
|
|
|
typedef Py_ssize_t (*lenfunc)(PyObject *);
|
|
|
|
typedef PyObject *(*ssizeargfunc)(PyObject *, Py_ssize_t);
|
|
|
|
typedef PyObject *(*ssizessizeargfunc)(PyObject *, Py_ssize_t, Py_ssize_t);
|
|
|
|
typedef int(*ssizeobjargproc)(PyObject *, Py_ssize_t, PyObject *);
|
|
|
|
typedef int(*ssizessizeobjargproc)(PyObject *, Py_ssize_t, Py_ssize_t, PyObject *);
|
2000-07-08 08:32:04 +08:00
|
|
|
typedef int(*objobjargproc)(PyObject *, PyObject *, PyObject *);
|
2006-02-16 01:27:45 +08:00
|
|
|
|
2000-07-08 08:32:04 +08:00
|
|
|
typedef int (*objobjproc)(PyObject *, PyObject *);
|
|
|
|
typedef int (*visitproc)(PyObject *, void *);
|
|
|
|
typedef int (*traverseproc)(PyObject *, visitproc, void *);
|
1994-08-01 19:34:53 +08:00
|
|
|
|
2002-07-07 13:13:56 +08:00
|
|
|
|
2002-04-12 09:57:06 +08:00
|
|
|
typedef void (*freefunc)(void *);
|
2000-07-08 08:32:04 +08:00
|
|
|
typedef void (*destructor)(PyObject *);
|
2006-02-28 00:46:16 +08:00
|
|
|
typedef PyObject *(*getattrfunc)(PyObject *, char *);
|
2000-07-08 08:32:04 +08:00
|
|
|
typedef PyObject *(*getattrofunc)(PyObject *, PyObject *);
|
2006-02-28 00:46:16 +08:00
|
|
|
typedef int (*setattrfunc)(PyObject *, char *, PyObject *);
|
2000-07-08 08:32:04 +08:00
|
|
|
typedef int (*setattrofunc)(PyObject *, PyObject *, PyObject *);
|
|
|
|
typedef PyObject *(*reprfunc)(PyObject *);
|
2010-10-18 04:54:53 +08:00
|
|
|
typedef Py_hash_t (*hashfunc)(PyObject *);
|
2001-01-17 23:20:39 +08:00
|
|
|
typedef PyObject *(*richcmpfunc) (PyObject *, PyObject *, int);
|
2001-04-21 03:13:02 +08:00
|
|
|
typedef PyObject *(*getiterfunc) (PyObject *);
|
2001-04-23 22:08:49 +08:00
|
|
|
typedef PyObject *(*iternextfunc) (PyObject *);
|
2001-08-02 12:15:00 +08:00
|
|
|
typedef PyObject *(*descrgetfunc) (PyObject *, PyObject *, PyObject *);
|
|
|
|
typedef int (*descrsetfunc) (PyObject *, PyObject *, PyObject *);
|
|
|
|
typedef int (*initproc)(PyObject *, PyObject *, PyObject *);
|
2020-02-05 22:10:39 +08:00
|
|
|
typedef PyObject *(*newfunc)(PyTypeObject *, PyObject *, PyObject *);
|
|
|
|
typedef PyObject *(*allocfunc)(PyTypeObject *, Py_ssize_t);
|
1990-10-14 20:07:46 +08:00
|
|
|
|
2010-12-04 04:14:31 +08:00
|
|
|
typedef struct{
|
|
|
|
int slot; /* slot id, see below */
|
|
|
|
void *pfunc; /* function pointer */
|
|
|
|
} PyType_Slot;
|
1990-10-14 20:07:46 +08:00
|
|
|
|
2010-12-04 04:14:31 +08:00
|
|
|
typedef struct{
|
|
|
|
const char* name;
|
|
|
|
int basicsize;
|
|
|
|
int itemsize;
|
2012-10-31 06:40:45 +08:00
|
|
|
unsigned int flags;
|
2010-12-04 04:14:31 +08:00
|
|
|
PyType_Slot *slots; /* terminated by slot==0. */
|
|
|
|
} PyType_Spec;
|
|
|
|
|
|
|
|
PyAPI_FUNC(PyObject*) PyType_FromSpec(PyType_Spec*);
|
2012-06-24 05:20:45 +08:00
|
|
|
#if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03030000
|
|
|
|
PyAPI_FUNC(PyObject*) PyType_FromSpecWithBases(PyType_Spec*, PyObject*);
|
|
|
|
#endif
|
2014-02-04 16:33:05 +08:00
|
|
|
#if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03040000
|
2020-02-05 22:10:39 +08:00
|
|
|
PyAPI_FUNC(void*) PyType_GetSlot(PyTypeObject*, int);
|
2014-02-04 16:33:05 +08:00
|
|
|
#endif
|
2010-12-04 04:14:31 +08:00
|
|
|
|
2001-08-02 12:15:00 +08:00
|
|
|
/* Generic type check */
|
2020-02-05 22:10:39 +08:00
|
|
|
PyAPI_FUNC(int) PyType_IsSubtype(PyTypeObject *, PyTypeObject *);
|
2001-08-02 12:15:00 +08:00
|
|
|
#define PyObject_TypeCheck(ob, tp) \
|
2010-05-09 23:52:27 +08:00
|
|
|
(Py_TYPE(ob) == (tp) || PyType_IsSubtype(Py_TYPE(ob), (tp)))
|
2001-08-02 12:15:00 +08:00
|
|
|
|
2020-02-05 22:10:39 +08:00
|
|
|
PyAPI_DATA(PyTypeObject) PyType_Type; /* built-in 'type' */
|
|
|
|
PyAPI_DATA(PyTypeObject) PyBaseObject_Type; /* built-in 'object' */
|
|
|
|
PyAPI_DATA(PyTypeObject) PySuper_Type; /* built-in 'super' */
|
2001-08-02 12:15:00 +08:00
|
|
|
|
2020-02-05 22:10:39 +08:00
|
|
|
PyAPI_FUNC(unsigned long) PyType_GetFlags(PyTypeObject*);
|
2011-02-06 04:35:29 +08:00
|
|
|
|
2020-02-05 22:10:39 +08:00
|
|
|
PyAPI_FUNC(int) PyType_Ready(PyTypeObject *);
|
|
|
|
PyAPI_FUNC(PyObject *) PyType_GenericAlloc(PyTypeObject *, Py_ssize_t);
|
|
|
|
PyAPI_FUNC(PyObject *) PyType_GenericNew(PyTypeObject *,
|
2010-05-09 23:52:27 +08:00
|
|
|
PyObject *, PyObject *);
|
2008-01-28 07:50:43 +08:00
|
|
|
PyAPI_FUNC(unsigned int) PyType_ClearCache(void);
|
2020-02-05 22:10:39 +08:00
|
|
|
PyAPI_FUNC(void) PyType_Modified(PyTypeObject *);
|
1990-10-14 20:07:46 +08:00
|
|
|
|
1990-12-20 23:06:42 +08:00
|
|
|
/* Generic operations on objects */
|
2002-07-29 21:42:14 +08:00
|
|
|
PyAPI_FUNC(PyObject *) PyObject_Repr(PyObject *);
|
|
|
|
PyAPI_FUNC(PyObject *) PyObject_Str(PyObject *);
|
2008-06-12 02:37:52 +08:00
|
|
|
PyAPI_FUNC(PyObject *) PyObject_ASCII(PyObject *);
|
2008-08-27 00:46:47 +08:00
|
|
|
PyAPI_FUNC(PyObject *) PyObject_Bytes(PyObject *);
|
2002-07-29 21:42:14 +08:00
|
|
|
PyAPI_FUNC(PyObject *) PyObject_RichCompare(PyObject *, PyObject *, int);
|
|
|
|
PyAPI_FUNC(int) PyObject_RichCompareBool(PyObject *, PyObject *, int);
|
2005-12-11 02:50:16 +08:00
|
|
|
PyAPI_FUNC(PyObject *) PyObject_GetAttrString(PyObject *, const char *);
|
|
|
|
PyAPI_FUNC(int) PyObject_SetAttrString(PyObject *, const char *, PyObject *);
|
|
|
|
PyAPI_FUNC(int) PyObject_HasAttrString(PyObject *, const char *);
|
2002-07-29 21:42:14 +08:00
|
|
|
PyAPI_FUNC(PyObject *) PyObject_GetAttr(PyObject *, PyObject *);
|
|
|
|
PyAPI_FUNC(int) PyObject_SetAttr(PyObject *, PyObject *, PyObject *);
|
|
|
|
PyAPI_FUNC(int) PyObject_HasAttr(PyObject *, PyObject *);
|
2003-03-18 03:46:11 +08:00
|
|
|
PyAPI_FUNC(PyObject *) PyObject_SelfIter(PyObject *);
|
2002-07-29 21:42:14 +08:00
|
|
|
PyAPI_FUNC(PyObject *) PyObject_GenericGetAttr(PyObject *, PyObject *);
|
2020-02-05 20:12:19 +08:00
|
|
|
PyAPI_FUNC(int) PyObject_GenericSetAttr(PyObject *, PyObject *, PyObject *);
|
2016-12-27 20:57:39 +08:00
|
|
|
#if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03030000
|
2012-02-20 08:59:10 +08:00
|
|
|
PyAPI_FUNC(int) PyObject_GenericSetDict(PyObject *, PyObject *, void *);
|
2016-12-27 20:57:39 +08:00
|
|
|
#endif
|
2010-10-18 04:54:53 +08:00
|
|
|
PyAPI_FUNC(Py_hash_t) PyObject_Hash(PyObject *);
|
|
|
|
PyAPI_FUNC(Py_hash_t) PyObject_HashNotImplemented(PyObject *);
|
2002-07-29 21:42:14 +08:00
|
|
|
PyAPI_FUNC(int) PyObject_IsTrue(PyObject *);
|
|
|
|
PyAPI_FUNC(int) PyObject_Not(PyObject *);
|
|
|
|
PyAPI_FUNC(int) PyCallable_Check(PyObject *);
|
|
|
|
PyAPI_FUNC(void) PyObject_ClearWeakRefs(PyObject *);
|
2001-09-19 04:38:53 +08:00
|
|
|
|
2007-12-02 17:40:06 +08:00
|
|
|
/* PyObject_Dir(obj) acts like Python builtins.dir(obj), returning a
|
|
|
|
list of strings. PyObject_Dir(NULL) is like builtins.dir(),
|
2001-09-05 06:08:56 +08:00
|
|
|
returning the names of the current locals. In this case, if there are
|
|
|
|
no current locals, NULL is returned, and PyErr_Occurred() is false.
|
|
|
|
*/
|
2002-07-29 21:42:14 +08:00
|
|
|
PyAPI_FUNC(PyObject *) PyObject_Dir(PyObject *);
|
2001-09-05 06:08:56 +08:00
|
|
|
|
|
|
|
|
1998-04-11 06:32:24 +08:00
|
|
|
/* Helpers for printing recursive container types */
|
2002-07-29 21:42:14 +08:00
|
|
|
PyAPI_FUNC(int) Py_ReprEnter(PyObject *);
|
|
|
|
PyAPI_FUNC(void) Py_ReprLeave(PyObject *);
|
1998-04-11 06:32:24 +08:00
|
|
|
|
1990-10-14 20:07:46 +08:00
|
|
|
/* Flag bits for printing: */
|
2010-05-09 23:52:27 +08:00
|
|
|
#define Py_PRINT_RAW 1 /* No string quotes etc. */
|
1990-10-14 20:07:46 +08:00
|
|
|
|
Changes by Greg Stein (code) and GvR (design).
Add a new member to the PyBufferProcs struct, bf_getcharbuffer. For
backward compatibility, this member should only be used (this includes
testing for NULL!) when the flag Py_TPFLAGS_HAVE_GETCHARBUFFER is set
in the type structure, below. Note that if its flag is not set, we
may be looking at an extension module compiled for 1.5.1, which will
have garbage at the bf_getcharbuffer member (because the struct wasn't
as long then). If the flag is one, the pointer may still be NULL.
The function found at this member is used in a similar manner as
bf_getreadbuffer, but it is known to point to 8-bit character data.
(See discussion in getargs.c checked in later.)
As a general feature for extending the type structure and the various
structures that (may) hang off it in a backwards compatible way, we
rename the tp_xxx4 "spare" slot to tp_flags. In 1.5.1 and before,
this slot was always zero. In 1.5.1, it may contain various flags
indicating extra fields that weren't present in 1.5.1. The only flag
defined so far is for the bf_getcharbuffer member of the PyBufferProcs
struct.
Note that the new spares (tp_xxx5 - tp_xxx8), once they become used,
should also be protected by a flag (or flags) in tp_flags.
1998-10-08 10:10:56 +08:00
|
|
|
/*
|
2019-05-30 04:12:38 +08:00
|
|
|
Type flags (tp_flags)
|
Changes by Greg Stein (code) and GvR (design).
Add a new member to the PyBufferProcs struct, bf_getcharbuffer. For
backward compatibility, this member should only be used (this includes
testing for NULL!) when the flag Py_TPFLAGS_HAVE_GETCHARBUFFER is set
in the type structure, below. Note that if its flag is not set, we
may be looking at an extension module compiled for 1.5.1, which will
have garbage at the bf_getcharbuffer member (because the struct wasn't
as long then). If the flag is one, the pointer may still be NULL.
The function found at this member is used in a similar manner as
bf_getreadbuffer, but it is known to point to 8-bit character data.
(See discussion in getargs.c checked in later.)
As a general feature for extending the type structure and the various
structures that (may) hang off it in a backwards compatible way, we
rename the tp_xxx4 "spare" slot to tp_flags. In 1.5.1 and before,
this slot was always zero. In 1.5.1, it may contain various flags
indicating extra fields that weren't present in 1.5.1. The only flag
defined so far is for the bf_getcharbuffer member of the PyBufferProcs
struct.
Note that the new spares (tp_xxx5 - tp_xxx8), once they become used,
should also be protected by a flag (or flags) in tp_flags.
1998-10-08 10:10:56 +08:00
|
|
|
|
2019-05-30 04:12:38 +08:00
|
|
|
These flags are used to change expected features and behavior for a
|
|
|
|
particular type.
|
Changes by Greg Stein (code) and GvR (design).
Add a new member to the PyBufferProcs struct, bf_getcharbuffer. For
backward compatibility, this member should only be used (this includes
testing for NULL!) when the flag Py_TPFLAGS_HAVE_GETCHARBUFFER is set
in the type structure, below. Note that if its flag is not set, we
may be looking at an extension module compiled for 1.5.1, which will
have garbage at the bf_getcharbuffer member (because the struct wasn't
as long then). If the flag is one, the pointer may still be NULL.
The function found at this member is used in a similar manner as
bf_getreadbuffer, but it is known to point to 8-bit character data.
(See discussion in getargs.c checked in later.)
As a general feature for extending the type structure and the various
structures that (may) hang off it in a backwards compatible way, we
rename the tp_xxx4 "spare" slot to tp_flags. In 1.5.1 and before,
this slot was always zero. In 1.5.1, it may contain various flags
indicating extra fields that weren't present in 1.5.1. The only flag
defined so far is for the bf_getcharbuffer member of the PyBufferProcs
struct.
Note that the new spares (tp_xxx5 - tp_xxx8), once they become used,
should also be protected by a flag (or flags) in tp_flags.
1998-10-08 10:10:56 +08:00
|
|
|
|
|
|
|
Arbitration of the flag bit positions will need to be coordinated among
|
2017-11-05 21:37:50 +08:00
|
|
|
all extension writers who publicly release their extensions (this will
|
2019-05-30 04:12:38 +08:00
|
|
|
be fewer than you might expect!).
|
Changes by Greg Stein (code) and GvR (design).
Add a new member to the PyBufferProcs struct, bf_getcharbuffer. For
backward compatibility, this member should only be used (this includes
testing for NULL!) when the flag Py_TPFLAGS_HAVE_GETCHARBUFFER is set
in the type structure, below. Note that if its flag is not set, we
may be looking at an extension module compiled for 1.5.1, which will
have garbage at the bf_getcharbuffer member (because the struct wasn't
as long then). If the flag is one, the pointer may still be NULL.
The function found at this member is used in a similar manner as
bf_getreadbuffer, but it is known to point to 8-bit character data.
(See discussion in getargs.c checked in later.)
As a general feature for extending the type structure and the various
structures that (may) hang off it in a backwards compatible way, we
rename the tp_xxx4 "spare" slot to tp_flags. In 1.5.1 and before,
this slot was always zero. In 1.5.1, it may contain various flags
indicating extra fields that weren't present in 1.5.1. The only flag
defined so far is for the bf_getcharbuffer member of the PyBufferProcs
struct.
Note that the new spares (tp_xxx5 - tp_xxx8), once they become used,
should also be protected by a flag (or flags) in tp_flags.
1998-10-08 10:10:56 +08:00
|
|
|
|
2006-07-28 05:53:35 +08:00
|
|
|
Most flags were removed as of Python 3.0 to make room for new flags. (Some
|
|
|
|
flags are not for backwards compatibility but to indicate the presence of an
|
|
|
|
optional feature; these flags remain of course.)
|
Changes by Greg Stein (code) and GvR (design).
Add a new member to the PyBufferProcs struct, bf_getcharbuffer. For
backward compatibility, this member should only be used (this includes
testing for NULL!) when the flag Py_TPFLAGS_HAVE_GETCHARBUFFER is set
in the type structure, below. Note that if its flag is not set, we
may be looking at an extension module compiled for 1.5.1, which will
have garbage at the bf_getcharbuffer member (because the struct wasn't
as long then). If the flag is one, the pointer may still be NULL.
The function found at this member is used in a similar manner as
bf_getreadbuffer, but it is known to point to 8-bit character data.
(See discussion in getargs.c checked in later.)
As a general feature for extending the type structure and the various
structures that (may) hang off it in a backwards compatible way, we
rename the tp_xxx4 "spare" slot to tp_flags. In 1.5.1 and before,
this slot was always zero. In 1.5.1, it may contain various flags
indicating extra fields that weren't present in 1.5.1. The only flag
defined so far is for the bf_getcharbuffer member of the PyBufferProcs
struct.
Note that the new spares (tp_xxx5 - tp_xxx8), once they become used,
should also be protected by a flag (or flags) in tp_flags.
1998-10-08 10:10:56 +08:00
|
|
|
|
|
|
|
Type definitions should use Py_TPFLAGS_DEFAULT for their tp_flags value.
|
|
|
|
|
|
|
|
Code can use PyType_HasFeature(type_ob, flag_value) to test whether the
|
|
|
|
given type object has a specified feature.
|
|
|
|
*/
|
|
|
|
|
2001-08-02 12:15:00 +08:00
|
|
|
/* Set if the type object is dynamically allocated */
|
2012-10-31 06:40:45 +08:00
|
|
|
#define Py_TPFLAGS_HEAPTYPE (1UL << 9)
|
2001-08-02 12:15:00 +08:00
|
|
|
|
|
|
|
/* Set if the type allows subclassing */
|
2012-10-31 06:40:45 +08:00
|
|
|
#define Py_TPFLAGS_BASETYPE (1UL << 10)
|
2001-08-02 12:15:00 +08:00
|
|
|
|
2019-05-30 02:31:52 +08:00
|
|
|
/* Set if the type implements the vectorcall protocol (PEP 590) */
|
|
|
|
#ifndef Py_LIMITED_API
|
|
|
|
#define _Py_TPFLAGS_HAVE_VECTORCALL (1UL << 11)
|
|
|
|
#endif
|
|
|
|
|
2001-08-11 01:37:02 +08:00
|
|
|
/* Set if the type is 'ready' -- fully initialized */
|
2012-10-31 06:40:45 +08:00
|
|
|
#define Py_TPFLAGS_READY (1UL << 12)
|
2001-08-11 01:37:02 +08:00
|
|
|
|
|
|
|
/* Set while the type is being 'readied', to prevent recursive ready calls */
|
2012-10-31 06:40:45 +08:00
|
|
|
#define Py_TPFLAGS_READYING (1UL << 13)
|
2001-08-11 01:37:02 +08:00
|
|
|
|
2019-05-30 04:12:38 +08:00
|
|
|
/* Objects support garbage collection (see objimpl.h) */
|
2012-10-31 06:40:45 +08:00
|
|
|
#define Py_TPFLAGS_HAVE_GC (1UL << 14)
|
2001-08-30 07:46:35 +08:00
|
|
|
|
2006-03-08 02:50:55 +08:00
|
|
|
/* These two bits are preserved for Stackless Python, next after this is 17 */
|
2003-05-20 23:14:31 +08:00
|
|
|
#ifdef STACKLESS
|
2012-10-31 06:40:45 +08:00
|
|
|
#define Py_TPFLAGS_HAVE_STACKLESS_EXTENSION (3UL << 15)
|
2003-05-20 23:14:31 +08:00
|
|
|
#else
|
2003-05-23 11:33:35 +08:00
|
|
|
#define Py_TPFLAGS_HAVE_STACKLESS_EXTENSION 0
|
2003-05-20 23:14:31 +08:00
|
|
|
#endif
|
|
|
|
|
2019-05-28 20:42:53 +08:00
|
|
|
/* Objects behave like an unbound method */
|
|
|
|
#define Py_TPFLAGS_METHOD_DESCRIPTOR (1UL << 17)
|
|
|
|
|
Merged revisions 59921-59932 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk
........
r59923 | raymond.hettinger | 2008-01-11 19:04:55 +0100 (Fri, 11 Jan 2008) | 1 line
Speed-up and simplify code urlparse's result objects.
........
r59924 | andrew.kuchling | 2008-01-11 20:33:24 +0100 (Fri, 11 Jan 2008) | 1 line
Bug #1790: update link; remove outdated paragraph
........
r59925 | thomas.heller | 2008-01-11 20:34:06 +0100 (Fri, 11 Jan 2008) | 5 lines
Raise an error instead of crashing with a segfault when a NULL
function pointer is called.
Will backport to release25-maint.
........
r59927 | thomas.heller | 2008-01-11 21:29:19 +0100 (Fri, 11 Jan 2008) | 4 lines
Fix a potential 'SystemError: NULL result without error'.
NULL may be a valid return value from PyLong_AsVoidPtr.
Will backport to release25-maint.
........
r59928 | raymond.hettinger | 2008-01-12 00:25:18 +0100 (Sat, 12 Jan 2008) | 1 line
Update the opcode docs for STORE_MAP and BUILD_MAP
........
r59929 | mark.dickinson | 2008-01-12 02:56:00 +0100 (Sat, 12 Jan 2008) | 4 lines
Issue 1780: Allow leading and trailing whitespace in Decimal constructor,
when constructing from a string. Disallow trailing newlines in
Context.create_decimal.
........
r59930 | georg.brandl | 2008-01-12 11:53:29 +0100 (Sat, 12 Jan 2008) | 3 lines
Move OSError docs to exceptions doc, remove obsolete descriptions
from os docs, rework posix docs.
........
r59931 | georg.brandl | 2008-01-12 14:47:57 +0100 (Sat, 12 Jan 2008) | 3 lines
Patch #1700288: Method cache optimization, by Armin Rigo, ported to
2.6 by Kevin Jacobs.
........
r59932 | georg.brandl | 2008-01-12 17:11:09 +0100 (Sat, 12 Jan 2008) | 2 lines
Fix editing glitch.
........
2008-01-13 03:39:10 +08:00
|
|
|
/* Objects support type attribute cache */
|
2012-10-31 06:40:45 +08:00
|
|
|
#define Py_TPFLAGS_HAVE_VERSION_TAG (1UL << 18)
|
|
|
|
#define Py_TPFLAGS_VALID_VERSION_TAG (1UL << 19)
|
Merged revisions 59921-59932 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk
........
r59923 | raymond.hettinger | 2008-01-11 19:04:55 +0100 (Fri, 11 Jan 2008) | 1 line
Speed-up and simplify code urlparse's result objects.
........
r59924 | andrew.kuchling | 2008-01-11 20:33:24 +0100 (Fri, 11 Jan 2008) | 1 line
Bug #1790: update link; remove outdated paragraph
........
r59925 | thomas.heller | 2008-01-11 20:34:06 +0100 (Fri, 11 Jan 2008) | 5 lines
Raise an error instead of crashing with a segfault when a NULL
function pointer is called.
Will backport to release25-maint.
........
r59927 | thomas.heller | 2008-01-11 21:29:19 +0100 (Fri, 11 Jan 2008) | 4 lines
Fix a potential 'SystemError: NULL result without error'.
NULL may be a valid return value from PyLong_AsVoidPtr.
Will backport to release25-maint.
........
r59928 | raymond.hettinger | 2008-01-12 00:25:18 +0100 (Sat, 12 Jan 2008) | 1 line
Update the opcode docs for STORE_MAP and BUILD_MAP
........
r59929 | mark.dickinson | 2008-01-12 02:56:00 +0100 (Sat, 12 Jan 2008) | 4 lines
Issue 1780: Allow leading and trailing whitespace in Decimal constructor,
when constructing from a string. Disallow trailing newlines in
Context.create_decimal.
........
r59930 | georg.brandl | 2008-01-12 11:53:29 +0100 (Sat, 12 Jan 2008) | 3 lines
Move OSError docs to exceptions doc, remove obsolete descriptions
from os docs, rework posix docs.
........
r59931 | georg.brandl | 2008-01-12 14:47:57 +0100 (Sat, 12 Jan 2008) | 3 lines
Patch #1700288: Method cache optimization, by Armin Rigo, ported to
2.6 by Kevin Jacobs.
........
r59932 | georg.brandl | 2008-01-12 17:11:09 +0100 (Sat, 12 Jan 2008) | 2 lines
Fix editing glitch.
........
2008-01-13 03:39:10 +08:00
|
|
|
|
Merged revisions 61038,61042-61045,61047,61050,61053,61055-61056,61061-61062,61066,61068,61070,61083,61085,61092-61103 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk
........
r61098 | jeffrey.yasskin | 2008-02-28 05:45:36 +0100 (Thu, 28 Feb 2008) | 7 lines
Move abc._Abstract into object by adding a new flag Py_TPFLAGS_IS_ABSTRACT,
which forbids constructing types that have it set. The effect is to speed
./python.exe -m timeit -s 'import abc' -s 'class Foo(object): __metaclass__ = abc.ABCMeta' 'Foo()'
up from 2.5us to 0.201us. This fixes issue 1762.
........
r61099 | jeffrey.yasskin | 2008-02-28 06:53:18 +0100 (Thu, 28 Feb 2008) | 3 lines
Speed test_socketserver up from 28.739s to 0.226s, simplify the logic, and make
sure all tests run even if some fail.
........
r61100 | jeffrey.yasskin | 2008-02-28 07:09:19 +0100 (Thu, 28 Feb 2008) | 21 lines
Thread.start() used sleep(0.000001) to make sure it didn't return before the
new thread had started. At least on my MacBook Pro, that wound up sleeping for
a full 10ms (probably 1 jiffy). By using an Event instead, we can be absolutely
certain that the thread has started, and return more quickly (217us).
Before:
$ ./python.exe -m timeit -s 'from threading import Thread' 't = Thread(); t.start(); t.join()'
100 loops, best of 3: 10.3 msec per loop
$ ./python.exe -m timeit -s 'from threading import Thread; t = Thread()' 't.isAlive()'
1000000 loops, best of 3: 0.47 usec per loop
After:
$ ./python.exe -m timeit -s 'from threading import Thread' 't = Thread(); t.start(); t.join()'
1000 loops, best of 3: 217 usec per loop
$ ./python.exe -m timeit -s 'from threading import Thread; t = Thread()' 't.isAlive()'
1000000 loops, best of 3: 0.86 usec per loop
To be fair, the 10ms isn't CPU time, and other threads including the spawned
one get to run during it. There are also some slightly more complicated ways to
get back the .4us in isAlive() if we want.
........
r61101 | raymond.hettinger | 2008-02-28 10:23:48 +0100 (Thu, 28 Feb 2008) | 1 line
Add repeat keyword argument to itertools.product().
........
r61102 | christian.heimes | 2008-02-28 12:18:49 +0100 (Thu, 28 Feb 2008) | 1 line
The empty tuple is usually a singleton with a much higher refcnt than 1
........
2008-02-28 20:27:11 +08:00
|
|
|
/* Type is abstract and cannot be instantiated */
|
2012-10-31 06:40:45 +08:00
|
|
|
#define Py_TPFLAGS_IS_ABSTRACT (1UL << 20)
|
Merged revisions 61038,61042-61045,61047,61050,61053,61055-61056,61061-61062,61066,61068,61070,61083,61085,61092-61103 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk
........
r61098 | jeffrey.yasskin | 2008-02-28 05:45:36 +0100 (Thu, 28 Feb 2008) | 7 lines
Move abc._Abstract into object by adding a new flag Py_TPFLAGS_IS_ABSTRACT,
which forbids constructing types that have it set. The effect is to speed
./python.exe -m timeit -s 'import abc' -s 'class Foo(object): __metaclass__ = abc.ABCMeta' 'Foo()'
up from 2.5us to 0.201us. This fixes issue 1762.
........
r61099 | jeffrey.yasskin | 2008-02-28 06:53:18 +0100 (Thu, 28 Feb 2008) | 3 lines
Speed test_socketserver up from 28.739s to 0.226s, simplify the logic, and make
sure all tests run even if some fail.
........
r61100 | jeffrey.yasskin | 2008-02-28 07:09:19 +0100 (Thu, 28 Feb 2008) | 21 lines
Thread.start() used sleep(0.000001) to make sure it didn't return before the
new thread had started. At least on my MacBook Pro, that wound up sleeping for
a full 10ms (probably 1 jiffy). By using an Event instead, we can be absolutely
certain that the thread has started, and return more quickly (217us).
Before:
$ ./python.exe -m timeit -s 'from threading import Thread' 't = Thread(); t.start(); t.join()'
100 loops, best of 3: 10.3 msec per loop
$ ./python.exe -m timeit -s 'from threading import Thread; t = Thread()' 't.isAlive()'
1000000 loops, best of 3: 0.47 usec per loop
After:
$ ./python.exe -m timeit -s 'from threading import Thread' 't = Thread(); t.start(); t.join()'
1000 loops, best of 3: 217 usec per loop
$ ./python.exe -m timeit -s 'from threading import Thread; t = Thread()' 't.isAlive()'
1000000 loops, best of 3: 0.86 usec per loop
To be fair, the 10ms isn't CPU time, and other threads including the spawned
one get to run during it. There are also some slightly more complicated ways to
get back the .4us in isAlive() if we want.
........
r61101 | raymond.hettinger | 2008-02-28 10:23:48 +0100 (Thu, 28 Feb 2008) | 1 line
Add repeat keyword argument to itertools.product().
........
r61102 | christian.heimes | 2008-02-28 12:18:49 +0100 (Thu, 28 Feb 2008) | 1 line
The empty tuple is usually a singleton with a much higher refcnt than 1
........
2008-02-28 20:27:11 +08:00
|
|
|
|
2007-02-26 04:39:11 +08:00
|
|
|
/* These flags are used to determine if a type is a subclass. */
|
2012-10-31 06:40:45 +08:00
|
|
|
#define Py_TPFLAGS_LONG_SUBCLASS (1UL << 24)
|
|
|
|
#define Py_TPFLAGS_LIST_SUBCLASS (1UL << 25)
|
|
|
|
#define Py_TPFLAGS_TUPLE_SUBCLASS (1UL << 26)
|
|
|
|
#define Py_TPFLAGS_BYTES_SUBCLASS (1UL << 27)
|
|
|
|
#define Py_TPFLAGS_UNICODE_SUBCLASS (1UL << 28)
|
|
|
|
#define Py_TPFLAGS_DICT_SUBCLASS (1UL << 29)
|
|
|
|
#define Py_TPFLAGS_BASE_EXC_SUBCLASS (1UL << 30)
|
|
|
|
#define Py_TPFLAGS_TYPE_SUBCLASS (1UL << 31)
|
2007-02-26 04:39:11 +08:00
|
|
|
|
2001-01-25 06:13:48 +08:00
|
|
|
#define Py_TPFLAGS_DEFAULT ( \
|
2010-05-09 23:52:27 +08:00
|
|
|
Py_TPFLAGS_HAVE_STACKLESS_EXTENSION | \
|
|
|
|
Py_TPFLAGS_HAVE_VERSION_TAG | \
|
|
|
|
0)
|
Changes by Greg Stein (code) and GvR (design).
Add a new member to the PyBufferProcs struct, bf_getcharbuffer. For
backward compatibility, this member should only be used (this includes
testing for NULL!) when the flag Py_TPFLAGS_HAVE_GETCHARBUFFER is set
in the type structure, below. Note that if its flag is not set, we
may be looking at an extension module compiled for 1.5.1, which will
have garbage at the bf_getcharbuffer member (because the struct wasn't
as long then). If the flag is one, the pointer may still be NULL.
The function found at this member is used in a similar manner as
bf_getreadbuffer, but it is known to point to 8-bit character data.
(See discussion in getargs.c checked in later.)
As a general feature for extending the type structure and the various
structures that (may) hang off it in a backwards compatible way, we
rename the tp_xxx4 "spare" slot to tp_flags. In 1.5.1 and before,
this slot was always zero. In 1.5.1, it may contain various flags
indicating extra fields that weren't present in 1.5.1. The only flag
defined so far is for the bf_getcharbuffer member of the PyBufferProcs
struct.
Note that the new spares (tp_xxx5 - tp_xxx8), once they become used,
should also be protected by a flag (or flags) in tp_flags.
1998-10-08 10:10:56 +08:00
|
|
|
|
2013-07-31 01:59:21 +08:00
|
|
|
/* NOTE: The following flags reuse lower bits (removed as part of the
|
|
|
|
* Python 3.0 transition). */
|
|
|
|
|
2019-07-06 05:37:15 +08:00
|
|
|
/* The following flag is kept for compatibility. Starting with 3.8,
|
|
|
|
* binary compatibility of C extensions across feature releases of
|
2019-05-30 04:12:38 +08:00
|
|
|
* Python is not supported anymore, except when using the stable ABI.
|
|
|
|
*/
|
|
|
|
|
2013-07-31 01:59:21 +08:00
|
|
|
/* Type structure has tp_finalize member (3.4) */
|
|
|
|
#define Py_TPFLAGS_HAVE_FINALIZE (1UL << 0)
|
|
|
|
|
Changes by Greg Stein (code) and GvR (design).
Add a new member to the PyBufferProcs struct, bf_getcharbuffer. For
backward compatibility, this member should only be used (this includes
testing for NULL!) when the flag Py_TPFLAGS_HAVE_GETCHARBUFFER is set
in the type structure, below. Note that if its flag is not set, we
may be looking at an extension module compiled for 1.5.1, which will
have garbage at the bf_getcharbuffer member (because the struct wasn't
as long then). If the flag is one, the pointer may still be NULL.
The function found at this member is used in a similar manner as
bf_getreadbuffer, but it is known to point to 8-bit character data.
(See discussion in getargs.c checked in later.)
As a general feature for extending the type structure and the various
structures that (may) hang off it in a backwards compatible way, we
rename the tp_xxx4 "spare" slot to tp_flags. In 1.5.1 and before,
this slot was always zero. In 1.5.1, it may contain various flags
indicating extra fields that weren't present in 1.5.1. The only flag
defined so far is for the bf_getcharbuffer member of the PyBufferProcs
struct.
Note that the new spares (tp_xxx5 - tp_xxx8), once they become used,
should also be protected by a flag (or flags) in tp_flags.
1998-10-08 10:10:56 +08:00
|
|
|
|
1990-10-14 20:07:46 +08:00
|
|
|
/*
|
1995-01-12 19:45:45 +08:00
|
|
|
The macros Py_INCREF(op) and Py_DECREF(op) are used to increment or decrement
|
2002-07-08 03:59:50 +08:00
|
|
|
reference counts. Py_DECREF calls the object's deallocator function when
|
|
|
|
the refcount falls to 0; for
|
1990-10-14 20:07:46 +08:00
|
|
|
objects that don't contain references to other objects or heap memory
|
|
|
|
this can be the standard function free(). Both macros can be used
|
2002-07-08 03:59:50 +08:00
|
|
|
wherever a void expression is allowed. The argument must not be a
|
Merged revisions 62021,62029,62035-62038,62043-62044,62052-62053 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk
........
r62021 | benjamin.peterson | 2008-03-28 18:11:01 -0500 (Fri, 28 Mar 2008) | 2 lines
NIL => NULL
........
r62029 | amaury.forgeotdarc | 2008-03-28 20:42:31 -0500 (Fri, 28 Mar 2008) | 3 lines
Correctly call the base class tearDown();
otherwise running test_logging twice produce the errors we see on all buildbots
........
r62035 | raymond.hettinger | 2008-03-29 05:42:07 -0500 (Sat, 29 Mar 2008) | 1 line
Be explicit about what efficient means.
........
r62036 | georg.brandl | 2008-03-29 06:46:18 -0500 (Sat, 29 Mar 2008) | 2 lines
Fix capitalization.
........
r62037 | amaury.forgeotdarc | 2008-03-29 07:42:54 -0500 (Sat, 29 Mar 2008) | 5 lines
lib2to3 should install a logging handler only when run as a main program,
not when used as a library.
This may please the buildbots, which fail when test_lib2to3 is run before test_logging.
........
r62043 | benjamin.peterson | 2008-03-29 10:24:25 -0500 (Sat, 29 Mar 2008) | 3 lines
#2503 make singletons compared with "is" not == or !=
Thanks to Wummel for the patch
........
r62044 | gerhard.haering | 2008-03-29 14:11:52 -0500 (Sat, 29 Mar 2008) | 2 lines
Documented the lastrowid attribute.
........
r62052 | benjamin.peterson | 2008-03-30 14:35:10 -0500 (Sun, 30 Mar 2008) | 2 lines
Updated README regarding doc formats
........
r62053 | georg.brandl | 2008-03-30 14:41:39 -0500 (Sun, 30 Mar 2008) | 2 lines
The other download formats will be available for 2.6 too.
........
2008-03-31 09:51:45 +08:00
|
|
|
NULL pointer. If it may be NULL, use Py_XINCREF/Py_XDECREF instead.
|
2002-07-08 03:59:50 +08:00
|
|
|
The macro _Py_NewReference(op) initialize reference counts to 1, and
|
|
|
|
in special builds (Py_REF_DEBUG, Py_TRACE_REFS) performs additional
|
|
|
|
bookkeeping appropriate to the special build.
|
1990-10-14 20:07:46 +08:00
|
|
|
|
|
|
|
We assume that the reference count field can never overflow; this can
|
2002-07-08 03:59:50 +08:00
|
|
|
be proven when the size of the field is the same as the pointer size, so
|
|
|
|
we ignore the possibility. Provided a C int is at least 32 bits (which
|
|
|
|
is implicitly assumed in many parts of this code), that's enough for
|
|
|
|
about 2**31 references to an object.
|
|
|
|
|
|
|
|
XXX The following became out of date in Python 2.2, but I'm not sure
|
|
|
|
XXX what the full truth is now. Certainly, heap-allocated type objects
|
|
|
|
XXX can and should be deallocated.
|
1990-10-14 20:07:46 +08:00
|
|
|
Type objects should never be deallocated; the type pointer in an object
|
|
|
|
is not considered to be a reference to the type object, to save
|
|
|
|
complications in the deallocation function. (This is actually a
|
|
|
|
decision that's up to the implementer of each new type so if you want,
|
|
|
|
you can count such references to the type object.)
|
|
|
|
*/
|
|
|
|
|
2002-07-08 03:59:50 +08:00
|
|
|
#ifdef Py_REF_DEBUG
|
2006-03-05 03:58:13 +08:00
|
|
|
PyAPI_DATA(Py_ssize_t) _Py_RefTotal;
|
2018-10-25 23:28:11 +08:00
|
|
|
PyAPI_FUNC(void) _Py_NegativeRefcount(const char *filename, int lineno,
|
|
|
|
PyObject *op);
|
2002-07-10 14:34:15 +08:00
|
|
|
#endif /* Py_REF_DEBUG */
|
2002-07-08 03:59:50 +08:00
|
|
|
|
2010-12-04 04:14:31 +08:00
|
|
|
PyAPI_FUNC(void) _Py_Dealloc(PyObject *);
|
2018-10-30 21:48:26 +08:00
|
|
|
|
2018-10-29 20:43:07 +08:00
|
|
|
static inline void _Py_INCREF(PyObject *op)
|
|
|
|
{
|
2020-02-04 00:55:05 +08:00
|
|
|
#ifdef Py_REF_DEBUG
|
|
|
|
_Py_RefTotal++;
|
|
|
|
#endif
|
2018-10-29 20:43:07 +08:00
|
|
|
op->ob_refcnt++;
|
|
|
|
}
|
|
|
|
|
2018-11-22 09:57:29 +08:00
|
|
|
#define Py_INCREF(op) _Py_INCREF(_PyObject_CAST(op))
|
2018-10-29 20:43:07 +08:00
|
|
|
|
2020-01-09 04:03:45 +08:00
|
|
|
static inline void _Py_DECREF(
|
|
|
|
#ifdef Py_REF_DEBUG
|
|
|
|
const char *filename, int lineno,
|
|
|
|
#endif
|
|
|
|
PyObject *op)
|
2018-10-29 20:43:07 +08:00
|
|
|
{
|
2020-02-04 00:55:05 +08:00
|
|
|
#ifdef Py_REF_DEBUG
|
|
|
|
_Py_RefTotal--;
|
|
|
|
#endif
|
2018-10-29 20:43:07 +08:00
|
|
|
if (--op->ob_refcnt != 0) {
|
|
|
|
#ifdef Py_REF_DEBUG
|
|
|
|
if (op->ob_refcnt < 0) {
|
|
|
|
_Py_NegativeRefcount(filename, lineno, op);
|
|
|
|
}
|
|
|
|
#endif
|
|
|
|
}
|
|
|
|
else {
|
|
|
|
_Py_Dealloc(op);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2020-01-09 04:03:45 +08:00
|
|
|
#ifdef Py_REF_DEBUG
|
|
|
|
# define Py_DECREF(op) _Py_DECREF(__FILE__, __LINE__, _PyObject_CAST(op))
|
|
|
|
#else
|
|
|
|
# define Py_DECREF(op) _Py_DECREF(_PyObject_CAST(op))
|
|
|
|
#endif
|
2018-10-29 20:43:07 +08:00
|
|
|
|
1990-10-14 20:07:46 +08:00
|
|
|
|
2006-04-21 18:40:58 +08:00
|
|
|
/* Safely decref `op` and set `op` to NULL, especially useful in tp_clear
|
2015-04-14 14:30:01 +08:00
|
|
|
* and tp_dealloc implementations.
|
2006-04-21 18:40:58 +08:00
|
|
|
*
|
|
|
|
* Note that "the obvious" code can be deadly:
|
|
|
|
*
|
|
|
|
* Py_XDECREF(op);
|
|
|
|
* op = NULL;
|
|
|
|
*
|
|
|
|
* Typically, `op` is something like self->containee, and `self` is done
|
|
|
|
* using its `containee` member. In the code sequence above, suppose
|
|
|
|
* `containee` is non-NULL with a refcount of 1. Its refcount falls to
|
|
|
|
* 0 on the first line, which can trigger an arbitrary amount of code,
|
|
|
|
* possibly including finalizers (like __del__ methods or weakref callbacks)
|
|
|
|
* coded in Python, which in turn can release the GIL and allow other threads
|
|
|
|
* to run, etc. Such code may even invoke methods of `self` again, or cause
|
|
|
|
* cyclic gc to trigger, but-- oops! --self->containee still points to the
|
|
|
|
* object being torn down, and it may be in an insane state while being torn
|
|
|
|
* down. This has in fact been a rich historic source of miserable (rare &
|
|
|
|
* hard-to-diagnose) segfaulting (and other) bugs.
|
|
|
|
*
|
|
|
|
* The safe way is:
|
|
|
|
*
|
|
|
|
* Py_CLEAR(op);
|
|
|
|
*
|
|
|
|
* That arranges to set `op` to NULL _before_ decref'ing, so that any code
|
|
|
|
* triggered as a side-effect of `op` getting torn down no longer believes
|
|
|
|
* `op` points to a valid object.
|
|
|
|
*
|
|
|
|
* There are cases where it's safe to use the naive code, but they're brittle.
|
|
|
|
* For example, if `op` points to a Python integer, you know that destroying
|
|
|
|
* one of those can't cause problems -- but in part that relies on that
|
|
|
|
* Python integers aren't currently weakly referencable. Best practice is
|
|
|
|
* to use Py_CLEAR() even if you can't think of a reason for why you need to.
|
|
|
|
*/
|
2010-05-09 23:52:27 +08:00
|
|
|
#define Py_CLEAR(op) \
|
|
|
|
do { \
|
2018-11-22 09:57:29 +08:00
|
|
|
PyObject *_py_tmp = _PyObject_CAST(op); \
|
2013-05-28 05:46:14 +08:00
|
|
|
if (_py_tmp != NULL) { \
|
2010-05-09 23:52:27 +08:00
|
|
|
(op) = NULL; \
|
|
|
|
Py_DECREF(_py_tmp); \
|
|
|
|
} \
|
|
|
|
} while (0)
|
2004-07-15 03:07:35 +08:00
|
|
|
|
2018-10-30 03:52:41 +08:00
|
|
|
/* Function to use in case the object pointer can be NULL: */
|
|
|
|
static inline void _Py_XINCREF(PyObject *op)
|
|
|
|
{
|
|
|
|
if (op != NULL) {
|
|
|
|
Py_INCREF(op);
|
|
|
|
}
|
|
|
|
}
|
2013-05-28 05:46:14 +08:00
|
|
|
|
2018-11-22 09:57:29 +08:00
|
|
|
#define Py_XINCREF(op) _Py_XINCREF(_PyObject_CAST(op))
|
2018-10-30 03:52:41 +08:00
|
|
|
|
|
|
|
static inline void _Py_XDECREF(PyObject *op)
|
|
|
|
{
|
|
|
|
if (op != NULL) {
|
|
|
|
Py_DECREF(op);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2018-11-22 09:57:29 +08:00
|
|
|
#define Py_XDECREF(op) _Py_XDECREF(_PyObject_CAST(op))
|
1990-10-14 20:07:46 +08:00
|
|
|
|
2004-04-23 01:23:49 +08:00
|
|
|
/*
|
|
|
|
These are provided as conveniences to Python runtime embedders, so that
|
|
|
|
they can have object code that is not dependent on Python compilation flags.
|
|
|
|
*/
|
|
|
|
PyAPI_FUNC(void) Py_IncRef(PyObject *);
|
|
|
|
PyAPI_FUNC(void) Py_DecRef(PyObject *);
|
|
|
|
|
1990-10-14 20:07:46 +08:00
|
|
|
/*
|
1995-01-12 19:45:45 +08:00
|
|
|
_Py_NoneStruct is an object of undefined type which can be used in contexts
|
1990-10-14 20:07:46 +08:00
|
|
|
where NULL (nil) is not suitable (since NULL often means 'error').
|
|
|
|
|
1995-01-12 19:45:45 +08:00
|
|
|
Don't forget to apply Py_INCREF() when returning this value!!!
|
1990-10-14 20:07:46 +08:00
|
|
|
*/
|
2002-07-29 21:42:14 +08:00
|
|
|
PyAPI_DATA(PyObject) _Py_NoneStruct; /* Don't use this directly */
|
1995-01-12 19:45:45 +08:00
|
|
|
#define Py_None (&_Py_NoneStruct)
|
1990-10-14 20:07:46 +08:00
|
|
|
|
2003-10-20 05:19:40 +08:00
|
|
|
/* Macro for returning Py_None from a function */
|
2004-07-22 09:46:43 +08:00
|
|
|
#define Py_RETURN_NONE return Py_INCREF(Py_None), Py_None
|
2003-10-20 05:19:40 +08:00
|
|
|
|
2001-01-04 09:31:50 +08:00
|
|
|
/*
|
|
|
|
Py_NotImplemented is a singleton used to signal that an operation is
|
|
|
|
not implemented for a given type combination.
|
|
|
|
*/
|
2002-07-29 21:42:14 +08:00
|
|
|
PyAPI_DATA(PyObject) _Py_NotImplementedStruct; /* Don't use this directly */
|
2001-01-04 09:31:50 +08:00
|
|
|
#define Py_NotImplemented (&_Py_NotImplementedStruct)
|
1990-10-14 20:07:46 +08:00
|
|
|
|
2011-08-11 09:05:21 +08:00
|
|
|
/* Macro for returning Py_NotImplemented from a function */
|
|
|
|
#define Py_RETURN_NOTIMPLEMENTED \
|
|
|
|
return Py_INCREF(Py_NotImplemented), Py_NotImplemented
|
|
|
|
|
2001-01-17 23:20:39 +08:00
|
|
|
/* Rich comparison opcodes */
|
|
|
|
#define Py_LT 0
|
|
|
|
#define Py_LE 1
|
|
|
|
#define Py_EQ 2
|
|
|
|
#define Py_NE 3
|
|
|
|
#define Py_GT 4
|
|
|
|
#define Py_GE 5
|
|
|
|
|
2017-11-02 18:32:54 +08:00
|
|
|
/*
|
|
|
|
* Macro for implementing rich comparisons
|
|
|
|
*
|
|
|
|
* Needs to be a macro because any C-comparable type can be used.
|
|
|
|
*/
|
|
|
|
#define Py_RETURN_RICHCOMPARE(val1, val2, op) \
|
|
|
|
do { \
|
|
|
|
switch (op) { \
|
|
|
|
case Py_EQ: if ((val1) == (val2)) Py_RETURN_TRUE; Py_RETURN_FALSE; \
|
|
|
|
case Py_NE: if ((val1) != (val2)) Py_RETURN_TRUE; Py_RETURN_FALSE; \
|
|
|
|
case Py_LT: if ((val1) < (val2)) Py_RETURN_TRUE; Py_RETURN_FALSE; \
|
|
|
|
case Py_GT: if ((val1) > (val2)) Py_RETURN_TRUE; Py_RETURN_FALSE; \
|
|
|
|
case Py_LE: if ((val1) <= (val2)) Py_RETURN_TRUE; Py_RETURN_FALSE; \
|
|
|
|
case Py_GE: if ((val1) >= (val2)) Py_RETURN_TRUE; Py_RETURN_FALSE; \
|
|
|
|
default: \
|
|
|
|
Py_UNREACHABLE(); \
|
|
|
|
} \
|
|
|
|
} while (0)
|
|
|
|
|
1994-08-01 19:34:53 +08:00
|
|
|
|
1990-10-14 20:07:46 +08:00
|
|
|
/*
|
|
|
|
More conventions
|
|
|
|
================
|
|
|
|
|
|
|
|
Argument Checking
|
|
|
|
-----------------
|
|
|
|
|
|
|
|
Functions that take objects as arguments normally don't check for nil
|
|
|
|
arguments, but they do check the type of the argument, and return an
|
|
|
|
error if the function doesn't apply to the type.
|
|
|
|
|
|
|
|
Failure Modes
|
|
|
|
-------------
|
|
|
|
|
|
|
|
Functions may fail for a variety of reasons, including running out of
|
1990-12-20 23:06:42 +08:00
|
|
|
memory. This is communicated to the caller in two ways: an error string
|
|
|
|
is set (see errors.h), and the function result differs: functions that
|
|
|
|
normally return a pointer return NULL for failure, functions returning
|
|
|
|
an integer return -1 (which could be a legal return value too!), and
|
|
|
|
other functions return 0 for success and -1 for failure.
|
2002-07-08 03:59:50 +08:00
|
|
|
Callers should always check for errors before using the result. If
|
|
|
|
an error was set, the caller must either explicitly clear it, or pass
|
|
|
|
the error on to its caller.
|
1990-10-14 20:07:46 +08:00
|
|
|
|
|
|
|
Reference Counts
|
|
|
|
----------------
|
|
|
|
|
|
|
|
It takes a while to get used to the proper usage of reference counts.
|
|
|
|
|
|
|
|
Functions that create an object set the reference count to 1; such new
|
1995-01-12 19:45:45 +08:00
|
|
|
objects must be stored somewhere or destroyed again with Py_DECREF().
|
2003-11-10 00:38:39 +08:00
|
|
|
Some functions that 'store' objects, such as PyTuple_SetItem() and
|
|
|
|
PyList_SetItem(),
|
1990-10-14 20:07:46 +08:00
|
|
|
don't increment the reference count of the object, since the most
|
|
|
|
frequent use is to store a fresh object. Functions that 'retrieve'
|
2003-11-10 00:38:39 +08:00
|
|
|
objects, such as PyTuple_GetItem() and PyDict_GetItemString(), also
|
1995-01-12 19:45:45 +08:00
|
|
|
don't increment
|
1990-10-14 20:07:46 +08:00
|
|
|
the reference count, since most frequently the object is only looked at
|
|
|
|
quickly. Thus, to retrieve an object and store it again, the caller
|
1995-01-12 19:45:45 +08:00
|
|
|
must call Py_INCREF() explicitly.
|
1990-10-14 20:07:46 +08:00
|
|
|
|
2003-11-10 00:38:39 +08:00
|
|
|
NOTE: functions that 'consume' a reference count, like
|
|
|
|
PyList_SetItem(), consume the reference even if the object wasn't
|
|
|
|
successfully stored, to simplify error handling.
|
1990-10-14 20:07:46 +08:00
|
|
|
|
|
|
|
It seems attractive to make other functions that take an object as
|
2003-11-10 00:38:39 +08:00
|
|
|
argument consume a reference count; however, this may quickly get
|
1990-10-14 20:07:46 +08:00
|
|
|
confusing (even the current practice is already confusing). Consider
|
1995-01-12 19:45:45 +08:00
|
|
|
it carefully, it may save lots of calls to Py_INCREF() and Py_DECREF() at
|
1990-10-14 20:07:46 +08:00
|
|
|
times.
|
|
|
|
*/
|
1993-07-28 17:05:47 +08:00
|
|
|
|
2018-10-25 23:31:10 +08:00
|
|
|
#ifndef Py_LIMITED_API
|
2018-11-27 00:09:16 +08:00
|
|
|
# define Py_CPYTHON_OBJECT_H
|
|
|
|
# include "cpython/object.h"
|
|
|
|
# undef Py_CPYTHON_OBJECT_H
|
2018-10-25 23:31:10 +08:00
|
|
|
#endif
|
|
|
|
|
2020-02-05 21:24:17 +08:00
|
|
|
|
|
|
|
static inline int
|
|
|
|
PyType_HasFeature(PyTypeObject *type, unsigned long feature) {
|
|
|
|
#ifdef Py_LIMITED_API
|
|
|
|
return ((PyType_GetFlags(type) & feature) != 0);
|
|
|
|
#else
|
|
|
|
return ((type->tp_flags & feature) != 0);
|
|
|
|
#endif
|
|
|
|
}
|
|
|
|
|
|
|
|
#define PyType_FastSubclass(type, flag) PyType_HasFeature(type, flag)
|
|
|
|
|
|
|
|
static inline int _PyType_Check(PyObject *op) {
|
|
|
|
return PyType_FastSubclass(Py_TYPE(op), Py_TPFLAGS_TYPE_SUBCLASS);
|
|
|
|
}
|
|
|
|
#define PyType_Check(op) _PyType_Check(_PyObject_CAST(op))
|
|
|
|
|
|
|
|
static inline int _PyType_CheckExact(PyObject *op) {
|
|
|
|
return (Py_TYPE(op) == &PyType_Type);
|
|
|
|
}
|
|
|
|
#define PyType_CheckExact(op) _PyType_CheckExact(_PyObject_CAST(op))
|
|
|
|
|
1993-07-28 17:05:47 +08:00
|
|
|
#ifdef __cplusplus
|
|
|
|
}
|
|
|
|
#endif
|
|
|
|
#endif /* !Py_OBJECT_H */
|