blob: 5da6cffdb98cfeba1cdf91156148017236d6e840 [file] [log] [blame]
Guido van Rossumf70e43a1991-02-19 12:39:46 +00001
Benjamin Peterson722954a2011-06-11 16:33:35 -05002/* Generic object operations; and implementation of None */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00003
Guido van Rossumc0b618a1997-05-02 03:12:38 +00004#include "Python.h"
Benjamin Petersonfd838e62009-04-20 02:09:13 +00005#include "frameobject.h"
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00006
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007#ifdef __cplusplus
8extern "C" {
9#endif
10
Victor Stinnerbd303c12013-11-07 23:07:29 +010011_Py_IDENTIFIER(Py_Repr);
12_Py_IDENTIFIER(__bytes__);
13_Py_IDENTIFIER(__dir__);
14_Py_IDENTIFIER(__isabstractmethod__);
15_Py_IDENTIFIER(builtins);
16
Tim Peters34592512002-07-11 06:23:50 +000017#ifdef Py_REF_DEBUG
Neal Norwitz84632ee2006-03-04 20:00:59 +000018Py_ssize_t _Py_RefTotal;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000019
20Py_ssize_t
21_Py_GetRefTotal(void)
22{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000023 PyObject *o;
24 Py_ssize_t total = _Py_RefTotal;
Antoine Pitrou9d952542013-08-24 21:07:07 +020025 o = _PySet_Dummy;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000026 if (o != NULL)
27 total -= o->ob_refcnt;
28 return total;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000029}
Nick Coghland6009512014-11-20 21:39:37 +100030
31void
32_PyDebug_PrintTotalRefs(void) {
33 PyObject *xoptions, *value;
34 _Py_IDENTIFIER(showrefcount);
35
36 xoptions = PySys_GetXOptions();
37 if (xoptions == NULL)
38 return;
39 value = _PyDict_GetItemId(xoptions, &PyId_showrefcount);
40 if (value == Py_True)
41 fprintf(stderr,
42 "[%" PY_FORMAT_SIZE_T "d refs, "
43 "%" PY_FORMAT_SIZE_T "d blocks]\n",
44 _Py_GetRefTotal(), _Py_GetAllocatedBlocks());
45}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000046#endif /* Py_REF_DEBUG */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000047
Guido van Rossum3f5da241990-12-20 15:06:42 +000048/* Object allocation routines used by NEWOBJ and NEWVAROBJ macros.
49 These are used by the individual routines for object creation.
50 Do not call them otherwise, they do not initialize the object! */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000051
Tim Peters78be7992003-03-23 02:51:01 +000052#ifdef Py_TRACE_REFS
Tim Peters7571a0f2003-03-23 17:52:28 +000053/* Head of circular doubly-linked list of all objects. These are linked
54 * together via the _ob_prev and _ob_next members of a PyObject, which
55 * exist only in a Py_TRACE_REFS build.
56 */
Tim Peters78be7992003-03-23 02:51:01 +000057static PyObject refchain = {&refchain, &refchain};
Tim Peters36eb4df2003-03-23 03:33:13 +000058
Tim Peters7571a0f2003-03-23 17:52:28 +000059/* Insert op at the front of the list of all objects. If force is true,
60 * op is added even if _ob_prev and _ob_next are non-NULL already. If
61 * force is false amd _ob_prev or _ob_next are non-NULL, do nothing.
62 * force should be true if and only if op points to freshly allocated,
63 * uninitialized memory, or you've unlinked op from the list and are
Tim Peters51f8d382003-03-23 18:06:08 +000064 * relinking it into the front.
Tim Peters7571a0f2003-03-23 17:52:28 +000065 * Note that objects are normally added to the list via _Py_NewReference,
66 * which is called by PyObject_Init. Not all objects are initialized that
67 * way, though; exceptions include statically allocated type objects, and
68 * statically allocated singletons (like Py_True and Py_None).
69 */
Tim Peters36eb4df2003-03-23 03:33:13 +000070void
Tim Peters7571a0f2003-03-23 17:52:28 +000071_Py_AddToAllObjects(PyObject *op, int force)
Tim Peters36eb4df2003-03-23 03:33:13 +000072{
Tim Peters7571a0f2003-03-23 17:52:28 +000073#ifdef Py_DEBUG
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000074 if (!force) {
75 /* If it's initialized memory, op must be in or out of
76 * the list unambiguously.
77 */
78 assert((op->_ob_prev == NULL) == (op->_ob_next == NULL));
79 }
Tim Peters78be7992003-03-23 02:51:01 +000080#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000081 if (force || op->_ob_prev == NULL) {
82 op->_ob_next = refchain._ob_next;
83 op->_ob_prev = &refchain;
84 refchain._ob_next->_ob_prev = op;
85 refchain._ob_next = op;
86 }
Tim Peters7571a0f2003-03-23 17:52:28 +000087}
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000088#endif /* Py_TRACE_REFS */
Tim Peters78be7992003-03-23 02:51:01 +000089
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +000090#ifdef COUNT_ALLOCS
Guido van Rossumc0b618a1997-05-02 03:12:38 +000091static PyTypeObject *type_list;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000092/* All types are added to type_list, at least when
93 they get one object created. That makes them
94 immortal, which unfortunately contributes to
95 garbage itself. If unlist_types_without_objects
96 is set, they will be removed from the type_list
97 once the last object is deallocated. */
Benjamin Petersona4a37fe2009-01-11 17:13:55 +000098static int unlist_types_without_objects;
99extern Py_ssize_t tuple_zero_allocs, fast_tuple_allocs;
100extern Py_ssize_t quick_int_allocs, quick_neg_int_allocs;
101extern Py_ssize_t null_strings, one_strings;
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000102void
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000103dump_counts(FILE* f)
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000104{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000105 PyTypeObject *tp;
Serhiy Storchaka7e160ce2016-07-03 21:03:53 +0300106 PyObject *xoptions, *value;
107 _Py_IDENTIFIER(showalloccount);
108
109 xoptions = PySys_GetXOptions();
110 if (xoptions == NULL)
111 return;
112 value = _PyDict_GetItemId(xoptions, &PyId_showalloccount);
113 if (value != Py_True)
114 return;
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000115
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000116 for (tp = type_list; tp; tp = tp->tp_next)
117 fprintf(f, "%s alloc'd: %" PY_FORMAT_SIZE_T "d, "
118 "freed: %" PY_FORMAT_SIZE_T "d, "
119 "max in use: %" PY_FORMAT_SIZE_T "d\n",
120 tp->tp_name, tp->tp_allocs, tp->tp_frees,
121 tp->tp_maxalloc);
122 fprintf(f, "fast tuple allocs: %" PY_FORMAT_SIZE_T "d, "
123 "empty: %" PY_FORMAT_SIZE_T "d\n",
124 fast_tuple_allocs, tuple_zero_allocs);
125 fprintf(f, "fast int allocs: pos: %" PY_FORMAT_SIZE_T "d, "
126 "neg: %" PY_FORMAT_SIZE_T "d\n",
127 quick_int_allocs, quick_neg_int_allocs);
128 fprintf(f, "null strings: %" PY_FORMAT_SIZE_T "d, "
129 "1-strings: %" PY_FORMAT_SIZE_T "d\n",
130 null_strings, one_strings);
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000131}
132
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000133PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000134get_counts(void)
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000135{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000136 PyTypeObject *tp;
137 PyObject *result;
138 PyObject *v;
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000139
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000140 result = PyList_New(0);
141 if (result == NULL)
142 return NULL;
143 for (tp = type_list; tp; tp = tp->tp_next) {
144 v = Py_BuildValue("(snnn)", tp->tp_name, tp->tp_allocs,
145 tp->tp_frees, tp->tp_maxalloc);
146 if (v == NULL) {
147 Py_DECREF(result);
148 return NULL;
149 }
150 if (PyList_Append(result, v) < 0) {
151 Py_DECREF(v);
152 Py_DECREF(result);
153 return NULL;
154 }
155 Py_DECREF(v);
156 }
157 return result;
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000158}
159
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000160void
Fred Drake100814d2000-07-09 15:48:49 +0000161inc_count(PyTypeObject *tp)
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000162{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000163 if (tp->tp_next == NULL && tp->tp_prev == NULL) {
164 /* first time; insert in linked list */
165 if (tp->tp_next != NULL) /* sanity check */
166 Py_FatalError("XXX inc_count sanity check");
167 if (type_list)
168 type_list->tp_prev = tp;
169 tp->tp_next = type_list;
170 /* Note that as of Python 2.2, heap-allocated type objects
171 * can go away, but this code requires that they stay alive
172 * until program exit. That's why we're careful with
173 * refcounts here. type_list gets a new reference to tp,
174 * while ownership of the reference type_list used to hold
175 * (if any) was transferred to tp->tp_next in the line above.
176 * tp is thus effectively immortal after this.
177 */
178 Py_INCREF(tp);
179 type_list = tp;
Tim Peters3e40c7f2003-03-23 03:04:32 +0000180#ifdef Py_TRACE_REFS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000181 /* Also insert in the doubly-linked list of all objects,
182 * if not already there.
183 */
184 _Py_AddToAllObjects((PyObject *)tp, 0);
Tim Peters78be7992003-03-23 02:51:01 +0000185#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000186 }
187 tp->tp_allocs++;
188 if (tp->tp_allocs - tp->tp_frees > tp->tp_maxalloc)
189 tp->tp_maxalloc = tp->tp_allocs - tp->tp_frees;
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000190}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000191
192void dec_count(PyTypeObject *tp)
193{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000194 tp->tp_frees++;
195 if (unlist_types_without_objects &&
196 tp->tp_allocs == tp->tp_frees) {
197 /* unlink the type from type_list */
198 if (tp->tp_prev)
199 tp->tp_prev->tp_next = tp->tp_next;
200 else
201 type_list = tp->tp_next;
202 if (tp->tp_next)
203 tp->tp_next->tp_prev = tp->tp_prev;
204 tp->tp_next = tp->tp_prev = NULL;
205 Py_DECREF(tp);
206 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000207}
208
Sjoerd Mullendera9c3c221993-10-11 12:54:31 +0000209#endif
210
Tim Peters7c321a82002-07-09 02:57:01 +0000211#ifdef Py_REF_DEBUG
212/* Log a fatal error; doesn't return. */
213void
214_Py_NegativeRefcount(const char *fname, int lineno, PyObject *op)
215{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000216 char buf[300];
Tim Peters7c321a82002-07-09 02:57:01 +0000217
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000218 PyOS_snprintf(buf, sizeof(buf),
219 "%s:%i object at %p has negative ref count "
220 "%" PY_FORMAT_SIZE_T "d",
221 fname, lineno, op, op->ob_refcnt);
222 Py_FatalError(buf);
Tim Peters7c321a82002-07-09 02:57:01 +0000223}
224
225#endif /* Py_REF_DEBUG */
226
Thomas Heller1328b522004-04-22 17:23:49 +0000227void
228Py_IncRef(PyObject *o)
229{
230 Py_XINCREF(o);
231}
232
233void
234Py_DecRef(PyObject *o)
235{
236 Py_XDECREF(o);
237}
238
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000239PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000240PyObject_Init(PyObject *op, PyTypeObject *tp)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000241{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000242 if (op == NULL)
243 return PyErr_NoMemory();
244 /* Any changes should be reflected in PyObject_INIT (objimpl.h) */
245 Py_TYPE(op) = tp;
246 _Py_NewReference(op);
247 return op;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000248}
249
Guido van Rossumb18618d2000-05-03 23:44:39 +0000250PyVarObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000251PyObject_InitVar(PyVarObject *op, PyTypeObject *tp, Py_ssize_t size)
Guido van Rossumb18618d2000-05-03 23:44:39 +0000252{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000253 if (op == NULL)
254 return (PyVarObject *) PyErr_NoMemory();
255 /* Any changes should be reflected in PyObject_INIT_VAR */
256 op->ob_size = size;
257 Py_TYPE(op) = tp;
258 _Py_NewReference((PyObject *)op);
259 return op;
Guido van Rossumb18618d2000-05-03 23:44:39 +0000260}
261
262PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000263_PyObject_New(PyTypeObject *tp)
Guido van Rossumb18618d2000-05-03 23:44:39 +0000264{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000265 PyObject *op;
266 op = (PyObject *) PyObject_MALLOC(_PyObject_SIZE(tp));
267 if (op == NULL)
268 return PyErr_NoMemory();
269 return PyObject_INIT(op, tp);
Guido van Rossumb18618d2000-05-03 23:44:39 +0000270}
271
Guido van Rossumd0c87ee1997-05-15 21:31:03 +0000272PyVarObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000273_PyObject_NewVar(PyTypeObject *tp, Py_ssize_t nitems)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000274{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000275 PyVarObject *op;
276 const size_t size = _PyObject_VAR_SIZE(tp, nitems);
277 op = (PyVarObject *) PyObject_MALLOC(size);
278 if (op == NULL)
279 return (PyVarObject *)PyErr_NoMemory();
280 return PyObject_INIT_VAR(op, tp, nitems);
Guido van Rossumb18618d2000-05-03 23:44:39 +0000281}
282
Antoine Pitrou796564c2013-07-30 19:59:21 +0200283void
284PyObject_CallFinalizer(PyObject *self)
285{
286 PyTypeObject *tp = Py_TYPE(self);
287
288 /* The former could happen on heaptypes created from the C API, e.g.
289 PyType_FromSpec(). */
290 if (!PyType_HasFeature(tp, Py_TPFLAGS_HAVE_FINALIZE) ||
291 tp->tp_finalize == NULL)
292 return;
293 /* tp_finalize should only be called once. */
294 if (PyType_IS_GC(tp) && _PyGC_FINALIZED(self))
295 return;
296
297 tp->tp_finalize(self);
298 if (PyType_IS_GC(tp))
299 _PyGC_SET_FINALIZED(self, 1);
300}
301
302int
303PyObject_CallFinalizerFromDealloc(PyObject *self)
304{
305 Py_ssize_t refcnt;
306
307 /* Temporarily resurrect the object. */
308 if (self->ob_refcnt != 0) {
309 Py_FatalError("PyObject_CallFinalizerFromDealloc called on "
310 "object with a non-zero refcount");
311 }
312 self->ob_refcnt = 1;
313
314 PyObject_CallFinalizer(self);
315
316 /* Undo the temporary resurrection; can't use DECREF here, it would
317 * cause a recursive call.
318 */
319 assert(self->ob_refcnt > 0);
320 if (--self->ob_refcnt == 0)
321 return 0; /* this is the normal path out */
322
323 /* tp_finalize resurrected it! Make it look like the original Py_DECREF
324 * never happened.
325 */
326 refcnt = self->ob_refcnt;
327 _Py_NewReference(self);
328 self->ob_refcnt = refcnt;
329
330 if (PyType_IS_GC(Py_TYPE(self))) {
331 assert(_PyGC_REFS(self) != _PyGC_REFS_UNTRACKED);
332 }
333 /* If Py_REF_DEBUG, _Py_NewReference bumped _Py_RefTotal, so
334 * we need to undo that. */
335 _Py_DEC_REFTOTAL;
336 /* If Py_TRACE_REFS, _Py_NewReference re-added self to the object
337 * chain, so no more to do there.
338 * If COUNT_ALLOCS, the original decref bumped tp_frees, and
339 * _Py_NewReference bumped tp_allocs: both of those need to be
340 * undone.
341 */
342#ifdef COUNT_ALLOCS
343 --Py_TYPE(self)->tp_frees;
344 --Py_TYPE(self)->tp_allocs;
345#endif
346 return -1;
347}
348
Antoine Pitrouc47bd4a2010-07-27 22:08:27 +0000349int
350PyObject_Print(PyObject *op, FILE *fp, int flags)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000351{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000352 int ret = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000353 if (PyErr_CheckSignals())
354 return -1;
Guido van Rossum9b00dfa1998-04-28 16:06:54 +0000355#ifdef USE_STACKCHECK
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000356 if (PyOS_CheckStack()) {
357 PyErr_SetString(PyExc_MemoryError, "stack overflow");
358 return -1;
359 }
Guido van Rossum9b00dfa1998-04-28 16:06:54 +0000360#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000361 clearerr(fp); /* Clear any previous error condition */
362 if (op == NULL) {
363 Py_BEGIN_ALLOW_THREADS
364 fprintf(fp, "<nil>");
365 Py_END_ALLOW_THREADS
366 }
367 else {
368 if (op->ob_refcnt <= 0)
369 /* XXX(twouters) cast refcount to long until %zd is
370 universally available */
371 Py_BEGIN_ALLOW_THREADS
372 fprintf(fp, "<refcnt %ld at %p>",
373 (long)op->ob_refcnt, op);
374 Py_END_ALLOW_THREADS
375 else {
376 PyObject *s;
377 if (flags & Py_PRINT_RAW)
378 s = PyObject_Str(op);
379 else
380 s = PyObject_Repr(op);
381 if (s == NULL)
382 ret = -1;
383 else if (PyBytes_Check(s)) {
384 fwrite(PyBytes_AS_STRING(s), 1,
385 PyBytes_GET_SIZE(s), fp);
386 }
387 else if (PyUnicode_Check(s)) {
388 PyObject *t;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200389 t = PyUnicode_AsEncodedString(s, "utf-8", "backslashreplace");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000390 if (t == NULL)
391 ret = 0;
392 else {
393 fwrite(PyBytes_AS_STRING(t), 1,
394 PyBytes_GET_SIZE(t), fp);
Victor Stinnerba6b4302010-05-17 09:33:42 +0000395 Py_DECREF(t);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000396 }
397 }
398 else {
399 PyErr_Format(PyExc_TypeError,
400 "str() or repr() returned '%.100s'",
401 s->ob_type->tp_name);
402 ret = -1;
403 }
404 Py_XDECREF(s);
405 }
406 }
407 if (ret == 0) {
408 if (ferror(fp)) {
409 PyErr_SetFromErrno(PyExc_IOError);
410 clearerr(fp);
411 ret = -1;
412 }
413 }
414 return ret;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000415}
416
Guido van Rossum38938152006-08-21 23:36:26 +0000417/* For debugging convenience. Set a breakpoint here and call it from your DLL */
418void
Thomas Woutersb2137042007-02-01 18:02:27 +0000419_Py_BreakPoint(void)
Guido van Rossum38938152006-08-21 23:36:26 +0000420{
421}
422
Neal Norwitz1a997502003-01-13 20:13:12 +0000423
Barry Warsaw9bf16442001-01-23 16:24:35 +0000424/* For debugging convenience. See Misc/gdbinit for some useful gdb hooks */
Guido van Rossum38938152006-08-21 23:36:26 +0000425void
426_PyObject_Dump(PyObject* op)
Barry Warsaw9bf16442001-01-23 16:24:35 +0000427{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000428 if (op == NULL)
429 fprintf(stderr, "NULL\n");
430 else {
Georg Brandldfd73442009-04-05 11:47:34 +0000431#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000432 PyGILState_STATE gil;
Georg Brandldfd73442009-04-05 11:47:34 +0000433#endif
Victor Stinnere5132102013-08-26 13:49:06 +0200434 PyObject *error_type, *error_value, *error_traceback;
435
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000436 fprintf(stderr, "object : ");
Georg Brandldfd73442009-04-05 11:47:34 +0000437#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000438 gil = PyGILState_Ensure();
Georg Brandldfd73442009-04-05 11:47:34 +0000439#endif
Victor Stinnere5132102013-08-26 13:49:06 +0200440
441 PyErr_Fetch(&error_type, &error_value, &error_traceback);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000442 (void)PyObject_Print(op, stderr, 0);
Victor Stinnere5132102013-08-26 13:49:06 +0200443 PyErr_Restore(error_type, error_value, error_traceback);
444
Georg Brandldfd73442009-04-05 11:47:34 +0000445#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000446 PyGILState_Release(gil);
Georg Brandldfd73442009-04-05 11:47:34 +0000447#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000448 /* XXX(twouters) cast refcount to long until %zd is
449 universally available */
450 fprintf(stderr, "\n"
451 "type : %s\n"
452 "refcount: %ld\n"
453 "address : %p\n",
454 Py_TYPE(op)==NULL ? "NULL" : Py_TYPE(op)->tp_name,
455 (long)op->ob_refcnt,
456 op);
457 }
Barry Warsaw9bf16442001-01-23 16:24:35 +0000458}
Barry Warsaw903138f2001-01-23 16:33:18 +0000459
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000460PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000461PyObject_Repr(PyObject *v)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000462{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000463 PyObject *res;
464 if (PyErr_CheckSignals())
465 return NULL;
Guido van Rossum9b00dfa1998-04-28 16:06:54 +0000466#ifdef USE_STACKCHECK
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000467 if (PyOS_CheckStack()) {
468 PyErr_SetString(PyExc_MemoryError, "stack overflow");
469 return NULL;
470 }
Guido van Rossum9b00dfa1998-04-28 16:06:54 +0000471#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000472 if (v == NULL)
473 return PyUnicode_FromString("<NULL>");
474 if (Py_TYPE(v)->tp_repr == NULL)
475 return PyUnicode_FromFormat("<%s object at %p>",
476 v->ob_type->tp_name, v);
Victor Stinner33824f62013-08-26 14:05:19 +0200477
478#ifdef Py_DEBUG
479 /* PyObject_Repr() must not be called with an exception set,
Victor Stinnera8cb5152017-01-18 14:12:51 +0100480 because it can clear it (directly or indirectly) and so the
Martin Panter9955a372015-10-07 10:26:23 +0000481 caller loses its exception */
Victor Stinner33824f62013-08-26 14:05:19 +0200482 assert(!PyErr_Occurred());
483#endif
484
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000485 res = (*v->ob_type->tp_repr)(v);
Victor Stinner0a54cf12011-12-01 03:22:44 +0100486 if (res == NULL)
487 return NULL;
488 if (!PyUnicode_Check(res)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000489 PyErr_Format(PyExc_TypeError,
490 "__repr__ returned non-string (type %.200s)",
491 res->ob_type->tp_name);
492 Py_DECREF(res);
493 return NULL;
494 }
Victor Stinnerdb88ae52011-12-01 02:15:00 +0100495#ifndef Py_DEBUG
496 if (PyUnicode_READY(res) < 0)
497 return NULL;
498#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000499 return res;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000500}
501
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000502PyObject *
Guido van Rossum98297ee2007-11-06 21:34:58 +0000503PyObject_Str(PyObject *v)
Guido van Rossumc6004111993-11-05 10:22:19 +0000504{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000505 PyObject *res;
506 if (PyErr_CheckSignals())
507 return NULL;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000508#ifdef USE_STACKCHECK
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000509 if (PyOS_CheckStack()) {
510 PyErr_SetString(PyExc_MemoryError, "stack overflow");
511 return NULL;
512 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000513#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000514 if (v == NULL)
515 return PyUnicode_FromString("<NULL>");
516 if (PyUnicode_CheckExact(v)) {
Victor Stinnerdb88ae52011-12-01 02:15:00 +0100517#ifndef Py_DEBUG
Victor Stinner4ead7c72011-11-20 19:48:36 +0100518 if (PyUnicode_READY(v) < 0)
519 return NULL;
Victor Stinnerdb88ae52011-12-01 02:15:00 +0100520#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000521 Py_INCREF(v);
522 return v;
523 }
524 if (Py_TYPE(v)->tp_str == NULL)
525 return PyObject_Repr(v);
Guido van Rossum4f288ab2001-05-01 16:53:37 +0000526
Victor Stinner33824f62013-08-26 14:05:19 +0200527#ifdef Py_DEBUG
528 /* PyObject_Str() must not be called with an exception set,
Victor Stinnera8cb5152017-01-18 14:12:51 +0100529 because it can clear it (directly or indirectly) and so the
Nick Coghland979e432014-02-09 10:43:21 +1000530 caller loses its exception */
Victor Stinner33824f62013-08-26 14:05:19 +0200531 assert(!PyErr_Occurred());
532#endif
533
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000534 /* It is possible for a type to have a tp_str representation that loops
535 infinitely. */
536 if (Py_EnterRecursiveCall(" while getting the str of an object"))
537 return NULL;
538 res = (*Py_TYPE(v)->tp_str)(v);
539 Py_LeaveRecursiveCall();
540 if (res == NULL)
541 return NULL;
542 if (!PyUnicode_Check(res)) {
543 PyErr_Format(PyExc_TypeError,
544 "__str__ returned non-string (type %.200s)",
545 Py_TYPE(res)->tp_name);
546 Py_DECREF(res);
547 return NULL;
548 }
Victor Stinnerdb88ae52011-12-01 02:15:00 +0100549#ifndef Py_DEBUG
Victor Stinner4ead7c72011-11-20 19:48:36 +0100550 if (PyUnicode_READY(res) < 0)
551 return NULL;
Victor Stinnerdb88ae52011-12-01 02:15:00 +0100552#endif
Victor Stinner4ead7c72011-11-20 19:48:36 +0100553 assert(_PyUnicode_CheckConsistency(res, 1));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000554 return res;
Neil Schemenauercf52c072005-08-12 17:34:58 +0000555}
556
Georg Brandl559e5d72008-06-11 18:37:52 +0000557PyObject *
558PyObject_ASCII(PyObject *v)
559{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000560 PyObject *repr, *ascii, *res;
Georg Brandl559e5d72008-06-11 18:37:52 +0000561
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000562 repr = PyObject_Repr(v);
563 if (repr == NULL)
564 return NULL;
Georg Brandl559e5d72008-06-11 18:37:52 +0000565
Victor Stinneraf037572013-04-14 18:44:10 +0200566 if (PyUnicode_IS_ASCII(repr))
567 return repr;
568
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000569 /* repr is guaranteed to be a PyUnicode object by PyObject_Repr */
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200570 ascii = _PyUnicode_AsASCIIString(repr, "backslashreplace");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000571 Py_DECREF(repr);
572 if (ascii == NULL)
573 return NULL;
Georg Brandl559e5d72008-06-11 18:37:52 +0000574
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000575 res = PyUnicode_DecodeASCII(
576 PyBytes_AS_STRING(ascii),
577 PyBytes_GET_SIZE(ascii),
578 NULL);
579
580 Py_DECREF(ascii);
581 return res;
Georg Brandl559e5d72008-06-11 18:37:52 +0000582}
Guido van Rossuma3af41d2001-01-18 22:07:06 +0000583
Benjamin Petersonc15a0732008-08-26 16:46:47 +0000584PyObject *
585PyObject_Bytes(PyObject *v)
586{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000587 PyObject *result, *func;
Benjamin Petersonc15a0732008-08-26 16:46:47 +0000588
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000589 if (v == NULL)
590 return PyBytes_FromString("<NULL>");
Benjamin Petersonc15a0732008-08-26 16:46:47 +0000591
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000592 if (PyBytes_CheckExact(v)) {
593 Py_INCREF(v);
594 return v;
595 }
Benjamin Petersonc15a0732008-08-26 16:46:47 +0000596
Benjamin Petersonce798522012-01-22 11:24:29 -0500597 func = _PyObject_LookupSpecial(v, &PyId___bytes__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000598 if (func != NULL) {
Victor Stinnerf17c3de2016-12-06 18:46:19 +0100599 result = _PyObject_CallNoArg(func);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000600 Py_DECREF(func);
601 if (result == NULL)
Benjamin Peterson41ece392010-09-11 16:39:57 +0000602 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000603 if (!PyBytes_Check(result)) {
Benjamin Peterson41ece392010-09-11 16:39:57 +0000604 PyErr_Format(PyExc_TypeError,
605 "__bytes__ returned non-bytes (type %.200s)",
606 Py_TYPE(result)->tp_name);
607 Py_DECREF(result);
608 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000609 }
610 return result;
611 }
612 else if (PyErr_Occurred())
613 return NULL;
614 return PyBytes_FromObject(v);
Benjamin Petersonc15a0732008-08-26 16:46:47 +0000615}
616
Mark Dickinsonc008a172009-02-01 13:59:22 +0000617/* For Python 3.0.1 and later, the old three-way comparison has been
618 completely removed in favour of rich comparisons. PyObject_Compare() and
619 PyObject_Cmp() are gone, and the builtin cmp function no longer exists.
Mark Dickinsone94c6792009-02-02 20:36:42 +0000620 The old tp_compare slot has been renamed to tp_reserved, and should no
Mark Dickinsonc008a172009-02-01 13:59:22 +0000621 longer be used. Use tp_richcompare instead.
Guido van Rossum98297ee2007-11-06 21:34:58 +0000622
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000623 See (*) below for practical amendments.
624
Mark Dickinsonc008a172009-02-01 13:59:22 +0000625 tp_richcompare gets called with a first argument of the appropriate type
626 and a second object of an arbitrary type. We never do any kind of
627 coercion.
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000628
Mark Dickinsonc008a172009-02-01 13:59:22 +0000629 The tp_richcompare slot should return an object, as follows:
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000630
631 NULL if an exception occurred
632 NotImplemented if the requested comparison is not implemented
633 any other false value if the requested comparison is false
634 any other true value if the requested comparison is true
635
636 The PyObject_RichCompare[Bool]() wrappers raise TypeError when they get
637 NotImplemented.
638
639 (*) Practical amendments:
640
641 - If rich comparison returns NotImplemented, == and != are decided by
642 comparing the object pointer (i.e. falling back to the base object
643 implementation).
644
Guido van Rossuma4073002002-05-31 20:03:54 +0000645*/
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000646
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000647/* Map rich comparison operators to their swapped version, e.g. LT <--> GT */
Brett Cannona5ca2e72004-09-25 01:37:24 +0000648int _Py_SwappedOp[] = {Py_GT, Py_GE, Py_EQ, Py_NE, Py_LT, Py_LE};
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +0000649
Serhiy Storchaka2d06e842015-12-25 19:53:18 +0200650static const char * const opstrings[] = {"<", "<=", "==", "!=", ">", ">="};
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000651
652/* Perform a rich comparison, raising TypeError when the requested comparison
653 operator is not supported. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000654static PyObject *
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000655do_richcompare(PyObject *v, PyObject *w, int op)
Guido van Rossume797ec12001-01-17 15:24:28 +0000656{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000657 richcmpfunc f;
658 PyObject *res;
659 int checked_reverse_op = 0;
Guido van Rossume797ec12001-01-17 15:24:28 +0000660
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000661 if (v->ob_type != w->ob_type &&
662 PyType_IsSubtype(w->ob_type, v->ob_type) &&
663 (f = w->ob_type->tp_richcompare) != NULL) {
664 checked_reverse_op = 1;
665 res = (*f)(w, v, _Py_SwappedOp[op]);
666 if (res != Py_NotImplemented)
667 return res;
668 Py_DECREF(res);
669 }
670 if ((f = v->ob_type->tp_richcompare) != NULL) {
671 res = (*f)(v, w, op);
672 if (res != Py_NotImplemented)
673 return res;
674 Py_DECREF(res);
675 }
676 if (!checked_reverse_op && (f = w->ob_type->tp_richcompare) != NULL) {
677 res = (*f)(w, v, _Py_SwappedOp[op]);
678 if (res != Py_NotImplemented)
679 return res;
680 Py_DECREF(res);
681 }
682 /* If neither object implements it, provide a sensible default
683 for == and !=, but raise an exception for ordering. */
684 switch (op) {
685 case Py_EQ:
686 res = (v == w) ? Py_True : Py_False;
687 break;
688 case Py_NE:
689 res = (v != w) ? Py_True : Py_False;
690 break;
691 default:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000692 PyErr_Format(PyExc_TypeError,
Victor Stinner91108f02015-10-14 18:25:31 +0200693 "'%s' not supported between instances of '%.100s' and '%.100s'",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000694 opstrings[op],
Victor Stinner91108f02015-10-14 18:25:31 +0200695 v->ob_type->tp_name,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000696 w->ob_type->tp_name);
697 return NULL;
698 }
699 Py_INCREF(res);
700 return res;
Guido van Rossume797ec12001-01-17 15:24:28 +0000701}
702
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000703/* Perform a rich comparison with object result. This wraps do_richcompare()
704 with a check for NULL arguments and a recursion check. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000705
Guido van Rossume797ec12001-01-17 15:24:28 +0000706PyObject *
707PyObject_RichCompare(PyObject *v, PyObject *w, int op)
708{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000709 PyObject *res;
Guido van Rossume797ec12001-01-17 15:24:28 +0000710
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000711 assert(Py_LT <= op && op <= Py_GE);
712 if (v == NULL || w == NULL) {
713 if (!PyErr_Occurred())
714 PyErr_BadInternalCall();
715 return NULL;
716 }
717 if (Py_EnterRecursiveCall(" in comparison"))
718 return NULL;
719 res = do_richcompare(v, w, op);
720 Py_LeaveRecursiveCall();
721 return res;
Guido van Rossume797ec12001-01-17 15:24:28 +0000722}
723
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000724/* Perform a rich comparison with integer result. This wraps
725 PyObject_RichCompare(), returning -1 for error, 0 for false, 1 for true. */
Guido van Rossume797ec12001-01-17 15:24:28 +0000726int
727PyObject_RichCompareBool(PyObject *v, PyObject *w, int op)
728{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000729 PyObject *res;
730 int ok;
Guido van Rossume797ec12001-01-17 15:24:28 +0000731
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000732 /* Quick result when objects are the same.
733 Guarantees that identity implies equality. */
734 if (v == w) {
735 if (op == Py_EQ)
736 return 1;
737 else if (op == Py_NE)
738 return 0;
739 }
Mark Dickinson4a1f5932008-11-12 23:23:36 +0000740
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000741 res = PyObject_RichCompare(v, w, op);
742 if (res == NULL)
743 return -1;
744 if (PyBool_Check(res))
745 ok = (res == Py_True);
746 else
747 ok = PyObject_IsTrue(res);
748 Py_DECREF(res);
749 return ok;
Guido van Rossume797ec12001-01-17 15:24:28 +0000750}
Fred Drake13634cf2000-06-29 19:17:04 +0000751
Antoine Pitrouce4a9da2011-11-21 20:46:33 +0100752Py_hash_t
Nick Coghland1abd252008-07-15 15:46:38 +0000753PyObject_HashNotImplemented(PyObject *v)
754{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000755 PyErr_Format(PyExc_TypeError, "unhashable type: '%.200s'",
756 Py_TYPE(v)->tp_name);
757 return -1;
Nick Coghland1abd252008-07-15 15:46:38 +0000758}
Fred Drake13634cf2000-06-29 19:17:04 +0000759
Benjamin Peterson8f67d082010-10-17 20:54:53 +0000760Py_hash_t
Fred Drake100814d2000-07-09 15:48:49 +0000761PyObject_Hash(PyObject *v)
Guido van Rossum9bfef441993-03-29 10:43:31 +0000762{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000763 PyTypeObject *tp = Py_TYPE(v);
764 if (tp->tp_hash != NULL)
765 return (*tp->tp_hash)(v);
766 /* To keep to the general practice that inheriting
767 * solely from object in C code should work without
768 * an explicit call to PyType_Ready, we implicitly call
769 * PyType_Ready here and then check the tp_hash slot again
770 */
771 if (tp->tp_dict == NULL) {
772 if (PyType_Ready(tp) < 0)
773 return -1;
774 if (tp->tp_hash != NULL)
775 return (*tp->tp_hash)(v);
776 }
777 /* Otherwise, the object can't be hashed */
778 return PyObject_HashNotImplemented(v);
Guido van Rossum9bfef441993-03-29 10:43:31 +0000779}
780
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000781PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000782PyObject_GetAttrString(PyObject *v, const char *name)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000783{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000784 PyObject *w, *res;
Guido van Rossumd8eb1b31996-08-09 20:52:03 +0000785
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000786 if (Py_TYPE(v)->tp_getattr != NULL)
787 return (*Py_TYPE(v)->tp_getattr)(v, (char*)name);
788 w = PyUnicode_InternFromString(name);
789 if (w == NULL)
790 return NULL;
791 res = PyObject_GetAttr(v, w);
Victor Stinner59af08f2012-03-22 02:09:08 +0100792 Py_DECREF(w);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000793 return res;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000794}
795
796int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000797PyObject_HasAttrString(PyObject *v, const char *name)
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000798{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000799 PyObject *res = PyObject_GetAttrString(v, name);
800 if (res != NULL) {
801 Py_DECREF(res);
802 return 1;
803 }
804 PyErr_Clear();
805 return 0;
Guido van Rossumed18fdc1993-07-11 19:55:34 +0000806}
807
808int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000809PyObject_SetAttrString(PyObject *v, const char *name, PyObject *w)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000810{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000811 PyObject *s;
812 int res;
Guido van Rossumd8eb1b31996-08-09 20:52:03 +0000813
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000814 if (Py_TYPE(v)->tp_setattr != NULL)
815 return (*Py_TYPE(v)->tp_setattr)(v, (char*)name, w);
816 s = PyUnicode_InternFromString(name);
817 if (s == NULL)
818 return -1;
819 res = PyObject_SetAttr(v, s, w);
820 Py_XDECREF(s);
821 return res;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000822}
823
Benjamin Petersonbfebb7b2011-12-15 15:34:02 -0500824int
825_PyObject_IsAbstract(PyObject *obj)
826{
827 int res;
828 PyObject* isabstract;
Benjamin Petersonbfebb7b2011-12-15 15:34:02 -0500829
830 if (obj == NULL)
831 return 0;
832
833 isabstract = _PyObject_GetAttrId(obj, &PyId___isabstractmethod__);
834 if (isabstract == NULL) {
835 if (PyErr_ExceptionMatches(PyExc_AttributeError)) {
836 PyErr_Clear();
837 return 0;
838 }
839 return -1;
840 }
841 res = PyObject_IsTrue(isabstract);
842 Py_DECREF(isabstract);
843 return res;
844}
845
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000846PyObject *
Martin v. Löwisafe55bb2011-10-09 10:38:36 +0200847_PyObject_GetAttrId(PyObject *v, _Py_Identifier *name)
848{
849 PyObject *result;
Martin v. Löwisd10759f2011-11-07 13:00:05 +0100850 PyObject *oname = _PyUnicode_FromId(name); /* borrowed */
Martin v. Löwisafe55bb2011-10-09 10:38:36 +0200851 if (!oname)
852 return NULL;
853 result = PyObject_GetAttr(v, oname);
Martin v. Löwisafe55bb2011-10-09 10:38:36 +0200854 return result;
855}
856
857int
858_PyObject_HasAttrId(PyObject *v, _Py_Identifier *name)
859{
860 int result;
Martin v. Löwisd10759f2011-11-07 13:00:05 +0100861 PyObject *oname = _PyUnicode_FromId(name); /* borrowed */
Martin v. Löwisafe55bb2011-10-09 10:38:36 +0200862 if (!oname)
863 return -1;
864 result = PyObject_HasAttr(v, oname);
Martin v. Löwisafe55bb2011-10-09 10:38:36 +0200865 return result;
866}
867
868int
869_PyObject_SetAttrId(PyObject *v, _Py_Identifier *name, PyObject *w)
870{
871 int result;
Martin v. Löwisd10759f2011-11-07 13:00:05 +0100872 PyObject *oname = _PyUnicode_FromId(name); /* borrowed */
Martin v. Löwisafe55bb2011-10-09 10:38:36 +0200873 if (!oname)
874 return -1;
875 result = PyObject_SetAttr(v, oname, w);
Martin v. Löwisafe55bb2011-10-09 10:38:36 +0200876 return result;
877}
878
879PyObject *
Fred Drake100814d2000-07-09 15:48:49 +0000880PyObject_GetAttr(PyObject *v, PyObject *name)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000881{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000882 PyTypeObject *tp = Py_TYPE(v);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000883
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000884 if (!PyUnicode_Check(name)) {
885 PyErr_Format(PyExc_TypeError,
886 "attribute name must be string, not '%.200s'",
887 name->ob_type->tp_name);
888 return NULL;
889 }
890 if (tp->tp_getattro != NULL)
891 return (*tp->tp_getattro)(v, name);
892 if (tp->tp_getattr != NULL) {
Serhiy Storchaka2a404b62017-01-22 23:07:07 +0200893 const char *name_str = PyUnicode_AsUTF8(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000894 if (name_str == NULL)
895 return NULL;
Serhiy Storchaka2a404b62017-01-22 23:07:07 +0200896 return (*tp->tp_getattr)(v, (char *)name_str);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000897 }
898 PyErr_Format(PyExc_AttributeError,
899 "'%.50s' object has no attribute '%U'",
900 tp->tp_name, name);
901 return NULL;
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000902}
903
904int
Fred Drake100814d2000-07-09 15:48:49 +0000905PyObject_HasAttr(PyObject *v, PyObject *name)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000906{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000907 PyObject *res = PyObject_GetAttr(v, name);
908 if (res != NULL) {
909 Py_DECREF(res);
910 return 1;
911 }
912 PyErr_Clear();
913 return 0;
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000914}
915
916int
Fred Drake100814d2000-07-09 15:48:49 +0000917PyObject_SetAttr(PyObject *v, PyObject *name, PyObject *value)
Guido van Rossum98ff96a1997-05-20 18:34:44 +0000918{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000919 PyTypeObject *tp = Py_TYPE(v);
920 int err;
Marc-André Lemburge44e5072000-09-18 16:20:57 +0000921
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000922 if (!PyUnicode_Check(name)) {
923 PyErr_Format(PyExc_TypeError,
924 "attribute name must be string, not '%.200s'",
925 name->ob_type->tp_name);
926 return -1;
927 }
928 Py_INCREF(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000929
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000930 PyUnicode_InternInPlace(&name);
931 if (tp->tp_setattro != NULL) {
932 err = (*tp->tp_setattro)(v, name, value);
933 Py_DECREF(name);
934 return err;
935 }
936 if (tp->tp_setattr != NULL) {
Serhiy Storchaka2a404b62017-01-22 23:07:07 +0200937 const char *name_str = PyUnicode_AsUTF8(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000938 if (name_str == NULL)
939 return -1;
Serhiy Storchaka2a404b62017-01-22 23:07:07 +0200940 err = (*tp->tp_setattr)(v, (char *)name_str, value);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000941 Py_DECREF(name);
942 return err;
943 }
944 Py_DECREF(name);
945 assert(name->ob_refcnt >= 1);
946 if (tp->tp_getattr == NULL && tp->tp_getattro == NULL)
947 PyErr_Format(PyExc_TypeError,
948 "'%.100s' object has no attributes "
949 "(%s .%U)",
950 tp->tp_name,
951 value==NULL ? "del" : "assign to",
952 name);
953 else
954 PyErr_Format(PyExc_TypeError,
955 "'%.100s' object has only read-only attributes "
956 "(%s .%U)",
957 tp->tp_name,
958 value==NULL ? "del" : "assign to",
959 name);
960 return -1;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000961}
962
963/* Helper to get a pointer to an object's __dict__ slot, if any */
964
965PyObject **
966_PyObject_GetDictPtr(PyObject *obj)
967{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000968 Py_ssize_t dictoffset;
969 PyTypeObject *tp = Py_TYPE(obj);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000970
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000971 dictoffset = tp->tp_dictoffset;
972 if (dictoffset == 0)
973 return NULL;
974 if (dictoffset < 0) {
975 Py_ssize_t tsize;
976 size_t size;
Guido van Rossum2eb0b872002-03-01 22:24:49 +0000977
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000978 tsize = ((PyVarObject *)obj)->ob_size;
979 if (tsize < 0)
980 tsize = -tsize;
981 size = _PyObject_VAR_SIZE(tp, tsize);
Guido van Rossum2eb0b872002-03-01 22:24:49 +0000982
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000983 dictoffset += (long)size;
984 assert(dictoffset > 0);
985 assert(dictoffset % SIZEOF_VOID_P == 0);
986 }
987 return (PyObject **) ((char *)obj + dictoffset);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000988}
989
Tim Peters6d6c1a32001-08-02 04:15:00 +0000990PyObject *
Raymond Hettinger1da1dbf2003-03-17 19:46:11 +0000991PyObject_SelfIter(PyObject *obj)
Raymond Hettinger01538262003-03-17 08:24:35 +0000992{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000993 Py_INCREF(obj);
994 return obj;
Raymond Hettinger01538262003-03-17 08:24:35 +0000995}
996
Antoine Pitroua7013882012-04-05 00:04:20 +0200997/* Convenience function to get a builtin from its name */
998PyObject *
999_PyObject_GetBuiltin(const char *name)
1000{
Victor Stinner53e9ec42013-11-07 00:43:05 +01001001 PyObject *mod_name, *mod, *attr;
1002
Victor Stinnerbd303c12013-11-07 23:07:29 +01001003 mod_name = _PyUnicode_FromId(&PyId_builtins); /* borrowed */
Victor Stinner53e9ec42013-11-07 00:43:05 +01001004 if (mod_name == NULL)
1005 return NULL;
1006 mod = PyImport_Import(mod_name);
Antoine Pitroua7013882012-04-05 00:04:20 +02001007 if (mod == NULL)
1008 return NULL;
1009 attr = PyObject_GetAttrString(mod, name);
1010 Py_DECREF(mod);
1011 return attr;
1012}
1013
Amaury Forgeot d'Arcf343e012009-01-12 23:58:21 +00001014/* Helper used when the __next__ method is removed from a type:
1015 tp_iternext is never NULL and can be safely called without checking
1016 on every iteration.
1017 */
1018
1019PyObject *
1020_PyObject_NextNotImplemented(PyObject *self)
1021{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001022 PyErr_Format(PyExc_TypeError,
1023 "'%.200s' object is not iterable",
1024 Py_TYPE(self)->tp_name);
1025 return NULL;
Amaury Forgeot d'Arcf343e012009-01-12 23:58:21 +00001026}
1027
Yury Selivanovf2392132016-12-13 19:03:51 -05001028
1029/* Specialized version of _PyObject_GenericGetAttrWithDict
1030 specifically for the LOAD_METHOD opcode.
1031
1032 Return 1 if a method is found, 0 if it's a regular attribute
1033 from __dict__ or something returned by using a descriptor
1034 protocol.
1035
1036 `method` will point to the resolved attribute or NULL. In the
1037 latter case, an error will be set.
1038*/
1039int
1040_PyObject_GetMethod(PyObject *obj, PyObject *name, PyObject **method)
1041{
1042 PyTypeObject *tp = Py_TYPE(obj);
1043 PyObject *descr;
1044 descrgetfunc f = NULL;
1045 PyObject **dictptr, *dict;
1046 PyObject *attr;
1047 int meth_found = 0;
1048
1049 assert(*method == NULL);
1050
1051 if (Py_TYPE(obj)->tp_getattro != PyObject_GenericGetAttr
1052 || !PyUnicode_Check(name)) {
1053 *method = PyObject_GetAttr(obj, name);
1054 return 0;
1055 }
1056
1057 if (tp->tp_dict == NULL && PyType_Ready(tp) < 0)
1058 return 0;
1059
1060 descr = _PyType_Lookup(tp, name);
1061 if (descr != NULL) {
1062 Py_INCREF(descr);
INADA Naoki5566bbb2017-02-03 07:43:03 +09001063 if (PyFunction_Check(descr) ||
1064 (Py_TYPE(descr) == &PyMethodDescr_Type)) {
Yury Selivanovf2392132016-12-13 19:03:51 -05001065 meth_found = 1;
1066 } else {
1067 f = descr->ob_type->tp_descr_get;
1068 if (f != NULL && PyDescr_IsData(descr)) {
1069 *method = f(descr, obj, (PyObject *)obj->ob_type);
1070 Py_DECREF(descr);
1071 return 0;
1072 }
1073 }
1074 }
1075
1076 dictptr = _PyObject_GetDictPtr(obj);
1077 if (dictptr != NULL && (dict = *dictptr) != NULL) {
1078 Py_INCREF(dict);
1079 attr = PyDict_GetItem(dict, name);
1080 if (attr != NULL) {
1081 Py_INCREF(attr);
1082 *method = attr;
1083 Py_DECREF(dict);
1084 Py_XDECREF(descr);
1085 return 0;
1086 }
1087 Py_DECREF(dict);
1088 }
1089
1090 if (meth_found) {
1091 *method = descr;
1092 return 1;
1093 }
1094
1095 if (f != NULL) {
1096 *method = f(descr, obj, (PyObject *)Py_TYPE(obj));
1097 Py_DECREF(descr);
1098 return 0;
1099 }
1100
1101 if (descr != NULL) {
1102 *method = descr;
1103 return 0;
1104 }
1105
1106 PyErr_Format(PyExc_AttributeError,
1107 "'%.50s' object has no attribute '%U'",
1108 tp->tp_name, name);
1109 return 0;
1110}
1111
1112/* Generic GetAttr functions - put these in your tp_[gs]etattro slot. */
Michael W. Hudson1593f502004-09-14 17:09:47 +00001113
Raymond Hettinger01538262003-03-17 08:24:35 +00001114PyObject *
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001115_PyObject_GenericGetAttrWithDict(PyObject *obj, PyObject *name, PyObject *dict)
Tim Peters6d6c1a32001-08-02 04:15:00 +00001116{
Yury Selivanovf2392132016-12-13 19:03:51 -05001117 /* Make sure the logic of _PyObject_GetMethod is in sync with
1118 this method.
1119 */
1120
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001121 PyTypeObject *tp = Py_TYPE(obj);
1122 PyObject *descr = NULL;
1123 PyObject *res = NULL;
1124 descrgetfunc f;
1125 Py_ssize_t dictoffset;
1126 PyObject **dictptr;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001127
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001128 if (!PyUnicode_Check(name)){
1129 PyErr_Format(PyExc_TypeError,
1130 "attribute name must be string, not '%.200s'",
1131 name->ob_type->tp_name);
1132 return NULL;
1133 }
Serhiy Storchaka55c861f2016-04-17 20:31:51 +03001134 Py_INCREF(name);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001135
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001136 if (tp->tp_dict == NULL) {
1137 if (PyType_Ready(tp) < 0)
1138 goto done;
1139 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001140
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001141 descr = _PyType_Lookup(tp, name);
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00001142
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001143 f = NULL;
1144 if (descr != NULL) {
Serhiy Storchaka55c861f2016-04-17 20:31:51 +03001145 Py_INCREF(descr);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001146 f = descr->ob_type->tp_descr_get;
1147 if (f != NULL && PyDescr_IsData(descr)) {
1148 res = f(descr, obj, (PyObject *)obj->ob_type);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001149 goto done;
1150 }
1151 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001152
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001153 if (dict == NULL) {
1154 /* Inline _PyObject_GetDictPtr */
1155 dictoffset = tp->tp_dictoffset;
1156 if (dictoffset != 0) {
1157 if (dictoffset < 0) {
1158 Py_ssize_t tsize;
1159 size_t size;
Guido van Rossumc66ff442002-08-19 16:50:48 +00001160
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001161 tsize = ((PyVarObject *)obj)->ob_size;
1162 if (tsize < 0)
1163 tsize = -tsize;
1164 size = _PyObject_VAR_SIZE(tp, tsize);
Serhiy Storchaka55c861f2016-04-17 20:31:51 +03001165 assert(size <= PY_SSIZE_T_MAX);
Guido van Rossumc66ff442002-08-19 16:50:48 +00001166
Serhiy Storchaka55c861f2016-04-17 20:31:51 +03001167 dictoffset += (Py_ssize_t)size;
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001168 assert(dictoffset > 0);
1169 assert(dictoffset % SIZEOF_VOID_P == 0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001170 }
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001171 dictptr = (PyObject **) ((char *)obj + dictoffset);
1172 dict = *dictptr;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001173 }
1174 }
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001175 if (dict != NULL) {
1176 Py_INCREF(dict);
1177 res = PyDict_GetItem(dict, name);
1178 if (res != NULL) {
1179 Py_INCREF(res);
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001180 Py_DECREF(dict);
1181 goto done;
1182 }
1183 Py_DECREF(dict);
1184 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001185
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001186 if (f != NULL) {
1187 res = f(descr, obj, (PyObject *)Py_TYPE(obj));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001188 goto done;
1189 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001190
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001191 if (descr != NULL) {
1192 res = descr;
Victor Stinner2d01dc02012-03-09 00:44:13 +01001193 descr = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001194 goto done;
1195 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001196
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001197 PyErr_Format(PyExc_AttributeError,
1198 "'%.50s' object has no attribute '%U'",
1199 tp->tp_name, name);
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001200 done:
Victor Stinner2d01dc02012-03-09 00:44:13 +01001201 Py_XDECREF(descr);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001202 Py_DECREF(name);
1203 return res;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001204}
1205
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001206PyObject *
1207PyObject_GenericGetAttr(PyObject *obj, PyObject *name)
1208{
1209 return _PyObject_GenericGetAttrWithDict(obj, name, NULL);
1210}
1211
Tim Peters6d6c1a32001-08-02 04:15:00 +00001212int
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001213_PyObject_GenericSetAttrWithDict(PyObject *obj, PyObject *name,
1214 PyObject *value, PyObject *dict)
Tim Peters6d6c1a32001-08-02 04:15:00 +00001215{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001216 PyTypeObject *tp = Py_TYPE(obj);
1217 PyObject *descr;
1218 descrsetfunc f;
1219 PyObject **dictptr;
1220 int res = -1;
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001221
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001222 if (!PyUnicode_Check(name)){
1223 PyErr_Format(PyExc_TypeError,
1224 "attribute name must be string, not '%.200s'",
1225 name->ob_type->tp_name);
1226 return -1;
1227 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001228
Benjamin Peterson74529ad2012-03-09 07:25:32 -08001229 if (tp->tp_dict == NULL && PyType_Ready(tp) < 0)
1230 return -1;
1231
1232 Py_INCREF(name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001233
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001234 descr = _PyType_Lookup(tp, name);
Victor Stinner2d01dc02012-03-09 00:44:13 +01001235
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001236 if (descr != NULL) {
Serhiy Storchaka55c861f2016-04-17 20:31:51 +03001237 Py_INCREF(descr);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001238 f = descr->ob_type->tp_descr_set;
Serhiy Storchaka55c861f2016-04-17 20:31:51 +03001239 if (f != NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001240 res = f(descr, obj, value);
1241 goto done;
1242 }
1243 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001244
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001245 if (dict == NULL) {
1246 dictptr = _PyObject_GetDictPtr(obj);
Serhiy Storchaka55c861f2016-04-17 20:31:51 +03001247 if (dictptr == NULL) {
1248 if (descr == NULL) {
1249 PyErr_Format(PyExc_AttributeError,
1250 "'%.100s' object has no attribute '%U'",
1251 tp->tp_name, name);
1252 }
1253 else {
1254 PyErr_Format(PyExc_AttributeError,
1255 "'%.50s' object attribute '%U' is read-only",
1256 tp->tp_name, name);
1257 }
Benjamin Peterson7d95e402012-04-23 11:24:50 -04001258 goto done;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001259 }
Serhiy Storchaka55c861f2016-04-17 20:31:51 +03001260 res = _PyObjectDict_SetItem(tp, dictptr, name, value);
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001261 }
Serhiy Storchaka55c861f2016-04-17 20:31:51 +03001262 else {
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001263 Py_INCREF(dict);
1264 if (value == NULL)
1265 res = PyDict_DelItem(dict, name);
1266 else
1267 res = PyDict_SetItem(dict, name, value);
Benjamin Peterson74529ad2012-03-09 07:25:32 -08001268 Py_DECREF(dict);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001269 }
Serhiy Storchaka55c861f2016-04-17 20:31:51 +03001270 if (res < 0 && PyErr_ExceptionMatches(PyExc_KeyError))
1271 PyErr_SetObject(PyExc_AttributeError, name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001272
Guido van Rossumebca9fc2001-12-04 15:54:53 +00001273 done:
Victor Stinner2d01dc02012-03-09 00:44:13 +01001274 Py_XDECREF(descr);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001275 Py_DECREF(name);
1276 return res;
Guido van Rossum98ff96a1997-05-20 18:34:44 +00001277}
1278
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001279int
1280PyObject_GenericSetAttr(PyObject *obj, PyObject *name, PyObject *value)
1281{
1282 return _PyObject_GenericSetAttrWithDict(obj, name, value, NULL);
1283}
1284
Benjamin Peterson8eb12692012-02-19 19:59:10 -05001285int
1286PyObject_GenericSetDict(PyObject *obj, PyObject *value, void *context)
1287{
Serhiy Storchaka576f1322016-01-05 21:27:54 +02001288 PyObject **dictptr = _PyObject_GetDictPtr(obj);
Benjamin Peterson8eb12692012-02-19 19:59:10 -05001289 if (dictptr == NULL) {
1290 PyErr_SetString(PyExc_AttributeError,
1291 "This object has no __dict__");
1292 return -1;
1293 }
1294 if (value == NULL) {
1295 PyErr_SetString(PyExc_TypeError, "cannot delete __dict__");
1296 return -1;
1297 }
1298 if (!PyDict_Check(value)) {
1299 PyErr_Format(PyExc_TypeError,
1300 "__dict__ must be set to a dictionary, "
1301 "not a '%.200s'", Py_TYPE(value)->tp_name);
1302 return -1;
1303 }
Serhiy Storchaka576f1322016-01-05 21:27:54 +02001304 Py_INCREF(value);
Serhiy Storchakaec397562016-04-06 09:50:03 +03001305 Py_XSETREF(*dictptr, value);
Benjamin Peterson8eb12692012-02-19 19:59:10 -05001306 return 0;
1307}
1308
Antoine Pitrou1a9a9d52010-08-28 18:17:03 +00001309
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001310/* Test a value used as condition, e.g., in a for or if statement.
1311 Return -1 if an error occurred */
1312
1313int
Fred Drake100814d2000-07-09 15:48:49 +00001314PyObject_IsTrue(PyObject *v)
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001315{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001316 Py_ssize_t res;
1317 if (v == Py_True)
1318 return 1;
1319 if (v == Py_False)
1320 return 0;
1321 if (v == Py_None)
1322 return 0;
1323 else if (v->ob_type->tp_as_number != NULL &&
1324 v->ob_type->tp_as_number->nb_bool != NULL)
1325 res = (*v->ob_type->tp_as_number->nb_bool)(v);
1326 else if (v->ob_type->tp_as_mapping != NULL &&
1327 v->ob_type->tp_as_mapping->mp_length != NULL)
1328 res = (*v->ob_type->tp_as_mapping->mp_length)(v);
1329 else if (v->ob_type->tp_as_sequence != NULL &&
1330 v->ob_type->tp_as_sequence->sq_length != NULL)
1331 res = (*v->ob_type->tp_as_sequence->sq_length)(v);
1332 else
1333 return 1;
1334 /* if it is negative, it should be either -1 or -2 */
1335 return (res > 0) ? 1 : Py_SAFE_DOWNCAST(res, Py_ssize_t, int);
Guido van Rossum6ac258d1993-05-12 08:24:20 +00001336}
1337
Tim Peters803526b2002-07-07 05:13:56 +00001338/* equivalent of 'not v'
Guido van Rossumc3d3f961998-04-09 17:53:59 +00001339 Return -1 if an error occurred */
1340
1341int
Fred Drake100814d2000-07-09 15:48:49 +00001342PyObject_Not(PyObject *v)
Guido van Rossumc3d3f961998-04-09 17:53:59 +00001343{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001344 int res;
1345 res = PyObject_IsTrue(v);
1346 if (res < 0)
1347 return res;
1348 return res == 0;
Guido van Rossumc3d3f961998-04-09 17:53:59 +00001349}
1350
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001351/* Test whether an object can be called */
1352
1353int
Fred Drake100814d2000-07-09 15:48:49 +00001354PyCallable_Check(PyObject *x)
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001355{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001356 if (x == NULL)
1357 return 0;
1358 return x->ob_type->tp_call != NULL;
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001359}
1360
Tim Peters7eea37e2001-09-04 22:08:56 +00001361
Georg Brandle32b4222007-03-10 22:13:27 +00001362/* Helper for PyObject_Dir without arguments: returns the local scope. */
1363static PyObject *
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001364_dir_locals(void)
Tim Peters305b5852001-09-17 02:38:46 +00001365{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001366 PyObject *names;
Victor Stinner41bb43a2013-10-29 01:19:37 +01001367 PyObject *locals;
Tim Peters305b5852001-09-17 02:38:46 +00001368
Victor Stinner41bb43a2013-10-29 01:19:37 +01001369 locals = PyEval_GetLocals();
1370 if (locals == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001371 return NULL;
Tim Peters305b5852001-09-17 02:38:46 +00001372
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001373 names = PyMapping_Keys(locals);
1374 if (!names)
1375 return NULL;
1376 if (!PyList_Check(names)) {
1377 PyErr_Format(PyExc_TypeError,
1378 "dir(): expected keys() of locals to be a list, "
1379 "not '%.200s'", Py_TYPE(names)->tp_name);
1380 Py_DECREF(names);
1381 return NULL;
1382 }
Benjamin Peterson3bbb7222011-06-11 16:12:08 -05001383 if (PyList_Sort(names)) {
1384 Py_DECREF(names);
1385 return NULL;
1386 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001387 /* the locals don't need to be DECREF'd */
1388 return names;
Georg Brandle32b4222007-03-10 22:13:27 +00001389}
1390
Benjamin Peterson82b00c12011-05-24 11:09:06 -05001391/* Helper for PyObject_Dir: object introspection. */
Georg Brandle32b4222007-03-10 22:13:27 +00001392static PyObject *
1393_dir_object(PyObject *obj)
1394{
Benjamin Peterson3bbb7222011-06-11 16:12:08 -05001395 PyObject *result, *sorted;
Benjamin Petersonce798522012-01-22 11:24:29 -05001396 PyObject *dirfunc = _PyObject_LookupSpecial(obj, &PyId___dir__);
Georg Brandle32b4222007-03-10 22:13:27 +00001397
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001398 assert(obj);
1399 if (dirfunc == NULL) {
Benjamin Peterson82b00c12011-05-24 11:09:06 -05001400 if (!PyErr_Occurred())
1401 PyErr_SetString(PyExc_TypeError, "object does not provide __dir__");
1402 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001403 }
Benjamin Peterson82b00c12011-05-24 11:09:06 -05001404 /* use __dir__ */
Victor Stinnerf17c3de2016-12-06 18:46:19 +01001405 result = _PyObject_CallNoArg(dirfunc);
Benjamin Peterson82b00c12011-05-24 11:09:06 -05001406 Py_DECREF(dirfunc);
1407 if (result == NULL)
1408 return NULL;
Benjamin Peterson3bbb7222011-06-11 16:12:08 -05001409 /* return sorted(result) */
1410 sorted = PySequence_List(result);
1411 Py_DECREF(result);
1412 if (sorted == NULL)
1413 return NULL;
1414 if (PyList_Sort(sorted)) {
1415 Py_DECREF(sorted);
1416 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001417 }
Benjamin Peterson3bbb7222011-06-11 16:12:08 -05001418 return sorted;
Georg Brandle32b4222007-03-10 22:13:27 +00001419}
1420
1421/* Implementation of dir() -- if obj is NULL, returns the names in the current
1422 (local) scope. Otherwise, performs introspection of the object: returns a
1423 sorted list of attribute names (supposedly) accessible from the object
1424*/
1425PyObject *
1426PyObject_Dir(PyObject *obj)
1427{
Benjamin Peterson3bbb7222011-06-11 16:12:08 -05001428 return (obj == NULL) ? _dir_locals() : _dir_object(obj);
Tim Peters7eea37e2001-09-04 22:08:56 +00001429}
Guido van Rossum49b11fe1995-01-26 00:38:22 +00001430
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001431/*
Raymond Hettinger66d2be82011-07-28 09:55:13 -07001432None is a non-NULL undefined value.
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001433There is (and should be!) no way to create other objects of this type,
Guido van Rossum3f5da241990-12-20 15:06:42 +00001434so there is exactly one (which is indestructible, by the way).
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001435*/
1436
Guido van Rossum0c182a11992-03-27 17:26:13 +00001437/* ARGSUSED */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001438static PyObject *
Fred Drake100814d2000-07-09 15:48:49 +00001439none_repr(PyObject *op)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001440{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001441 return PyUnicode_FromString("None");
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001442}
1443
Barry Warsaw9bf16442001-01-23 16:24:35 +00001444/* ARGUSED */
1445static void
Tim Peters803526b2002-07-07 05:13:56 +00001446none_dealloc(PyObject* ignore)
Barry Warsaw9bf16442001-01-23 16:24:35 +00001447{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001448 /* This should never get called, but we also don't want to SEGV if
1449 * we accidentally decref None out of existence.
1450 */
1451 Py_FatalError("deallocating None");
Barry Warsaw9bf16442001-01-23 16:24:35 +00001452}
1453
Benjamin Petersonc4607ae2011-07-29 18:19:43 -05001454static PyObject *
1455none_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)
1456{
Serhiy Storchaka5ab81d72016-12-16 16:18:57 +02001457 if (PyTuple_GET_SIZE(args) || (kwargs && PyDict_GET_SIZE(kwargs))) {
Benjamin Petersonc4607ae2011-07-29 18:19:43 -05001458 PyErr_SetString(PyExc_TypeError, "NoneType takes no arguments");
1459 return NULL;
1460 }
1461 Py_RETURN_NONE;
1462}
1463
Raymond Hettinger66d2be82011-07-28 09:55:13 -07001464static int
1465none_bool(PyObject *v)
1466{
1467 return 0;
1468}
1469
1470static PyNumberMethods none_as_number = {
1471 0, /* nb_add */
1472 0, /* nb_subtract */
1473 0, /* nb_multiply */
1474 0, /* nb_remainder */
1475 0, /* nb_divmod */
1476 0, /* nb_power */
1477 0, /* nb_negative */
1478 0, /* nb_positive */
1479 0, /* nb_absolute */
1480 (inquiry)none_bool, /* nb_bool */
1481 0, /* nb_invert */
1482 0, /* nb_lshift */
1483 0, /* nb_rshift */
1484 0, /* nb_and */
1485 0, /* nb_xor */
1486 0, /* nb_or */
1487 0, /* nb_int */
1488 0, /* nb_reserved */
1489 0, /* nb_float */
1490 0, /* nb_inplace_add */
1491 0, /* nb_inplace_subtract */
1492 0, /* nb_inplace_multiply */
1493 0, /* nb_inplace_remainder */
1494 0, /* nb_inplace_power */
1495 0, /* nb_inplace_lshift */
1496 0, /* nb_inplace_rshift */
1497 0, /* nb_inplace_and */
1498 0, /* nb_inplace_xor */
1499 0, /* nb_inplace_or */
1500 0, /* nb_floor_divide */
1501 0, /* nb_true_divide */
1502 0, /* nb_inplace_floor_divide */
1503 0, /* nb_inplace_true_divide */
1504 0, /* nb_index */
1505};
Barry Warsaw9bf16442001-01-23 16:24:35 +00001506
Alexandre Vassalotti65846c62013-11-30 17:55:48 -08001507PyTypeObject _PyNone_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001508 PyVarObject_HEAD_INIT(&PyType_Type, 0)
1509 "NoneType",
1510 0,
1511 0,
1512 none_dealloc, /*tp_dealloc*/ /*never called*/
1513 0, /*tp_print*/
1514 0, /*tp_getattr*/
1515 0, /*tp_setattr*/
1516 0, /*tp_reserved*/
1517 none_repr, /*tp_repr*/
Raymond Hettinger66d2be82011-07-28 09:55:13 -07001518 &none_as_number, /*tp_as_number*/
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001519 0, /*tp_as_sequence*/
1520 0, /*tp_as_mapping*/
1521 0, /*tp_hash */
Benjamin Petersonc4607ae2011-07-29 18:19:43 -05001522 0, /*tp_call */
1523 0, /*tp_str */
1524 0, /*tp_getattro */
1525 0, /*tp_setattro */
1526 0, /*tp_as_buffer */
1527 Py_TPFLAGS_DEFAULT, /*tp_flags */
1528 0, /*tp_doc */
1529 0, /*tp_traverse */
1530 0, /*tp_clear */
1531 0, /*tp_richcompare */
1532 0, /*tp_weaklistoffset */
1533 0, /*tp_iter */
1534 0, /*tp_iternext */
1535 0, /*tp_methods */
1536 0, /*tp_members */
1537 0, /*tp_getset */
1538 0, /*tp_base */
1539 0, /*tp_dict */
1540 0, /*tp_descr_get */
1541 0, /*tp_descr_set */
1542 0, /*tp_dictoffset */
1543 0, /*tp_init */
1544 0, /*tp_alloc */
1545 none_new, /*tp_new */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001546};
1547
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001548PyObject _Py_NoneStruct = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001549 _PyObject_EXTRA_INIT
Alexandre Vassalotti65846c62013-11-30 17:55:48 -08001550 1, &_PyNone_Type
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001551};
1552
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001553/* NotImplemented is an object that can be used to signal that an
1554 operation is not implemented for the given type combination. */
1555
1556static PyObject *
1557NotImplemented_repr(PyObject *op)
1558{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001559 return PyUnicode_FromString("NotImplemented");
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001560}
1561
Benjamin Peterson18d7d7a2011-07-29 18:27:44 -05001562static PyObject *
Alexandre Vassalottic49477b2013-11-24 02:53:45 -08001563NotImplemented_reduce(PyObject *op)
1564{
1565 return PyUnicode_FromString("NotImplemented");
1566}
1567
1568static PyMethodDef notimplemented_methods[] = {
1569 {"__reduce__", (PyCFunction)NotImplemented_reduce, METH_NOARGS, NULL},
1570 {NULL, NULL}
1571};
1572
1573static PyObject *
Benjamin Peterson18d7d7a2011-07-29 18:27:44 -05001574notimplemented_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)
1575{
Serhiy Storchaka5ab81d72016-12-16 16:18:57 +02001576 if (PyTuple_GET_SIZE(args) || (kwargs && PyDict_GET_SIZE(kwargs))) {
Benjamin Peterson18d7d7a2011-07-29 18:27:44 -05001577 PyErr_SetString(PyExc_TypeError, "NotImplementedType takes no arguments");
1578 return NULL;
1579 }
Brian Curtindfc80e32011-08-10 20:28:54 -05001580 Py_RETURN_NOTIMPLEMENTED;
Benjamin Peterson18d7d7a2011-07-29 18:27:44 -05001581}
1582
Armin Ronacher226b1db2012-10-06 14:28:58 +02001583static void
1584notimplemented_dealloc(PyObject* ignore)
1585{
1586 /* This should never get called, but we also don't want to SEGV if
1587 * we accidentally decref NotImplemented out of existence.
1588 */
1589 Py_FatalError("deallocating NotImplemented");
1590}
1591
Alexandre Vassalotti65846c62013-11-30 17:55:48 -08001592PyTypeObject _PyNotImplemented_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001593 PyVarObject_HEAD_INIT(&PyType_Type, 0)
1594 "NotImplementedType",
1595 0,
1596 0,
Armin Ronacher226b1db2012-10-06 14:28:58 +02001597 notimplemented_dealloc, /*tp_dealloc*/ /*never called*/
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001598 0, /*tp_print*/
1599 0, /*tp_getattr*/
1600 0, /*tp_setattr*/
1601 0, /*tp_reserved*/
1602 NotImplemented_repr, /*tp_repr*/
1603 0, /*tp_as_number*/
1604 0, /*tp_as_sequence*/
1605 0, /*tp_as_mapping*/
1606 0, /*tp_hash */
Benjamin Peterson18d7d7a2011-07-29 18:27:44 -05001607 0, /*tp_call */
1608 0, /*tp_str */
1609 0, /*tp_getattro */
1610 0, /*tp_setattro */
1611 0, /*tp_as_buffer */
1612 Py_TPFLAGS_DEFAULT, /*tp_flags */
1613 0, /*tp_doc */
1614 0, /*tp_traverse */
1615 0, /*tp_clear */
1616 0, /*tp_richcompare */
1617 0, /*tp_weaklistoffset */
1618 0, /*tp_iter */
1619 0, /*tp_iternext */
Alexandre Vassalottic49477b2013-11-24 02:53:45 -08001620 notimplemented_methods, /*tp_methods */
Benjamin Peterson18d7d7a2011-07-29 18:27:44 -05001621 0, /*tp_members */
1622 0, /*tp_getset */
1623 0, /*tp_base */
1624 0, /*tp_dict */
1625 0, /*tp_descr_get */
1626 0, /*tp_descr_set */
1627 0, /*tp_dictoffset */
1628 0, /*tp_init */
1629 0, /*tp_alloc */
1630 notimplemented_new, /*tp_new */
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001631};
1632
1633PyObject _Py_NotImplementedStruct = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001634 _PyObject_EXTRA_INIT
Alexandre Vassalotti65846c62013-11-30 17:55:48 -08001635 1, &_PyNotImplemented_Type
Neil Schemenauer5ed85ec2001-01-04 01:48:10 +00001636};
1637
Guido van Rossumba21a492001-08-16 08:17:26 +00001638void
1639_Py_ReadyTypes(void)
1640{
Victor Stinner5a1bb4e2014-06-02 14:10:59 +02001641 if (PyType_Ready(&PyBaseObject_Type) < 0)
1642 Py_FatalError("Can't initialize object type");
1643
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001644 if (PyType_Ready(&PyType_Type) < 0)
1645 Py_FatalError("Can't initialize type type");
Guido van Rossumba21a492001-08-16 08:17:26 +00001646
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001647 if (PyType_Ready(&_PyWeakref_RefType) < 0)
1648 Py_FatalError("Can't initialize weakref type");
Fred Drake0a4dd392004-07-02 18:57:45 +00001649
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001650 if (PyType_Ready(&_PyWeakref_CallableProxyType) < 0)
1651 Py_FatalError("Can't initialize callable weakref proxy type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001652
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001653 if (PyType_Ready(&_PyWeakref_ProxyType) < 0)
1654 Py_FatalError("Can't initialize weakref proxy type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001655
Victor Stinner5a1bb4e2014-06-02 14:10:59 +02001656 if (PyType_Ready(&PyLong_Type) < 0)
1657 Py_FatalError("Can't initialize int type");
1658
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001659 if (PyType_Ready(&PyBool_Type) < 0)
1660 Py_FatalError("Can't initialize bool type");
Guido van Rossum77f6a652002-04-03 22:41:51 +00001661
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001662 if (PyType_Ready(&PyByteArray_Type) < 0)
1663 Py_FatalError("Can't initialize bytearray type");
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00001664
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001665 if (PyType_Ready(&PyBytes_Type) < 0)
1666 Py_FatalError("Can't initialize 'str'");
Guido van Rossumcacfc072002-05-24 19:01:59 +00001667
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001668 if (PyType_Ready(&PyList_Type) < 0)
1669 Py_FatalError("Can't initialize list type");
Guido van Rossumba21a492001-08-16 08:17:26 +00001670
Alexandre Vassalotti65846c62013-11-30 17:55:48 -08001671 if (PyType_Ready(&_PyNone_Type) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001672 Py_FatalError("Can't initialize None type");
Guido van Rossumba21a492001-08-16 08:17:26 +00001673
Alexandre Vassalotti65846c62013-11-30 17:55:48 -08001674 if (PyType_Ready(&_PyNotImplemented_Type) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001675 Py_FatalError("Can't initialize NotImplemented type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001676
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001677 if (PyType_Ready(&PyTraceBack_Type) < 0)
1678 Py_FatalError("Can't initialize traceback type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001679
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001680 if (PyType_Ready(&PySuper_Type) < 0)
1681 Py_FatalError("Can't initialize super type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001682
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001683 if (PyType_Ready(&PyRange_Type) < 0)
1684 Py_FatalError("Can't initialize range type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001685
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001686 if (PyType_Ready(&PyDict_Type) < 0)
1687 Py_FatalError("Can't initialize dict type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001688
Benjamin Petersondb87c992016-11-06 13:01:07 -08001689 if (PyType_Ready(&PyDictKeys_Type) < 0)
1690 Py_FatalError("Can't initialize dict keys type");
1691
1692 if (PyType_Ready(&PyDictValues_Type) < 0)
1693 Py_FatalError("Can't initialize dict values type");
1694
1695 if (PyType_Ready(&PyDictItems_Type) < 0)
1696 Py_FatalError("Can't initialize dict items type");
1697
Eric Snow96c6af92015-05-29 22:21:39 -06001698 if (PyType_Ready(&PyODict_Type) < 0)
1699 Py_FatalError("Can't initialize OrderedDict type");
1700
1701 if (PyType_Ready(&PyODictKeys_Type) < 0)
1702 Py_FatalError("Can't initialize odict_keys type");
1703
1704 if (PyType_Ready(&PyODictItems_Type) < 0)
1705 Py_FatalError("Can't initialize odict_items type");
1706
1707 if (PyType_Ready(&PyODictValues_Type) < 0)
1708 Py_FatalError("Can't initialize odict_values type");
1709
1710 if (PyType_Ready(&PyODictIter_Type) < 0)
1711 Py_FatalError("Can't initialize odict_keyiterator type");
1712
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001713 if (PyType_Ready(&PySet_Type) < 0)
1714 Py_FatalError("Can't initialize set type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001715
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001716 if (PyType_Ready(&PyUnicode_Type) < 0)
1717 Py_FatalError("Can't initialize str type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001718
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001719 if (PyType_Ready(&PySlice_Type) < 0)
1720 Py_FatalError("Can't initialize slice type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001721
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001722 if (PyType_Ready(&PyStaticMethod_Type) < 0)
1723 Py_FatalError("Can't initialize static method type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001724
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001725 if (PyType_Ready(&PyComplex_Type) < 0)
1726 Py_FatalError("Can't initialize complex type");
Skip Montanaroba1e0f42009-10-18 14:25:35 +00001727
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001728 if (PyType_Ready(&PyFloat_Type) < 0)
1729 Py_FatalError("Can't initialize float type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001730
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001731 if (PyType_Ready(&PyFrozenSet_Type) < 0)
1732 Py_FatalError("Can't initialize frozenset type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001733
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001734 if (PyType_Ready(&PyProperty_Type) < 0)
1735 Py_FatalError("Can't initialize property type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001736
Stefan Krah9a2d99e2012-02-25 12:24:21 +01001737 if (PyType_Ready(&_PyManagedBuffer_Type) < 0)
1738 Py_FatalError("Can't initialize managed buffer type");
1739
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001740 if (PyType_Ready(&PyMemoryView_Type) < 0)
1741 Py_FatalError("Can't initialize memoryview type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001742
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001743 if (PyType_Ready(&PyTuple_Type) < 0)
1744 Py_FatalError("Can't initialize tuple type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001745
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001746 if (PyType_Ready(&PyEnum_Type) < 0)
1747 Py_FatalError("Can't initialize enumerate type");
Benjamin Petersonae937c02009-04-18 20:54:08 +00001748
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001749 if (PyType_Ready(&PyReversed_Type) < 0)
1750 Py_FatalError("Can't initialize reversed type");
Guido van Rossum47b9ff62006-08-24 00:41:19 +00001751
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001752 if (PyType_Ready(&PyStdPrinter_Type) < 0)
1753 Py_FatalError("Can't initialize StdPrinter");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001754
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001755 if (PyType_Ready(&PyCode_Type) < 0)
1756 Py_FatalError("Can't initialize code type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001757
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001758 if (PyType_Ready(&PyFrame_Type) < 0)
1759 Py_FatalError("Can't initialize frame type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001760
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001761 if (PyType_Ready(&PyCFunction_Type) < 0)
1762 Py_FatalError("Can't initialize builtin function type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001763
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001764 if (PyType_Ready(&PyMethod_Type) < 0)
1765 Py_FatalError("Can't initialize method type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001766
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001767 if (PyType_Ready(&PyFunction_Type) < 0)
1768 Py_FatalError("Can't initialize function type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001769
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001770 if (PyType_Ready(&PyDictProxy_Type) < 0)
1771 Py_FatalError("Can't initialize dict proxy type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001772
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001773 if (PyType_Ready(&PyGen_Type) < 0)
1774 Py_FatalError("Can't initialize generator type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001775
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001776 if (PyType_Ready(&PyGetSetDescr_Type) < 0)
1777 Py_FatalError("Can't initialize get-set descriptor type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001778
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001779 if (PyType_Ready(&PyWrapperDescr_Type) < 0)
1780 Py_FatalError("Can't initialize wrapper type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001781
Benjamin Petersoneff61f62011-09-01 16:32:31 -04001782 if (PyType_Ready(&_PyMethodWrapper_Type) < 0)
1783 Py_FatalError("Can't initialize method wrapper type");
1784
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001785 if (PyType_Ready(&PyEllipsis_Type) < 0)
1786 Py_FatalError("Can't initialize ellipsis type");
Benjamin Petersonfd838e62009-04-20 02:09:13 +00001787
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001788 if (PyType_Ready(&PyMemberDescr_Type) < 0)
1789 Py_FatalError("Can't initialize member descriptor type");
Benjamin Peterson8bc5b682009-05-09 18:10:51 +00001790
Barry Warsaw409da152012-06-03 16:18:47 -04001791 if (PyType_Ready(&_PyNamespace_Type) < 0)
1792 Py_FatalError("Can't initialize namespace type");
Benjamin Petersone8ea97f2012-10-30 23:27:52 -04001793
Benjamin Petersonc4311282012-10-30 23:21:10 -04001794 if (PyType_Ready(&PyCapsule_Type) < 0)
1795 Py_FatalError("Can't initialize capsule type");
1796
1797 if (PyType_Ready(&PyLongRangeIter_Type) < 0)
1798 Py_FatalError("Can't initialize long range iterator type");
1799
1800 if (PyType_Ready(&PyCell_Type) < 0)
1801 Py_FatalError("Can't initialize cell type");
1802
1803 if (PyType_Ready(&PyInstanceMethod_Type) < 0)
1804 Py_FatalError("Can't initialize instance method type");
1805
1806 if (PyType_Ready(&PyClassMethodDescr_Type) < 0)
1807 Py_FatalError("Can't initialize class method descr type");
1808
1809 if (PyType_Ready(&PyMethodDescr_Type) < 0)
1810 Py_FatalError("Can't initialize method descr type");
1811
1812 if (PyType_Ready(&PyCallIter_Type) < 0)
1813 Py_FatalError("Can't initialize call iter type");
1814
1815 if (PyType_Ready(&PySeqIter_Type) < 0)
1816 Py_FatalError("Can't initialize sequence iterator type");
Yury Selivanov5376ba92015-06-22 12:19:30 -04001817
1818 if (PyType_Ready(&PyCoro_Type) < 0)
1819 Py_FatalError("Can't initialize coroutine type");
1820
1821 if (PyType_Ready(&_PyCoroWrapper_Type) < 0)
1822 Py_FatalError("Can't initialize coroutine wrapper type");
Guido van Rossumba21a492001-08-16 08:17:26 +00001823}
1824
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001825
Guido van Rossum84a90321996-05-22 16:34:47 +00001826#ifdef Py_TRACE_REFS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001827
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001828void
Fred Drake100814d2000-07-09 15:48:49 +00001829_Py_NewReference(PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001830{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001831 _Py_INC_REFTOTAL;
1832 op->ob_refcnt = 1;
1833 _Py_AddToAllObjects(op, 1);
1834 _Py_INC_TPALLOCS(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001835}
1836
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001837void
Antoine Pitrou9ed5f272013-08-13 20:18:52 +02001838_Py_ForgetReference(PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001839{
Guido van Rossumbffd6832000-01-20 22:32:56 +00001840#ifdef SLOW_UNREF_CHECK
Antoine Pitrou9ed5f272013-08-13 20:18:52 +02001841 PyObject *p;
Guido van Rossumbffd6832000-01-20 22:32:56 +00001842#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001843 if (op->ob_refcnt < 0)
1844 Py_FatalError("UNREF negative refcnt");
1845 if (op == &refchain ||
1846 op->_ob_prev->_ob_next != op || op->_ob_next->_ob_prev != op) {
1847 fprintf(stderr, "* ob\n");
1848 _PyObject_Dump(op);
1849 fprintf(stderr, "* op->_ob_prev->_ob_next\n");
1850 _PyObject_Dump(op->_ob_prev->_ob_next);
1851 fprintf(stderr, "* op->_ob_next->_ob_prev\n");
1852 _PyObject_Dump(op->_ob_next->_ob_prev);
1853 Py_FatalError("UNREF invalid object");
1854 }
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001855#ifdef SLOW_UNREF_CHECK
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001856 for (p = refchain._ob_next; p != &refchain; p = p->_ob_next) {
1857 if (p == op)
1858 break;
1859 }
1860 if (p == &refchain) /* Not found */
1861 Py_FatalError("UNREF unknown object");
Guido van Rossum2e8f6141992-09-03 20:32:55 +00001862#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001863 op->_ob_next->_ob_prev = op->_ob_prev;
1864 op->_ob_prev->_ob_next = op->_ob_next;
1865 op->_ob_next = op->_ob_prev = NULL;
1866 _Py_INC_TPFREES(op);
Guido van Rossum3f5da241990-12-20 15:06:42 +00001867}
1868
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001869void
Fred Drake100814d2000-07-09 15:48:49 +00001870_Py_Dealloc(PyObject *op)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001871{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001872 destructor dealloc = Py_TYPE(op)->tp_dealloc;
1873 _Py_ForgetReference(op);
1874 (*dealloc)(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001875}
1876
Tim Peters269b2a62003-04-17 19:52:29 +00001877/* Print all live objects. Because PyObject_Print is called, the
1878 * interpreter must be in a healthy state.
1879 */
Guido van Rossumaacdc9d1996-08-12 21:32:12 +00001880void
Fred Drake100814d2000-07-09 15:48:49 +00001881_Py_PrintReferences(FILE *fp)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001882{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001883 PyObject *op;
1884 fprintf(fp, "Remaining objects:\n");
1885 for (op = refchain._ob_next; op != &refchain; op = op->_ob_next) {
1886 fprintf(fp, "%p [%" PY_FORMAT_SIZE_T "d] ", op, op->ob_refcnt);
1887 if (PyObject_Print(op, fp, 0) != 0)
1888 PyErr_Clear();
1889 putc('\n', fp);
1890 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001891}
1892
Tim Peters269b2a62003-04-17 19:52:29 +00001893/* Print the addresses of all live objects. Unlike _Py_PrintReferences, this
1894 * doesn't make any calls to the Python C API, so is always safe to call.
1895 */
1896void
1897_Py_PrintReferenceAddresses(FILE *fp)
1898{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001899 PyObject *op;
1900 fprintf(fp, "Remaining object addresses:\n");
1901 for (op = refchain._ob_next; op != &refchain; op = op->_ob_next)
1902 fprintf(fp, "%p [%" PY_FORMAT_SIZE_T "d] %s\n", op,
1903 op->ob_refcnt, Py_TYPE(op)->tp_name);
Tim Peters269b2a62003-04-17 19:52:29 +00001904}
1905
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001906PyObject *
Fred Drake100814d2000-07-09 15:48:49 +00001907_Py_GetObjects(PyObject *self, PyObject *args)
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001908{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001909 int i, n;
1910 PyObject *t = NULL;
1911 PyObject *res, *op;
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001912
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001913 if (!PyArg_ParseTuple(args, "i|O", &n, &t))
1914 return NULL;
1915 op = refchain._ob_next;
1916 res = PyList_New(0);
1917 if (res == NULL)
1918 return NULL;
1919 for (i = 0; (n == 0 || i < n) && op != &refchain; i++) {
1920 while (op == self || op == args || op == res || op == t ||
1921 (t != NULL && Py_TYPE(op) != (PyTypeObject *) t)) {
1922 op = op->_ob_next;
1923 if (op == &refchain)
1924 return res;
1925 }
1926 if (PyList_Append(res, op) < 0) {
1927 Py_DECREF(res);
1928 return NULL;
1929 }
1930 op = op->_ob_next;
1931 }
1932 return res;
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001933}
1934
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001935#endif
Guido van Rossum97ead3f1996-01-12 01:24:09 +00001936
Benjamin Petersonb173f782009-05-05 22:31:58 +00001937
Guido van Rossum84a90321996-05-22 16:34:47 +00001938/* Hack to force loading of abstract.o */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001939Py_ssize_t (*_Py_abstract_hack)(PyObject *) = PyObject_Size;
Guido van Rossume09fb551997-08-05 02:04:34 +00001940
1941
David Malcolm49526f42012-06-22 14:55:41 -04001942void
1943_PyObject_DebugTypeStats(FILE *out)
1944{
1945 _PyCFunction_DebugMallocStats(out);
1946 _PyDict_DebugMallocStats(out);
1947 _PyFloat_DebugMallocStats(out);
1948 _PyFrame_DebugMallocStats(out);
1949 _PyList_DebugMallocStats(out);
1950 _PyMethod_DebugMallocStats(out);
David Malcolm49526f42012-06-22 14:55:41 -04001951 _PyTuple_DebugMallocStats(out);
1952}
Guido van Rossumb18618d2000-05-03 23:44:39 +00001953
Guido van Rossum86610361998-04-10 22:32:46 +00001954/* These methods are used to control infinite recursion in repr, str, print,
1955 etc. Container objects that may recursively contain themselves,
Martin Panter8d56c022016-05-29 04:13:35 +00001956 e.g. builtin dictionaries and lists, should use Py_ReprEnter() and
Guido van Rossum86610361998-04-10 22:32:46 +00001957 Py_ReprLeave() to avoid infinite recursion.
1958
1959 Py_ReprEnter() returns 0 the first time it is called for a particular
1960 object and 1 every time thereafter. It returns -1 if an exception
1961 occurred. Py_ReprLeave() has no return value.
1962
1963 See dictobject.c and listobject.c for examples of use.
1964*/
1965
Guido van Rossum86610361998-04-10 22:32:46 +00001966int
Fred Drake100814d2000-07-09 15:48:49 +00001967Py_ReprEnter(PyObject *obj)
Guido van Rossum86610361998-04-10 22:32:46 +00001968{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001969 PyObject *dict;
1970 PyObject *list;
1971 Py_ssize_t i;
Guido van Rossum86610361998-04-10 22:32:46 +00001972
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001973 dict = PyThreadState_GetDict();
Antoine Pitrou04d17d32014-03-31 22:04:38 +02001974 /* Ignore a missing thread-state, so that this function can be called
1975 early on startup. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001976 if (dict == NULL)
1977 return 0;
Victor Stinner7a07e452013-11-06 18:57:29 +01001978 list = _PyDict_GetItemId(dict, &PyId_Py_Repr);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001979 if (list == NULL) {
1980 list = PyList_New(0);
1981 if (list == NULL)
1982 return -1;
Victor Stinner7a07e452013-11-06 18:57:29 +01001983 if (_PyDict_SetItemId(dict, &PyId_Py_Repr, list) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001984 return -1;
1985 Py_DECREF(list);
1986 }
1987 i = PyList_GET_SIZE(list);
1988 while (--i >= 0) {
1989 if (PyList_GET_ITEM(list, i) == obj)
1990 return 1;
1991 }
Victor Stinnere901d1f2013-07-17 21:58:41 +02001992 if (PyList_Append(list, obj) < 0)
1993 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001994 return 0;
Guido van Rossum86610361998-04-10 22:32:46 +00001995}
1996
1997void
Fred Drake100814d2000-07-09 15:48:49 +00001998Py_ReprLeave(PyObject *obj)
Guido van Rossum86610361998-04-10 22:32:46 +00001999{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002000 PyObject *dict;
2001 PyObject *list;
2002 Py_ssize_t i;
Victor Stinner1b634932013-07-16 22:24:44 +02002003 PyObject *error_type, *error_value, *error_traceback;
2004
2005 PyErr_Fetch(&error_type, &error_value, &error_traceback);
Guido van Rossum86610361998-04-10 22:32:46 +00002006
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002007 dict = PyThreadState_GetDict();
2008 if (dict == NULL)
Victor Stinner1b634932013-07-16 22:24:44 +02002009 goto finally;
2010
Victor Stinner7a07e452013-11-06 18:57:29 +01002011 list = _PyDict_GetItemId(dict, &PyId_Py_Repr);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002012 if (list == NULL || !PyList_Check(list))
Victor Stinner1b634932013-07-16 22:24:44 +02002013 goto finally;
2014
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002015 i = PyList_GET_SIZE(list);
2016 /* Count backwards because we always expect obj to be list[-1] */
2017 while (--i >= 0) {
2018 if (PyList_GET_ITEM(list, i) == obj) {
2019 PyList_SetSlice(list, i, i + 1, NULL);
2020 break;
2021 }
2022 }
Victor Stinner1b634932013-07-16 22:24:44 +02002023
2024finally:
2025 /* ignore exceptions because there is no way to report them. */
2026 PyErr_Restore(error_type, error_value, error_traceback);
Guido van Rossum86610361998-04-10 22:32:46 +00002027}
Guido van Rossumd724b232000-03-13 16:01:29 +00002028
Tim Peters803526b2002-07-07 05:13:56 +00002029/* Trashcan support. */
Guido van Rossumd724b232000-03-13 16:01:29 +00002030
Tim Peters803526b2002-07-07 05:13:56 +00002031/* Current call-stack depth of tp_dealloc calls. */
Guido van Rossumd724b232000-03-13 16:01:29 +00002032int _PyTrash_delete_nesting = 0;
Guido van Rossume92e6102000-04-24 15:40:53 +00002033
Tim Peters803526b2002-07-07 05:13:56 +00002034/* List of objects that still need to be cleaned up, singly linked via their
2035 * gc headers' gc_prev pointers.
2036 */
2037PyObject *_PyTrash_delete_later = NULL;
Guido van Rossumd724b232000-03-13 16:01:29 +00002038
Tim Peters803526b2002-07-07 05:13:56 +00002039/* Add op to the _PyTrash_delete_later list. Called when the current
2040 * call-stack depth gets large. op must be a currently untracked gc'ed
2041 * object, with refcount 0. Py_DECREF must already have been called on it.
2042 */
Guido van Rossumd724b232000-03-13 16:01:29 +00002043void
Fred Drake100814d2000-07-09 15:48:49 +00002044_PyTrash_deposit_object(PyObject *op)
Guido van Rossumd724b232000-03-13 16:01:29 +00002045{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002046 assert(PyObject_IS_GC(op));
Antoine Pitrou796564c2013-07-30 19:59:21 +02002047 assert(_PyGC_REFS(op) == _PyGC_REFS_UNTRACKED);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002048 assert(op->ob_refcnt == 0);
2049 _Py_AS_GC(op)->gc.gc_prev = (PyGC_Head *)_PyTrash_delete_later;
2050 _PyTrash_delete_later = op;
Guido van Rossumd724b232000-03-13 16:01:29 +00002051}
2052
Antoine Pitrou2b0218a2012-09-06 00:59:49 +02002053/* The equivalent API, using per-thread state recursion info */
2054void
2055_PyTrash_thread_deposit_object(PyObject *op)
2056{
2057 PyThreadState *tstate = PyThreadState_GET();
2058 assert(PyObject_IS_GC(op));
Antoine Pitrou796564c2013-07-30 19:59:21 +02002059 assert(_PyGC_REFS(op) == _PyGC_REFS_UNTRACKED);
Antoine Pitrou2b0218a2012-09-06 00:59:49 +02002060 assert(op->ob_refcnt == 0);
2061 _Py_AS_GC(op)->gc.gc_prev = (PyGC_Head *) tstate->trash_delete_later;
2062 tstate->trash_delete_later = op;
2063}
2064
Tim Peters803526b2002-07-07 05:13:56 +00002065/* Dealloccate all the objects in the _PyTrash_delete_later list. Called when
2066 * the call-stack unwinds again.
2067 */
Guido van Rossumd724b232000-03-13 16:01:29 +00002068void
Fred Drake100814d2000-07-09 15:48:49 +00002069_PyTrash_destroy_chain(void)
Guido van Rossumd724b232000-03-13 16:01:29 +00002070{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002071 while (_PyTrash_delete_later) {
2072 PyObject *op = _PyTrash_delete_later;
2073 destructor dealloc = Py_TYPE(op)->tp_dealloc;
Neil Schemenauerf589c052002-03-29 03:05:54 +00002074
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002075 _PyTrash_delete_later =
2076 (PyObject*) _Py_AS_GC(op)->gc.gc_prev;
Neil Schemenauerf589c052002-03-29 03:05:54 +00002077
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002078 /* Call the deallocator directly. This used to try to
2079 * fool Py_DECREF into calling it indirectly, but
2080 * Py_DECREF was already called on this object, and in
2081 * assorted non-release builds calling Py_DECREF again ends
2082 * up distorting allocation statistics.
2083 */
2084 assert(op->ob_refcnt == 0);
2085 ++_PyTrash_delete_nesting;
2086 (*dealloc)(op);
2087 --_PyTrash_delete_nesting;
2088 }
Guido van Rossumd724b232000-03-13 16:01:29 +00002089}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002090
Antoine Pitrou2b0218a2012-09-06 00:59:49 +02002091/* The equivalent API, using per-thread state recursion info */
2092void
2093_PyTrash_thread_destroy_chain(void)
2094{
2095 PyThreadState *tstate = PyThreadState_GET();
2096 while (tstate->trash_delete_later) {
2097 PyObject *op = tstate->trash_delete_later;
2098 destructor dealloc = Py_TYPE(op)->tp_dealloc;
2099
2100 tstate->trash_delete_later =
2101 (PyObject*) _Py_AS_GC(op)->gc.gc_prev;
2102
2103 /* Call the deallocator directly. This used to try to
2104 * fool Py_DECREF into calling it indirectly, but
2105 * Py_DECREF was already called on this object, and in
2106 * assorted non-release builds calling Py_DECREF again ends
2107 * up distorting allocation statistics.
2108 */
2109 assert(op->ob_refcnt == 0);
2110 ++tstate->trash_delete_nesting;
2111 (*dealloc)(op);
2112 --tstate->trash_delete_nesting;
2113 }
2114}
2115
Martin v. Löwis4d0d4712010-12-03 20:14:31 +00002116#ifndef Py_TRACE_REFS
2117/* For Py_LIMITED_API, we need an out-of-line version of _Py_Dealloc.
2118 Define this here, so we can undefine the macro. */
2119#undef _Py_Dealloc
2120PyAPI_FUNC(void) _Py_Dealloc(PyObject *);
2121void
2122_Py_Dealloc(PyObject *op)
2123{
2124 _Py_INC_TPFREES(op) _Py_COUNT_ALLOCS_COMMA
2125 (*Py_TYPE(op)->tp_dealloc)(op);
2126}
2127#endif
2128
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002129#ifdef __cplusplus
2130}
2131#endif