GitHub Viewer - FazBrowse

# Python Documentation Turkish Translation # Copyright (C) 2001-2024, Python Software Foundation # This file is distributed under the same license as the Python package. # #, fuzzy msgid "" msgstr "" "Project-Id-Version: Python 3.12\n" "Report-Msgid-Bugs-To: \n" "POT-Creation-Date: 2024-11-01 00:21+0000\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: \n" "Language-Team: TURKISH \n" "Language: tr\n" "MIME-Version: 1.0\n" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" #: c-api/typeobj.rst:6 msgid "Type Objects" msgstr "" #: c-api/typeobj.rst:8 msgid "" "Perhaps one of the most important structures of the Python object system is " "the structure that defines a new type: the :c:type:`PyTypeObject` " "structure. Type objects can be handled using any of the ``PyObject_*`` or " "``PyType_*`` functions, but do not offer much that's interesting to most " "Python applications. These objects are fundamental to how objects behave, so " "they are very important to the interpreter itself and to any extension " "module that implements new types." msgstr "" #: c-api/typeobj.rst:16 msgid "" "Type objects are fairly large compared to most of the standard types. The " "reason for the size is that each type object stores a large number of " "values, mostly C function pointers, each of which implements a small part of " "the type's functionality. The fields of the type object are examined in " "detail in this section. The fields will be described in the order in which " "they occur in the structure." msgstr "" #: c-api/typeobj.rst:23 msgid "" "In addition to the following quick reference, the :ref:`typedef-examples` " "section provides at-a-glance insight into the meaning and use of :c:type:" "`PyTypeObject`." msgstr "" #: c-api/typeobj.rst:29 msgid "Quick Reference" msgstr "" #: c-api/typeobj.rst:34 msgid "\"tp slots\"" msgstr "" #: c-api/typeobj.rst:40 msgid "PyTypeObject Slot [#slots]_" msgstr "" #: c-api/typeobj.rst:201 msgid ":ref:`Type `" msgstr "" #: c-api/typeobj.rst:40 msgid "special methods/attrs" msgstr "" #: c-api/typeobj.rst:40 msgid "Info [#cols]_" msgstr "" #: c-api/typeobj.rst:42 msgid "O" msgstr "" #: c-api/typeobj.rst:42 msgid "T" msgstr "" #: c-api/typeobj.rst:42 msgid "D" msgstr "" #: c-api/typeobj.rst:42 msgid "I" msgstr "" #: c-api/typeobj.rst:44 msgid " :c:member:`~PyTypeObject.tp_name`" msgstr "" #: c-api/typeobj.rst:44 c-api/typeobj.rst:86 msgid "const char *" msgstr "" #: c-api/typeobj.rst:44 msgid "__name__" msgstr "" #: c-api/typeobj.rst:46 c-api/typeobj.rst:50 c-api/typeobj.rst:62 #: c-api/typeobj.rst:72 c-api/typeobj.rst:76 c-api/typeobj.rst:84 #: c-api/typeobj.rst:88 c-api/typeobj.rst:92 c-api/typeobj.rst:101 #: c-api/typeobj.rst:105 c-api/typeobj.rst:109 c-api/typeobj.rst:115 #: c-api/typeobj.rst:120 c-api/typeobj.rst:124 c-api/typeobj.rst:128 #: c-api/typeobj.rst:146 msgid "X" msgstr "" #: c-api/typeobj.rst:46 msgid ":c:member:`~PyTypeObject.tp_basicsize`" msgstr "" #: c-api/typeobj.rst:46 c-api/typeobj.rst:52 c-api/typeobj.rst:120 #: c-api/typeobj.rst:416 msgid ":c:type:`Py_ssize_t`" msgstr "" #: c-api/typeobj.rst:48 msgid ":c:member:`~PyTypeObject.tp_itemsize`" msgstr "" #: c-api/typeobj.rst:50 msgid ":c:member:`~PyTypeObject.tp_dealloc`" msgstr "" #: c-api/typeobj.rst:142 c-api/typeobj.rst:346 msgid ":c:type:`destructor`" msgstr "" #: c-api/typeobj.rst:52 msgid ":c:member:`~PyTypeObject.tp_vectorcall_offset`" msgstr "" #: c-api/typeobj.rst:54 msgid "(:c:member:`~PyTypeObject.tp_getattr`)" msgstr "" #: c-api/typeobj.rst:370 msgid ":c:type:`getattrfunc`" msgstr "" #: c-api/typeobj.rst:76 msgid "__getattribute__, __getattr__" msgstr "" #: c-api/typeobj.rst:57 c-api/typeobj.rst:76 c-api/typeobj.rst:88 #: c-api/typeobj.rst:92 msgid "G" msgstr "" #: c-api/typeobj.rst:57 msgid "(:c:member:`~PyTypeObject.tp_setattr`)" msgstr "" #: c-api/typeobj.rst:375 msgid ":c:type:`setattrfunc`" msgstr "" #: c-api/typeobj.rst:79 msgid "__setattr__, __delattr__" msgstr "" #: c-api/typeobj.rst:60 msgid ":c:member:`~PyTypeObject.tp_as_async`" msgstr "" #: c-api/typeobj.rst:60 msgid ":c:type:`PyAsyncMethods` *" msgstr "" #: c-api/typeobj.rst:64 c-api/typeobj.rst:68 msgid ":ref:`sub-slots`" msgstr "" #: c-api/typeobj.rst:64 c-api/typeobj.rst:68 c-api/typeobj.rst:82 msgid "%" msgstr "" #: c-api/typeobj.rst:62 msgid ":c:member:`~PyTypeObject.tp_repr`" msgstr "" #: c-api/typeobj.rst:74 c-api/typeobj.rst:368 msgid ":c:type:`reprfunc`" msgstr "" #: c-api/typeobj.rst:62 msgid "__repr__" msgstr "" #: c-api/typeobj.rst:64 msgid ":c:member:`~PyTypeObject.tp_as_number`" msgstr "" #: c-api/typeobj.rst:64 msgid ":c:type:`PyNumberMethods` *" msgstr "" #: c-api/typeobj.rst:66 msgid ":c:member:`~PyTypeObject.tp_as_sequence`" msgstr "" #: c-api/typeobj.rst:66 msgid ":c:type:`PySequenceMethods` *" msgstr "" #: c-api/typeobj.rst:68 msgid ":c:member:`~PyTypeObject.tp_as_mapping`" msgstr "" #: c-api/typeobj.rst:68 msgid ":c:type:`PyMappingMethods` *" msgstr "" #: c-api/typeobj.rst:70 msgid ":c:member:`~PyTypeObject.tp_hash`" msgstr "" #: c-api/typeobj.rst:404 msgid ":c:type:`hashfunc`" msgstr "" #: c-api/typeobj.rst:70 msgid "__hash__" msgstr "" #: c-api/typeobj.rst:72 msgid ":c:member:`~PyTypeObject.tp_call`" msgstr "" #: c-api/typeobj.rst:237 c-api/typeobj.rst:440 msgid ":c:type:`ternaryfunc`" msgstr "" #: c-api/typeobj.rst:72 msgid "__call__" msgstr "" #: c-api/typeobj.rst:74 msgid ":c:member:`~PyTypeObject.tp_str`" msgstr "" #: c-api/typeobj.rst:74 msgid "__str__" msgstr "" #: c-api/typeobj.rst:76 msgid ":c:member:`~PyTypeObject.tp_getattro`" msgstr "" #: c-api/typeobj.rst:381 msgid ":c:type:`getattrofunc`" msgstr "" #: c-api/typeobj.rst:79 msgid ":c:member:`~PyTypeObject.tp_setattro`" msgstr "" #: c-api/typeobj.rst:386 msgid ":c:type:`setattrofunc`" msgstr "" #: c-api/typeobj.rst:82 msgid ":c:member:`~PyTypeObject.tp_as_buffer`" msgstr "" #: c-api/typeobj.rst:82 msgid ":c:type:`PyBufferProcs` *" msgstr "" #: c-api/typeobj.rst:84 msgid ":c:member:`~PyTypeObject.tp_flags`" msgstr "" #: c-api/typeobj.rst:84 msgid "unsigned long" msgstr "" #: c-api/typeobj.rst:99 c-api/typeobj.rst:120 c-api/typeobj.rst:126 #: c-api/typeobj.rst:128 msgid "?" msgstr "" #: c-api/typeobj.rst:86 msgid ":c:member:`~PyTypeObject.tp_doc`" msgstr "" #: c-api/typeobj.rst:86 msgid "__doc__" msgstr "" #: c-api/typeobj.rst:88 msgid ":c:member:`~PyTypeObject.tp_traverse`" msgstr "" #: c-api/typeobj.rst:350 msgid ":c:type:`traverseproc`" msgstr "" #: c-api/typeobj.rst:90 msgid ":c:member:`~PyTypeObject.tp_clear`" msgstr "" #: c-api/typeobj.rst:130 c-api/typeobj.rst:429 msgid ":c:type:`inquiry`" msgstr "" #: c-api/typeobj.rst:92 msgid ":c:member:`~PyTypeObject.tp_richcompare`" msgstr "" #: c-api/typeobj.rst:406 msgid ":c:type:`richcmpfunc`" msgstr "" #: c-api/typeobj.rst:92 msgid "__lt__, __le__, __eq__, __ne__, __gt__, __ge__" msgstr "" #: c-api/typeobj.rst:99 msgid "(:c:member:`~PyTypeObject.tp_weaklistoffset`)" msgstr "" #: c-api/typeobj.rst:101 msgid ":c:member:`~PyTypeObject.tp_iter`" msgstr "" #: c-api/typeobj.rst:412 msgid ":c:type:`getiterfunc`" msgstr "" #: c-api/typeobj.rst:101 msgid "__iter__" msgstr "" #: c-api/typeobj.rst:103 msgid ":c:member:`~PyTypeObject.tp_iternext`" msgstr "" #: c-api/typeobj.rst:414 msgid ":c:type:`iternextfunc`" msgstr "" #: c-api/typeobj.rst:103 msgid "__next__" msgstr "" #: c-api/typeobj.rst:105 msgid ":c:member:`~PyTypeObject.tp_methods`" msgstr "" #: c-api/typeobj.rst:105 msgid ":c:type:`PyMethodDef` []" msgstr "" #: c-api/typeobj.rst:107 msgid ":c:member:`~PyTypeObject.tp_members`" msgstr "" #: c-api/typeobj.rst:107 msgid ":c:type:`PyMemberDef` []" msgstr "" #: c-api/typeobj.rst:109 msgid ":c:member:`~PyTypeObject.tp_getset`" msgstr "" #: c-api/typeobj.rst:109 msgid ":c:type:`PyGetSetDef` []" msgstr "" #: c-api/typeobj.rst:111 msgid ":c:member:`~PyTypeObject.tp_base`" msgstr "" #: c-api/typeobj.rst:111 msgid ":c:type:`PyTypeObject` *" msgstr "" #: c-api/typeobj.rst:111 msgid "__base__" msgstr "" #: c-api/typeobj.rst:113 msgid ":c:member:`~PyTypeObject.tp_dict`" msgstr "" #: c-api/typeobj.rst:113 c-api/typeobj.rst:134 c-api/typeobj.rst:140 #: c-api/typeobj.rst:346 c-api/typeobj.rst:368 c-api/typeobj.rst:381 #: c-api/typeobj.rst:404 c-api/typeobj.rst:412 c-api/typeobj.rst:416 #: c-api/typeobj.rst:431 c-api/typeobj.rst:440 c-api/typeobj.rst:446 msgid ":c:type:`PyObject` *" msgstr "" #: c-api/typeobj.rst:113 msgid "__dict__" msgstr "" #: c-api/typeobj.rst:115 msgid ":c:member:`~PyTypeObject.tp_descr_get`" msgstr "" #: c-api/typeobj.rst:392 msgid ":c:type:`descrgetfunc`" msgstr "" #: c-api/typeobj.rst:115 msgid "__get__" msgstr "" #: c-api/typeobj.rst:117 msgid ":c:member:`~PyTypeObject.tp_descr_set`" msgstr "" #: c-api/typeobj.rst:398 msgid ":c:type:`descrsetfunc`" msgstr "" #: c-api/typeobj.rst:117 msgid "__set__, __delete__" msgstr "" #: c-api/typeobj.rst:120 msgid "(:c:member:`~PyTypeObject.tp_dictoffset`)" msgstr "" #: c-api/typeobj.rst:122 msgid ":c:member:`~PyTypeObject.tp_init`" msgstr "" #: c-api/typeobj.rst:362 msgid ":c:type:`initproc`" msgstr "" #: c-api/typeobj.rst:122 msgid "__init__" msgstr "" #: c-api/typeobj.rst:124 msgid ":c:member:`~PyTypeObject.tp_alloc`" msgstr "" #: c-api/typeobj.rst:341 msgid ":c:type:`allocfunc`" msgstr "" #: c-api/typeobj.rst:126 msgid ":c:member:`~PyTypeObject.tp_new`" msgstr "" #: c-api/typeobj.rst:356 msgid ":c:type:`newfunc`" msgstr "" #: c-api/typeobj.rst:126 msgid "__new__" msgstr "" #: c-api/typeobj.rst:128 msgid ":c:member:`~PyTypeObject.tp_free`" msgstr "" #: c-api/typeobj.rst:348 msgid ":c:type:`freefunc`" msgstr "" #: c-api/typeobj.rst:130 msgid ":c:member:`~PyTypeObject.tp_is_gc`" msgstr "" #: c-api/typeobj.rst:132 msgid "" msgstr "" #: c-api/typeobj.rst:132 msgid "__bases__" msgstr "" #: c-api/typeobj.rst:134 msgid "~" msgstr "" #: c-api/typeobj.rst:134 msgid "" msgstr "" #: c-api/typeobj.rst:134 msgid "__mro__" msgstr "" #: c-api/typeobj.rst:136 msgid "[:c:member:`~PyTypeObject.tp_cache`]" msgstr "" #: c-api/typeobj.rst:138 msgid "[:c:member:`~PyTypeObject.tp_subclasses`]" msgstr "" #: c-api/typeobj.rst:138 c-api/typeobj.rst:348 msgid "void *" msgstr "" #: c-api/typeobj.rst:138 msgid "__subclasses__" msgstr "" #: c-api/typeobj.rst:140 msgid "[:c:member:`~PyTypeObject.tp_weaklist`]" msgstr "" #: c-api/typeobj.rst:142 msgid "(:c:member:`~PyTypeObject.tp_del`)" msgstr "" #: c-api/typeobj.rst:144 msgid "[:c:member:`~PyTypeObject.tp_version_tag`]" msgstr "" #: c-api/typeobj.rst:144 msgid "unsigned int" msgstr "" #: c-api/typeobj.rst:146 msgid ":c:member:`~PyTypeObject.tp_finalize`" msgstr "" #: c-api/typeobj.rst:146 msgid "__del__" msgstr "" #: c-api/typeobj.rst:148 msgid ":c:member:`~PyTypeObject.tp_vectorcall`" msgstr "" #: c-api/typeobj.rst:148 msgid ":c:type:`vectorcallfunc`" msgstr "" #: c-api/typeobj.rst:150 msgid "[:c:member:`~PyTypeObject.tp_watched`]" msgstr "" #: c-api/typeobj.rst:150 msgid "unsigned char" msgstr "" #: c-api/typeobj.rst:155 msgid "" "**()**: A slot name in parentheses indicates it is (effectively) deprecated." msgstr "" #: c-api/typeobj.rst:157 msgid "" "****: Names in angle brackets should be initially set to ``NULL`` and " "treated as read-only." msgstr "" #: c-api/typeobj.rst:160 msgid "**[]**: Names in square brackets are for internal use only." msgstr "" #: c-api/typeobj.rst:162 msgid "" "**** (as a prefix) means the field is required (must be non-``NULL``)." msgstr "" #: c-api/typeobj.rst:164 msgid "Columns:" msgstr "" #: c-api/typeobj.rst:166 msgid "**\"O\"**: set on :c:data:`PyBaseObject_Type`" msgstr "" #: c-api/typeobj.rst:168 msgid "**\"T\"**: set on :c:data:`PyType_Type`" msgstr "" #: c-api/typeobj.rst:170 msgid "**\"D\"**: default (if slot is set to ``NULL``)" msgstr "" #: c-api/typeobj.rst:172 msgid "" "X - PyType_Ready sets this value if it is NULL\n" "~ - PyType_Ready always sets this value (it should be NULL)\n" "? - PyType_Ready may set this value depending on other slots\n" "\n" "Also see the inheritance column (\"I\")." msgstr "" #: c-api/typeobj.rst:180 msgid "**\"I\"**: inheritance" msgstr "" #: c-api/typeobj.rst:182 msgid "" "X - type slot is inherited via *PyType_Ready* if defined with a *NULL* " "value\n" "% - the slots of the sub-struct are inherited individually\n" "G - inherited, but only in combination with other slots; see the slot's " "description\n" "? - it's complicated; see the slot's description" msgstr "" #: c-api/typeobj.rst:189 msgid "" "Note that some slots are effectively inherited through the normal attribute " "lookup chain." msgstr "" #: c-api/typeobj.rst:195 msgid "sub-slots" msgstr "" #: c-api/typeobj.rst:201 msgid "Slot" msgstr "" #: c-api/typeobj.rst:201 msgid "special methods" msgstr "" #: c-api/typeobj.rst:204 msgid ":c:member:`~PyAsyncMethods.am_await`" msgstr "" #: c-api/typeobj.rst:206 c-api/typeobj.rst:242 c-api/typeobj.rst:246 #: c-api/typeobj.rst:277 c-api/typeobj.rst:291 c-api/typeobj.rst:431 msgid ":c:type:`unaryfunc`" msgstr "" #: c-api/typeobj.rst:204 msgid "__await__" msgstr "" #: c-api/typeobj.rst:206 msgid ":c:member:`~PyAsyncMethods.am_aiter`" msgstr "" #: c-api/typeobj.rst:206 msgid "__aiter__" msgstr "" #: c-api/typeobj.rst:208 msgid ":c:member:`~PyAsyncMethods.am_anext`" msgstr "" #: c-api/typeobj.rst:208 msgid "__anext__" msgstr "" #: c-api/typeobj.rst:210 msgid ":c:member:`~PyAsyncMethods.am_send`" msgstr "" #: c-api/typeobj.rst:210 msgid ":c:type:`sendfunc`" msgstr "" #: c-api/typeobj.rst:214 msgid ":c:member:`~PyNumberMethods.nb_add`" msgstr "" #: c-api/typeobj.rst:217 c-api/typeobj.rst:222 c-api/typeobj.rst:227 #: c-api/typeobj.rst:232 c-api/typeobj.rst:252 c-api/typeobj.rst:257 #: c-api/typeobj.rst:262 c-api/typeobj.rst:267 c-api/typeobj.rst:272 #: c-api/typeobj.rst:283 c-api/typeobj.rst:287 c-api/typeobj.rst:293 #: c-api/typeobj.rst:302 c-api/typeobj.rst:322 c-api/typeobj.rst:435 msgid ":c:type:`binaryfunc`" msgstr "" #: c-api/typeobj.rst:214 msgid "__add__ __radd__" msgstr "" #: c-api/typeobj.rst:217 msgid ":c:member:`~PyNumberMethods.nb_inplace_add`" msgstr "" #: c-api/typeobj.rst:322 msgid "__iadd__" msgstr "" #: c-api/typeobj.rst:219 msgid ":c:member:`~PyNumberMethods.nb_subtract`" msgstr "" #: c-api/typeobj.rst:219 msgid "__sub__ __rsub__" msgstr "" #: c-api/typeobj.rst:222 msgid ":c:member:`~PyNumberMethods.nb_inplace_subtract`" msgstr "" #: c-api/typeobj.rst:222 msgid "__isub__" msgstr "" #: c-api/typeobj.rst:224 msgid ":c:member:`~PyNumberMethods.nb_multiply`" msgstr "" #: c-api/typeobj.rst:224 msgid "__mul__ __rmul__" msgstr "" #: c-api/typeobj.rst:227 msgid ":c:member:`~PyNumberMethods.nb_inplace_multiply`" msgstr "" #: c-api/typeobj.rst:324 msgid "__imul__" msgstr "" #: c-api/typeobj.rst:229 msgid ":c:member:`~PyNumberMethods.nb_remainder`" msgstr "" #: c-api/typeobj.rst:229 msgid "__mod__ __rmod__" msgstr "" #: c-api/typeobj.rst:232 msgid ":c:member:`~PyNumberMethods.nb_inplace_remainder`" msgstr "" #: c-api/typeobj.rst:232 msgid "__imod__" msgstr "" #: c-api/typeobj.rst:234 msgid ":c:member:`~PyNumberMethods.nb_divmod`" msgstr "" #: c-api/typeobj.rst:234 msgid "__divmod__ __rdivmod__" msgstr "" #: c-api/typeobj.rst:237 msgid ":c:member:`~PyNumberMethods.nb_power`" msgstr "" #: c-api/typeobj.rst:237 msgid "__pow__ __rpow__" msgstr "" #: c-api/typeobj.rst:240 msgid ":c:member:`~PyNumberMethods.nb_inplace_power`" msgstr "" #: c-api/typeobj.rst:240 msgid "__ipow__" msgstr "" #: c-api/typeobj.rst:242 msgid ":c:member:`~PyNumberMethods.nb_negative`" msgstr "" #: c-api/typeobj.rst:242 msgid "__neg__" msgstr "" #: c-api/typeobj.rst:244 msgid ":c:member:`~PyNumberMethods.nb_positive`" msgstr "" #: c-api/typeobj.rst:244 msgid "__pos__" msgstr "" #: c-api/typeobj.rst:246 msgid ":c:member:`~PyNumberMethods.nb_absolute`" msgstr "" #: c-api/typeobj.rst:246 msgid "__abs__" msgstr "" #: c-api/typeobj.rst:248 msgid ":c:member:`~PyNumberMethods.nb_bool`" msgstr "" #: c-api/typeobj.rst:248 msgid "__bool__" msgstr "" #: c-api/typeobj.rst:250 msgid ":c:member:`~PyNumberMethods.nb_invert`" msgstr "" #: c-api/typeobj.rst:250 msgid "__invert__" msgstr "" #: c-api/typeobj.rst:252 msgid ":c:member:`~PyNumberMethods.nb_lshift`" msgstr "" #: c-api/typeobj.rst:252 msgid "__lshift__ __rlshift__" msgstr "" #: c-api/typeobj.rst:255 msgid ":c:member:`~PyNumberMethods.nb_inplace_lshift`" msgstr "" #: c-api/typeobj.rst:255 msgid "__ilshift__" msgstr "" #: c-api/typeobj.rst:257 msgid ":c:member:`~PyNumberMethods.nb_rshift`" msgstr "" #: c-api/typeobj.rst:257 msgid "__rshift__ __rrshift__" msgstr "" #: c-api/typeobj.rst:260 msgid ":c:member:`~PyNumberMethods.nb_inplace_rshift`" msgstr "" #: c-api/typeobj.rst:260 msgid "__irshift__" msgstr "" #: c-api/typeobj.rst:262 msgid ":c:member:`~PyNumberMethods.nb_and`" msgstr "" #: c-api/typeobj.rst:262 msgid "__and__ __rand__" msgstr "" #: c-api/typeobj.rst:265 msgid ":c:member:`~PyNumberMethods.nb_inplace_and`" msgstr "" #: c-api/typeobj.rst:265 msgid "__iand__" msgstr "" #: c-api/typeobj.rst:267 msgid ":c:member:`~PyNumberMethods.nb_xor`" msgstr "" #: c-api/typeobj.rst:267 msgid "__xor__ __rxor__" msgstr "" #: c-api/typeobj.rst:270 msgid ":c:member:`~PyNumberMethods.nb_inplace_xor`" msgstr "" #: c-api/typeobj.rst:270 msgid "__ixor__" msgstr "" #: c-api/typeobj.rst:272 msgid ":c:member:`~PyNumberMethods.nb_or`" msgstr "" #: c-api/typeobj.rst:272 msgid "__or__ __ror__" msgstr "" #: c-api/typeobj.rst:275 msgid ":c:member:`~PyNumberMethods.nb_inplace_or`" msgstr "" #: c-api/typeobj.rst:275 msgid "__ior__" msgstr "" #: c-api/typeobj.rst:277 msgid ":c:member:`~PyNumberMethods.nb_int`" msgstr "" #: c-api/typeobj.rst:277 msgid "__int__" msgstr "" #: c-api/typeobj.rst:279 msgid ":c:member:`~PyNumberMethods.nb_reserved`" msgstr "" #: c-api/typeobj.rst:281 msgid ":c:member:`~PyNumberMethods.nb_float`" msgstr "" #: c-api/typeobj.rst:281 msgid "__float__" msgstr "" #: c-api/typeobj.rst:283 msgid ":c:member:`~PyNumberMethods.nb_floor_divide`" msgstr "" #: c-api/typeobj.rst:283 msgid "__floordiv__" msgstr "" #: c-api/typeobj.rst:285 msgid ":c:member:`~PyNumberMethods.nb_inplace_floor_divide`" msgstr "" #: c-api/typeobj.rst:285 msgid "__ifloordiv__" msgstr "" #: c-api/typeobj.rst:287 msgid ":c:member:`~PyNumberMethods.nb_true_divide`" msgstr "" #: c-api/typeobj.rst:287 msgid "__truediv__" msgstr "" #: c-api/typeobj.rst:289 msgid ":c:member:`~PyNumberMethods.nb_inplace_true_divide`" msgstr "" #: c-api/typeobj.rst:289 msgid "__itruediv__" msgstr "" #: c-api/typeobj.rst:291 msgid ":c:member:`~PyNumberMethods.nb_index`" msgstr "" #: c-api/typeobj.rst:291 msgid "__index__" msgstr "" #: c-api/typeobj.rst:293 msgid ":c:member:`~PyNumberMethods.nb_matrix_multiply`" msgstr "" #: c-api/typeobj.rst:293 msgid "__matmul__ __rmatmul__" msgstr "" #: c-api/typeobj.rst:296 msgid ":c:member:`~PyNumberMethods.nb_inplace_matrix_multiply`" msgstr "" #: c-api/typeobj.rst:296 msgid "__imatmul__" msgstr "" #: c-api/typeobj.rst:300 msgid ":c:member:`~PyMappingMethods.mp_length`" msgstr "" #: c-api/typeobj.rst:309 c-api/typeobj.rst:416 msgid ":c:type:`lenfunc`" msgstr "" #: c-api/typeobj.rst:309 msgid "__len__" msgstr "" #: c-api/typeobj.rst:302 msgid ":c:member:`~PyMappingMethods.mp_subscript`" msgstr "" #: c-api/typeobj.rst:315 msgid "__getitem__" msgstr "" #: c-api/typeobj.rst:304 msgid ":c:member:`~PyMappingMethods.mp_ass_subscript`" msgstr "" #: c-api/typeobj.rst:462 msgid ":c:type:`objobjargproc`" msgstr "" #: c-api/typeobj.rst:304 msgid "__setitem__, __delitem__" msgstr "" #: c-api/typeobj.rst:309 msgid ":c:member:`~PySequenceMethods.sq_length`" msgstr "" #: c-api/typeobj.rst:311 msgid ":c:member:`~PySequenceMethods.sq_concat`" msgstr "" #: c-api/typeobj.rst:311 msgid "__add__" msgstr "" #: c-api/typeobj.rst:313 msgid ":c:member:`~PySequenceMethods.sq_repeat`" msgstr "" #: c-api/typeobj.rst:315 c-api/typeobj.rst:446 msgid ":c:type:`ssizeargfunc`" msgstr "" #: c-api/typeobj.rst:313 msgid "__mul__" msgstr "" #: c-api/typeobj.rst:315 msgid ":c:member:`~PySequenceMethods.sq_item`" msgstr "" #: c-api/typeobj.rst:317 msgid ":c:member:`~PySequenceMethods.sq_ass_item`" msgstr "" #: c-api/typeobj.rst:451 msgid ":c:type:`ssizeobjargproc`" msgstr "" #: c-api/typeobj.rst:317 msgid "__setitem__ __delitem__" msgstr "" #: c-api/typeobj.rst:320 msgid ":c:member:`~PySequenceMethods.sq_contains`" msgstr "" #: c-api/typeobj.rst:457 msgid ":c:type:`objobjproc`" msgstr "" #: c-api/typeobj.rst:320 msgid "__contains__" msgstr "" #: c-api/typeobj.rst:322 msgid ":c:member:`~PySequenceMethods.sq_inplace_concat`" msgstr "" #: c-api/typeobj.rst:324 msgid ":c:member:`~PySequenceMethods.sq_inplace_repeat`" msgstr "" #: c-api/typeobj.rst:328 msgid ":c:member:`~PyBufferProcs.bf_getbuffer`" msgstr "" #: c-api/typeobj.rst:328 msgid ":c:func:`getbufferproc`" msgstr "" #: c-api/typeobj.rst:330 msgid ":c:member:`~PyBufferProcs.bf_releasebuffer`" msgstr "" #: c-api/typeobj.rst:330 msgid ":c:func:`releasebufferproc`" msgstr "" #: c-api/typeobj.rst:336 msgid "slot typedefs" msgstr "" #: c-api/typeobj.rst:339 msgid "typedef" msgstr "" #: c-api/typeobj.rst:339 msgid "Parameter Types" msgstr "" #: c-api/typeobj.rst:339 msgid "Return Type" msgstr "" #: c-api/typeobj.rst:348 c-api/typeobj.rst:424 msgid "void" msgstr "" #: c-api/typeobj.rst:0 msgid ":c:type:`visitproc`" msgstr "" #: c-api/typeobj.rst:350 c-api/typeobj.rst:375 c-api/typeobj.rst:398 #: c-api/typeobj.rst:429 c-api/typeobj.rst:457 c-api/typeobj.rst:462 msgid "int" msgstr "" #: c-api/typeobj.rst:404 msgid "Py_hash_t" msgstr "" #: c-api/typeobj.rst:418 msgid ":c:type:`getbufferproc`" msgstr "" #: c-api/typeobj.rst:0 msgid ":c:type:`Py_buffer` *" msgstr "" #: c-api/typeobj.rst:424 msgid ":c:type:`releasebufferproc`" msgstr "" #: c-api/typeobj.rst:469 msgid "See :ref:`slot-typedefs` below for more detail." msgstr "" #: c-api/typeobj.rst:473 msgid "PyTypeObject Definition" msgstr "" #: c-api/typeobj.rst:475 msgid "" "The structure definition for :c:type:`PyTypeObject` can be found in :file:" "`Include/object.h`. For convenience of reference, this repeats the " "definition found there:" msgstr "" #: c-api/typeobj.rst:481 msgid "" "typedef struct _typeobject {\n" " PyObject_VAR_HEAD\n" " const char *tp_name; /* For printing, in format \".\" */\n" " Py_ssize_t tp_basicsize, tp_itemsize; /* For allocation */\n" "\n" " /* Methods to implement standard operations */\n" "\n" " destructor tp_dealloc;\n" " Py_ssize_t tp_vectorcall_offset;\n" " getattrfunc tp_getattr;\n" " setattrfunc tp_setattr;\n" " PyAsyncMethods *tp_as_async; /* formerly known as tp_compare (Python 2)\n" " or tp_reserved (Python 3) */\n" " reprfunc tp_repr;\n" "\n" " /* Method suites for standard classes */\n" "\n" " PyNumberMethods *tp_as_number;\n" " PySequenceMethods *tp_as_sequence;\n" " PyMappingMethods *tp_as_mapping;\n" "\n" " /* More standard operations (here for binary compatibility) */\n" "\n" " hashfunc tp_hash;\n" " ternaryfunc tp_call;\n" " reprfunc tp_str;\n" " getattrofunc tp_getattro;\n" " setattrofunc tp_setattro;\n" "\n" " /* Functions to access object as input/output buffer */\n" " PyBufferProcs *tp_as_buffer;\n" "\n" " /* Flags to define presence of optional/expanded features */\n" " unsigned long tp_flags;\n" "\n" " const char *tp_doc; /* Documentation string */\n" "\n" " /* Assigned meaning in release 2.0 */\n" " /* call function for all accessible objects */\n" " traverseproc tp_traverse;\n" "\n" " /* delete references to contained objects */\n" " inquiry tp_clear;\n" "\n" " /* Assigned meaning in release 2.1 */\n" " /* rich comparisons */\n" " richcmpfunc tp_richcompare;\n" "\n" " /* weak reference enabler */\n" " Py_ssize_t tp_weaklistoffset;\n" "\n" " /* Iterators */\n" " getiterfunc tp_iter;\n" " iternextfunc tp_iternext;\n" "\n" " /* Attribute descriptor and subclassing stuff */\n" " struct PyMethodDef *tp_methods;\n" " struct PyMemberDef *tp_members;\n" " struct PyGetSetDef *tp_getset;\n" " // Strong reference on a heap type, borrowed reference on a static type\n" " struct _typeobject *tp_base;\n" " PyObject *tp_dict;\n" " descrgetfunc tp_descr_get;\n" " descrsetfunc tp_descr_set;\n" " Py_ssize_t tp_dictoffset;\n" " initproc tp_init;\n" " allocfunc tp_alloc;\n" " newfunc tp_new;\n" " freefunc tp_free; /* Low-level free-memory routine */\n" " inquiry tp_is_gc; /* For PyObject_IS_GC */\n" " PyObject *tp_bases;\n" " PyObject *tp_mro; /* method resolution order */\n" " PyObject *tp_cache;\n" " PyObject *tp_subclasses;\n" " PyObject *tp_weaklist;\n" " destructor tp_del;\n" "\n" " /* Type attribute cache version tag. Added in version 2.6 */\n" " unsigned int tp_version_tag;\n" "\n" " destructor tp_finalize;\n" " vectorcallfunc tp_vectorcall;\n" "\n" " /* bitset of which type-watchers care about this type */\n" " unsigned char tp_watched;\n" "} PyTypeObject;\n" msgstr "" #: c-api/typeobj.rst:485 msgid "PyObject Slots" msgstr "" #: c-api/typeobj.rst:487 msgid "" "The type object structure extends the :c:type:`PyVarObject` structure. The :" "c:member:`~PyVarObject.ob_size` field is used for dynamic types (created by :" "c:func:`!type_new`, usually called from a class statement). Note that :c:" "data:`PyType_Type` (the metatype) initializes :c:member:`~PyTypeObject." "tp_itemsize`, which means that its instances (i.e. type objects) *must* have " "the :c:member:`~PyVarObject.ob_size` field." msgstr "" #: c-api/typeobj.rst:496 msgid "" "This is the type object's reference count, initialized to ``1`` by the " "``PyObject_HEAD_INIT`` macro. Note that for :ref:`statically allocated type " "objects `, the type's instances (objects whose :c:member:" "`~PyObject.ob_type` points back to the type) do *not* count as references. " "But for :ref:`dynamically allocated type objects `, the " "instances *do* count as references." msgstr "" #: c-api/typeobj.rst:526 c-api/typeobj.rst:562 c-api/typeobj.rst:649 #: c-api/typeobj.rst:762 c-api/typeobj.rst:796 c-api/typeobj.rst:838 #: c-api/typeobj.rst:867 c-api/typeobj.rst:912 c-api/typeobj.rst:950 #: c-api/typeobj.rst:997 c-api/typeobj.rst:1032 c-api/typeobj.rst:1082 #: c-api/typeobj.rst:1102 c-api/typeobj.rst:1134 c-api/typeobj.rst:1172 #: c-api/typeobj.rst:1207 c-api/typeobj.rst:1272 c-api/typeobj.rst:1321 #: c-api/typeobj.rst:1369 c-api/typeobj.rst:1505 c-api/typeobj.rst:1602 #: c-api/typeobj.rst:1650 c-api/typeobj.rst:1678 c-api/typeobj.rst:1722 #: c-api/typeobj.rst:1780 c-api/typeobj.rst:1827 c-api/typeobj.rst:1888 #: c-api/typeobj.rst:1951 c-api/typeobj.rst:2011 c-api/typeobj.rst:2034 #: c-api/typeobj.rst:2068 c-api/typeobj.rst:2117 c-api/typeobj.rst:2140 msgid "**Inheritance:**" msgstr "" #: c-api/typeobj.rst:564 c-api/typeobj.rst:608 msgid "This field is not inherited by subtypes." msgstr "" #: c-api/typeobj.rst:510 msgid "" "This is the type's type, in other words its metatype. It is initialized by " "the argument to the ``PyObject_HEAD_INIT`` macro, and its value should " "normally be ``&PyType_Type``. However, for dynamically loadable extension " "modules that must be usable on Windows (at least), the compiler complains " "that this is not a valid initializer. Therefore, the convention is to pass " "``NULL`` to the ``PyObject_HEAD_INIT`` macro and to initialize this field " "explicitly at the start of the module's initialization function, before " "doing anything else. This is typically done like this::" msgstr "" #: c-api/typeobj.rst:519 msgid "Foo_Type.ob_type = &PyType_Type;" msgstr "" #: c-api/typeobj.rst:521 msgid "" "This should be done before any instances of the type are created. :c:func:" "`PyType_Ready` checks if :c:member:`~PyObject.ob_type` is ``NULL``, and if " "so, initializes it to the :c:member:`~PyObject.ob_type` field of the base " "class. :c:func:`PyType_Ready` will not change this field if it is non-zero." msgstr "" #: c-api/typeobj.rst:723 c-api/typeobj.rst:932 c-api/typeobj.rst:1629 #: c-api/typeobj.rst:1782 c-api/typeobj.rst:1873 c-api/typeobj.rst:2119 msgid "This field is inherited by subtypes." msgstr "" #: c-api/typeobj.rst:534 msgid "" "These fields are only present when the macro ``Py_TRACE_REFS`` is defined " "(see the :option:`configure --with-trace-refs option `)." msgstr "" #: c-api/typeobj.rst:537 msgid "" "Their initialization to ``NULL`` is taken care of by the " "``PyObject_HEAD_INIT`` macro. For :ref:`statically allocated objects " "`, these fields always remain ``NULL``. For :ref:`dynamically " "allocated objects `, these two fields are used to link the " "object into a doubly linked list of *all* live objects on the heap." msgstr "" #: c-api/typeobj.rst:543 msgid "" "This could be used for various debugging purposes; currently the only uses " "are the :func:`sys.getobjects` function and to print the objects that are " "still alive at the end of a run when the environment variable :envvar:" "`PYTHONDUMPREFS` is set." msgstr "" #: c-api/typeobj.rst:550 msgid "These fields are not inherited by subtypes." msgstr "" #: c-api/typeobj.rst:554 msgid "PyVarObject Slots" msgstr "" #: c-api/typeobj.rst:558 msgid "" "For :ref:`statically allocated type objects `, this should be " "initialized to zero. For :ref:`dynamically allocated type objects `, this field has a special internal meaning." msgstr "" #: c-api/typeobj.rst:568 msgid "PyTypeObject Slots" msgstr "" #: c-api/typeobj.rst:570 msgid "" "Each slot has a section describing inheritance. If :c:func:`PyType_Ready` " "may set a value when the field is set to ``NULL`` then there will also be a " "\"Default\" section. (Note that many fields set on :c:data:" "`PyBaseObject_Type` and :c:data:`PyType_Type` effectively act as defaults.)" msgstr "" #: c-api/typeobj.rst:577 msgid "" "Pointer to a NUL-terminated string containing the name of the type. For " "types that are accessible as module globals, the string should be the full " "module name, followed by a dot, followed by the type name; for built-in " "types, it should be just the type name. If the module is a submodule of a " "package, the full package name is part of the full module name. For " "example, a type named :class:`!T` defined in module :mod:`!M` in subpackage :" "mod:`!Q` in package :mod:`!P` should have the :c:member:`~PyTypeObject." "tp_name` initializer ``\"P.Q.M.T\"``." msgstr "" #: c-api/typeobj.rst:585 msgid "" "For :ref:`dynamically allocated type objects `, this should just " "be the type name, and the module name explicitly stored in the type dict as " "the value for key ``'__module__'``." msgstr "" #: c-api/typeobj.rst:590 msgid "" "For :ref:`statically allocated type objects `, the *tp_name* " "field should contain a dot. Everything before the last dot is made " "accessible as the :attr:`~type.__module__` attribute, and everything after " "the last dot is made accessible as the :attr:`~type.__name__` attribute." msgstr "" #: c-api/typeobj.rst:596 msgid "" "If no dot is present, the entire :c:member:`~PyTypeObject.tp_name` field is " "made accessible as the :attr:`~type.__name__` attribute, and the :attr:" "`~type.__module__` attribute is undefined (unless explicitly set in the " "dictionary, as explained above). This means your type will be impossible to " "pickle. Additionally, it will not be listed in module documentations " "created with pydoc." msgstr "" #: c-api/typeobj.rst:602 msgid "" "This field must not be ``NULL``. It is the only required field in :c:func:" "`PyTypeObject` (other than potentially :c:member:`~PyTypeObject." "tp_itemsize`)." msgstr "" #: c-api/typeobj.rst:614 msgid "" "These fields allow calculating the size in bytes of instances of the type." msgstr "" #: c-api/typeobj.rst:616 msgid "" "There are two kinds of types: types with fixed-length instances have a zero :" "c:member:`~PyTypeObject.tp_itemsize` field, types with variable-length " "instances have a non-zero :c:member:`~PyTypeObject.tp_itemsize` field. For " "a type with fixed-length instances, all instances have the same size, given " "in :c:member:`~PyTypeObject.tp_basicsize`." msgstr "" #: c-api/typeobj.rst:621 msgid "" "For a type with variable-length instances, the instances must have an :c:" "member:`~PyVarObject.ob_size` field, and the instance size is :c:member:" "`~PyTypeObject.tp_basicsize` plus N times :c:member:`~PyTypeObject." "tp_itemsize`, where N is the \"length\" of the object. The value of N is " "typically stored in the instance's :c:member:`~PyVarObject.ob_size` field. " "There are exceptions: for example, ints use a negative :c:member:" "`~PyVarObject.ob_size` to indicate a negative number, and N is " "``abs(ob_size)`` there. Also, the presence of an :c:member:`~PyVarObject." "ob_size` field in the instance layout doesn't mean that the instance " "structure is variable-length (for example, the structure for the list type " "has fixed-length instances, yet those instances have a meaningful :c:member:" "`~PyVarObject.ob_size` field)." msgstr "" #: c-api/typeobj.rst:632 msgid "" "The basic size includes the fields in the instance declared by the macro :c:" "macro:`PyObject_HEAD` or :c:macro:`PyObject_VAR_HEAD` (whichever is used to " "declare the instance struct) and this in turn includes the :c:member:" "`~PyObject._ob_prev` and :c:member:`~PyObject._ob_next` fields if they are " "present. This means that the only correct way to get an initializer for " "the :c:member:`~PyTypeObject.tp_basicsize` is to use the ``sizeof`` operator " "on the struct used to declare the instance layout. The basic size does not " "include the GC header size." msgstr "" #: c-api/typeobj.rst:640 msgid "" "A note about alignment: if the variable items require a particular " "alignment, this should be taken care of by the value of :c:member:" "`~PyTypeObject.tp_basicsize`. Example: suppose a type implements an array " "of ``double``. :c:member:`~PyTypeObject.tp_itemsize` is ``sizeof(double)``. " "It is the programmer's responsibility that :c:member:`~PyTypeObject." "tp_basicsize` is a multiple of ``sizeof(double)`` (assuming this is the " "alignment requirement for ``double``)." msgstr "" #: c-api/typeobj.rst:647 msgid "" "For any type with variable-length instances, this field must not be ``NULL``." msgstr "" #: c-api/typeobj.rst:651 msgid "" "These fields are inherited separately by subtypes. If the base type has a " "non-zero :c:member:`~PyTypeObject.tp_itemsize`, it is generally not safe to " "set :c:member:`~PyTypeObject.tp_itemsize` to a different non-zero value in a " "subtype (though this depends on the implementation of the base type)." msgstr "" #: c-api/typeobj.rst:659 msgid "" "A pointer to the instance destructor function. This function must be " "defined unless the type guarantees that its instances will never be " "deallocated (as is the case for the singletons ``None`` and ``Ellipsis``). " "The function signature is::" msgstr "" #: c-api/typeobj.rst:663 msgid "void tp_dealloc(PyObject *self);" msgstr "" #: c-api/typeobj.rst:665 msgid "" "The destructor function is called by the :c:func:`Py_DECREF` and :c:func:" "`Py_XDECREF` macros when the new reference count is zero. At this point, " "the instance is still in existence, but there are no references to it. The " "destructor function should free all references which the instance owns, free " "all memory buffers owned by the instance (using the freeing function " "corresponding to the allocation function used to allocate the buffer), and " "call the type's :c:member:`~PyTypeObject.tp_free` function. If the type is " "not subtypable (doesn't have the :c:macro:`Py_TPFLAGS_BASETYPE` flag bit " "set), it is permissible to call the object deallocator directly instead of " "via :c:member:`~PyTypeObject.tp_free`. The object deallocator should be the " "one used to allocate the instance; this is normally :c:func:`PyObject_Del` " "if the instance was allocated using :c:macro:`PyObject_New` or :c:macro:" "`PyObject_NewVar`, or :c:func:`PyObject_GC_Del` if the instance was " "allocated using :c:macro:`PyObject_GC_New` or :c:macro:`PyObject_GC_NewVar`." msgstr "" #: c-api/typeobj.rst:680 msgid "" "If the type supports garbage collection (has the :c:macro:" "`Py_TPFLAGS_HAVE_GC` flag bit set), the destructor should call :c:func:" "`PyObject_GC_UnTrack` before clearing any member fields." msgstr "" #: c-api/typeobj.rst:684 msgid "" "static void foo_dealloc(foo_object *self) {\n" " PyObject_GC_UnTrack(self);\n" " Py_CLEAR(self->ref);\n" " Py_TYPE(self)->tp_free((PyObject *)self);\n" "}" msgstr "" #: c-api/typeobj.rst:692 msgid "" "Finally, if the type is heap allocated (:c:macro:`Py_TPFLAGS_HEAPTYPE`), the " "deallocator should release the owned reference to its type object (via :c:" "func:`Py_DECREF`) after calling the type deallocator. In order to avoid " "dangling pointers, the recommended way to achieve this is:" msgstr "" #: c-api/typeobj.rst:698 msgid "" "static void foo_dealloc(foo_object *self) {\n" " PyTypeObject *tp = Py_TYPE(self);\n" " // free references and buffers here\n" " tp->tp_free(self);\n" " Py_DECREF(tp);\n" "}" msgstr "" #: c-api/typeobj.rst:709 msgid "" "In a garbage collected Python, :c:member:`!tp_dealloc` may be called from " "any Python thread, not just the thread which created the object (if the " "object becomes part of a refcount cycle, that cycle might be collected by a " "garbage collection on any thread). This is not a problem for Python API " "calls, since the thread on which :c:member:`!tp_dealloc` is called will own " "the Global Interpreter Lock (GIL). However, if the object being destroyed " "in turn destroys objects from some other C or C++ library, care should be " "taken to ensure that destroying those objects on the thread which called :c:" "member:`!tp_dealloc` will not violate any assumptions of the library." msgstr "" #: c-api/typeobj.rst:728 msgid "" "An optional offset to a per-instance function that implements calling the " "object using the :ref:`vectorcall protocol `, a more efficient " "alternative of the simpler :c:member:`~PyTypeObject.tp_call`." msgstr "" #: c-api/typeobj.rst:733 msgid "" "This field is only used if the flag :c:macro:`Py_TPFLAGS_HAVE_VECTORCALL` is " "set. If so, this must be a positive integer containing the offset in the " "instance of a :c:type:`vectorcallfunc` pointer." msgstr "" #: c-api/typeobj.rst:737 msgid "" "The *vectorcallfunc* pointer may be ``NULL``, in which case the instance " "behaves as if :c:macro:`Py_TPFLAGS_HAVE_VECTORCALL` was not set: calling the " "instance falls back to :c:member:`~PyTypeObject.tp_call`." msgstr "" #: c-api/typeobj.rst:741 msgid "" "Any class that sets ``Py_TPFLAGS_HAVE_VECTORCALL`` must also set :c:member:" "`~PyTypeObject.tp_call` and make sure its behaviour is consistent with the " "*vectorcallfunc* function. This can be done by setting *tp_call* to :c:func:" "`PyVectorcall_Call`." msgstr "" #: c-api/typeobj.rst:748 msgid "" "Before version 3.8, this slot was named ``tp_print``. In Python 2.x, it was " "used for printing to a file. In Python 3.0 to 3.7, it was unused." msgstr "" #: c-api/typeobj.rst:754 msgid "" "Before version 3.12, it was not recommended for :ref:`mutable heap types " "` to implement the vectorcall protocol. When a user sets :attr:" "`~object.__call__` in Python code, only *tp_call* is updated, likely making " "it inconsistent with the vectorcall function. Since 3.12, setting " "``__call__`` will disable vectorcall optimization by clearing the :c:macro:" "`Py_TPFLAGS_HAVE_VECTORCALL` flag." msgstr "" #: c-api/typeobj.rst:764 msgid "" "This field is always inherited. However, the :c:macro:" "`Py_TPFLAGS_HAVE_VECTORCALL` flag is not always inherited. If it's not set, " "then the subclass won't use :ref:`vectorcall `, except when :c:" "func:`PyVectorcall_Call` is explicitly called." msgstr "" #: c-api/typeobj.rst:773 msgid "An optional pointer to the get-attribute-string function." msgstr "" #: c-api/typeobj.rst:775 msgid "" "This field is deprecated. When it is defined, it should point to a function " "that acts the same as the :c:member:`~PyTypeObject.tp_getattro` function, " "but taking a C string instead of a Python string object to give the " "attribute name." msgstr "" #: c-api/typeobj.rst:973 msgid "" "Group: :c:member:`~PyTypeObject.tp_getattr`, :c:member:`~PyTypeObject." "tp_getattro`" msgstr "" #: c-api/typeobj.rst:783 msgid "" "This field is inherited by subtypes together with :c:member:`~PyTypeObject." "tp_getattro`: a subtype inherits both :c:member:`~PyTypeObject.tp_getattr` " "and :c:member:`~PyTypeObject.tp_getattro` from its base type when the " "subtype's :c:member:`~PyTypeObject.tp_getattr` and :c:member:`~PyTypeObject." "tp_getattro` are both ``NULL``." msgstr "" #: c-api/typeobj.rst:986 msgid "" "An optional pointer to the function for setting and deleting attributes." msgstr "" #: c-api/typeobj.rst:792 msgid "" "This field is deprecated. When it is defined, it should point to a function " "that acts the same as the :c:member:`~PyTypeObject.tp_setattro` function, " "but taking a C string instead of a Python string object to give the " "attribute name." msgstr "" #: c-api/typeobj.rst:999 msgid "" "Group: :c:member:`~PyTypeObject.tp_setattr`, :c:member:`~PyTypeObject." "tp_setattro`" msgstr "" #: c-api/typeobj.rst:800 msgid "" "This field is inherited by subtypes together with :c:member:`~PyTypeObject." "tp_setattro`: a subtype inherits both :c:member:`~PyTypeObject.tp_setattr` " "and :c:member:`~PyTypeObject.tp_setattro` from its base type when the " "subtype's :c:member:`~PyTypeObject.tp_setattr` and :c:member:`~PyTypeObject." "tp_setattro` are both ``NULL``." msgstr "" #: c-api/typeobj.rst:807 msgid "" "Pointer to an additional structure that contains fields relevant only to " "objects which implement :term:`awaitable` and :term:`asynchronous iterator` " "protocols at the C-level. See :ref:`async-structs` for details." msgstr "" #: c-api/typeobj.rst:811 msgid "Formerly known as ``tp_compare`` and ``tp_reserved``." msgstr "" #: c-api/typeobj.rst:816 msgid "" "The :c:member:`~PyTypeObject.tp_as_async` field is not inherited, but the " "contained fields are inherited individually." msgstr "" #: c-api/typeobj.rst:824 msgid "" "An optional pointer to a function that implements the built-in function :" "func:`repr`." msgstr "" #: c-api/typeobj.rst:827 msgid "The signature is the same as for :c:func:`PyObject_Repr`::" msgstr "" #: c-api/typeobj.rst:829 msgid "PyObject *tp_repr(PyObject *self);" msgstr "" #: c-api/typeobj.rst:831 msgid "" "The function must return a string or a Unicode object. Ideally, this " "function should return a string that, when passed to :func:`eval`, given a " "suitable environment, returns an object with the same value. If this is not " "feasible, it should return a string starting with ``''`` from which both the type and the value of the object can be deduced." msgstr "" #: c-api/typeobj.rst:954 c-api/typeobj.rst:1005 c-api/typeobj.rst:1575 #: c-api/typeobj.rst:1726 c-api/typeobj.rst:1834 c-api/typeobj.rst:1893 #: c-api/typeobj.rst:1956 c-api/typeobj.rst:1987 msgid "**Default:**" msgstr "" #: c-api/typeobj.rst:844 msgid "" "When this field is not set, a string of the form ```` is " "returned, where ``%s`` is replaced by the type name, and ``%p`` by the " "object's memory address." msgstr "" #: c-api/typeobj.rst:851 msgid "" "Pointer to an additional structure that contains fields relevant only to " "objects which implement the number protocol. These fields are documented " "in :ref:`number-structs`." msgstr "" #: c-api/typeobj.rst:857 msgid "" "The :c:member:`~PyTypeObject.tp_as_number` field is not inherited, but the " "contained fields are inherited individually." msgstr "" #: c-api/typeobj.rst:863 msgid "" "Pointer to an additional structure that contains fields relevant only to " "objects which implement the sequence protocol. These fields are documented " "in :ref:`sequence-structs`." msgstr "" #: c-api/typeobj.rst:869 msgid "" "The :c:member:`~PyTypeObject.tp_as_sequence` field is not inherited, but the " "contained fields are inherited individually." msgstr "" #: c-api/typeobj.rst:875 msgid "" "Pointer to an additional structure that contains fields relevant only to " "objects which implement the mapping protocol. These fields are documented " "in :ref:`mapping-structs`." msgstr "" #: c-api/typeobj.rst:881 msgid "" "The :c:member:`~PyTypeObject.tp_as_mapping` field is not inherited, but the " "contained fields are inherited individually." msgstr "" #: c-api/typeobj.rst:889 msgid "" "An optional pointer to a function that implements the built-in function :" "func:`hash`." msgstr "" #: c-api/typeobj.rst:892 msgid "The signature is the same as for :c:func:`PyObject_Hash`::" msgstr "" #: c-api/typeobj.rst:894 msgid "Py_hash_t tp_hash(PyObject *);" msgstr "" #: c-api/typeobj.rst:896 msgid "" "The value ``-1`` should not be returned as a normal return value; when an " "error occurs during the computation of the hash value, the function should " "set an exception and return ``-1``." msgstr "" #: c-api/typeobj.rst:900 msgid "" "When this field is not set (*and* :c:member:`~PyTypeObject.tp_richcompare` " "is not set), an attempt to take the hash of the object raises :exc:" "`TypeError`. This is the same as setting it to :c:func:" "`PyObject_HashNotImplemented`." msgstr "" #: c-api/typeobj.rst:904 msgid "" "This field can be set explicitly to :c:func:`PyObject_HashNotImplemented` to " "block inheritance of the hash method from a parent type. This is interpreted " "as the equivalent of ``__hash__ = None`` at the Python level, causing " "``isinstance(o, collections.Hashable)`` to correctly return ``False``. Note " "that the converse is also true - setting ``__hash__ = None`` on a class at " "the Python level will result in the ``tp_hash`` slot being set to :c:func:" "`PyObject_HashNotImplemented`." msgstr "" #: c-api/typeobj.rst:1568 msgid "" "Group: :c:member:`~PyTypeObject.tp_hash`, :c:member:`~PyTypeObject." "tp_richcompare`" msgstr "" #: c-api/typeobj.rst:916 msgid "" "This field is inherited by subtypes together with :c:member:`~PyTypeObject." "tp_richcompare`: a subtype inherits both of :c:member:`~PyTypeObject." "tp_richcompare` and :c:member:`~PyTypeObject.tp_hash`, when the subtype's :c:" "member:`~PyTypeObject.tp_richcompare` and :c:member:`~PyTypeObject.tp_hash` " "are both ``NULL``." msgstr "" #: c-api/typeobj.rst:924 msgid "" "An optional pointer to a function that implements calling the object. This " "should be ``NULL`` if the object is not callable. The signature is the same " "as for :c:func:`PyObject_Call`::" msgstr "" #: c-api/typeobj.rst:928 msgid "PyObject *tp_call(PyObject *self, PyObject *args, PyObject *kwargs);" msgstr "" #: c-api/typeobj.rst:937 msgid "" "An optional pointer to a function that implements the built-in operation :" "func:`str`. (Note that :class:`str` is a type now, and :func:`str` calls " "the constructor for that type. This constructor calls :c:func:" "`PyObject_Str` to do the actual work, and :c:func:`PyObject_Str` will call " "this handler.)" msgstr "" #: c-api/typeobj.rst:942 msgid "The signature is the same as for :c:func:`PyObject_Str`::" msgstr "" #: c-api/typeobj.rst:944 msgid "PyObject *tp_str(PyObject *self);" msgstr "" #: c-api/typeobj.rst:946 msgid "" "The function must return a string or a Unicode object. It should be a " "\"friendly\" string representation of the object, as this is the " "representation that will be used, among other things, by the :func:`print` " "function." msgstr "" #: c-api/typeobj.rst:956 msgid "" "When this field is not set, :c:func:`PyObject_Repr` is called to return a " "string representation." msgstr "" #: c-api/typeobj.rst:962 msgid "An optional pointer to the get-attribute function." msgstr "" #: c-api/typeobj.rst:964 msgid "The signature is the same as for :c:func:`PyObject_GetAttr`::" msgstr "" #: c-api/typeobj.rst:966 msgid "PyObject *tp_getattro(PyObject *self, PyObject *attr);" msgstr "" #: c-api/typeobj.rst:968 msgid "" "It is usually convenient to set this field to :c:func:" "`PyObject_GenericGetAttr`, which implements the normal way of looking for " "object attributes." msgstr "" #: c-api/typeobj.rst:975 msgid "" "This field is inherited by subtypes together with :c:member:`~PyTypeObject." "tp_getattr`: a subtype inherits both :c:member:`~PyTypeObject.tp_getattr` " "and :c:member:`~PyTypeObject.tp_getattro` from its base type when the " "subtype's :c:member:`~PyTypeObject.tp_getattr` and :c:member:`~PyTypeObject." "tp_getattro` are both ``NULL``." msgstr "" #: c-api/typeobj.rst:981 msgid ":c:data:`PyBaseObject_Type` uses :c:func:`PyObject_GenericGetAttr`." msgstr "" #: c-api/typeobj.rst:988 msgid "The signature is the same as for :c:func:`PyObject_SetAttr`::" msgstr "" #: c-api/typeobj.rst:990 msgid "int tp_setattro(PyObject *self, PyObject *attr, PyObject *value);" msgstr "" #: c-api/typeobj.rst:992 msgid "" "In addition, setting *value* to ``NULL`` to delete an attribute must be " "supported. It is usually convenient to set this field to :c:func:" "`PyObject_GenericSetAttr`, which implements the normal way of setting object " "attributes." msgstr "" #: c-api/typeobj.rst:1001 msgid "" "This field is inherited by subtypes together with :c:member:`~PyTypeObject." "tp_setattr`: a subtype inherits both :c:member:`~PyTypeObject.tp_setattr` " "and :c:member:`~PyTypeObject.tp_setattro` from its base type when the " "subtype's :c:member:`~PyTypeObject.tp_setattr` and :c:member:`~PyTypeObject." "tp_setattro` are both ``NULL``." msgstr "" #: c-api/typeobj.rst:1007 msgid ":c:data:`PyBaseObject_Type` uses :c:func:`PyObject_GenericSetAttr`." msgstr "" #: c-api/typeobj.rst:1012 msgid "" "Pointer to an additional structure that contains fields relevant only to " "objects which implement the buffer interface. These fields are documented " "in :ref:`buffer-structs`." msgstr "" #: c-api/typeobj.rst:1018 msgid "" "The :c:member:`~PyTypeObject.tp_as_buffer` field is not inherited, but the " "contained fields are inherited individually." msgstr "" #: c-api/typeobj.rst:1024 msgid "" "This field is a bit mask of various flags. Some flags indicate variant " "semantics for certain situations; others are used to indicate that certain " "fields in the type object (or in the extension structures referenced via :c:" "member:`~PyTypeObject.tp_as_number`, :c:member:`~PyTypeObject." "tp_as_sequence`, :c:member:`~PyTypeObject.tp_as_mapping`, and :c:member:" "`~PyTypeObject.tp_as_buffer`) that were historically not always present are " "valid; if such a flag bit is clear, the type fields it guards must not be " "accessed and must be considered to have a zero or ``NULL`` value instead." msgstr "" #: c-api/typeobj.rst:1034 msgid "" "Inheritance of this field is complicated. Most flag bits are inherited " "individually, i.e. if the base type has a flag bit set, the subtype inherits " "this flag bit. The flag bits that pertain to extension structures are " "strictly inherited if the extension structure is inherited, i.e. the base " "type's value of the flag bit is copied into the subtype together with a " "pointer to the extension structure. The :c:macro:`Py_TPFLAGS_HAVE_GC` flag " "bit is inherited together with the :c:member:`~PyTypeObject.tp_traverse` " "and :c:member:`~PyTypeObject.tp_clear` fields, i.e. if the :c:macro:" "`Py_TPFLAGS_HAVE_GC` flag bit is clear in the subtype and the :c:member:" "`~PyTypeObject.tp_traverse` and :c:member:`~PyTypeObject.tp_clear` fields in " "the subtype exist and have ``NULL`` values. .. XXX are most flag bits " "*really* inherited individually?" msgstr "" #: c-api/typeobj.rst:1048 msgid "" ":c:data:`PyBaseObject_Type` uses ``Py_TPFLAGS_DEFAULT | " "Py_TPFLAGS_BASETYPE``." msgstr "" #: c-api/typeobj.rst:1051 msgid "**Bit Masks:**" msgstr "" #: c-api/typeobj.rst:1055 msgid "" "The following bit masks are currently defined; these can be ORed together " "using the ``|`` operator to form the value of the :c:member:`~PyTypeObject." "tp_flags` field. The macro :c:func:`PyType_HasFeature` takes a type and a " "flags value, *tp* and *f*, and checks whether ``tp->tp_flags & f`` is non-" "zero." msgstr "" #: c-api/typeobj.rst:1062 msgid "" "This bit is set when the type object itself is allocated on the heap, for " "example, types created dynamically using :c:func:`PyType_FromSpec`. In this " "case, the :c:member:`~PyObject.ob_type` field of its instances is considered " "a reference to the type, and the type object is INCREF'ed when a new " "instance is created, and DECREF'ed when an instance is destroyed (this does " "not apply to instances of subtypes; only the type referenced by the " "instance's ob_type gets INCREF'ed or DECREF'ed). Heap types should also :ref:" "`support garbage collection ` as they can form a " "reference cycle with their own module object." msgstr "" #: c-api/typeobj.rst:1084 c-api/typeobj.rst:1104 c-api/typeobj.rst:1136 msgid "???" msgstr "" #: c-api/typeobj.rst:1078 msgid "" "This bit is set when the type can be used as the base type of another type. " "If this bit is clear, the type cannot be subtyped (similar to a \"final\" " "class in Java)." msgstr "" #: c-api/typeobj.rst:1089 msgid "" "This bit is set when the type object has been fully initialized by :c:func:" "`PyType_Ready`." msgstr "" #: c-api/typeobj.rst:1099 msgid "" "This bit is set while :c:func:`PyType_Ready` is in the process of " "initializing the type object." msgstr "" #: c-api/typeobj.rst:1109 msgid "" "This bit is set when the object supports garbage collection. If this bit is " "set, instances must be created using :c:macro:`PyObject_GC_New` and " "destroyed using :c:func:`PyObject_GC_Del`. More information in section :ref:" "`supporting-cycle-detection`. This bit also implies that the GC-related " "fields :c:member:`~PyTypeObject.tp_traverse` and :c:member:`~PyTypeObject." "tp_clear` are present in the type object." msgstr "" #: c-api/typeobj.rst:1439 c-api/typeobj.rst:1507 msgid "" "Group: :c:macro:`Py_TPFLAGS_HAVE_GC`, :c:member:`~PyTypeObject." "tp_traverse`, :c:member:`~PyTypeObject.tp_clear`" msgstr "" #: c-api/typeobj.rst:1120 msgid "" "The :c:macro:`Py_TPFLAGS_HAVE_GC` flag bit is inherited together with the :c:" "member:`~PyTypeObject.tp_traverse` and :c:member:`~PyTypeObject.tp_clear` " "fields, i.e. if the :c:macro:`Py_TPFLAGS_HAVE_GC` flag bit is clear in the " "subtype and the :c:member:`~PyTypeObject.tp_traverse` and :c:member:" "`~PyTypeObject.tp_clear` fields in the subtype exist and have ``NULL`` " "values." msgstr "" #: c-api/typeobj.rst:1130 msgid "" "This is a bitmask of all the bits that pertain to the existence of certain " "fields in the type object and its extension structures. Currently, it " "includes the following bits: :c:macro:`Py_TPFLAGS_HAVE_STACKLESS_EXTENSION`." msgstr "" #: c-api/typeobj.rst:1141 msgid "This bit indicates that objects behave like unbound methods." msgstr "" #: c-api/typeobj.rst:1143 msgid "If this flag is set for ``type(meth)``, then:" msgstr "" #: c-api/typeobj.rst:1145 msgid "" "``meth.__get__(obj, cls)(*args, **kwds)`` (with ``obj`` not None) must be " "equivalent to ``meth(obj, *args, **kwds)``." msgstr "" #: c-api/typeobj.rst:1148 msgid "" "``meth.__get__(None, cls)(*args, **kwds)`` must be equivalent to " "``meth(*args, **kwds)``." msgstr "" #: c-api/typeobj.rst:1151 msgid "" "This flag enables an optimization for typical method calls like ``obj." "meth()``: it avoids creating a temporary \"bound method\" object for ``obj." "meth``." msgstr "" #: c-api/typeobj.rst:1159 msgid "" "This flag is never inherited by types without the :c:macro:" "`Py_TPFLAGS_IMMUTABLETYPE` flag set. For extension types, it is inherited " "whenever :c:member:`~PyTypeObject.tp_descr_get` is inherited." msgstr "" #: c-api/typeobj.rst:1165 msgid "" "This bit indicates that instances of the class have a `~object.__dict__` " "attribute, and that the space for the dictionary is managed by the VM." msgstr "" #: c-api/typeobj.rst:1168 msgid "If this flag is set, :c:macro:`Py_TPFLAGS_HAVE_GC` should also be set." msgstr "" #: c-api/typeobj.rst:1174 msgid "" "This flag is inherited unless the :c:member:`~PyTypeObject.tp_dictoffset` " "field is set in a superclass." msgstr "" #: c-api/typeobj.rst:1180 msgid "" "This bit indicates that instances of the class should be weakly " "referenceable." msgstr "" #: c-api/typeobj.rst:1187 msgid "" "This flag is inherited unless the :c:member:`~PyTypeObject." "tp_weaklistoffset` field is set in a superclass." msgstr "" #: c-api/typeobj.rst:1193 msgid "" "Only usable with variable-size types, i.e. ones with non-zero :c:member:" "`~PyTypeObject.tp_itemsize`." msgstr "" #: c-api/typeobj.rst:1196 msgid "" "Indicates that the variable-sized portion of an instance of this type is at " "the end of the instance's memory area, at an offset of ``Py_TYPE(obj)-" ">tp_basicsize`` (which may be different in each subclass)." msgstr "" #: c-api/typeobj.rst:1201 msgid "" "When setting this flag, be sure that all superclasses either use this memory " "layout, or are not variable-sized. Python does not check this." msgstr "" #: c-api/typeobj.rst:1209 msgid "This flag is inherited." msgstr "" #: c-api/typeobj.rst:1223 msgid "" "These flags are used by functions such as :c:func:`PyLong_Check` to quickly " "determine if a type is a subclass of a built-in type; such specific checks " "are faster than a generic check, like :c:func:`PyObject_IsInstance`. Custom " "types that inherit from built-ins should have their :c:member:`~PyTypeObject." "tp_flags` set appropriately, or the code that interacts with such types will " "behave differently depending on what kind of check is used." msgstr "" #: c-api/typeobj.rst:1234 msgid "" "This bit is set when the :c:member:`~PyTypeObject.tp_finalize` slot is " "present in the type structure." msgstr "" #: c-api/typeobj.rst:1239 msgid "" "This flag isn't necessary anymore, as the interpreter assumes the :c:member:" "`~PyTypeObject.tp_finalize` slot is always present in the type structure." msgstr "" #: c-api/typeobj.rst:1247 msgid "" "This bit is set when the class implements the :ref:`vectorcall protocol " "`. See :c:member:`~PyTypeObject.tp_vectorcall_offset` for " "details." msgstr "" #: c-api/typeobj.rst:1253 msgid "" "This bit is inherited if :c:member:`~PyTypeObject.tp_call` is also inherited." msgstr "" #: c-api/typeobj.rst:1260 msgid "" "This flag is now removed from a class when the class's :py:meth:`~object." "__call__` method is reassigned." msgstr "" #: c-api/typeobj.rst:1263 msgid "This flag can now be inherited by mutable classes." msgstr "" #: c-api/typeobj.rst:1267 msgid "" "This bit is set for type objects that are immutable: type attributes cannot " "be set nor deleted." msgstr "" #: c-api/typeobj.rst:1269 msgid "" ":c:func:`PyType_Ready` automatically applies this flag to :ref:`static types " "`." msgstr "" #: c-api/typeobj.rst:1274 msgid "This flag is not inherited." msgstr "" #: c-api/typeobj.rst:1280 msgid "" "Disallow creating instances of the type: set :c:member:`~PyTypeObject." "tp_new` to NULL and don't create the ``__new__`` key in the type dictionary." msgstr "" #: c-api/typeobj.rst:1284 msgid "" "The flag must be set before creating the type, not after. For example, it " "must be set before :c:func:`PyType_Ready` is called on the type." msgstr "" #: c-api/typeobj.rst:1287 msgid "" "The flag is set automatically on :ref:`static types ` if :c:" "member:`~PyTypeObject.tp_base` is NULL or ``&PyBaseObject_Type`` and :c:" "member:`~PyTypeObject.tp_new` is NULL." msgstr "" #: c-api/typeobj.rst:1293 msgid "" "This flag is not inherited. However, subclasses will not be instantiable " "unless they provide a non-NULL :c:member:`~PyTypeObject.tp_new` (which is " "only possible via the C API)." msgstr "" #: c-api/typeobj.rst:1300 msgid "" "To disallow instantiating a class directly but allow instantiating its " "subclasses (e.g. for an :term:`abstract base class`), do not use this flag. " "Instead, make :c:member:`~PyTypeObject.tp_new` only succeed for subclasses." msgstr "" #: c-api/typeobj.rst:1311 msgid "" "This bit indicates that instances of the class may match mapping patterns " "when used as the subject of a :keyword:`match` block. It is automatically " "set when registering or subclassing :class:`collections.abc.Mapping`, and " "unset when registering :class:`collections.abc.Sequence`." msgstr "" #: c-api/typeobj.rst:1340 msgid "" ":c:macro:`Py_TPFLAGS_MAPPING` and :c:macro:`Py_TPFLAGS_SEQUENCE` are " "mutually exclusive; it is an error to enable both flags simultaneously." msgstr "" #: c-api/typeobj.rst:1323 msgid "" "This flag is inherited by types that do not already set :c:macro:" "`Py_TPFLAGS_SEQUENCE`." msgstr "" #: c-api/typeobj.rst:1348 msgid ":pep:`634` -- Structural Pattern Matching: Specification" msgstr "" #: c-api/typeobj.rst:1333 msgid "" "This bit indicates that instances of the class may match sequence patterns " "when used as the subject of a :keyword:`match` block. It is automatically " "set when registering or subclassing :class:`collections.abc.Sequence`, and " "unset when registering :class:`collections.abc.Mapping`." msgstr "" #: c-api/typeobj.rst:1345 msgid "" "This flag is inherited by types that do not already set :c:macro:" "`Py_TPFLAGS_MAPPING`." msgstr "" #: c-api/typeobj.rst:1355 msgid "" "Internal. Do not set or unset this flag. To indicate that a class has " "changed call :c:func:`PyType_Modified`" msgstr "" #: c-api/typeobj.rst:1359 msgid "" "This flag is present in header files, but is an internal feature and should " "not be used. It will be removed in a future version of CPython" msgstr "" #: c-api/typeobj.rst:1365 msgid "" "An optional pointer to a NUL-terminated C string giving the docstring for " "this type object. This is exposed as the :attr:`~type.__doc__` attribute on " "the type and instances of the type." msgstr "" #: c-api/typeobj.rst:1371 msgid "This field is *not* inherited by subtypes." msgstr "" #: c-api/typeobj.rst:1376 msgid "" "An optional pointer to a traversal function for the garbage collector. This " "is only used if the :c:macro:`Py_TPFLAGS_HAVE_GC` flag bit is set. The " "signature is::" msgstr "" #: c-api/typeobj.rst:1379 msgid "int tp_traverse(PyObject *self, visitproc visit, void *arg);" msgstr "" #: c-api/typeobj.rst:1502 msgid "" "More information about Python's garbage collection scheme can be found in " "section :ref:`supporting-cycle-detection`." msgstr "" #: c-api/typeobj.rst:1384 msgid "" "The :c:member:`~PyTypeObject.tp_traverse` pointer is used by the garbage " "collector to detect reference cycles. A typical implementation of a :c:" "member:`~PyTypeObject.tp_traverse` function simply calls :c:func:`Py_VISIT` " "on each of the instance's members that are Python objects that the instance " "owns. For example, this is function :c:func:`!local_traverse` from the :mod:" "`!_thread` extension module::" msgstr "" #: c-api/typeobj.rst:1390 msgid "" "static int\n" "local_traverse(localobject *self, visitproc visit, void *arg)\n" "{\n" " Py_VISIT(self->args);\n" " Py_VISIT(self->kw);\n" " Py_VISIT(self->dict);\n" " return 0;\n" "}" msgstr "" #: c-api/typeobj.rst:1399 msgid "" "Note that :c:func:`Py_VISIT` is called only on those members that can " "participate in reference cycles. Although there is also a ``self->key`` " "member, it can only be ``NULL`` or a Python string and therefore cannot be " "part of a reference cycle." msgstr "" #: c-api/typeobj.rst:1403 msgid "" "On the other hand, even if you know a member can never be part of a cycle, " "as a debugging aid you may want to visit it anyway just so the :mod:`gc` " "module's :func:`~gc.get_referents` function will include it." msgstr "" #: c-api/typeobj.rst:1408 msgid "" "When implementing :c:member:`~PyTypeObject.tp_traverse`, only the members " "that the instance *owns* (by having :term:`strong references ` to them) must be visited. For instance, if an object supports " "weak references via the :c:member:`~PyTypeObject.tp_weaklist` slot, the " "pointer supporting the linked list (what *tp_weaklist* points to) must " "**not** be visited as the instance does not directly own the weak references " "to itself (the weakreference list is there to support the weak reference " "machinery, but the instance has no strong reference to the elements inside " "it, as they are allowed to be removed even if the instance is still alive)." msgstr "" #: c-api/typeobj.rst:1419 msgid "" "Note that :c:func:`Py_VISIT` requires the *visit* and *arg* parameters to :c:" "func:`local_traverse` to have these specific names; don't name them just " "anything." msgstr "" #: c-api/typeobj.rst:1423 msgid "" "Instances of :ref:`heap-allocated types ` hold a reference to " "their type. Their traversal function must therefore either visit :c:func:" "`Py_TYPE(self) `, or delegate this responsibility by calling " "``tp_traverse`` of another heap-allocated type (such as a heap-allocated " "superclass). If they do not, the type object may not be garbage-collected." msgstr "" #: c-api/typeobj.rst:1432 msgid "" "Heap-allocated types are expected to visit ``Py_TYPE(self)`` in " "``tp_traverse``. In earlier versions of Python, due to `bug 40217 `_, doing this may lead to crashes in subclasses." msgstr "" #: c-api/typeobj.rst:1441 msgid "" "This field is inherited by subtypes together with :c:member:`~PyTypeObject." "tp_clear` and the :c:macro:`Py_TPFLAGS_HAVE_GC` flag bit: the flag bit, :c:" "member:`~PyTypeObject.tp_traverse`, and :c:member:`~PyTypeObject.tp_clear` " "are all inherited from the base type if they are all zero in the subtype." msgstr "" #: c-api/typeobj.rst:1449 msgid "" "An optional pointer to a clear function for the garbage collector. This is " "only used if the :c:macro:`Py_TPFLAGS_HAVE_GC` flag bit is set. The " "signature is::" msgstr "" #: c-api/typeobj.rst:1452 msgid "int tp_clear(PyObject *);" msgstr "" #: c-api/typeobj.rst:1454 msgid "" "The :c:member:`~PyTypeObject.tp_clear` member function is used to break " "reference cycles in cyclic garbage detected by the garbage collector. Taken " "together, all :c:member:`~PyTypeObject.tp_clear` functions in the system " "must combine to break all reference cycles. This is subtle, and if in any " "doubt supply a :c:member:`~PyTypeObject.tp_clear` function. For example, " "the tuple type does not implement a :c:member:`~PyTypeObject.tp_clear` " "function, because it's possible to prove that no reference cycle can be " "composed entirely of tuples. Therefore the :c:member:`~PyTypeObject." "tp_clear` functions of other types must be sufficient to break any cycle " "containing a tuple. This isn't immediately obvious, and there's rarely a " "good reason to avoid implementing :c:member:`~PyTypeObject.tp_clear`." msgstr "" #: c-api/typeobj.rst:1464 msgid "" "Implementations of :c:member:`~PyTypeObject.tp_clear` should drop the " "instance's references to those of its members that may be Python objects, " "and set its pointers to those members to ``NULL``, as in the following " "example::" msgstr "" #: c-api/typeobj.rst:1468 msgid "" "static int\n" "local_clear(localobject *self)\n" "{\n" " Py_CLEAR(self->key);\n" " Py_CLEAR(self->args);\n" " Py_CLEAR(self->kw);\n" " Py_CLEAR(self->dict);\n" " return 0;\n" "}" msgstr "" #: c-api/typeobj.rst:1478 msgid "" "The :c:func:`Py_CLEAR` macro should be used, because clearing references is " "delicate: the reference to the contained object must not be released (via :" "c:func:`Py_DECREF`) until after the pointer to the contained object is set " "to ``NULL``. This is because releasing the reference may cause the " "contained object to become trash, triggering a chain of reclamation activity " "that may include invoking arbitrary Python code (due to finalizers, or " "weakref callbacks, associated with the contained object). If it's possible " "for such code to reference *self* again, it's important that the pointer to " "the contained object be ``NULL`` at that time, so that *self* knows the " "contained object can no longer be used. The :c:func:`Py_CLEAR` macro " "performs the operations in a safe order." msgstr "" #: c-api/typeobj.rst:1490 msgid "" "Note that :c:member:`~PyTypeObject.tp_clear` is not *always* called before " "an instance is deallocated. For example, when reference counting is enough " "to determine that an object is no longer used, the cyclic garbage collector " "is not involved and :c:member:`~PyTypeObject.tp_dealloc` is called directly." msgstr "" #: c-api/typeobj.rst:1496 msgid "" "Because the goal of :c:member:`~PyTypeObject.tp_clear` functions is to break " "reference cycles, it's not necessary to clear contained objects like Python " "strings or Python integers, which can't participate in reference cycles. On " "the other hand, it may be convenient to clear all contained Python objects, " "and write the type's :c:member:`~PyTypeObject.tp_dealloc` function to " "invoke :c:member:`~PyTypeObject.tp_clear`." msgstr "" #: c-api/typeobj.rst:1509 msgid "" "This field is inherited by subtypes together with :c:member:`~PyTypeObject." "tp_traverse` and the :c:macro:`Py_TPFLAGS_HAVE_GC` flag bit: the flag bit, :" "c:member:`~PyTypeObject.tp_traverse`, and :c:member:`~PyTypeObject.tp_clear` " "are all inherited from the base type if they are all zero in the subtype." msgstr "" #: c-api/typeobj.rst:1517 msgid "" "An optional pointer to the rich comparison function, whose signature is::" msgstr "" #: c-api/typeobj.rst:1519 msgid "PyObject *tp_richcompare(PyObject *self, PyObject *other, int op);" msgstr "" #: c-api/typeobj.rst:1521 msgid "" "The first parameter is guaranteed to be an instance of the type that is " "defined by :c:type:`PyTypeObject`." msgstr "" #: c-api/typeobj.rst:1524 msgid "" "The function should return the result of the comparison (usually ``Py_True`` " "or ``Py_False``). If the comparison is undefined, it must return " "``Py_NotImplemented``, if another error occurred it must return ``NULL`` and " "set an exception condition." msgstr "" #: c-api/typeobj.rst:1529 msgid "" "The following constants are defined to be used as the third argument for :c:" "member:`~PyTypeObject.tp_richcompare` and for :c:func:`PyObject_RichCompare`:" msgstr "" #: c-api/typeobj.rst:1535 msgid "Constant" msgstr "" #: c-api/typeobj.rst:1535 msgid "Comparison" msgstr "" #: c-api/typeobj.rst:1537 msgid "``=``" msgstr "" #: c-api/typeobj.rst:1550 msgid "" "The following macro is defined to ease writing rich comparison functions:" msgstr "" #: c-api/typeobj.rst:1554 msgid "" "Return ``Py_True`` or ``Py_False`` from the function, depending on the " "result of a comparison. VAL_A and VAL_B must be orderable by C comparison " "operators (for example, they may be C ints or floats). The third argument " "specifies the requested operation, as for :c:func:`PyObject_RichCompare`." msgstr "" #: c-api/typeobj.rst:1560 msgid "The returned value is a new :term:`strong reference`." msgstr "" #: c-api/typeobj.rst:1562 msgid "On error, sets an exception and returns ``NULL`` from the function." msgstr "" #: c-api/typeobj.rst:1570 msgid "" "This field is inherited by subtypes together with :c:member:`~PyTypeObject." "tp_hash`: a subtype inherits :c:member:`~PyTypeObject.tp_richcompare` and :c:" "member:`~PyTypeObject.tp_hash` when the subtype's :c:member:`~PyTypeObject." "tp_richcompare` and :c:member:`~PyTypeObject.tp_hash` are both ``NULL``." msgstr "" #: c-api/typeobj.rst:1577 msgid "" ":c:data:`PyBaseObject_Type` provides a :c:member:`~PyTypeObject." "tp_richcompare` implementation, which may be inherited. However, if only :c:" "member:`~PyTypeObject.tp_hash` is defined, not even the inherited function " "is used and instances of the type will not be able to participate in any " "comparisons." msgstr "" #: c-api/typeobj.rst:1586 msgid "" "While this field is still supported, :c:macro:`Py_TPFLAGS_MANAGED_WEAKREF` " "should be used instead, if at all possible." msgstr "" #: c-api/typeobj.rst:1589 msgid "" "If the instances of this type are weakly referenceable, this field is " "greater than zero and contains the offset in the instance structure of the " "weak reference list head (ignoring the GC header, if present); this offset " "is used by :c:func:`PyObject_ClearWeakRefs` and the ``PyWeakref_*`` " "functions. The instance structure needs to include a field of type :c:expr:" "`PyObject*` which is initialized to ``NULL``." msgstr "" #: c-api/typeobj.rst:1596 msgid "" "Do not confuse this field with :c:member:`~PyTypeObject.tp_weaklist`; that " "is the list head for weak references to the type object itself." msgstr "" #: c-api/typeobj.rst:1599 msgid "" "It is an error to set both the :c:macro:`Py_TPFLAGS_MANAGED_WEAKREF` bit " "and :c:member:`~PyTypeObject.tp_weaklistoffset`." msgstr "" #: c-api/typeobj.rst:1604 msgid "" "This field is inherited by subtypes, but see the rules listed below. A " "subtype may override this offset; this means that the subtype uses a " "different weak reference list head than the base type. Since the list head " "is always found via :c:member:`~PyTypeObject.tp_weaklistoffset`, this should " "not be a problem." msgstr "" #: c-api/typeobj.rst:1611 msgid "" "If the :c:macro:`Py_TPFLAGS_MANAGED_WEAKREF` bit is set in the :c:member:" "`~PyTypeObject.tp_flags` field, then :c:member:`~PyTypeObject." "tp_weaklistoffset` will be set to a negative value, to indicate that it is " "unsafe to use this field." msgstr "" #: c-api/typeobj.rst:1619 msgid "" "An optional pointer to a function that returns an :term:`iterator` for the " "object. Its presence normally signals that the instances of this type are :" "term:`iterable` (although sequences may be iterable without this function)." msgstr "" #: c-api/typeobj.rst:1623 msgid "This function has the same signature as :c:func:`PyObject_GetIter`::" msgstr "" #: c-api/typeobj.rst:1625 msgid "PyObject *tp_iter(PyObject *self);" msgstr "" #: c-api/typeobj.rst:1634 msgid "" "An optional pointer to a function that returns the next item in an :term:" "`iterator`. The signature is::" msgstr "" #: c-api/typeobj.rst:1637 msgid "PyObject *tp_iternext(PyObject *self);" msgstr "" #: c-api/typeobj.rst:1639 msgid "" "When the iterator is exhausted, it must return ``NULL``; a :exc:" "`StopIteration` exception may or may not be set. When another error occurs, " "it must return ``NULL`` too. Its presence signals that the instances of " "this type are iterators." msgstr "" #: c-api/typeobj.rst:1644 msgid "" "Iterator types should also define the :c:member:`~PyTypeObject.tp_iter` " "function, and that function should return the iterator instance itself (not " "a new iterator instance)." msgstr "" #: c-api/typeobj.rst:1648 msgid "This function has the same signature as :c:func:`PyIter_Next`." msgstr "" #: c-api/typeobj.rst:1657 msgid "" "An optional pointer to a static ``NULL``-terminated array of :c:type:" "`PyMethodDef` structures, declaring regular methods of this type." msgstr "" #: c-api/typeobj.rst:1660 msgid "" "For each entry in the array, an entry is added to the type's dictionary " "(see :c:member:`~PyTypeObject.tp_dict` below) containing a method descriptor." msgstr "" #: c-api/typeobj.rst:1665 msgid "" "This field is not inherited by subtypes (methods are inherited through a " "different mechanism)." msgstr "" #: c-api/typeobj.rst:1671 msgid "" "An optional pointer to a static ``NULL``-terminated array of :c:type:" "`PyMemberDef` structures, declaring regular data members (fields or slots) " "of instances of this type." msgstr "" #: c-api/typeobj.rst:1675 msgid "" "For each entry in the array, an entry is added to the type's dictionary " "(see :c:member:`~PyTypeObject.tp_dict` below) containing a member descriptor." msgstr "" #: c-api/typeobj.rst:1680 msgid "" "This field is not inherited by subtypes (members are inherited through a " "different mechanism)." msgstr "" #: c-api/typeobj.rst:1686 msgid "" "An optional pointer to a static ``NULL``-terminated array of :c:type:" "`PyGetSetDef` structures, declaring computed attributes of instances of this " "type." msgstr "" #: c-api/typeobj.rst:1689 msgid "" "For each entry in the array, an entry is added to the type's dictionary " "(see :c:member:`~PyTypeObject.tp_dict` below) containing a getset descriptor." msgstr "" #: c-api/typeobj.rst:1694 msgid "" "This field is not inherited by subtypes (computed attributes are inherited " "through a different mechanism)." msgstr "" #: c-api/typeobj.rst:1700 msgid "" "An optional pointer to a base type from which type properties are " "inherited. At this level, only single inheritance is supported; multiple " "inheritance require dynamically creating a type object by calling the " "metatype." msgstr "" #: c-api/typeobj.rst:1708 msgid "" "Slot initialization is subject to the rules of initializing globals. C99 " "requires the initializers to be \"address constants\". Function designators " "like :c:func:`PyType_GenericNew`, with implicit conversion to a pointer, are " "valid C99 address constants." msgstr "" #: c-api/typeobj.rst:1713 msgid "" "However, the unary '&' operator applied to a non-static variable like :c:" "data:`PyBaseObject_Type` is not required to produce an address constant. " "Compilers may support this (gcc does), MSVC does not. Both compilers are " "strictly standard conforming in this particular behavior." msgstr "" #: c-api/typeobj.rst:1719 msgid "" "Consequently, :c:member:`~PyTypeObject.tp_base` should be set in the " "extension module's init function." msgstr "" #: c-api/typeobj.rst:1724 msgid "This field is not inherited by subtypes (obviously)." msgstr "" #: c-api/typeobj.rst:1728 msgid "" "This field defaults to ``&PyBaseObject_Type`` (which to Python programmers " "is known as the type :class:`object`)." msgstr "" #: c-api/typeobj.rst:1734 msgid "The type's dictionary is stored here by :c:func:`PyType_Ready`." msgstr "" #: c-api/typeobj.rst:1736 msgid "" "This field should normally be initialized to ``NULL`` before PyType_Ready is " "called; it may also be initialized to a dictionary containing initial " "attributes for the type. Once :c:func:`PyType_Ready` has initialized the " "type, extra attributes for the type may be added to this dictionary only if " "they don't correspond to overloaded operations (like :meth:`~object." "__add__`). Once initialization for the type has finished, this field should " "be treated as read-only." msgstr "" #: c-api/typeobj.rst:1744 msgid "" "Some types may not store their dictionary in this slot. Use :c:func:" "`PyType_GetDict` to retrieve the dictionary for an arbitrary type." msgstr "" #: c-api/typeobj.rst:1750 msgid "" "Internals detail: For static builtin types, this is always ``NULL``. " "Instead, the dict for such types is stored on ``PyInterpreterState``. Use :c:" "func:`PyType_GetDict` to get the dict for an arbitrary type." msgstr "" #: c-api/typeobj.rst:1756 msgid "" "This field is not inherited by subtypes (though the attributes defined in " "here are inherited through a different mechanism)." msgstr "" #: c-api/typeobj.rst:1761 msgid "" "If this field is ``NULL``, :c:func:`PyType_Ready` will assign a new " "dictionary to it." msgstr "" #: c-api/typeobj.rst:1766 msgid "" "It is not safe to use :c:func:`PyDict_SetItem` on or otherwise modify :c:" "member:`~PyTypeObject.tp_dict` with the dictionary C-API." msgstr "" #: c-api/typeobj.rst:1772 msgid "An optional pointer to a \"descriptor get\" function." msgstr "" #: c-api/typeobj.rst:1790 c-api/typeobj.rst:1884 c-api/typeobj.rst:1908 msgid "The function signature is::" msgstr "" #: c-api/typeobj.rst:1776 msgid "PyObject * tp_descr_get(PyObject *self, PyObject *obj, PyObject *type);" msgstr "" #: c-api/typeobj.rst:1787 msgid "" "An optional pointer to a function for setting and deleting a descriptor's " "value." msgstr "" #: c-api/typeobj.rst:1792 msgid "int tp_descr_set(PyObject *self, PyObject *obj, PyObject *value);" msgstr "" #: c-api/typeobj.rst:1794 msgid "The *value* argument is set to ``NULL`` to delete the value." msgstr "" #: c-api/typeobj.rst:1805 msgid "" "While this field is still supported, :c:macro:`Py_TPFLAGS_MANAGED_DICT` " "should be used instead, if at all possible." msgstr "" #: c-api/typeobj.rst:1808 msgid "" "If the instances of this type have a dictionary containing instance " "variables, this field is non-zero and contains the offset in the instances " "of the type of the instance variable dictionary; this offset is used by :c:" "func:`PyObject_GenericGetAttr`." msgstr "" #: c-api/typeobj.rst:1813 msgid "" "Do not confuse this field with :c:member:`~PyTypeObject.tp_dict`; that is " "the dictionary for attributes of the type object itself." msgstr "" #: c-api/typeobj.rst:1816 msgid "" "The value specifies the offset of the dictionary from the start of the " "instance structure." msgstr "" #: c-api/typeobj.rst:1818 msgid "" "The :c:member:`~PyTypeObject.tp_dictoffset` should be regarded as write-" "only. To get the pointer to the dictionary call :c:func:" "`PyObject_GenericGetDict`. Calling :c:func:`PyObject_GenericGetDict` may " "need to allocate memory for the dictionary, so it is may be more efficient " "to call :c:func:`PyObject_GetAttr` when accessing an attribute on the object." msgstr "" #: c-api/typeobj.rst:1824 msgid "" "It is an error to set both the :c:macro:`Py_TPFLAGS_MANAGED_WEAKREF` bit " "and :c:member:`~PyTypeObject.tp_dictoffset`." msgstr "" #: c-api/typeobj.rst:1829 msgid "" "This field is inherited by subtypes. A subtype should not override this " "offset; doing so could be unsafe, if C code tries to access the dictionary " "at the previous offset. To properly support inheritance, use :c:macro:" "`Py_TPFLAGS_MANAGED_DICT`." msgstr "" #: c-api/typeobj.rst:1836 msgid "" "This slot has no default. For :ref:`static types `, if the " "field is ``NULL`` then no :attr:`~object.__dict__` gets created for " "instances." msgstr "" #: c-api/typeobj.rst:1839 msgid "" "If the :c:macro:`Py_TPFLAGS_MANAGED_DICT` bit is set in the :c:member:" "`~PyTypeObject.tp_dict` field, then :c:member:`~PyTypeObject.tp_dictoffset` " "will be set to ``-1``, to indicate that it is unsafe to use this field." msgstr "" #: c-api/typeobj.rst:1847 msgid "An optional pointer to an instance initialization function." msgstr "" #: c-api/typeobj.rst:1849 msgid "" "This function corresponds to the :meth:`~object.__init__` method of " "classes. Like :meth:`!__init__`, it is possible to create an instance " "without calling :meth:`!__init__`, and it is possible to reinitialize an " "instance by calling its :meth:`!__init__` method again." msgstr "" #: c-api/typeobj.rst:1856 msgid "int tp_init(PyObject *self, PyObject *args, PyObject *kwds);" msgstr "" #: c-api/typeobj.rst:1858 msgid "" "The self argument is the instance to be initialized; the *args* and *kwds* " "arguments represent positional and keyword arguments of the call to :meth:" "`~object.__init__`." msgstr "" #: c-api/typeobj.rst:1862 msgid "" "The :c:member:`~PyTypeObject.tp_init` function, if not ``NULL``, is called " "when an instance is created normally by calling its type, after the type's :" "c:member:`~PyTypeObject.tp_new` function has returned an instance of the " "type. If the :c:member:`~PyTypeObject.tp_new` function returns an instance " "of some other type that is not a subtype of the original type, no :c:member:" "`~PyTypeObject.tp_init` function is called; if :c:member:`~PyTypeObject." "tp_new` returns an instance of a subtype of the original type, the " "subtype's :c:member:`~PyTypeObject.tp_init` is called." msgstr "" #: c-api/typeobj.rst:1869 msgid "Returns ``0`` on success, ``-1`` and sets an exception on error." msgstr "" #: c-api/typeobj.rst:1877 msgid "" "For :ref:`static types ` this field does not have a default." msgstr "" #: c-api/typeobj.rst:1882 msgid "An optional pointer to an instance allocation function." msgstr "" #: c-api/typeobj.rst:1886 msgid "PyObject *tp_alloc(PyTypeObject *self, Py_ssize_t nitems);" msgstr "" #: c-api/typeobj.rst:1890 msgid "" "This field is inherited by static subtypes, but not by dynamic subtypes " "(subtypes created by a class statement)." msgstr "" #: c-api/typeobj.rst:1895 msgid "" "For dynamic subtypes, this field is always set to :c:func:" "`PyType_GenericAlloc`, to force a standard heap allocation strategy." msgstr "" #: c-api/typeobj.rst:1899 msgid "" "For static subtypes, :c:data:`PyBaseObject_Type` uses :c:func:" "`PyType_GenericAlloc`. That is the recommended value for all statically " "defined types." msgstr "" #: c-api/typeobj.rst:1906 msgid "An optional pointer to an instance creation function." msgstr "" #: c-api/typeobj.rst:1910 msgid "" "PyObject *tp_new(PyTypeObject *subtype, PyObject *args, PyObject *kwds);" msgstr "" #: c-api/typeobj.rst:1912 msgid "" "The *subtype* argument is the type of the object being created; the *args* " "and *kwds* arguments represent positional and keyword arguments of the call " "to the type. Note that *subtype* doesn't have to equal the type whose :c:" "member:`~PyTypeObject.tp_new` function is called; it may be a subtype of " "that type (but not an unrelated type)." msgstr "" #: c-api/typeobj.rst:1918 msgid "" "The :c:member:`~PyTypeObject.tp_new` function should call ``subtype-" ">tp_alloc(subtype, nitems)`` to allocate space for the object, and then do " "only as much further initialization as is absolutely necessary. " "Initialization that can safely be ignored or repeated should be placed in " "the :c:member:`~PyTypeObject.tp_init` handler. A good rule of thumb is that " "for immutable types, all initialization should take place in :c:member:" "`~PyTypeObject.tp_new`, while for mutable types, most initialization should " "be deferred to :c:member:`~PyTypeObject.tp_init`." msgstr "" #: c-api/typeobj.rst:1926 msgid "" "Set the :c:macro:`Py_TPFLAGS_DISALLOW_INSTANTIATION` flag to disallow " "creating instances of the type in Python." msgstr "" #: c-api/typeobj.rst:1931 msgid "" "This field is inherited by subtypes, except it is not inherited by :ref:" "`static types ` whose :c:member:`~PyTypeObject.tp_base` is " "``NULL`` or ``&PyBaseObject_Type``." msgstr "" #: c-api/typeobj.rst:1937 msgid "" "For :ref:`static types ` this field has no default. This means " "if the slot is defined as ``NULL``, the type cannot be called to create new " "instances; presumably there is some other way to create instances, like a " "factory function." msgstr "" #: c-api/typeobj.rst:1945 msgid "" "An optional pointer to an instance deallocation function. Its signature is::" msgstr "" #: c-api/typeobj.rst:1947 msgid "void tp_free(void *self);" msgstr "" #: c-api/typeobj.rst:1949 msgid "" "An initializer that is compatible with this signature is :c:func:" "`PyObject_Free`." msgstr "" #: c-api/typeobj.rst:1953 msgid "" "This field is inherited by static subtypes, but not by dynamic subtypes " "(subtypes created by a class statement)" msgstr "" #: c-api/typeobj.rst:1958 msgid "" "In dynamic subtypes, this field is set to a deallocator suitable to match :c:" "func:`PyType_GenericAlloc` and the value of the :c:macro:" "`Py_TPFLAGS_HAVE_GC` flag bit." msgstr "" #: c-api/typeobj.rst:1962 msgid "" "For static subtypes, :c:data:`PyBaseObject_Type` uses :c:func:`PyObject_Del`." msgstr "" #: c-api/typeobj.rst:1967 msgid "An optional pointer to a function called by the garbage collector." msgstr "" #: c-api/typeobj.rst:1969 msgid "" "The garbage collector needs to know whether a particular object is " "collectible or not. Normally, it is sufficient to look at the object's " "type's :c:member:`~PyTypeObject.tp_flags` field, and check the :c:macro:" "`Py_TPFLAGS_HAVE_GC` flag bit. But some types have a mixture of statically " "and dynamically allocated instances, and the statically allocated instances " "are not collectible. Such types should define this function; it should " "return ``1`` for a collectible instance, and ``0`` for a non-collectible " "instance. The signature is::" msgstr "" #: c-api/typeobj.rst:1977 msgid "int tp_is_gc(PyObject *self);" msgstr "" #: c-api/typeobj.rst:1979 msgid "" "(The only example of this are types themselves. The metatype, :c:data:" "`PyType_Type`, defines this function to distinguish between statically and :" "ref:`dynamically allocated types `.)" msgstr "" #: c-api/typeobj.rst:1989 msgid "" "This slot has no default. If this field is ``NULL``, :c:macro:" "`Py_TPFLAGS_HAVE_GC` is used as the functional equivalent." msgstr "" #: c-api/typeobj.rst:1995 msgid "Tuple of base types." msgstr "" #: c-api/typeobj.rst:2021 msgid "" "This field should be set to ``NULL`` and treated as read-only. Python will " "fill it in when the type is :c:func:`initialized `." msgstr "" #: c-api/typeobj.rst:2000 msgid "" "For dynamically created classes, the ``Py_tp_bases`` :c:type:`slot " "` can be used instead of the *bases* argument of :c:func:" "`PyType_FromSpecWithBases`. The argument form is preferred." msgstr "" #: c-api/typeobj.rst:2007 msgid "" "Multiple inheritance does not work well for statically defined types. If you " "set ``tp_bases`` to a tuple, Python will not raise an error, but some slots " "will only be inherited from the first base." msgstr "" #: c-api/typeobj.rst:2036 c-api/typeobj.rst:2070 c-api/typeobj.rst:2084 msgid "This field is not inherited." msgstr "" #: c-api/typeobj.rst:2018 msgid "" "Tuple containing the expanded set of base types, starting with the type " "itself and ending with :class:`object`, in Method Resolution Order." msgstr "" #: c-api/typeobj.rst:2026 msgid "" "This field is not inherited; it is calculated fresh by :c:func:" "`PyType_Ready`." msgstr "" #: c-api/typeobj.rst:2032 msgid "Unused. Internal use only." msgstr "" #: c-api/typeobj.rst:2041 msgid "" "A collection of subclasses. Internal use only. May be an invalid pointer." msgstr "" #: c-api/typeobj.rst:2043 msgid "" "To get a list of subclasses, call the Python method :py:meth:`~type." "__subclasses__`." msgstr "" #: c-api/typeobj.rst:2048 msgid "" "For some types, this field does not hold a valid :c:expr:`PyObject*`. The " "type was changed to :c:expr:`void*` to indicate this." msgstr "" #: c-api/typeobj.rst:2058 msgid "" "Weak reference list head, for weak references to this type object. Not " "inherited. Internal use only." msgstr "" #: c-api/typeobj.rst:2063 msgid "" "Internals detail: For the static builtin types this is always ``NULL``, even " "if weakrefs are added. Instead, the weakrefs for each are stored on " "``PyInterpreterState``. Use the public C-API or the internal " "``_PyObject_GET_WEAKREFS_LISTPTR()`` macro to avoid the distinction." msgstr "" #: c-api/typeobj.rst:2075 msgid "" "This field is deprecated. Use :c:member:`~PyTypeObject.tp_finalize` instead." msgstr "" #: c-api/typeobj.rst:2080 msgid "Used to index into the method cache. Internal use only." msgstr "" #: c-api/typeobj.rst:2089 msgid "" "An optional pointer to an instance finalization function. Its signature is::" msgstr "" #: c-api/typeobj.rst:2091 msgid "void tp_finalize(PyObject *self);" msgstr "" #: c-api/typeobj.rst:2093 msgid "" "If :c:member:`~PyTypeObject.tp_finalize` is set, the interpreter calls it " "once when finalizing an instance. It is called either from the garbage " "collector (if the instance is part of an isolated reference cycle) or just " "before the object is deallocated. Either way, it is guaranteed to be called " "before attempting to break reference cycles, ensuring that it finds the " "object in a sane state." msgstr "" #: c-api/typeobj.rst:2100 msgid "" ":c:member:`~PyTypeObject.tp_finalize` should not mutate the current " "exception status; therefore, a recommended way to write a non-trivial " "finalizer is::" msgstr "" #: c-api/typeobj.rst:2103 msgid "" "static void\n" "local_finalize(PyObject *self)\n" "{\n" " PyObject *error_type, *error_value, *error_traceback;\n" "\n" " /* Save the current exception, if any. */\n" " PyErr_Fetch(&error_type, &error_value, &error_traceback);\n" "\n" " /* ... */\n" "\n" " /* Restore the saved exception. */\n" " PyErr_Restore(error_type, error_value, error_traceback);\n" "}" msgstr "" #: c-api/typeobj.rst:2125 msgid "" "Before version 3.8 it was necessary to set the :c:macro:" "`Py_TPFLAGS_HAVE_FINALIZE` flags bit in order for this field to be used. " "This is no longer required." msgstr "" #: c-api/typeobj.rst:2129 msgid "\"Safe object finalization\" (:pep:`442`)" msgstr "" #: c-api/typeobj.rst:2134 msgid "" "Vectorcall function to use for calls of this type object. In other words, it " "is used to implement :ref:`vectorcall ` for ``type.__call__``. " "If ``tp_vectorcall`` is ``NULL``, the default call implementation using :" "meth:`~object.__new__` and :meth:`~object.__init__` is used." msgstr "" #: c-api/typeobj.rst:2142 msgid "This field is never inherited." msgstr "" #: c-api/typeobj.rst:2144 msgid "(the field exists since 3.8 but it's only used since 3.9)" msgstr "" #: c-api/typeobj.rst:2149 msgid "Internal. Do not use." msgstr "" #: c-api/typeobj.rst:2157 msgid "Static Types" msgstr "" #: c-api/typeobj.rst:2159 msgid "" "Traditionally, types defined in C code are *static*, that is, a static :c:" "type:`PyTypeObject` structure is defined directly in code and initialized " "using :c:func:`PyType_Ready`." msgstr "" #: c-api/typeobj.rst:2163 msgid "" "This results in types that are limited relative to types defined in Python:" msgstr "" #: c-api/typeobj.rst:2165 msgid "" "Static types are limited to one base, i.e. they cannot use multiple " "inheritance." msgstr "" #: c-api/typeobj.rst:2167 msgid "" "Static type objects (but not necessarily their instances) are immutable. It " "is not possible to add or modify the type object's attributes from Python." msgstr "" #: c-api/typeobj.rst:2169 msgid "" "Static type objects are shared across :ref:`sub-interpreters `, so they should not include any subinterpreter-" "specific state." msgstr "" #: c-api/typeobj.rst:2173 msgid "" "Also, since :c:type:`PyTypeObject` is only part of the :ref:`Limited API " "` as an opaque struct, any extension modules using static " "types must be compiled for a specific Python minor version." msgstr "" #: c-api/typeobj.rst:2181 msgid "Heap Types" msgstr "" #: c-api/typeobj.rst:2183 msgid "" "An alternative to :ref:`static types ` is *heap-allocated " "types*, or *heap types* for short, which correspond closely to classes " "created by Python's ``class`` statement. Heap types have the :c:macro:" "`Py_TPFLAGS_HEAPTYPE` flag set." msgstr "" #: c-api/typeobj.rst:2188 msgid "" "This is done by filling a :c:type:`PyType_Spec` structure and calling :c:" "func:`PyType_FromSpec`, :c:func:`PyType_FromSpecWithBases`, :c:func:" "`PyType_FromModuleAndSpec`, or :c:func:`PyType_FromMetaclass`." msgstr "" #: c-api/typeobj.rst:2196 msgid "Number Object Structures" msgstr "" #: c-api/typeobj.rst:2203 msgid "" "This structure holds pointers to the functions which an object uses to " "implement the number protocol. Each function is used by the function of " "similar name documented in the :ref:`number` section." msgstr "" #: c-api/typeobj.rst:2533 msgid "Here is the structure definition::" msgstr "" #: c-api/typeobj.rst:2211 msgid "" "typedef struct {\n" " binaryfunc nb_add;\n" " binaryfunc nb_subtract;\n" " binaryfunc nb_multiply;\n" " binaryfunc nb_remainder;\n" " binaryfunc nb_divmod;\n" " ternaryfunc nb_power;\n" " unaryfunc nb_negative;\n" " unaryfunc nb_positive;\n" " unaryfunc nb_absolute;\n" " inquiry nb_bool;\n" " unaryfunc nb_invert;\n" " binaryfunc nb_lshift;\n" " binaryfunc nb_rshift;\n" " binaryfunc nb_and;\n" " binaryfunc nb_xor;\n" " binaryfunc nb_or;\n" " unaryfunc nb_int;\n" " void *nb_reserved;\n" " unaryfunc nb_float;\n" "\n" " binaryfunc nb_inplace_add;\n" " binaryfunc nb_inplace_subtract;\n" " binaryfunc nb_inplace_multiply;\n" " binaryfunc nb_inplace_remainder;\n" " ternaryfunc nb_inplace_power;\n" " binaryfunc nb_inplace_lshift;\n" " binaryfunc nb_inplace_rshift;\n" " binaryfunc nb_inplace_and;\n" " binaryfunc nb_inplace_xor;\n" " binaryfunc nb_inplace_or;\n" "\n" " binaryfunc nb_floor_divide;\n" " binaryfunc nb_true_divide;\n" " binaryfunc nb_inplace_floor_divide;\n" " binaryfunc nb_inplace_true_divide;\n" "\n" " unaryfunc nb_index;\n" "\n" " binaryfunc nb_matrix_multiply;\n" " binaryfunc nb_inplace_matrix_multiply;\n" "} PyNumberMethods;" msgstr "" #: c-api/typeobj.rst:2256 msgid "" "Binary and ternary functions must check the type of all their operands, and " "implement the necessary conversions (at least one of the operands is an " "instance of the defined type). If the operation is not defined for the " "given operands, binary and ternary functions must return " "``Py_NotImplemented``, if another error occurred they must return ``NULL`` " "and set an exception." msgstr "" #: c-api/typeobj.rst:2265 msgid "" "The :c:member:`~PyNumberMethods.nb_reserved` field should always be " "``NULL``. It was previously called :c:member:`!nb_long`, and was renamed in " "Python 3.0.1." msgstr "" #: c-api/typeobj.rst:2310 msgid "Mapping Object Structures" msgstr "" #: c-api/typeobj.rst:2317 msgid "" "This structure holds pointers to the functions which an object uses to " "implement the mapping protocol. It has three members:" msgstr "" #: c-api/typeobj.rst:2322 msgid "" "This function is used by :c:func:`PyMapping_Size` and :c:func:" "`PyObject_Size`, and has the same signature. This slot may be set to " "``NULL`` if the object has no defined length." msgstr "" #: c-api/typeobj.rst:2328 msgid "" "This function is used by :c:func:`PyObject_GetItem` and :c:func:" "`PySequence_GetSlice`, and has the same signature as :c:func:`!" "PyObject_GetItem`. This slot must be filled for the :c:func:" "`PyMapping_Check` function to return ``1``, it can be ``NULL`` otherwise." msgstr "" #: c-api/typeobj.rst:2336 msgid "" "This function is used by :c:func:`PyObject_SetItem`, :c:func:" "`PyObject_DelItem`, :c:func:`PySequence_SetSlice` and :c:func:" "`PySequence_DelSlice`. It has the same signature as :c:func:`!" "PyObject_SetItem`, but *v* can also be set to ``NULL`` to delete an item. " "If this slot is ``NULL``, the object does not support item assignment and " "deletion." msgstr "" #: c-api/typeobj.rst:2347 msgid "Sequence Object Structures" msgstr "" #: c-api/typeobj.rst:2354 msgid "" "This structure holds pointers to the functions which an object uses to " "implement the sequence protocol." msgstr "" #: c-api/typeobj.rst:2359 msgid "" "This function is used by :c:func:`PySequence_Size` and :c:func:" "`PyObject_Size`, and has the same signature. It is also used for handling " "negative indices via the :c:member:`~PySequenceMethods.sq_item` and the :c:" "member:`~PySequenceMethods.sq_ass_item` slots." msgstr "" #: c-api/typeobj.rst:2366 msgid "" "This function is used by :c:func:`PySequence_Concat` and has the same " "signature. It is also used by the ``+`` operator, after trying the numeric " "addition via the :c:member:`~PyNumberMethods.nb_add` slot." msgstr "" #: c-api/typeobj.rst:2372 msgid "" "This function is used by :c:func:`PySequence_Repeat` and has the same " "signature. It is also used by the ``*`` operator, after trying numeric " "multiplication via the :c:member:`~PyNumberMethods.nb_multiply` slot." msgstr "" #: c-api/typeobj.rst:2378 msgid "" "This function is used by :c:func:`PySequence_GetItem` and has the same " "signature. It is also used by :c:func:`PyObject_GetItem`, after trying the " "subscription via the :c:member:`~PyMappingMethods.mp_subscript` slot. This " "slot must be filled for the :c:func:`PySequence_Check` function to return " "``1``, it can be ``NULL`` otherwise." msgstr "" #: c-api/typeobj.rst:2384 msgid "" "Negative indexes are handled as follows: if the :c:member:" "`~PySequenceMethods.sq_length` slot is filled, it is called and the sequence " "length is used to compute a positive index which is passed to :c:member:" "`~PySequenceMethods.sq_item`. If :c:member:`!sq_length` is ``NULL``, the " "index is passed as is to the function." msgstr "" #: c-api/typeobj.rst:2391 msgid "" "This function is used by :c:func:`PySequence_SetItem` and has the same " "signature. It is also used by :c:func:`PyObject_SetItem` and :c:func:" "`PyObject_DelItem`, after trying the item assignment and deletion via the :c:" "member:`~PyMappingMethods.mp_ass_subscript` slot. This slot may be left to " "``NULL`` if the object does not support item assignment and deletion." msgstr "" #: c-api/typeobj.rst:2400 msgid "" "This function may be used by :c:func:`PySequence_Contains` and has the same " "signature. This slot may be left to ``NULL``, in this case :c:func:`!" "PySequence_Contains` simply traverses the sequence until it finds a match." msgstr "" #: c-api/typeobj.rst:2407 msgid "" "This function is used by :c:func:`PySequence_InPlaceConcat` and has the same " "signature. It should modify its first operand, and return it. This slot " "may be left to ``NULL``, in this case :c:func:`!PySequence_InPlaceConcat` " "will fall back to :c:func:`PySequence_Concat`. It is also used by the " "augmented assignment ``+=``, after trying numeric in-place addition via the :" "c:member:`~PyNumberMethods.nb_inplace_add` slot." msgstr "" #: c-api/typeobj.rst:2416 msgid "" "This function is used by :c:func:`PySequence_InPlaceRepeat` and has the same " "signature. It should modify its first operand, and return it. This slot " "may be left to ``NULL``, in this case :c:func:`!PySequence_InPlaceRepeat` " "will fall back to :c:func:`PySequence_Repeat`. It is also used by the " "augmented assignment ``*=``, after trying numeric in-place multiplication " "via the :c:member:`~PyNumberMethods.nb_inplace_multiply` slot." msgstr "" #: c-api/typeobj.rst:2427 msgid "Buffer Object Structures" msgstr "" #: c-api/typeobj.rst:2435 msgid "" "This structure holds pointers to the functions required by the :ref:`Buffer " "protocol `. The protocol defines how an exporter object can " "expose its internal data to consumer objects." msgstr "" #: c-api/typeobj.rst:2490 c-api/typeobj.rst:2555 c-api/typeobj.rst:2577 msgid "The signature of this function is::" msgstr "" #: c-api/typeobj.rst:2443 msgid "int (PyObject *exporter, Py_buffer *view, int flags);" msgstr "" #: c-api/typeobj.rst:2445 msgid "" "Handle a request to *exporter* to fill in *view* as specified by *flags*. " "Except for point (3), an implementation of this function MUST take these " "steps:" msgstr "" #: c-api/typeobj.rst:2449 msgid "" "Check if the request can be met. If not, raise :exc:`BufferError`, set :c:" "expr:`view->obj` to ``NULL`` and return ``-1``." msgstr "" #: c-api/typeobj.rst:2452 msgid "Fill in the requested fields." msgstr "" #: c-api/typeobj.rst:2454 msgid "Increment an internal counter for the number of exports." msgstr "" #: c-api/typeobj.rst:2456 msgid "" "Set :c:expr:`view->obj` to *exporter* and increment :c:expr:`view->obj`." msgstr "" #: c-api/typeobj.rst:2458 msgid "Return ``0``." msgstr "" #: c-api/typeobj.rst:2460 msgid "" "If *exporter* is part of a chain or tree of buffer providers, two main " "schemes can be used:" msgstr "" #: c-api/typeobj.rst:2463 msgid "" "Re-export: Each member of the tree acts as the exporting object and sets :c:" "expr:`view->obj` to a new reference to itself." msgstr "" #: c-api/typeobj.rst:2466 msgid "" "Redirect: The buffer request is redirected to the root object of the tree. " "Here, :c:expr:`view->obj` will be a new reference to the root object." msgstr "" #: c-api/typeobj.rst:2470 msgid "" "The individual fields of *view* are described in section :ref:`Buffer " "structure `, the rules how an exporter must react to " "specific requests are in section :ref:`Buffer request types `." msgstr "" #: c-api/typeobj.rst:2475 msgid "" "All memory pointed to in the :c:type:`Py_buffer` structure belongs to the " "exporter and must remain valid until there are no consumers left. :c:member:" "`~Py_buffer.format`, :c:member:`~Py_buffer.shape`, :c:member:`~Py_buffer." "strides`, :c:member:`~Py_buffer.suboffsets` and :c:member:`~Py_buffer." "internal` are read-only for the consumer." msgstr "" #: c-api/typeobj.rst:2482 msgid "" ":c:func:`PyBuffer_FillInfo` provides an easy way of exposing a simple bytes " "buffer while dealing correctly with all request types." msgstr "" #: c-api/typeobj.rst:2485 msgid "" ":c:func:`PyObject_GetBuffer` is the interface for the consumer that wraps " "this function." msgstr "" #: c-api/typeobj.rst:2492 msgid "void (PyObject *exporter, Py_buffer *view);" msgstr "" #: c-api/typeobj.rst:2494 msgid "" "Handle a request to release the resources of the buffer. If no resources " "need to be released, :c:member:`PyBufferProcs.bf_releasebuffer` may be " "``NULL``. Otherwise, a standard implementation of this function will take " "these optional steps:" msgstr "" #: c-api/typeobj.rst:2499 msgid "Decrement an internal counter for the number of exports." msgstr "" #: c-api/typeobj.rst:2501 msgid "If the counter is ``0``, free all memory associated with *view*." msgstr "" #: c-api/typeobj.rst:2503 msgid "" "The exporter MUST use the :c:member:`~Py_buffer.internal` field to keep " "track of buffer-specific resources. This field is guaranteed to remain " "constant, while a consumer MAY pass a copy of the original buffer as the " "*view* argument." msgstr "" #: c-api/typeobj.rst:2509 msgid "" "This function MUST NOT decrement :c:expr:`view->obj`, since that is done " "automatically in :c:func:`PyBuffer_Release` (this scheme is useful for " "breaking reference cycles)." msgstr "" #: c-api/typeobj.rst:2514 msgid "" ":c:func:`PyBuffer_Release` is the interface for the consumer that wraps this " "function." msgstr "" #: c-api/typeobj.rst:2522 msgid "Async Object Structures" msgstr "" #: c-api/typeobj.rst:2530 msgid "" "This structure holds pointers to the functions required to implement :term:" "`awaitable` and :term:`asynchronous iterator` objects." msgstr "" #: c-api/typeobj.rst:2535 msgid "" "typedef struct {\n" " unaryfunc am_await;\n" " unaryfunc am_aiter;\n" " unaryfunc am_anext;\n" " sendfunc am_send;\n" "} PyAsyncMethods;" msgstr "" #: c-api/typeobj.rst:2546 msgid "PyObject *am_await(PyObject *self);" msgstr "" #: c-api/typeobj.rst:2548 msgid "" "The returned object must be an :term:`iterator`, i.e. :c:func:`PyIter_Check` " "must return ``1`` for it." msgstr "" #: c-api/typeobj.rst:2551 msgid "" "This slot may be set to ``NULL`` if an object is not an :term:`awaitable`." msgstr "" #: c-api/typeobj.rst:2557 msgid "PyObject *am_aiter(PyObject *self);" msgstr "" #: c-api/typeobj.rst:2559 msgid "" "Must return an :term:`asynchronous iterator` object. See :meth:`~object." "__anext__` for details." msgstr "" #: c-api/typeobj.rst:2562 msgid "" "This slot may be set to ``NULL`` if an object does not implement " "asynchronous iteration protocol." msgstr "" #: c-api/typeobj.rst:2569 msgid "PyObject *am_anext(PyObject *self);" msgstr "" #: c-api/typeobj.rst:2571 msgid "" "Must return an :term:`awaitable` object. See :meth:`~object.__anext__` for " "details. This slot may be set to ``NULL``." msgstr "" #: c-api/typeobj.rst:2579 msgid "PySendResult am_send(PyObject *self, PyObject *arg, PyObject **result);" msgstr "" #: c-api/typeobj.rst:2581 msgid "" "See :c:func:`PyIter_Send` for details. This slot may be set to ``NULL``." msgstr "" #: c-api/typeobj.rst:2590 msgid "Slot Type typedefs" msgstr "" #: c-api/typeobj.rst:2594 msgid "" "The purpose of this function is to separate memory allocation from memory " "initialization. It should return a pointer to a block of memory of adequate " "length for the instance, suitably aligned, and initialized to zeros, but " "with :c:member:`~PyObject.ob_refcnt` set to ``1`` and :c:member:`~PyObject." "ob_type` set to the type argument. If the type's :c:member:`~PyTypeObject." "tp_itemsize` is non-zero, the object's :c:member:`~PyVarObject.ob_size` " "field should be initialized to *nitems* and the length of the allocated " "memory block should be ``tp_basicsize + nitems*tp_itemsize``, rounded up to " "a multiple of ``sizeof(void*)``; otherwise, *nitems* is not used and the " "length of the block should be :c:member:`~PyTypeObject.tp_basicsize`." msgstr "" #: c-api/typeobj.rst:2604 msgid "" "This function should not do any other instance initialization, not even to " "allocate additional memory; that should be done by :c:member:`~PyTypeObject." "tp_new`." msgstr "" #: c-api/typeobj.rst:2611 msgid "See :c:member:`~PyTypeObject.tp_free`." msgstr "" #: c-api/typeobj.rst:2615 msgid "See :c:member:`~PyTypeObject.tp_new`." msgstr "" #: c-api/typeobj.rst:2619 msgid "See :c:member:`~PyTypeObject.tp_init`." msgstr "" #: c-api/typeobj.rst:2623 msgid "See :c:member:`~PyTypeObject.tp_repr`." msgstr "" #: c-api/typeobj.rst:2636 msgid "Return the value of the named attribute for the object." msgstr "" #: c-api/typeobj.rst:2642 msgid "" "Set the value of the named attribute for the object. The value argument is " "set to ``NULL`` to delete the attribute." msgstr "" #: c-api/typeobj.rst:2638 msgid "See :c:member:`~PyTypeObject.tp_getattro`." msgstr "" #: c-api/typeobj.rst:2645 msgid "See :c:member:`~PyTypeObject.tp_setattro`." msgstr "" #: c-api/typeobj.rst:2649 msgid "See :c:member:`~PyTypeObject.tp_descr_get`." msgstr "" #: c-api/typeobj.rst:2653 msgid "See :c:member:`~PyTypeObject.tp_descr_set`." msgstr "" #: c-api/typeobj.rst:2657 msgid "See :c:member:`~PyTypeObject.tp_hash`." msgstr "" #: c-api/typeobj.rst:2661 msgid "See :c:member:`~PyTypeObject.tp_richcompare`." msgstr "" #: c-api/typeobj.rst:2665 msgid "See :c:member:`~PyTypeObject.tp_iter`." msgstr "" #: c-api/typeobj.rst:2669 msgid "See :c:member:`~PyTypeObject.tp_iternext`." msgstr "" #: c-api/typeobj.rst:2683 msgid "See :c:member:`~PyAsyncMethods.am_send`." msgstr "" #: c-api/typeobj.rst:2699 msgid "Examples" msgstr "" #: c-api/typeobj.rst:2701 msgid "" "The following are simple examples of Python type definitions. They include " "common usage you may encounter. Some demonstrate tricky corner cases. For " "more examples, practical info, and a tutorial, see :ref:`defining-new-types` " "and :ref:`new-types-topics`." msgstr "" #: c-api/typeobj.rst:2706 msgid "A basic :ref:`static type `::" msgstr "" #: c-api/typeobj.rst:2708 msgid "" "typedef struct {\n" " PyObject_HEAD\n" " const char *data;\n" "} MyObject;\n" "\n" "static PyTypeObject MyObject_Type = {\n" " PyVarObject_HEAD_INIT(NULL, 0)\n" " .tp_name = \"mymod.MyObject\",\n" " .tp_basicsize = sizeof(MyObject),\n" " .tp_doc = PyDoc_STR(\"My objects\"),\n" " .tp_new = myobj_new,\n" " .tp_dealloc = (destructor)myobj_dealloc,\n" " .tp_repr = (reprfunc)myobj_repr,\n" "};" msgstr "" #: c-api/typeobj.rst:2723 msgid "" "You may also find older code (especially in the CPython code base) with a " "more verbose initializer::" msgstr "" #: c-api/typeobj.rst:2726 msgid "" "static PyTypeObject MyObject_Type = {\n" " PyVarObject_HEAD_INIT(NULL, 0)\n" " \"mymod.MyObject\", /* tp_name */\n" " sizeof(MyObject), /* tp_basicsize */\n" " 0, /* tp_itemsize */\n" " (destructor)myobj_dealloc, /* tp_dealloc */\n" " 0, /* tp_vectorcall_offset */\n" " 0, /* tp_getattr */\n" " 0, /* tp_setattr */\n" " 0, /* tp_as_async */\n" " (reprfunc)myobj_repr, /* tp_repr */\n" " 0, /* tp_as_number */\n" " 0, /* tp_as_sequence */\n" " 0, /* tp_as_mapping */\n" " 0, /* tp_hash */\n" " 0, /* tp_call */\n" " 0, /* tp_str */\n" " 0, /* tp_getattro */\n" " 0, /* tp_setattro */\n" " 0, /* tp_as_buffer */\n" " 0, /* tp_flags */\n" " PyDoc_STR(\"My objects\"), /* tp_doc */\n" " 0, /* tp_traverse */\n" " 0, /* tp_clear */\n" " 0, /* tp_richcompare */\n" " 0, /* tp_weaklistoffset */\n" " 0, /* tp_iter */\n" " 0, /* tp_iternext */\n" " 0, /* tp_methods */\n" " 0, /* tp_members */\n" " 0, /* tp_getset */\n" " 0, /* tp_base */\n" " 0, /* tp_dict */\n" " 0, /* tp_descr_get */\n" " 0, /* tp_descr_set */\n" " 0, /* tp_dictoffset */\n" " 0, /* tp_init */\n" " 0, /* tp_alloc */\n" " myobj_new, /* tp_new */\n" "};" msgstr "" #: c-api/typeobj.rst:2767 msgid "A type that supports weakrefs, instance dicts, and hashing::" msgstr "" #: c-api/typeobj.rst:2769 msgid "" "typedef struct {\n" " PyObject_HEAD\n" " const char *data;\n" "} MyObject;\n" "\n" "static PyTypeObject MyObject_Type = {\n" " PyVarObject_HEAD_INIT(NULL, 0)\n" " .tp_name = \"mymod.MyObject\",\n" " .tp_basicsize = sizeof(MyObject),\n" " .tp_doc = PyDoc_STR(\"My objects\"),\n" " .tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE |\n" " Py_TPFLAGS_HAVE_GC | Py_TPFLAGS_MANAGED_DICT |\n" " Py_TPFLAGS_MANAGED_WEAKREF,\n" " .tp_new = myobj_new,\n" " .tp_traverse = (traverseproc)myobj_traverse,\n" " .tp_clear = (inquiry)myobj_clear,\n" " .tp_alloc = PyType_GenericNew,\n" " .tp_dealloc = (destructor)myobj_dealloc,\n" " .tp_repr = (reprfunc)myobj_repr,\n" " .tp_hash = (hashfunc)myobj_hash,\n" " .tp_richcompare = PyBaseObject_Type.tp_richcompare,\n" "};" msgstr "" #: c-api/typeobj.rst:2792 msgid "" "A str subclass that cannot be subclassed and cannot be called to create " "instances (e.g. uses a separate factory func) using :c:macro:" "`Py_TPFLAGS_DISALLOW_INSTANTIATION` flag::" msgstr "" #: c-api/typeobj.rst:2796 msgid "" "typedef struct {\n" " PyUnicodeObject raw;\n" " char *extra;\n" "} MyStr;\n" "\n" "static PyTypeObject MyStr_Type = {\n" " PyVarObject_HEAD_INIT(NULL, 0)\n" " .tp_name = \"mymod.MyStr\",\n" " .tp_basicsize = sizeof(MyStr),\n" " .tp_base = NULL, // set to &PyUnicode_Type in module init\n" " .tp_doc = PyDoc_STR(\"my custom str\"),\n" " .tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_DISALLOW_INSTANTIATION,\n" " .tp_repr = (reprfunc)myobj_repr,\n" "};" msgstr "" #: c-api/typeobj.rst:2811 msgid "" "The simplest :ref:`static type ` with fixed-length instances::" msgstr "" #: c-api/typeobj.rst:2813 msgid "" "typedef struct {\n" " PyObject_HEAD\n" "} MyObject;\n" "\n" "static PyTypeObject MyObject_Type = {\n" " PyVarObject_HEAD_INIT(NULL, 0)\n" " .tp_name = \"mymod.MyObject\",\n" "};" msgstr "" #: c-api/typeobj.rst:2822 msgid "" "The simplest :ref:`static type ` with variable-length " "instances::" msgstr "" #: c-api/typeobj.rst:2824 msgid "" "typedef struct {\n" " PyObject_VAR_HEAD\n" " const char *data[1];\n" "} MyObject;\n" "\n" "static PyTypeObject MyObject_Type = {\n" " PyVarObject_HEAD_INIT(NULL, 0)\n" " .tp_name = \"mymod.MyObject\",\n" " .tp_basicsize = sizeof(MyObject) - sizeof(char *),\n" " .tp_itemsize = sizeof(char *),\n" "};" msgstr "" #: c-api/typeobj.rst:887 msgid "built-in function" msgstr "" #: c-api/typeobj.rst:822 msgid "repr" msgstr "" #: c-api/typeobj.rst:887 msgid "hash" msgstr ""