This instance of PyTypeObject
represents the Python tuple type; it
is the same object as tuple
in the Python layer.
Return true if p is a tuple object or an instance of a subtype of the tuple type. This function always succeeds.
Return true if p is a tuple object, but not an instance of a subtype of the tuple type. This function always succeeds.
Return a new tuple object of size len,
or NULL
with an exception set on failure.
Return a new tuple object of size n,
or NULL
with an exception set on failure. The tuple values
are initialized to the subsequent n C arguments pointing to Python objects.
PyTuple_Pack(2, a, b)
is equivalent to Py_BuildValue("(OO)", a, b)
.
Take a pointer to a tuple object, and return the size of that tuple.
On error, return -1
and with an exception set.
Like PyTuple_Size()
, but without error checking.
Return the object at position pos in the tuple pointed to by p. If pos is
negative or out of bounds, return NULL
and set an IndexError
exception.
The returned reference is borrowed from the tuple p
(that is: it is only valid as long as you hold a reference to p).
To get a strong reference, use
Py_NewRef(PyTuple_GetItem(...))
or PySequence_GetItem()
.
Like PyTuple_GetItem()
, but does no checking of its arguments.
Return the slice of the tuple pointed to by p between low and high,
or NULL
with an exception set on failure.
This is the equivalent of the Python expression p[low:high]
.
Indexing from the end of the tuple is not supported.
Insert a reference to object o at position pos of the tuple pointed to by
p. Return 0
on success. If pos is out of bounds, return -1
and set an IndexError
exception.
備註
This function "steals" a reference to o and discards a reference to an item already in the tuple at the affected position.
Like PyTuple_SetItem()
, but does no error checking, and should only be
used to fill in brand new tuples.
Bounds checking is performed as an assertion if Python is built in
debug mode or with assertions
.
備註
This function "steals" a reference to o, and, unlike
PyTuple_SetItem()
, does not discard a reference to any item that
is being replaced; any reference in the tuple at position pos will be
leaked.
Can be used to resize a tuple. newsize will be the new length of the tuple.
Because tuples are supposed to be immutable, this should only be used if there
is only one reference to the object. Do not use this if the tuple may already
be known to some other part of the code. The tuple will always grow or shrink
at the end. Think of this as destroying the old tuple and creating a new one,
only more efficiently. Returns 0
on success. Client code should never
assume that the resulting value of *p
will be the same as before calling
this function. If the object referenced by *p
is replaced, the original
*p
is destroyed. On failure, returns -1
and sets *p
to NULL
, and
raises MemoryError
or SystemError
.
Struct sequence objects are the C equivalent of namedtuple()
objects, i.e. a sequence whose items can also be accessed through attributes.
To create a struct sequence, you first have to create a specific struct sequence
type.
Create a new struct sequence type from the data in desc, described below. Instances
of the resulting type can be created with PyStructSequence_New()
.
失敗時回傳 NULL
並設定例外。
Initializes a struct sequence type type from desc in place.
Like PyStructSequence_InitType()
, but returns 0
on success
and -1
with an exception set on failure.
在 3.4 版被加入.
Contains the meta information of a struct sequence type to create.
Fully qualified name of the type; null-terminated UTF-8 encoded. The name must contain the module name.
Pointer to docstring for the type or NULL
to omit.
Pointer to NULL
-terminated array with field names of the new type.
Number of fields visible to the Python side (if used as tuple).
Describes a field of a struct sequence. As a struct sequence is modeled as a
tuple, all fields are typed as PyObject*. The index in the
fields
array of
the PyStructSequence_Desc
determines which
field of the struct sequence is described.
Name for the field or NULL
to end the list of named fields,
set to PyStructSequence_UnnamedField
to leave unnamed.
Field docstring or NULL
to omit.
Special value for a field name to leave it unnamed.
在 3.9 版的變更: The type was changed from char *
.
Creates an instance of type, which must have been created with
PyStructSequence_NewType()
.
失敗時回傳 NULL
並設定例外。
Return the object at position pos in the struct sequence pointed to by p.
Bounds checking is performed as an assertion if Python is built in
debug mode or with assertions
.
Alias to PyStructSequence_GetItem()
.
在 3.13 版的變更: Now implemented as an alias to PyStructSequence_GetItem()
.
Sets the field at index pos of the struct sequence p to value o. Like
PyTuple_SET_ITEM()
, this should only be used to fill in brand new
instances.
Bounds checking is performed as an assertion if Python is built in
debug mode or with assertions
.
備註
This function "steals" a reference to o.
Alias to PyStructSequence_SetItem()
.
在 3.13 版的變更: Now implemented as an alias to PyStructSequence_SetItem()
.