cpython-lru_cache-weakref: Doc/c-api/object.rst annotate

annotate Doc/c-api/object.rst @ 58925:eecf1bef052d 2.6

Merged revisions 78207 via svnmerge from svn+ssh://pythondev@svn.python.org/python/trunk ........ r78207 | ezio.melotti | 2010-02-17 01:26:09 +0200 (Wed, 17 Feb 2010) | 1 line #7930: fix stripid ........

author	Ezio Melotti <ezio.melotti@gmail.com>
date	Tue, 16 Feb 2010 23:29:44 +0000
parents	817d8b28cd6b
children	d27f95e3b52f

rev	line source
44796 13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	1 .. highlightlang:: c
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	2
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	3 .. _object:
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	4
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	5 Object Protocol
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	6 ===============
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	7
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	8
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	9 .. cfunction:: int PyObject_Print(PyObject o, FILE fp, int flags)
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	10
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	11 Print an object o, on file fp. Returns ``-1`` on error. The flags argument
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	12 is used to enable certain printing options. The only option currently supported
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	13 is :const:`Py_PRINT_RAW`; if given, the :func:`str` of the object is written
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	14 instead of the :func:`repr`.
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	15
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	16
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	17 .. cfunction:: int PyObject_HasAttr(PyObject o, PyObject attr_name)
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	18
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	19 Returns ``1`` if o has the attribute attr_name, and ``0`` otherwise. This
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	20 is equivalent to the Python expression ``hasattr(o, attr_name)``. This function
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	21 always succeeds.
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	22
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	23
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	24 .. cfunction:: int PyObject_HasAttrString(PyObject o, const char attr_name)
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	25
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	26 Returns ``1`` if o has the attribute attr_name, and ``0`` otherwise. This
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	27 is equivalent to the Python expression ``hasattr(o, attr_name)``. This function
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	28 always succeeds.
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	29
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	30
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	31 .. cfunction:: PyObject* PyObject_GetAttr(PyObject o, PyObject attr_name)
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	32
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	33 Retrieve an attribute named attr_name from object o. Returns the attribute
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	34 value on success, or NULL on failure. This is the equivalent of the Python
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	35 expression ``o.attr_name``.
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	36
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	37
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	38 .. cfunction:: PyObject* PyObject_GetAttrString(PyObject o, const char attr_name)
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	39
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	40 Retrieve an attribute named attr_name from object o. Returns the attribute
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	41 value on success, or NULL on failure. This is the equivalent of the Python
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	42 expression ``o.attr_name``.
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	43
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	44
52898 fb2ea8bb3a33 Merged revisions 70642,70648,70656,70661,70765,70773,70789,70824-70825,70828,70830,70832,70836,70838,70842,70851,70855,70857-70858 via svnmerge from Georg Brandl <georg@python.org> parents: 49355 diff changeset	45 .. cfunction:: PyObject* PyObject_GenericGetAttr(PyObject o, PyObject name)
fb2ea8bb3a33 Merged revisions 70642,70648,70656,70661,70765,70773,70789,70824-70825,70828,70830,70832,70836,70838,70842,70851,70855,70857-70858 via svnmerge from Georg Brandl <georg@python.org> parents: 49355 diff changeset	46
fb2ea8bb3a33 Merged revisions 70642,70648,70656,70661,70765,70773,70789,70824-70825,70828,70830,70832,70836,70838,70842,70851,70855,70857-70858 via svnmerge from Georg Brandl <georg@python.org> parents: 49355 diff changeset	47 Generic attribute getter function that is meant to be put into a type
fb2ea8bb3a33 Merged revisions 70642,70648,70656,70661,70765,70773,70789,70824-70825,70828,70830,70832,70836,70838,70842,70851,70855,70857-70858 via svnmerge from Georg Brandl <georg@python.org> parents: 49355 diff changeset	48 object's ``tp_getattro`` slot. It looks for a descriptor in the dictionary
fb2ea8bb3a33 Merged revisions 70642,70648,70656,70661,70765,70773,70789,70824-70825,70828,70830,70832,70836,70838,70842,70851,70855,70857-70858 via svnmerge from Georg Brandl <georg@python.org> parents: 49355 diff changeset	49 of classes in the object's MRO as well as an attribute in the object's
fb2ea8bb3a33 Merged revisions 70642,70648,70656,70661,70765,70773,70789,70824-70825,70828,70830,70832,70836,70838,70842,70851,70855,70857-70858 via svnmerge from Georg Brandl <georg@python.org> parents: 49355 diff changeset	50 :attr:`__dict__` (if present). As outlined in :ref:`descriptors`, data
fb2ea8bb3a33 Merged revisions 70642,70648,70656,70661,70765,70773,70789,70824-70825,70828,70830,70832,70836,70838,70842,70851,70855,70857-70858 via svnmerge from Georg Brandl <georg@python.org> parents: 49355 diff changeset	51 descriptors take preference over instance attributes, while non-data
fb2ea8bb3a33 Merged revisions 70642,70648,70656,70661,70765,70773,70789,70824-70825,70828,70830,70832,70836,70838,70842,70851,70855,70857-70858 via svnmerge from Georg Brandl <georg@python.org> parents: 49355 diff changeset	52 descriptors don't. Otherwise, an :exc:`AttributeError` is raised.
fb2ea8bb3a33 Merged revisions 70642,70648,70656,70661,70765,70773,70789,70824-70825,70828,70830,70832,70836,70838,70842,70851,70855,70857-70858 via svnmerge from Georg Brandl <georg@python.org> parents: 49355 diff changeset	53
fb2ea8bb3a33 Merged revisions 70642,70648,70656,70661,70765,70773,70789,70824-70825,70828,70830,70832,70836,70838,70842,70851,70855,70857-70858 via svnmerge from Georg Brandl <georg@python.org> parents: 49355 diff changeset	54
44796 13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	55 .. cfunction:: int PyObject_SetAttr(PyObject o, PyObject attr_name, PyObject *v)
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	56
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	57 Set the value of the attribute named attr_name, for object o, to the value
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	58 v. Returns ``-1`` on failure. This is the equivalent of the Python statement
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	59 ``o.attr_name = v``.
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	60
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	61
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	62 .. cfunction:: int PyObject_SetAttrString(PyObject o, const char attr_name, PyObject *v)
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	63
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	64 Set the value of the attribute named attr_name, for object o, to the value
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	65 v. Returns ``-1`` on failure. This is the equivalent of the Python statement
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	66 ``o.attr_name = v``.
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	67
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	68
52927 73600515999b Fixed typo. Hirokazu Yamamoto <ocean-city@m2.ccsnet.ne.jp> parents: 52898 diff changeset	69 .. cfunction:: int PyObject_GenericSetAttr(PyObject o, PyObject name, PyObject *value)
52898 fb2ea8bb3a33 Merged revisions 70642,70648,70656,70661,70765,70773,70789,70824-70825,70828,70830,70832,70836,70838,70842,70851,70855,70857-70858 via svnmerge from Georg Brandl <georg@python.org> parents: 49355 diff changeset	70
fb2ea8bb3a33 Merged revisions 70642,70648,70656,70661,70765,70773,70789,70824-70825,70828,70830,70832,70836,70838,70842,70851,70855,70857-70858 via svnmerge from Georg Brandl <georg@python.org> parents: 49355 diff changeset	71 Generic attribute setter function that is meant to be put into a type
fb2ea8bb3a33 Merged revisions 70642,70648,70656,70661,70765,70773,70789,70824-70825,70828,70830,70832,70836,70838,70842,70851,70855,70857-70858 via svnmerge from Georg Brandl <georg@python.org> parents: 49355 diff changeset	72 object's ``tp_setattro`` slot. It looks for a data descriptor in the
fb2ea8bb3a33 Merged revisions 70642,70648,70656,70661,70765,70773,70789,70824-70825,70828,70830,70832,70836,70838,70842,70851,70855,70857-70858 via svnmerge from Georg Brandl <georg@python.org> parents: 49355 diff changeset	73 dictionary of classes in the object's MRO, and if found it takes preference
fb2ea8bb3a33 Merged revisions 70642,70648,70656,70661,70765,70773,70789,70824-70825,70828,70830,70832,70836,70838,70842,70851,70855,70857-70858 via svnmerge from Georg Brandl <georg@python.org> parents: 49355 diff changeset	74 over setting the attribute in the instance dictionary. Otherwise, the
fb2ea8bb3a33 Merged revisions 70642,70648,70656,70661,70765,70773,70789,70824-70825,70828,70830,70832,70836,70838,70842,70851,70855,70857-70858 via svnmerge from Georg Brandl <georg@python.org> parents: 49355 diff changeset	75 attribute is set in the object's :attr:`__dict__` (if present). Otherwise,
fb2ea8bb3a33 Merged revisions 70642,70648,70656,70661,70765,70773,70789,70824-70825,70828,70830,70832,70836,70838,70842,70851,70855,70857-70858 via svnmerge from Georg Brandl <georg@python.org> parents: 49355 diff changeset	76 an :exc:`AttributeError` is raised and ``-1`` is returned.
fb2ea8bb3a33 Merged revisions 70642,70648,70656,70661,70765,70773,70789,70824-70825,70828,70830,70832,70836,70838,70842,70851,70855,70857-70858 via svnmerge from Georg Brandl <georg@python.org> parents: 49355 diff changeset	77
fb2ea8bb3a33 Merged revisions 70642,70648,70656,70661,70765,70773,70789,70824-70825,70828,70830,70832,70836,70838,70842,70851,70855,70857-70858 via svnmerge from Georg Brandl <georg@python.org> parents: 49355 diff changeset	78
44796 13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	79 .. cfunction:: int PyObject_DelAttr(PyObject o, PyObject attr_name)
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	80
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	81 Delete attribute named attr_name, for object o. Returns ``-1`` on failure.
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	82 This is the equivalent of the Python statement ``del o.attr_name``.
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	83
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	84
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	85 .. cfunction:: int PyObject_DelAttrString(PyObject o, const char attr_name)
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	86
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	87 Delete attribute named attr_name, for object o. Returns ``-1`` on failure.
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	88 This is the equivalent of the Python statement ``del o.attr_name``.
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	89
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	90
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	91 .. cfunction:: PyObject* PyObject_RichCompare(PyObject o1, PyObject o2, int opid)
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	92
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	93 Compare the values of o1 and o2 using the operation specified by opid,
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	94 which must be one of :const:`Py_LT`, :const:`Py_LE`, :const:`Py_EQ`,
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	95 :const:`Py_NE`, :const:`Py_GT`, or :const:`Py_GE`, corresponding to ``<``,
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	96 ``<=``, ``==``, ``!=``, ``>``, or ``>=`` respectively. This is the equivalent of
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	97 the Python expression ``o1 op o2``, where ``op`` is the operator corresponding
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	98 to opid. Returns the value of the comparison on success, or NULL on failure.
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	99
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	100
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	101 .. cfunction:: int PyObject_RichCompareBool(PyObject o1, PyObject o2, int opid)
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	102
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	103 Compare the values of o1 and o2 using the operation specified by opid,
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	104 which must be one of :const:`Py_LT`, :const:`Py_LE`, :const:`Py_EQ`,
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	105 :const:`Py_NE`, :const:`Py_GT`, or :const:`Py_GE`, corresponding to ``<``,
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	106 ``<=``, ``==``, ``!=``, ``>``, or ``>=`` respectively. Returns ``-1`` on error,
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	107 ``0`` if the result is false, ``1`` otherwise. This is the equivalent of the
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	108 Python expression ``o1 op o2``, where ``op`` is the operator corresponding to
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	109 opid.
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	110
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	111
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	112 .. cfunction:: int PyObject_Cmp(PyObject o1, PyObject o2, int *result)
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	113
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	114 .. index:: builtin: cmp
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	115
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	116 Compare the values of o1 and o2 using a routine provided by o1, if one
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	117 exists, otherwise with a routine provided by o2. The result of the comparison
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	118 is returned in result. Returns ``-1`` on failure. This is the equivalent of
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	119 the Python statement ``result = cmp(o1, o2)``.
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	120
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	121
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	122 .. cfunction:: int PyObject_Compare(PyObject o1, PyObject o2)
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	123
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	124 .. index:: builtin: cmp
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	125
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	126 Compare the values of o1 and o2 using a routine provided by o1, if one
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	127 exists, otherwise with a routine provided by o2. Returns the result of the
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	128 comparison on success. On error, the value returned is undefined; use
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	129 :cfunc:`PyErr_Occurred` to detect an error. This is equivalent to the Python
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	130 expression ``cmp(o1, o2)``.
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	131
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	132
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	133 .. cfunction:: PyObject* PyObject_Repr(PyObject *o)
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	134
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	135 .. index:: builtin: repr
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	136
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	137 Compute a string representation of object o. Returns the string
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	138 representation on success, NULL on failure. This is the equivalent of the
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	139 Python expression ``repr(o)``. Called by the :func:`repr` built-in function and
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	140 by reverse quotes.
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	141
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	142
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	143 .. cfunction:: PyObject* PyObject_Str(PyObject *o)
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	144
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	145 .. index:: builtin: str
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	146
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	147 Compute a string representation of object o. Returns the string
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	148 representation on success, NULL on failure. This is the equivalent of the
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	149 Python expression ``str(o)``. Called by the :func:`str` built-in function and
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	150 by the :keyword:`print` statement.
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	151
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	152
48872 edd2ca894a67 sort of backport 66038 by aliasing PyObject_Bytes to PyObject_Str Benjamin Peterson <benjamin@python.org> parents: 48285 diff changeset	153 .. cfunction:: PyObject* PyObject_Bytes(PyObject *o)
edd2ca894a67 sort of backport 66038 by aliasing PyObject_Bytes to PyObject_Str Benjamin Peterson <benjamin@python.org> parents: 48285 diff changeset	154
edd2ca894a67 sort of backport 66038 by aliasing PyObject_Bytes to PyObject_Str Benjamin Peterson <benjamin@python.org> parents: 48285 diff changeset	155 .. index:: builtin: bytes
edd2ca894a67 sort of backport 66038 by aliasing PyObject_Bytes to PyObject_Str Benjamin Peterson <benjamin@python.org> parents: 48285 diff changeset	156
edd2ca894a67 sort of backport 66038 by aliasing PyObject_Bytes to PyObject_Str Benjamin Peterson <benjamin@python.org> parents: 48285 diff changeset	157 Compute a bytes representation of object o. In 2.x, this is just a alias
edd2ca894a67 sort of backport 66038 by aliasing PyObject_Bytes to PyObject_Str Benjamin Peterson <benjamin@python.org> parents: 48285 diff changeset	158 for :cfunc:`PyObject_Str`.
edd2ca894a67 sort of backport 66038 by aliasing PyObject_Bytes to PyObject_Str Benjamin Peterson <benjamin@python.org> parents: 48285 diff changeset	159
edd2ca894a67 sort of backport 66038 by aliasing PyObject_Bytes to PyObject_Str Benjamin Peterson <benjamin@python.org> parents: 48285 diff changeset	160
44796 13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	161 .. cfunction:: PyObject* PyObject_Unicode(PyObject *o)
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	162
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	163 .. index:: builtin: unicode
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	164
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	165 Compute a Unicode string representation of object o. Returns the Unicode
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	166 string representation on success, NULL on failure. This is the equivalent of
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	167 the Python expression ``unicode(o)``. Called by the :func:`unicode` built-in
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	168 function.
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	169
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	170
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	171 .. cfunction:: int PyObject_IsInstance(PyObject inst, PyObject cls)
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	172
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	173 Returns ``1`` if inst is an instance of the class cls or a subclass of
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	174 cls, or ``0`` if not. On error, returns ``-1`` and sets an exception. If
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	175 cls is a type object rather than a class object, :cfunc:`PyObject_IsInstance`
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	176 returns ``1`` if inst is of type cls. If cls is a tuple, the check will
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	177 be done against every entry in cls. The result will be ``1`` when at least one
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	178 of the checks returns ``1``, otherwise it will be ``0``. If inst is not a
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	179 class instance and cls is neither a type object, nor a class object, nor a
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	180 tuple, inst must have a :attr:`__class__` attribute --- the class relationship
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	181 of the value of that attribute with cls will be used to determine the result
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	182 of this function.
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	183
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	184 .. versionadded:: 2.1
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	185
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	186 .. versionchanged:: 2.2
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	187 Support for a tuple as the second argument added.
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	188
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	189 Subclass determination is done in a fairly straightforward way, but includes a
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	190 wrinkle that implementors of extensions to the class system may want to be aware
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	191 of. If :class:`A` and :class:`B` are class objects, :class:`B` is a subclass of
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	192 :class:`A` if it inherits from :class:`A` either directly or indirectly. If
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	193 either is not a class object, a more general mechanism is used to determine the
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	194 class relationship of the two objects. When testing if B is a subclass of
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	195 A, if A is B, :cfunc:`PyObject_IsSubclass` returns true. If A and B
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	196 are different objects, B's :attr:`__bases__` attribute is searched in a
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	197 depth-first fashion for A --- the presence of the :attr:`__bases__` attribute
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	198 is considered sufficient for this determination.
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	199
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	200
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	201 .. cfunction:: int PyObject_IsSubclass(PyObject derived, PyObject cls)
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	202
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	203 Returns ``1`` if the class derived is identical to or derived from the class
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	204 cls, otherwise returns ``0``. In case of an error, returns ``-1``. If cls
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	205 is a tuple, the check will be done against every entry in cls. The result will
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	206 be ``1`` when at least one of the checks returns ``1``, otherwise it will be
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	207 ``0``. If either derived or cls is not an actual class object (or tuple),
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	208 this function uses the generic algorithm described above.
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	209
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	210 .. versionadded:: 2.1
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	211
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	212 .. versionchanged:: 2.3
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	213 Older versions of Python did not support a tuple as the second argument.
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	214
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	215
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	216 .. cfunction:: int PyCallable_Check(PyObject *o)
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	217
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	218 Determine if the object o is callable. Return ``1`` if the object is callable
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	219 and ``0`` otherwise. This function always succeeds.
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	220
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	221
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	222 .. cfunction:: PyObject* PyObject_Call(PyObject callable_object, PyObject args, PyObject *kw)
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	223
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	224 .. index:: builtin: apply
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	225
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	226 Call a callable Python object callable_object, with arguments given by the
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	227 tuple args, and named arguments given by the dictionary kw. If no named
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	228 arguments are needed, kw may be NULL. args must not be NULL, use an
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	229 empty tuple if no arguments are needed. Returns the result of the call on
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	230 success, or NULL on failure. This is the equivalent of the Python expression
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	231 ``apply(callable_object, args, kw)`` or ``callable_object(args, *kw)``.
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	232
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	233 .. versionadded:: 2.2
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	234
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	235
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	236 .. cfunction:: PyObject* PyObject_CallObject(PyObject callable_object, PyObject args)
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	237
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	238 .. index:: builtin: apply
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	239
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	240 Call a callable Python object callable_object, with arguments given by the
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	241 tuple args. If no arguments are needed, then args may be NULL. Returns
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	242 the result of the call on success, or NULL on failure. This is the equivalent
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	243 of the Python expression ``apply(callable_object, args)`` or
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	244 ``callable_object(*args)``.
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	245
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	246
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	247 .. cfunction:: PyObject* PyObject_CallFunction(PyObject callable, char format, ...)
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	248
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	249 .. index:: builtin: apply
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	250
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	251 Call a callable Python object callable, with a variable number of C arguments.
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	252 The C arguments are described using a :cfunc:`Py_BuildValue` style format
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	253 string. The format may be NULL, indicating that no arguments are provided.
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	254 Returns the result of the call on success, or NULL on failure. This is the
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	255 equivalent of the Python expression ``apply(callable, args)`` or
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	256 ``callable(args)``. Note that if you only pass :ctype:`PyObject \` args,
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	257 :cfunc:`PyObject_CallFunctionObjArgs` is a faster alternative.
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	258
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	259
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	260 .. cfunction:: PyObject* PyObject_CallMethod(PyObject o, char method, char *format, ...)
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	261
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	262 Call the method named method of object o with a variable number of C
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	263 arguments. The C arguments are described by a :cfunc:`Py_BuildValue` format
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	264 string that should produce a tuple. The format may be NULL, indicating that
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	265 no arguments are provided. Returns the result of the call on success, or NULL
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	266 on failure. This is the equivalent of the Python expression ``o.method(args)``.
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	267 Note that if you only pass :ctype:`PyObject \*` args,
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	268 :cfunc:`PyObject_CallMethodObjArgs` is a faster alternative.
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	269
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	270
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	271 .. cfunction:: PyObject* PyObject_CallFunctionObjArgs(PyObject *callable, ..., NULL)
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	272
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	273 Call a callable Python object callable, with a variable number of
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	274 :ctype:`PyObject\*` arguments. The arguments are provided as a variable number
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	275 of parameters followed by NULL. Returns the result of the call on success, or
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	276 NULL on failure.
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	277
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	278 .. versionadded:: 2.2
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	279
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	280
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	281 .. cfunction:: PyObject* PyObject_CallMethodObjArgs(PyObject o, PyObject name, ..., NULL)
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	282
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	283 Calls a method of the object o, where the name of the method is given as a
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	284 Python string object in name. It is called with a variable number of
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	285 :ctype:`PyObject\*` arguments. The arguments are provided as a variable number
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	286 of parameters followed by NULL. Returns the result of the call on success, or
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	287 NULL on failure.
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	288
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	289 .. versionadded:: 2.2
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	290
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	291
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	292 .. cfunction:: long PyObject_Hash(PyObject *o)
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	293
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	294 .. index:: builtin: hash
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	295
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	296 Compute and return the hash value of an object o. On failure, return ``-1``.
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	297 This is the equivalent of the Python expression ``hash(o)``.
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	298
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	299
48284 2254aa824d4d Issue 2235: document PyObject_HashNotImplemented Nick Coghlan <ncoghlan@gmail.com> parents: 44796 diff changeset	300 .. cfunction:: long PyObject_HashNotImplemented(PyObject *o)
2254aa824d4d Issue 2235: document PyObject_HashNotImplemented Nick Coghlan <ncoghlan@gmail.com> parents: 44796 diff changeset	301
49355 6ceacd015d67 Markup fix Andrew M. Kuchling <amk@amk.ca> parents: 48872 diff changeset	302 Set a :exc:`TypeError` indicating that ``type(o)`` is not hashable and return ``-1``.
48284 2254aa824d4d Issue 2235: document PyObject_HashNotImplemented Nick Coghlan <ncoghlan@gmail.com> parents: 44796 diff changeset	303 This function receives special treatment when stored in a ``tp_hash`` slot,
48285 4207219acc7a Fix typo Nick Coghlan <ncoghlan@gmail.com> parents: 48284 diff changeset	304 allowing a type to explicitly indicate to the interpreter that it is not
48284 2254aa824d4d Issue 2235: document PyObject_HashNotImplemented Nick Coghlan <ncoghlan@gmail.com> parents: 44796 diff changeset	305 hashable.
2254aa824d4d Issue 2235: document PyObject_HashNotImplemented Nick Coghlan <ncoghlan@gmail.com> parents: 44796 diff changeset	306
2254aa824d4d Issue 2235: document PyObject_HashNotImplemented Nick Coghlan <ncoghlan@gmail.com> parents: 44796 diff changeset	307 .. versionadded:: 2.6
2254aa824d4d Issue 2235: document PyObject_HashNotImplemented Nick Coghlan <ncoghlan@gmail.com> parents: 44796 diff changeset	308
2254aa824d4d Issue 2235: document PyObject_HashNotImplemented Nick Coghlan <ncoghlan@gmail.com> parents: 44796 diff changeset	309
44796 13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	310 .. cfunction:: int PyObject_IsTrue(PyObject *o)
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	311
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	312 Returns ``1`` if the object o is considered to be true, and ``0`` otherwise.
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	313 This is equivalent to the Python expression ``not not o``. On failure, return
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	314 ``-1``.
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	315
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	316
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	317 .. cfunction:: int PyObject_Not(PyObject *o)
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	318
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	319 Returns ``0`` if the object o is considered to be true, and ``1`` otherwise.
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	320 This is equivalent to the Python expression ``not o``. On failure, return
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	321 ``-1``.
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	322
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	323
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	324 .. cfunction:: PyObject* PyObject_Type(PyObject *o)
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	325
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	326 .. index:: builtin: type
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	327
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	328 When o is non-NULL, returns a type object corresponding to the object type
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	329 of object o. On failure, raises :exc:`SystemError` and returns NULL. This
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	330 is equivalent to the Python expression ``type(o)``. This function increments the
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	331 reference count of the return value. There's really no reason to use this
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	332 function instead of the common expression ``o->ob_type``, which returns a
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	333 pointer of type :ctype:`PyTypeObject\*`, except when the incremented reference
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	334 count is needed.
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	335
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	336
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	337 .. cfunction:: int PyObject_TypeCheck(PyObject o, PyTypeObject type)
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	338
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	339 Return true if the object o is of type type or a subtype of type. Both
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	340 parameters must be non-NULL.
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	341
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	342 .. versionadded:: 2.2
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	343
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	344
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	345 .. cfunction:: Py_ssize_t PyObject_Length(PyObject *o)
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	346 Py_ssize_t PyObject_Size(PyObject *o)
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	347
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	348 .. index:: builtin: len
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	349
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	350 Return the length of object o. If the object o provides either the sequence
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	351 and mapping protocols, the sequence length is returned. On error, ``-1`` is
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	352 returned. This is the equivalent to the Python expression ``len(o)``.
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	353
53588 817d8b28cd6b Merged revisions 71873-71874,71882,71890,71893,71898-71900,71910,71914-71923,71925-71929,71931-71934,71937 via svnmerge from Jeroen Ruigrok van der Werven <asmodai@in-nomine.org> parents: 52927 diff changeset	354 .. versionchanged:: 2.5
817d8b28cd6b Merged revisions 71873-71874,71882,71890,71893,71898-71900,71910,71914-71923,71925-71929,71931-71934,71937 via svnmerge from Jeroen Ruigrok van der Werven <asmodai@in-nomine.org> parents: 52927 diff changeset	355 These functions returned an :ctype:`int` type. This might require
817d8b28cd6b Merged revisions 71873-71874,71882,71890,71893,71898-71900,71910,71914-71923,71925-71929,71931-71934,71937 via svnmerge from Jeroen Ruigrok van der Werven <asmodai@in-nomine.org> parents: 52927 diff changeset	356 changes in your code for properly supporting 64-bit systems.
817d8b28cd6b Merged revisions 71873-71874,71882,71890,71893,71898-71900,71910,71914-71923,71925-71929,71931-71934,71937 via svnmerge from Jeroen Ruigrok van der Werven <asmodai@in-nomine.org> parents: 52927 diff changeset	357
44796 13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	358
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	359 .. cfunction:: PyObject* PyObject_GetItem(PyObject o, PyObject key)
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	360
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	361 Return element of o corresponding to the object key or NULL on failure.
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	362 This is the equivalent of the Python expression ``o[key]``.
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	363
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	364
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	365 .. cfunction:: int PyObject_SetItem(PyObject o, PyObject key, PyObject *v)
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	366
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	367 Map the object key to the value v. Returns ``-1`` on failure. This is the
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	368 equivalent of the Python statement ``o[key] = v``.
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	369
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	370
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	371 .. cfunction:: int PyObject_DelItem(PyObject o, PyObject key)
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	372
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	373 Delete the mapping for key from o. Returns ``-1`` on failure. This is the
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	374 equivalent of the Python statement ``del o[key]``.
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	375
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	376
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	377 .. cfunction:: int PyObject_AsFileDescriptor(PyObject *o)
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	378
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	379 Derives a file descriptor from a Python object. If the object is an integer or
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	380 long integer, its value is returned. If not, the object's :meth:`fileno` method
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	381 is called if it exists; the method must return an integer or long integer, which
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	382 is returned as the file descriptor value. Returns ``-1`` on failure.
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	383
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	384
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	385 .. cfunction:: PyObject* PyObject_Dir(PyObject *o)
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	386
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	387 This is equivalent to the Python expression ``dir(o)``, returning a (possibly
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	388 empty) list of strings appropriate for the object argument, or NULL if there
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	389 was an error. If the argument is NULL, this is like the Python ``dir()``,
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	390 returning the names of the current locals; in this case, if no execution frame
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	391 is active then NULL is returned but :cfunc:`PyErr_Occurred` will return false.
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	392
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	393
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	394 .. cfunction:: PyObject* PyObject_GetIter(PyObject *o)
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	395
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	396 This is equivalent to the Python expression ``iter(o)``. It returns a new
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	397 iterator for the object argument, or the object itself if the object is already
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	398 an iterator. Raises :exc:`TypeError` and returns NULL if the object cannot be
13dc65fe8599 Split the monstrous C API manual files in smaller parts. Georg Brandl <georg@python.org> parents: diff changeset	399 iterated.

Mercurial > cpython-lru_cache-weakref

annotate Doc/c-api/object.rst @ 58925:eecf1bef052d 2.6