1
0
Fork 0
python-docs-fr/c-api/typeobj.po

1692 lines
62 KiB
Plaintext

# Copyright (C) 2001-2018, Python Software Foundation
# This file is distributed under the same license as the Python package.
# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
#
#, fuzzy
msgid ""
msgstr ""
"Project-Id-Version: Python 3.6\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2018-06-28 15:29+0200\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"Language: fr\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
#: ../Doc/c-api/typeobj.rst:6
msgid "Type Objects"
msgstr "Objets type"
#: ../Doc/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 :c:func:`PyObject_"
"\\*` or :c:func:`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 ""
#: ../Doc/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 ""
#: ../Doc/c-api/typeobj.rst:23
msgid ""
"Typedefs: unaryfunc, binaryfunc, ternaryfunc, inquiry, intargfunc, "
"intintargfunc, intobjargproc, intintobjargproc, objobjargproc, destructor, "
"freefunc, printfunc, getattrfunc, getattrofunc, setattrfunc, setattrofunc, "
"reprfunc, hashfunc"
msgstr ""
#: ../Doc/c-api/typeobj.rst:28
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 ""
#: ../Doc/c-api/typeobj.rst:35
msgid ""
"The type object structure extends the :c:type:`PyVarObject` structure. The :"
"attr:`ob_size` field is used for dynamic types (created by :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 :attr:`ob_size` field."
msgstr ""
#: ../Doc/c-api/typeobj.rst:45
msgid ""
"These fields are only present when the macro ``Py_TRACE_REFS`` is defined. "
"Their initialization to *NULL* is taken care of by the "
"``PyObject_HEAD_INIT`` macro. For statically allocated objects, these "
"fields always remain *NULL*. For dynamically allocated objects, these two "
"fields are used to link the object into a doubly-linked list of *all* live "
"objects on the heap. This could be used for various debugging purposes; "
"currently the only use is to print the objects that are still alive at the "
"end of a run when the environment variable :envvar:`PYTHONDUMPREFS` is set."
msgstr ""
#: ../Doc/c-api/typeobj.rst:54
msgid "These fields are not inherited by subtypes."
msgstr ""
#: ../Doc/c-api/typeobj.rst:59
msgid ""
"This is the type object's reference count, initialized to ``1`` by the "
"``PyObject_HEAD_INIT`` macro. Note that for statically allocated type "
"objects, the type's instances (objects whose :attr:`ob_type` points back to "
"the type) do *not* count as references. But for dynamically allocated type "
"objects, the instances *do* count as references."
msgstr ""
#: ../Doc/c-api/typeobj.rst:65 ../Doc/c-api/typeobj.rst:94
#: ../Doc/c-api/typeobj.rst:122
msgid "This field is not inherited by subtypes."
msgstr ""
#: ../Doc/c-api/typeobj.rst:70
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 ""
#: ../Doc/c-api/typeobj.rst:81
msgid ""
"This should be done before any instances of the type are created. :c:func:"
"`PyType_Ready` checks if :attr:`ob_type` is *NULL*, and if so, initializes "
"it to the :attr:`ob_type` field of the base class. :c:func:`PyType_Ready` "
"will not change this field if it is non-zero."
msgstr ""
#: ../Doc/c-api/typeobj.rst:86 ../Doc/c-api/typeobj.rst:188
#: ../Doc/c-api/typeobj.rst:255 ../Doc/c-api/typeobj.rst:322
#: ../Doc/c-api/typeobj.rst:340 ../Doc/c-api/typeobj.rst:682
#: ../Doc/c-api/typeobj.rst:699 ../Doc/c-api/typeobj.rst:779
#: ../Doc/c-api/typeobj.rst:874 ../Doc/c-api/typeobj.rst:967
#: ../Doc/c-api/typeobj.rst:1022
msgid "This field is inherited by subtypes."
msgstr ""
#: ../Doc/c-api/typeobj.rst:91
msgid ""
"For statically allocated type objects, this should be initialized to zero. "
"For dynamically allocated type objects, this field has a special internal "
"meaning."
msgstr ""
#: ../Doc/c-api/typeobj.rst:99
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 ""
#: ../Doc/c-api/typeobj.rst:107
msgid ""
"For 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 ""
#: ../Doc/c-api/typeobj.rst:111
msgid ""
"For statically allocated type objects, the tp_name field should contain a "
"dot. Everything before the last dot is made accessible as the :attr:"
"`__module__` attribute, and everything after the last dot is made accessible "
"as the :attr:`~definition.__name__` attribute."
msgstr ""
#: ../Doc/c-api/typeobj.rst:116
msgid ""
"If no dot is present, the entire :c:member:`~PyTypeObject.tp_name` field is "
"made accessible as the :attr:`~definition.__name__` attribute, and the :attr:"
"`__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 ""
#: ../Doc/c-api/typeobj.rst:128
msgid ""
"These fields allow calculating the size in bytes of instances of the type."
msgstr ""
#: ../Doc/c-api/typeobj.rst:130
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 ""
#: ../Doc/c-api/typeobj.rst:135
msgid ""
"For a type with variable-length instances, the instances must have an :attr:"
"`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 :attr:`ob_size` field. There are exceptions: for example, ints "
"use a negative :attr:`ob_size` to indicate a negative number, and N is "
"``abs(ob_size)`` there. Also, the presence of an :attr:`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 :attr:`ob_size` field)."
msgstr ""
#: ../Doc/c-api/typeobj.rst:146
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 :attr:`_ob_prev` "
"and :attr:`_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 ""
#: ../Doc/c-api/typeobj.rst:154
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 ""
#: ../Doc/c-api/typeobj.rst:159
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 ""
#: ../Doc/c-api/typeobj.rst:169
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``)."
msgstr ""
#: ../Doc/c-api/typeobj.rst:173
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 "
"finally (as its last action) call the type's :c:member:`~PyTypeObject."
"tp_free` function. If the type is not subtypable (doesn't have the :const:"
"`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:func:"
"`PyObject_New` or :c:func:`PyObject_VarNew`, or :c:func:`PyObject_GC_Del` if "
"the instance was allocated using :c:func:`PyObject_GC_New` or :c:func:"
"`PyObject_GC_NewVar`."
msgstr ""
#: ../Doc/c-api/typeobj.rst:193
msgid "Reserved slot, formerly used for print formatting in Python 2.x."
msgstr ""
#: ../Doc/c-api/typeobj.rst:198
msgid "An optional pointer to the get-attribute-string function."
msgstr ""
#: ../Doc/c-api/typeobj.rst:200
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. The signature is ::"
msgstr ""
#: ../Doc/c-api/typeobj.rst:206
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 ""
#: ../Doc/c-api/typeobj.rst:213 ../Doc/c-api/typeobj.rst:358
msgid ""
"An optional pointer to the function for setting and deleting attributes."
msgstr ""
#: ../Doc/c-api/typeobj.rst:215
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. The signature is ::"
msgstr ""
#: ../Doc/c-api/typeobj.rst:221
msgid ""
"The *v* argument is set to *NULL* to delete the attribute. 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 ""
#: ../Doc/c-api/typeobj.rst:229
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 ""
#: ../Doc/c-api/typeobj.rst:233
msgid "Formerly known as ``tp_compare`` and ``tp_reserved``."
msgstr ""
#: ../Doc/c-api/typeobj.rst:241
msgid ""
"An optional pointer to a function that implements the built-in function :"
"func:`repr`."
msgstr ""
#: ../Doc/c-api/typeobj.rst:244
msgid ""
"The signature is the same as for :c:func:`PyObject_Repr`; it 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 ``'<'`` and ending with ``'>'`` from which both the "
"type and the value of the object can be deduced."
msgstr ""
#: ../Doc/c-api/typeobj.rst:251
msgid ""
"When this field is not set, a string of the form ``<%s object at %p>`` is "
"returned, where ``%s`` is replaced by the type name, and ``%p`` by the "
"object's memory address."
msgstr ""
#: ../Doc/c-api/typeobj.rst:259
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 ""
#: ../Doc/c-api/typeobj.rst:263
msgid ""
"The :c:member:`~PyTypeObject.tp_as_number` field is not inherited, but the "
"contained fields are inherited individually."
msgstr ""
#: ../Doc/c-api/typeobj.rst:269
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 ""
#: ../Doc/c-api/typeobj.rst:273
msgid ""
"The :c:member:`~PyTypeObject.tp_as_sequence` field is not inherited, but the "
"contained fields are inherited individually."
msgstr ""
#: ../Doc/c-api/typeobj.rst:279
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 ""
#: ../Doc/c-api/typeobj.rst:283
msgid ""
"The :c:member:`~PyTypeObject.tp_as_mapping` field is not inherited, but the "
"contained fields are inherited individually."
msgstr ""
#: ../Doc/c-api/typeobj.rst:291
msgid ""
"An optional pointer to a function that implements the built-in function :"
"func:`hash`."
msgstr ""
#: ../Doc/c-api/typeobj.rst:294
msgid ""
"The signature is the same as for :c:func:`PyObject_Hash`; it must return a "
"value of the type Py_hash_t. 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 ""
#: ../Doc/c-api/typeobj.rst:299
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 ""
#: ../Doc/c-api/typeobj.rst:307
msgid ""
"When this field is not set, an attempt to take the hash of the object "
"raises :exc:`TypeError`."
msgstr ""
#: ../Doc/c-api/typeobj.rst:310
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 ""
#: ../Doc/c-api/typeobj.rst:318
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 ""
#: ../Doc/c-api/typeobj.rst:327
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 ""
#: ../Doc/c-api/typeobj.rst:332
msgid ""
"The signature is the same as for :c:func:`PyObject_Str`; it must return a "
"string or a Unicode object. This function should return 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 ""
#: ../Doc/c-api/typeobj.rst:337
msgid ""
"When this field is not set, :c:func:`PyObject_Repr` is called to return a "
"string representation."
msgstr ""
#: ../Doc/c-api/typeobj.rst:345
msgid "An optional pointer to the get-attribute function."
msgstr ""
#: ../Doc/c-api/typeobj.rst:347
msgid ""
"The signature is the same as for :c:func:`PyObject_GetAttr`. It is usually "
"convenient to set this field to :c:func:`PyObject_GenericGetAttr`, which "
"implements the normal way of looking for object attributes."
msgstr ""
#: ../Doc/c-api/typeobj.rst:351
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 ""
#: ../Doc/c-api/typeobj.rst:360
msgid ""
"The signature is the same as for :c:func:`PyObject_SetAttr`, but setting *v* "
"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 ""
#: ../Doc/c-api/typeobj.rst:365
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 ""
#: ../Doc/c-api/typeobj.rst:372
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 ""
#: ../Doc/c-api/typeobj.rst:376
msgid ""
"The :c:member:`~PyTypeObject.tp_as_buffer` field is not inherited, but the "
"contained fields are inherited individually."
msgstr ""
#: ../Doc/c-api/typeobj.rst:382
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 ""
#: ../Doc/c-api/typeobj.rst:390
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 :const:`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 :const:"
"`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 ""
#: ../Doc/c-api/typeobj.rst:401
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 ""
#: ../Doc/c-api/typeobj.rst:409
msgid ""
"This bit is set when the type object itself is allocated on the heap. In "
"this case, the :attr:`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)."
msgstr ""
#: ../Doc/c-api/typeobj.rst:419
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 ""
#: ../Doc/c-api/typeobj.rst:426
msgid ""
"This bit is set when the type object has been fully initialized by :c:func:"
"`PyType_Ready`."
msgstr ""
#: ../Doc/c-api/typeobj.rst:432
msgid ""
"This bit is set while :c:func:`PyType_Ready` is in the process of "
"initializing the type object."
msgstr ""
#: ../Doc/c-api/typeobj.rst:438
msgid ""
"This bit is set when the object supports garbage collection. If this bit is "
"set, instances must be created using :c:func:`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 ""
#: ../Doc/c-api/typeobj.rst:448
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: :const:`Py_TPFLAGS_HAVE_STACKLESS_EXTENSION`, :"
"const:`Py_TPFLAGS_HAVE_VERSION_TAG`."
msgstr ""
#: ../Doc/c-api/typeobj.rst:463
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 ""
#: ../Doc/c-api/typeobj.rst:474
msgid ""
"This bit is set when the :c:member:`~PyTypeObject.tp_finalize` slot is "
"present in the type structure."
msgstr ""
#: ../Doc/c-api/typeobj.rst:482
msgid ""
"An optional pointer to a NUL-terminated C string giving the docstring for "
"this type object. This is exposed as the :attr:`__doc__` attribute on the "
"type and instances of the type."
msgstr ""
#: ../Doc/c-api/typeobj.rst:486
msgid "This field is *not* inherited by subtypes."
msgstr ""
#: ../Doc/c-api/typeobj.rst:491
msgid ""
"An optional pointer to a traversal function for the garbage collector. This "
"is only used if the :const:`Py_TPFLAGS_HAVE_GC` flag bit is set. More "
"information about Python's garbage collection scheme can be found in "
"section :ref:`supporting-cycle-detection`."
msgstr ""
#: ../Doc/c-api/typeobj.rst:496
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. For example, "
"this is function :c:func:`local_traverse` from the :mod:`_thread` extension "
"module::"
msgstr ""
#: ../Doc/c-api/typeobj.rst:511
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 ""
#: ../Doc/c-api/typeobj.rst:515
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 ""
#: ../Doc/c-api/typeobj.rst:519
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 ""
#: ../Doc/c-api/typeobj.rst:523
msgid ""
"This field is inherited by subtypes together with :c:member:`~PyTypeObject."
"tp_clear` and the :const:`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 ""
#: ../Doc/c-api/typeobj.rst:531
msgid ""
"An optional pointer to a clear function for the garbage collector. This is "
"only used if the :const:`Py_TPFLAGS_HAVE_GC` flag bit is set."
msgstr ""
#: ../Doc/c-api/typeobj.rst:534
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 ""
#: ../Doc/c-api/typeobj.rst:544
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 ""
#: ../Doc/c-api/typeobj.rst:558
msgid ""
"The :c:func:`Py_CLEAR` macro should be used, because clearing references is "
"delicate: the reference to the contained object must not be decremented "
"until after the pointer to the contained object is set to *NULL*. This is "
"because decrementing the reference count 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 ""
#: ../Doc/c-api/typeobj.rst:569
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 ""
#: ../Doc/c-api/typeobj.rst:575
msgid ""
"More information about Python's garbage collection scheme can be found in "
"section :ref:`supporting-cycle-detection`."
msgstr ""
#: ../Doc/c-api/typeobj.rst:578
msgid ""
"This field is inherited by subtypes together with :c:member:`~PyTypeObject."
"tp_traverse` and the :const:`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 ""
#: ../Doc/c-api/typeobj.rst:586
msgid ""
"An optional pointer to the rich comparison function, whose signature is "
"``PyObject *tp_richcompare(PyObject *a, PyObject *b, int op)``. The first "
"parameter is guaranteed to be an instance of the type that is defined by :c:"
"type:`PyTypeObject`."
msgstr ""
#: ../Doc/c-api/typeobj.rst:591
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 ""
#: ../Doc/c-api/typeobj.rst:598
msgid ""
"If you want to implement a type for which only a limited set of comparisons "
"makes sense (e.g. ``==`` and ``!=``, but not ``<`` and friends), directly "
"raise :exc:`TypeError` in the rich comparison function."
msgstr ""
#: ../Doc/c-api/typeobj.rst:602
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 ""
#: ../Doc/c-api/typeobj.rst:607
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 ""
#: ../Doc/c-api/typeobj.rst:611
msgid "Constant"
msgstr "Constante"
#: ../Doc/c-api/typeobj.rst:611
msgid "Comparison"
msgstr "Comparaison"
#: ../Doc/c-api/typeobj.rst:613
msgid ":const:`Py_LT`"
msgstr ""
#: ../Doc/c-api/typeobj.rst:613
msgid "``<``"
msgstr "``<``"
#: ../Doc/c-api/typeobj.rst:615
msgid ":const:`Py_LE`"
msgstr ""
#: ../Doc/c-api/typeobj.rst:615
msgid "``<=``"
msgstr "``<=``"
#: ../Doc/c-api/typeobj.rst:617
msgid ":const:`Py_EQ`"
msgstr ""
#: ../Doc/c-api/typeobj.rst:617
msgid "``==``"
msgstr "``==``"
#: ../Doc/c-api/typeobj.rst:619
msgid ":const:`Py_NE`"
msgstr ""
#: ../Doc/c-api/typeobj.rst:619
msgid "``!=``"
msgstr "``!=``"
#: ../Doc/c-api/typeobj.rst:621
msgid ":const:`Py_GT`"
msgstr ""
#: ../Doc/c-api/typeobj.rst:621
msgid "``>``"
msgstr "``>``"
#: ../Doc/c-api/typeobj.rst:623
msgid ":const:`Py_GE`"
msgstr ""
#: ../Doc/c-api/typeobj.rst:623
msgid "``>=``"
msgstr "``>=``"
#: ../Doc/c-api/typeobj.rst:626
msgid ""
"The following macro is defined to ease writing rich comparison functions:"
msgstr ""
#: ../Doc/c-api/typeobj.rst:630
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 ""
#: ../Doc/c-api/typeobj.rst:636
msgid "The return value's reference count is properly incremented."
msgstr ""
#: ../Doc/c-api/typeobj.rst:638
msgid "On error, sets an exception and returns NULL from the function."
msgstr ""
#: ../Doc/c-api/typeobj.rst:645
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 :c:func:`PyWeakref_\\*` "
"functions. The instance structure needs to include a field of type :c:type:"
"`PyObject\\*` which is initialized to *NULL*."
msgstr ""
#: ../Doc/c-api/typeobj.rst:652
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 ""
#: ../Doc/c-api/typeobj.rst:655
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 ""
#: ../Doc/c-api/typeobj.rst:660
msgid ""
"When a type defined by a class statement has no :attr:`~object.__slots__` "
"declaration, and none of its base types are weakly referenceable, the type "
"is made weakly referenceable by adding a weak reference list head slot to "
"the instance layout and setting the :c:member:`~PyTypeObject."
"tp_weaklistoffset` of that slot's offset."
msgstr ""
#: ../Doc/c-api/typeobj.rst:665
msgid ""
"When a type's :attr:`__slots__` declaration contains a slot named :attr:"
"`__weakref__`, that slot becomes the weak reference list head for instances "
"of the type, and the slot's offset is stored in the type's :c:member:"
"`~PyTypeObject.tp_weaklistoffset`."
msgstr ""
#: ../Doc/c-api/typeobj.rst:670
msgid ""
"When a type's :attr:`__slots__` declaration does not contain a slot named :"
"attr:`__weakref__`, the type inherits its :c:member:`~PyTypeObject."
"tp_weaklistoffset` from its base type."
msgstr ""
#: ../Doc/c-api/typeobj.rst:676
msgid ""
"An optional pointer to a function that returns an iterator for the object. "
"Its presence normally signals that the instances of this type are iterable "
"(although sequences may be iterable without this function)."
msgstr ""
#: ../Doc/c-api/typeobj.rst:680
msgid "This function has the same signature as :c:func:`PyObject_GetIter`."
msgstr ""
#: ../Doc/c-api/typeobj.rst:687
msgid ""
"An optional pointer to a function that returns the next item in an iterator. "
"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 ""
#: ../Doc/c-api/typeobj.rst:693
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 ""
#: ../Doc/c-api/typeobj.rst:697
msgid "This function has the same signature as :c:func:`PyIter_Next`."
msgstr ""
#: ../Doc/c-api/typeobj.rst:704
msgid ""
"An optional pointer to a static *NULL*-terminated array of :c:type:"
"`PyMethodDef` structures, declaring regular methods of this type."
msgstr ""
#: ../Doc/c-api/typeobj.rst:707
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 ""
#: ../Doc/c-api/typeobj.rst:710
msgid ""
"This field is not inherited by subtypes (methods are inherited through a "
"different mechanism)."
msgstr ""
#: ../Doc/c-api/typeobj.rst:716
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 ""
#: ../Doc/c-api/typeobj.rst:720
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 ""
#: ../Doc/c-api/typeobj.rst:723
msgid ""
"This field is not inherited by subtypes (members are inherited through a "
"different mechanism)."
msgstr ""
#: ../Doc/c-api/typeobj.rst:729
msgid ""
"An optional pointer to a static *NULL*-terminated array of :c:type:"
"`PyGetSetDef` structures, declaring computed attributes of instances of this "
"type."
msgstr ""
#: ../Doc/c-api/typeobj.rst:732
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 ""
#: ../Doc/c-api/typeobj.rst:735
msgid ""
"This field is not inherited by subtypes (computed attributes are inherited "
"through a different mechanism)."
msgstr ""
#: ../Doc/c-api/typeobj.rst:741
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 ""
#: ../Doc/c-api/typeobj.rst:745
msgid ""
"This field is not inherited by subtypes (obviously), but it defaults to "
"``&PyBaseObject_Type`` (which to Python programmers is known as the type :"
"class:`object`)."
msgstr ""
#: ../Doc/c-api/typeobj.rst:752
msgid "The type's dictionary is stored here by :c:func:`PyType_Ready`."
msgstr ""
#: ../Doc/c-api/typeobj.rst:754
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:`__add__`)."
msgstr ""
#: ../Doc/c-api/typeobj.rst:760
msgid ""
"This field is not inherited by subtypes (though the attributes defined in "
"here are inherited through a different mechanism)."
msgstr ""
#: ../Doc/c-api/typeobj.rst:765
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 ""
#: ../Doc/c-api/typeobj.rst:771
msgid "An optional pointer to a \"descriptor get\" function."
msgstr ""
#: ../Doc/c-api/typeobj.rst:773 ../Doc/c-api/typeobj.rst:787
#: ../Doc/c-api/typeobj.rst:859 ../Doc/c-api/typeobj.rst:881
#: ../Doc/c-api/typeobj.rst:912
msgid "The function signature is ::"
msgstr ""
#: ../Doc/c-api/typeobj.rst:784
msgid ""
"An optional pointer to a function for setting and deleting a descriptor's "
"value."
msgstr ""
#: ../Doc/c-api/typeobj.rst:791
msgid ""
"The *value* argument is set to *NULL* to delete the value. This field is "
"inherited by subtypes."
msgstr ""
#: ../Doc/c-api/typeobj.rst:799
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 ""
#: ../Doc/c-api/typeobj.rst:804
msgid ""
"Do not confuse this field with :c:member:`~PyTypeObject.tp_dict`; that is "
"the dictionary for attributes of the type object itself."
msgstr ""
#: ../Doc/c-api/typeobj.rst:807
msgid ""
"If the value of this field is greater than zero, it specifies the offset "
"from the start of the instance structure. If the value is less than zero, "
"it specifies the offset from the *end* of the instance structure. A "
"negative offset is more expensive to use, and should only be used when the "
"instance structure contains a variable-length part. This is used for "
"example to add an instance variable dictionary to subtypes of :class:`str` "
"or :class:`tuple`. Note that the :c:member:`~PyTypeObject.tp_basicsize` "
"field should account for the dictionary added to the end in that case, even "
"though the dictionary is not included in the basic object layout. On a "
"system with a pointer size of 4 bytes, :c:member:`~PyTypeObject."
"tp_dictoffset` should be set to ``-4`` to indicate that the dictionary is at "
"the very end of the structure."
msgstr ""
#: ../Doc/c-api/typeobj.rst:819
msgid ""
"The real dictionary offset in an instance can be computed from a negative :c:"
"member:`~PyTypeObject.tp_dictoffset` as follows::"
msgstr ""
#: ../Doc/c-api/typeobj.rst:826
msgid ""
"where :c:member:`~PyTypeObject.tp_basicsize`, :c:member:`~PyTypeObject."
"tp_itemsize` and :c:member:`~PyTypeObject.tp_dictoffset` are taken from the "
"type object, and :attr:`ob_size` is taken from the instance. The absolute "
"value is taken because ints use the sign of :attr:`ob_size` to store the "
"sign of the number. (There's never a need to do this calculation yourself; "
"it is done for you by :c:func:`_PyObject_GetDictPtr`.)"
msgstr ""
#: ../Doc/c-api/typeobj.rst:832
msgid ""
"This field is inherited by subtypes, but see the rules listed below. A "
"subtype may override this offset; this means that the subtype instances "
"store the dictionary at a difference offset than the base type. Since the "
"dictionary is always found via :c:member:`~PyTypeObject.tp_dictoffset`, this "
"should not be a problem."
msgstr ""
#: ../Doc/c-api/typeobj.rst:837
msgid ""
"When a type defined by a class statement has no :attr:`~object.__slots__` "
"declaration, and none of its base types has an instance variable dictionary, "
"a dictionary slot is added to the instance layout and the :c:member:"
"`~PyTypeObject.tp_dictoffset` is set to that slot's offset."
msgstr ""
#: ../Doc/c-api/typeobj.rst:842
msgid ""
"When a type defined by a class statement has a :attr:`__slots__` "
"declaration, the type inherits its :c:member:`~PyTypeObject.tp_dictoffset` "
"from its base type."
msgstr ""
#: ../Doc/c-api/typeobj.rst:845
msgid ""
"(Adding a slot named :attr:`~object.__dict__` to the :attr:`__slots__` "
"declaration does not have the expected effect, it just causes confusion. "
"Maybe this should be added as a feature just like :attr:`__weakref__` "
"though.)"
msgstr ""
#: ../Doc/c-api/typeobj.rst:852
msgid "An optional pointer to an instance initialization function."
msgstr ""
#: ../Doc/c-api/typeobj.rst:854
msgid ""
"This function corresponds to the :meth:`__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 ""
#: ../Doc/c-api/typeobj.rst:863
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:"
"`__init__`."
msgstr ""
#: ../Doc/c-api/typeobj.rst:867
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 ""
#: ../Doc/c-api/typeobj.rst:879
msgid "An optional pointer to an instance allocation function."
msgstr ""
#: ../Doc/c-api/typeobj.rst:885
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 :attr:`ob_refcnt` set to ``1`` and :attr:`ob_type` set to the type "
"argument. If the type's :c:member:`~PyTypeObject.tp_itemsize` is non-zero, "
"the object's :attr:`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 ""
#: ../Doc/c-api/typeobj.rst:895
msgid ""
"Do not use this function to do any other instance initialization, not even "
"to allocate additional memory; that should be done by :c:member:"
"`~PyTypeObject.tp_new`."
msgstr ""
#: ../Doc/c-api/typeobj.rst:898
msgid ""
"This field is inherited by static subtypes, but not by dynamic subtypes "
"(subtypes created by a class statement); in the latter, this field is always "
"set to :c:func:`PyType_GenericAlloc`, to force a standard heap allocation "
"strategy. That is also the recommended value for statically defined types."
msgstr ""
#: ../Doc/c-api/typeobj.rst:906
msgid "An optional pointer to an instance creation function."
msgstr ""
#: ../Doc/c-api/typeobj.rst:908
msgid ""
"If this function is *NULL* for a particular type, that type cannot be called "
"to create new instances; presumably there is some other way to create "
"instances, like a factory function."
msgstr ""
#: ../Doc/c-api/typeobj.rst:916
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 ""
#: ../Doc/c-api/typeobj.rst:922
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 ""
#: ../Doc/c-api/typeobj.rst:930
msgid ""
"This field is inherited by subtypes, except it is not inherited by static "
"types whose :c:member:`~PyTypeObject.tp_base` is *NULL* or "
"``&PyBaseObject_Type``."
msgstr ""
#: ../Doc/c-api/typeobj.rst:936
msgid ""
"An optional pointer to an instance deallocation function. Its signature is :"
"c:type:`freefunc`::"
msgstr ""
#: ../Doc/c-api/typeobj.rst:941
msgid ""
"An initializer that is compatible with this signature is :c:func:"
"`PyObject_Free`."
msgstr ""
#: ../Doc/c-api/typeobj.rst:943
msgid ""
"This field is inherited by static subtypes, but not by dynamic subtypes "
"(subtypes created by a class statement); in the latter, this field is set to "
"a deallocator suitable to match :c:func:`PyType_GenericAlloc` and the value "
"of the :const:`Py_TPFLAGS_HAVE_GC` flag bit."
msgstr ""
#: ../Doc/c-api/typeobj.rst:951
msgid "An optional pointer to a function called by the garbage collector."
msgstr ""
#: ../Doc/c-api/typeobj.rst:953
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 :const:"
"`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 ""
#: ../Doc/c-api/typeobj.rst:963
msgid ""
"(The only example of this are types themselves. The metatype, :c:data:"
"`PyType_Type`, defines this function to distinguish between statically and "
"dynamically allocated types.)"
msgstr ""
#: ../Doc/c-api/typeobj.rst:972
msgid "Tuple of base types."
msgstr ""
#: ../Doc/c-api/typeobj.rst:974
msgid ""
"This is set for types created by a class statement. It should be *NULL* for "
"statically defined types."
msgstr ""
#: ../Doc/c-api/typeobj.rst:977
msgid "This field is not inherited."
msgstr ""
#: ../Doc/c-api/typeobj.rst:982
msgid ""
"Tuple containing the expanded set of base types, starting with the type "
"itself and ending with :class:`object`, in Method Resolution Order."
msgstr ""
#: ../Doc/c-api/typeobj.rst:985
msgid ""
"This field is not inherited; it is calculated fresh by :c:func:"
"`PyType_Ready`."
msgstr ""
#: ../Doc/c-api/typeobj.rst:990
msgid ""
"An optional pointer to an instance finalization function. Its signature is :"
"c:type:`destructor`::"
msgstr ""
#: ../Doc/c-api/typeobj.rst:995
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 ""
#: ../Doc/c-api/typeobj.rst:1002
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 ""
#: ../Doc/c-api/typeobj.rst:1019
msgid ""
"For this field to be taken into account (even through inheritance), you must "
"also set the :const:`Py_TPFLAGS_HAVE_FINALIZE` flags bit."
msgstr ""
#: ../Doc/c-api/typeobj.rst:1026
msgid "\"Safe object finalization\" (:pep:`442`)"
msgstr ""
#: ../Doc/c-api/typeobj.rst:1031
msgid "Unused. Not inherited. Internal use only."
msgstr ""
#: ../Doc/c-api/typeobj.rst:1036
msgid ""
"List of weak references to subclasses. Not inherited. Internal use only."
msgstr ""
#: ../Doc/c-api/typeobj.rst:1041
msgid ""
"Weak reference list head, for weak references to this type object. Not "
"inherited. Internal use only."
msgstr ""
#: ../Doc/c-api/typeobj.rst:1044
msgid ""
"The remaining fields are only defined if the feature test macro :const:"
"`COUNT_ALLOCS` is defined, and are for internal use only. They are "
"documented here for completeness. None of these fields are inherited by "
"subtypes."
msgstr ""
#: ../Doc/c-api/typeobj.rst:1052
msgid "Number of allocations."
msgstr ""
#: ../Doc/c-api/typeobj.rst:1057
msgid "Number of frees."
msgstr ""
#: ../Doc/c-api/typeobj.rst:1062
msgid "Maximum simultaneously allocated objects."
msgstr ""
#: ../Doc/c-api/typeobj.rst:1067
msgid ""
"Pointer to the next type object with a non-zero :c:member:`~PyTypeObject."
"tp_allocs` field."
msgstr ""
#: ../Doc/c-api/typeobj.rst:1069
msgid ""
"Also, note that, in a garbage collected Python, 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 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 tp_dealloc "
"will not violate any assumptions of the library."
msgstr ""
#: ../Doc/c-api/typeobj.rst:1083
msgid "Number Object Structures"
msgstr ""
#: ../Doc/c-api/typeobj.rst:1090
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 ""
#: ../Doc/c-api/typeobj.rst:1094 ../Doc/c-api/typeobj.rst:1381
msgid "Here is the structure definition::"
msgstr ""
#: ../Doc/c-api/typeobj.rst:1141
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 ""
#: ../Doc/c-api/typeobj.rst:1150
msgid ""
"The :c:data:`nb_reserved` field should always be ``NULL``. It was "
"previously called :c:data:`nb_long`, and was renamed in Python 3.0.1."
msgstr ""
#: ../Doc/c-api/typeobj.rst:1158
msgid "Mapping Object Structures"
msgstr ""
#: ../Doc/c-api/typeobj.rst:1165
msgid ""
"This structure holds pointers to the functions which an object uses to "
"implement the mapping protocol. It has three members:"
msgstr ""
#: ../Doc/c-api/typeobj.rst:1170
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 ""
#: ../Doc/c-api/typeobj.rst:1176
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 ""
#: ../Doc/c-api/typeobj.rst:1184
msgid ""
"This function is used by :c:func:`PyObject_SetItem`, :c:func:"
"`PyObject_DelItem`, :c:func:`PyObject_SetSlice` and :c:func:"
"`PyObject_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 ""
#: ../Doc/c-api/typeobj.rst:1195
msgid "Sequence Object Structures"
msgstr ""
#: ../Doc/c-api/typeobj.rst:1202
msgid ""
"This structure holds pointers to the functions which an object uses to "
"implement the sequence protocol."
msgstr ""
#: ../Doc/c-api/typeobj.rst:1207
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 ""
#: ../Doc/c-api/typeobj.rst:1214
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 ""
#: ../Doc/c-api/typeobj.rst:1220
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 ""
#: ../Doc/c-api/typeobj.rst:1226
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 ""
#: ../Doc/c-api/typeobj.rst:1232
msgid ""
"Negative indexes are handled as follows: if the :attr:`sq_length` slot is "
"filled, it is called and the sequence length is used to compute a positive "
"index which is passed to :attr:`sq_item`. If :attr:`sq_length` is *NULL*, "
"the index is passed as is to the function."
msgstr ""
#: ../Doc/c-api/typeobj.rst:1239
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 ""
#: ../Doc/c-api/typeobj.rst:1248
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 ""
#: ../Doc/c-api/typeobj.rst:1255
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 inplace addition via the :c:member:"
"`~PyNumberMethods.nb_inplace_add` slot."
msgstr ""
#: ../Doc/c-api/typeobj.rst:1264
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 inplace multiplication via the :c:"
"member:`~PyNumberMethods.nb_inplace_multiply` slot."
msgstr ""
#: ../Doc/c-api/typeobj.rst:1275
msgid "Buffer Object Structures"
msgstr ""
#: ../Doc/c-api/typeobj.rst:1283
msgid ""
"This structure holds pointers to the functions required by the :ref:`Buffer "
"protocol <bufferobjects>`. The protocol defines how an exporter object can "
"expose its internal data to consumer objects."
msgstr ""
#: ../Doc/c-api/typeobj.rst:1289 ../Doc/c-api/typeobj.rst:1338
#: ../Doc/c-api/typeobj.rst:1391 ../Doc/c-api/typeobj.rst:1402
#: ../Doc/c-api/typeobj.rst:1413
msgid "The signature of this function is::"
msgstr ""
#: ../Doc/c-api/typeobj.rst:1293
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 ""
#: ../Doc/c-api/typeobj.rst:1297
msgid ""
"Check if the request can be met. If not, raise :c:data:`PyExc_BufferError`, "
"set :c:data:`view->obj` to *NULL* and return ``-1``."
msgstr ""
#: ../Doc/c-api/typeobj.rst:1300
msgid "Fill in the requested fields."
msgstr ""
#: ../Doc/c-api/typeobj.rst:1302
msgid "Increment an internal counter for the number of exports."
msgstr ""
#: ../Doc/c-api/typeobj.rst:1304
msgid ""
"Set :c:data:`view->obj` to *exporter* and increment :c:data:`view->obj`."
msgstr ""
#: ../Doc/c-api/typeobj.rst:1306
msgid "Return ``0``."
msgstr ""
#: ../Doc/c-api/typeobj.rst:1308
msgid ""
"If *exporter* is part of a chain or tree of buffer providers, two main "
"schemes can be used:"
msgstr ""
#: ../Doc/c-api/typeobj.rst:1311
msgid ""
"Re-export: Each member of the tree acts as the exporting object and sets :c:"
"data:`view->obj` to a new reference to itself."
msgstr ""
#: ../Doc/c-api/typeobj.rst:1314
msgid ""
"Redirect: The buffer request is redirected to the root object of the tree. "
"Here, :c:data:`view->obj` will be a new reference to the root object."
msgstr ""
#: ../Doc/c-api/typeobj.rst:1318
msgid ""
"The individual fields of *view* are described in section :ref:`Buffer "
"structure <buffer-structure>`, the rules how an exporter must react to "
"specific requests are in section :ref:`Buffer request types <buffer-request-"
"types>`."
msgstr ""
#: ../Doc/c-api/typeobj.rst:1323
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 ""
#: ../Doc/c-api/typeobj.rst:1330
msgid ""
":c:func:`PyBuffer_FillInfo` provides an easy way of exposing a simple bytes "
"buffer while dealing correctly with all request types."
msgstr ""
#: ../Doc/c-api/typeobj.rst:1333
msgid ""
":c:func:`PyObject_GetBuffer` is the interface for the consumer that wraps "
"this function."
msgstr ""
#: ../Doc/c-api/typeobj.rst:1342
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 ""
#: ../Doc/c-api/typeobj.rst:1347
msgid "Decrement an internal counter for the number of exports."
msgstr ""
#: ../Doc/c-api/typeobj.rst:1349
msgid "If the counter is ``0``, free all memory associated with *view*."
msgstr ""
#: ../Doc/c-api/typeobj.rst:1351
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 ""
#: ../Doc/c-api/typeobj.rst:1357
msgid ""
"This function MUST NOT decrement :c:data:`view->obj`, since that is done "
"automatically in :c:func:`PyBuffer_Release` (this scheme is useful for "
"breaking reference cycles)."
msgstr ""
#: ../Doc/c-api/typeobj.rst:1362
msgid ""
":c:func:`PyBuffer_Release` is the interface for the consumer that wraps this "
"function."
msgstr ""
#: ../Doc/c-api/typeobj.rst:1370
msgid "Async Object Structures"
msgstr ""
#: ../Doc/c-api/typeobj.rst:1378
msgid ""
"This structure holds pointers to the functions required to implement :term:"
"`awaitable` and :term:`asynchronous iterator` objects."
msgstr ""
#: ../Doc/c-api/typeobj.rst:1395
msgid ""
"The returned object must be an iterator, i.e. :c:func:`PyIter_Check` must "
"return ``1`` for it."
msgstr ""
#: ../Doc/c-api/typeobj.rst:1398
msgid ""
"This slot may be set to *NULL* if an object is not an :term:`awaitable`."
msgstr ""
#: ../Doc/c-api/typeobj.rst:1406
msgid ""
"Must return an :term:`awaitable` object. See :meth:`__anext__` for details."
msgstr ""
#: ../Doc/c-api/typeobj.rst:1408
msgid ""
"This slot may be set to *NULL* if an object does not implement asynchronous "
"iteration protocol."
msgstr ""
#: ../Doc/c-api/typeobj.rst:1417
msgid ""
"Must return an :term:`awaitable` object. See :meth:`__anext__` for details. "
"This slot may be set to *NULL*."
msgstr ""