Skip to content
Projeler
Gruplar
Parçacıklar
Yardım
Yükleniyor...
Oturum aç / Kaydol
Gezinmeyi değiştir
C
cpython
Proje
Proje
Ayrıntılar
Etkinlik
Cycle Analytics
Depo (repository)
Depo (repository)
Dosyalar
Kayıtlar (commit)
Dallar (branch)
Etiketler
Katkıda bulunanlar
Grafik
Karşılaştır
Grafikler
Konular (issue)
0
Konular (issue)
0
Liste
Pano
Etiketler
Kilometre Taşları
Birleştirme (merge) Talepleri
0
Birleştirme (merge) Talepleri
0
CI / CD
CI / CD
İş akışları (pipeline)
İşler
Zamanlamalar
Grafikler
Paketler
Paketler
Wiki
Wiki
Parçacıklar
Parçacıklar
Üyeler
Üyeler
Collapse sidebar
Close sidebar
Etkinlik
Grafik
Grafikler
Yeni bir konu (issue) oluştur
İşler
Kayıtlar (commit)
Konu (issue) Panoları
Kenar çubuğunu aç
Batuhan Osman TASKAYA
cpython
Commits
29fafd87
Kaydet (Commit)
29fafd87
authored
Mar 01, 2006
tarafından
Martin v. Löwis
Dosyalara gözat
Seçenekler
Dosyalara Gözat
İndir
Eposta Yamaları
Sade Fark
Make documentation match the implementation.
üst
67d70eb9
Expand all
Hide whitespace changes
Inline
Side-by-side
Showing
6 changed files
with
69 additions
and
68 deletions
+69
-68
abstract.tex
Doc/api/abstract.tex
+24
-24
concrete.tex
Doc/api/concrete.tex
+0
-0
exceptions.tex
Doc/api/exceptions.tex
+6
-5
init.tex
Doc/api/init.tex
+1
-1
newtypes.tex
Doc/api/newtypes.tex
+26
-26
utilities.tex
Doc/api/utilities.tex
+12
-12
No files found.
Doc/api/abstract.tex
Dosyayı görüntüle @
29fafd87
...
...
@@ -16,7 +16,7 @@ for which they do not apply, they will raise a Python exception.
object is written instead of the
\function
{
repr()
}
.
\end{cfuncdesc}
\begin{cfuncdesc}
{
int
}{
PyObject
_
HasAttrString
}{
PyObject *o, char *attr
_
name
}
\begin{cfuncdesc}
{
int
}{
PyObject
_
HasAttrString
}{
PyObject *o, c
onst c
har *attr
_
name
}
Returns
\code
{
1
}
if
\var
{
o
}
has the attribute
\var
{
attr
_
name
}
, and
\code
{
0
}
otherwise. This is equivalent to the Python expression
\samp
{
hasattr(
\var
{
o
}
,
\var
{
attr
_
name
}
)
}
. This function always
...
...
@@ -24,7 +24,7 @@ for which they do not apply, they will raise a Python exception.
\end{cfuncdesc}
\begin{cfuncdesc}
{
PyObject*
}{
PyObject
_
GetAttrString
}{
PyObject *o,
char *attr
_
name
}
c
onst c
har *attr
_
name
}
Retrieve an attribute named
\var
{
attr
_
name
}
from object
\var
{
o
}
.
Returns the attribute value on success, or
\NULL
{}
on failure.
This is the equivalent of the Python expression
...
...
@@ -50,7 +50,7 @@ for which they do not apply, they will raise a Python exception.
\begin{cfuncdesc}
{
int
}{
PyObject
_
SetAttrString
}{
PyObject *o,
char *attr
_
name, PyObject *v
}
c
onst c
har *attr
_
name, PyObject *v
}
Set the value of the attribute named
\var
{
attr
_
name
}
, for object
\var
{
o
}
, to the value
\var
{
v
}
. Returns
\code
{
-1
}
on failure. This
is the equivalent of the Python statement
...
...
@@ -67,7 +67,7 @@ for which they do not apply, they will raise a Python exception.
\end{cfuncdesc}
\begin{cfuncdesc}
{
int
}{
PyObject
_
DelAttrString
}{
PyObject *o, char *attr
_
name
}
\begin{cfuncdesc}
{
int
}{
PyObject
_
DelAttrString
}{
PyObject *o, c
onst c
har *attr
_
name
}
Delete attribute named
\var
{
attr
_
name
}
, for object
\var
{
o
}
. Returns
\code
{
-1
}
on failure. This is the equivalent of the Python
statement:
\samp
{
del
\var
{
o
}
.
\var
{
attr
_
name
}}
.
...
...
@@ -301,7 +301,7 @@ determination.
\end{cfuncdesc}
\begin{cfuncdesc}
{
int
}{
PyObject
_
Hash
}{
PyObject *o
}
\begin{cfuncdesc}
{
long
}{
PyObject
_
Hash
}{
PyObject *o
}
Compute and return the hash value of an object
\var
{
o
}
. On failure,
return
\code
{
-1
}
. This is the equivalent of the Python expression
\samp
{
hash(
\var
{
o
}
)
}
.
\bifuncindex
{
hash
}
...
...
@@ -340,8 +340,8 @@ determination.
\versionadded
{
2.2
}
\end{cfuncdesc}
\begin{cfuncdesc}
{
in
t
}{
PyObject
_
Length
}{
PyObject *o
}
\cfuncline
{
in
t
}{
PyObject
_
Size
}{
PyObject *o
}
\begin{cfuncdesc}
{
Py
_
ssize
_
t
}{
PyObject
_
Length
}{
PyObject *o
}
\cfuncline
{
Py
_
ssize
_
t
}{
PyObject
_
Size
}{
PyObject *o
}
Return the length of object
\var
{
o
}
. If the object
\var
{
o
}
provides
either the sequence and mapping protocols, the sequence length is
returned. On error,
\code
{
-1
}
is returned. This is the equivalent
...
...
@@ -697,14 +697,14 @@ determination.
\code
{
0
}
otherwise. This function always succeeds.
\end{cfuncdesc}
\begin{cfuncdesc}
{
in
t
}{
PySequence
_
Size
}{
PyObject *o
}
\begin{cfuncdesc}
{
Py
_
ssize
_
t
}{
PySequence
_
Size
}{
PyObject *o
}
Returns the number of objects in sequence
\var
{
o
}
on success, and
\code
{
-1
}
on failure. For objects that do not provide sequence
protocol, this is equivalent to the Python expression
\samp
{
len(
\var
{
o
}
)
}
.
\bifuncindex
{
len
}
\end{cfuncdesc}
\begin{cfuncdesc}
{
in
t
}{
PySequence
_
Length
}{
PyObject *o
}
\begin{cfuncdesc}
{
Py
_
ssize
_
t
}{
PySequence
_
Length
}{
PyObject *o
}
Alternate name for
\cfunction
{
PySequence
_
Size()
}
.
\end{cfuncdesc}
...
...
@@ -715,7 +715,7 @@ determination.
\end{cfuncdesc}
\begin{cfuncdesc}
{
PyObject*
}{
PySequence
_
Repeat
}{
PyObject *o,
in
t count
}
\begin{cfuncdesc}
{
PyObject*
}{
PySequence
_
Repeat
}{
PyObject *o,
Py
_
ssize
_
t count
}
Return the result of repeating sequence object
\var
{
o
}
\var
{
count
}
times, or
\NULL
{}
on failure. This is the equivalent of the Python
expression
\samp
{
\var
{
o
}
*
\var
{
count
}}
.
...
...
@@ -730,7 +730,7 @@ determination.
\end{cfuncdesc}
\begin{cfuncdesc}
{
PyObject*
}{
PySequence
_
InPlaceRepeat
}{
PyObject *o,
in
t count
}
\begin{cfuncdesc}
{
PyObject*
}{
PySequence
_
InPlaceRepeat
}{
PyObject *o,
Py
_
ssize
_
t count
}
Return the result of repeating sequence object
\var
{
o
}
\var
{
count
}
times, or
\NULL
{}
on failure. The operation is done
\emph
{
in-place
}
when
\var
{
o
}
supports it. This is the equivalent of the Python
...
...
@@ -738,41 +738,41 @@ determination.
\end{cfuncdesc}
\begin{cfuncdesc}
{
PyObject*
}{
PySequence
_
GetItem
}{
PyObject *o,
in
t i
}
\begin{cfuncdesc}
{
PyObject*
}{
PySequence
_
GetItem
}{
PyObject *o,
Py
_
ssize
_
t i
}
Return the
\var
{
i
}
th element of
\var
{
o
}
, or
\NULL
{}
on failure.
This is the equivalent of the Python expression
\samp
{
\var
{
o
}
[
\var
{
i
}
]
}
.
\end{cfuncdesc}
\begin{cfuncdesc}
{
PyObject*
}{
PySequence
_
GetSlice
}{
PyObject *o,
int i1, in
t i2
}
\begin{cfuncdesc}
{
PyObject*
}{
PySequence
_
GetSlice
}{
PyObject *o,
Py
_
ssize
_
t i1, Py
_
ssize
_
t i2
}
Return the slice of sequence object
\var
{
o
}
between
\var
{
i1
}
and
\var
{
i2
}
, or
\NULL
{}
on failure. This is the equivalent of the
Python expression
\samp
{
\var
{
o
}
[
\var
{
i1
}
:
\var
{
i2
}
]
}
.
\end{cfuncdesc}
\begin{cfuncdesc}
{
int
}{
PySequence
_
SetItem
}{
PyObject *o,
in
t i, PyObject *v
}
\begin{cfuncdesc}
{
int
}{
PySequence
_
SetItem
}{
PyObject *o,
Py
_
ssize
_
t i, PyObject *v
}
Assign object
\var
{
v
}
to the
\var
{
i
}
th element of
\var
{
o
}
. Returns
\code
{
-1
}
on failure. This is the equivalent of the Python
statement
\samp
{
\var
{
o
}
[
\var
{
i
}
] =
\var
{
v
}}
. This function
\emph
{
does not
}
steal a reference to
\var
{
v
}
.
\end{cfuncdesc}
\begin{cfuncdesc}
{
int
}{
PySequence
_
DelItem
}{
PyObject *o,
in
t i
}
\begin{cfuncdesc}
{
int
}{
PySequence
_
DelItem
}{
PyObject *o,
Py
_
ssize
_
t i
}
Delete the
\var
{
i
}
th element of object
\var
{
o
}
. Returns
\code
{
-1
}
on failure. This is the equivalent of the Python statement
\samp
{
del
\var
{
o
}
[
\var
{
i
}
]
}
.
\end{cfuncdesc}
\begin{cfuncdesc}
{
int
}{
PySequence
_
SetSlice
}{
PyObject *o,
in
t i1,
in
t i2, PyObject *v
}
\begin{cfuncdesc}
{
int
}{
PySequence
_
SetSlice
}{
PyObject *o,
Py
_
ssize
_
t i1,
Py
_
ssize
_
t i2, PyObject *v
}
Assign the sequence object
\var
{
v
}
to the slice in sequence object
\var
{
o
}
from
\var
{
i1
}
to
\var
{
i2
}
. This is the equivalent of the
Python statement
\samp
{
\var
{
o
}
[
\var
{
i1
}
:
\var
{
i2
}
] =
\var
{
v
}}
.
\end{cfuncdesc}
\begin{cfuncdesc}
{
int
}{
PySequence
_
DelSlice
}{
PyObject *o,
int i1, in
t i2
}
\begin{cfuncdesc}
{
int
}{
PySequence
_
DelSlice
}{
PyObject *o,
Py
_
ssize
_
t i1, Py
_
ssize
_
t i2
}
Delete the slice in sequence object
\var
{
o
}
from
\var
{
i1
}
to
\var
{
i2
}
. Returns
\code
{
-1
}
on failure. This is the equivalent of
the Python statement
\samp
{
del
\var
{
o
}
[
\var
{
i1
}
:
\var
{
i2
}
]
}
.
...
...
@@ -821,7 +821,7 @@ determination.
text.
\end{cfuncdesc}
\begin{cfuncdesc}
{
PyObject*
}{
PySequence
_
Fast
_
GET
_
ITEM
}{
PyObject *o,
in
t i
}
\begin{cfuncdesc}
{
PyObject*
}{
PySequence
_
Fast
_
GET
_
ITEM
}{
PyObject *o,
Py
_
ssize
_
t i
}
Return the
\var
{
i
}
th element of
\var
{
o
}
, assuming that
\var
{
o
}
was
returned by
\cfunction
{
PySequence
_
Fast()
}
,
\var
{
o
}
is not
\NULL
,
and that
\var
{
i
}
is within bounds.
...
...
@@ -834,7 +834,7 @@ determination.
\versionadded
{
2.4
}
\end{cfuncdesc}
\begin{cfuncdesc}
{
PyObject*
}{
PySequence
_
ITEM
}{
PyObject *o,
in
t i
}
\begin{cfuncdesc}
{
PyObject*
}{
PySequence
_
ITEM
}{
PyObject *o,
Py
_
ssize
_
t i
}
Return the
\var
{
i
}
th element of
\var
{
o
}
or
\NULL
{}
on failure.
Macro form of
\cfunction
{
PySequence
_
GetItem()
}
but without checking
that
\cfunction
{
PySequence
_
Check(
\var
{
o
}
)
}
is true and without
...
...
@@ -860,7 +860,7 @@ determination.
\end{cfuncdesc}
\begin{cfuncdesc}
{
in
t
}{
PyMapping
_
Length
}{
PyObject *o
}
\begin{cfuncdesc}
{
Py
_
ssize
_
t
}{
PyMapping
_
Length
}{
PyObject *o
}
Returns the number of keys in object
\var
{
o
}
on success, and
\code
{
-1
}
on failure. For objects that do not provide mapping
protocol, this is equivalent to the Python expression
...
...
@@ -986,7 +986,7 @@ else {
\begin{cfuncdesc}
{
int
}{
PyObject
_
AsCharBuffer
}{
PyObject *obj,
const char **buffer,
in
t *buffer
_
len
}
Py
_
ssize
_
t *buffer
_
len
}
Returns a pointer to a read-only memory location useable as character-
based input. The
\var
{
obj
}
argument must support the single-segment
character buffer interface. On success, returns
\code
{
0
}
, sets
...
...
@@ -997,7 +997,7 @@ else {
\begin{cfuncdesc}
{
int
}{
PyObject
_
AsReadBuffer
}{
PyObject *obj,
const void **buffer,
in
t *buffer
_
len
}
Py
_
ssize
_
t *buffer
_
len
}
Returns a pointer to a read-only memory location containing
arbitrary data. The
\var
{
obj
}
argument must support the
single-segment readable buffer interface. On success, returns
...
...
@@ -1015,7 +1015,7 @@ else {
\begin{cfuncdesc}
{
int
}{
PyObject
_
AsWriteBuffer
}{
PyObject *obj,
void **buffer,
in
t *buffer
_
len
}
Py
_
ssize
_
t *buffer
_
len
}
Returns a pointer to a writeable memory location. The
\var
{
obj
}
argument must support the single-segment, character buffer
interface. On success, returns
\code
{
0
}
, sets
\var
{
buffer
}
to the
...
...
Doc/api/concrete.tex
Dosyayı görüntüle @
29fafd87
This diff is collapsed.
Click to expand it.
Doc/api/exceptions.tex
Dosyayı görüntüle @
29fafd87
...
...
@@ -113,7 +113,7 @@ for each thread.
exception state.
}
\end{cfuncdesc}
\begin{cfuncdesc}
{
void
}{
PyErr
_
SetString
}{
PyObject *type, char *message
}
\begin{cfuncdesc}
{
void
}{
PyErr
_
SetString
}{
PyObject *type, c
onst c
har *message
}
This is the most common way to set the error indicator. The first
argument specifies the exception type; it is normally one of the
standard exceptions, e.g.
\cdata
{
PyExc
_
RuntimeError
}
. You need not
...
...
@@ -184,7 +184,7 @@ for each thread.
\end{cfuncdesc}
\begin{cfuncdesc}
{
PyObject*
}{
PyErr
_
SetFromErrnoWithFilename
}{
PyObject *type,
char *filename
}
c
onst c
har *filename
}
Similar to
\cfunction
{
PyErr
_
SetFromErrno()
}
, with the additional
behavior that if
\var
{
filename
}
is not
\NULL
, it is passed to the
constructor of
\var
{
type
}
as a third parameter. In the case of
...
...
@@ -217,7 +217,7 @@ for each thread.
\end{cfuncdesc}
\begin{cfuncdesc}
{
PyObject*
}{
PyErr
_
SetFromWindowsErrWithFilename
}{
int ierr,
char *filename
}
c
onst c
har *filename
}
Similar to
\cfunction
{
PyErr
_
SetFromWindowsErr()
}
, with the
additional behavior that if
\var
{
filename
}
is not
\NULL
, it is
passed to the constructor of
\exception
{
WindowsError
}
as a third
...
...
@@ -275,8 +275,9 @@ for each thread.
command line documentation. There is no C API for warning control.
\end{cfuncdesc}
\begin{cfuncdesc}
{
int
}{
PyErr
_
WarnExplicit
}{
PyObject *category, char *message,
char *filename, int lineno, char *module, PyObject *registry
}
\begin{cfuncdesc}
{
int
}{
PyErr
_
WarnExplicit
}{
PyObject *category,
const char *message, const char *filename, int lineno,
const char *module, PyObject *registry
}
Issue a warning message with explicit control over all warning
attributes. This is a straightforward wrapper around the Python
function
\function
{
warnings.warn
_
explicit()
}
, see there for more
...
...
Doc/api/init.tex
Dosyayı görüntüle @
29fafd87
...
...
@@ -331,7 +331,7 @@
\withsubitem
{
(in module sys)
}{
\ttindex
{
version
}}
\end{cfuncdesc}
\begin{cfuncdesc}
{
int
}{
PySys
_
SetArgv
}{
int argc, char **argv
}
\begin{cfuncdesc}
{
void
}{
PySys
_
SetArgv
}{
int argc, char **argv
}
Set
\code
{
sys.argv
}
based on
\var
{
argc
}
and
\var
{
argv
}
. These
parameters are similar to those passed to the program's
\cfunction
{
main()
}
\ttindex
{
main()
}
function with the difference that
...
...
Doc/api/newtypes.tex
Dosyayı görüntüle @
29fafd87
...
...
@@ -11,7 +11,7 @@ defining new object types.
\begin{cfuncdesc}
{
PyObject*
}{_
PyObject
_
New
}{
PyTypeObject *type
}
\end{cfuncdesc}
\begin{cfuncdesc}
{
PyVarObject*
}{_
PyObject
_
NewVar
}{
PyTypeObject *type,
in
t size
}
\begin{cfuncdesc}
{
PyVarObject*
}{_
PyObject
_
NewVar
}{
PyTypeObject *type,
Py
_
ssize
_
t size
}
\end{cfuncdesc}
\begin{cfuncdesc}
{
void
}{_
PyObject
_
Del
}{
PyObject *op
}
...
...
@@ -27,7 +27,7 @@ defining new object types.
\end{cfuncdesc}
\begin{cfuncdesc}
{
PyVarObject*
}{
PyObject
_
InitVar
}{
PyVarObject *op,
PyTypeObject *type,
in
t size
}
PyTypeObject *type,
Py
_
ssize
_
t size
}
This does everything
\cfunction
{
PyObject
_
Init()
}
does, and also
initializes the length information for a variable-size object.
\end{cfuncdesc}
...
...
@@ -42,7 +42,7 @@ defining new object types.
\end{cfuncdesc}
\begin{cfuncdesc}
{
\var
{
TYPE
}
*
}{
PyObject
_
NewVar
}{
TYPE, PyTypeObject *type,
in
t size
}
Py
_
ssize
_
t size
}
Allocate a new Python object using the C structure type
\var
{
TYPE
}
and the Python type object
\var
{
type
}
. Fields not defined by the
Python object header are not initialized. The allocated memory
...
...
@@ -69,7 +69,7 @@ defining new object types.
\end{cfuncdesc}
\begin{cfuncdesc}
{
\var
{
TYPE
}
*
}{
PyObject
_
NEW
_
VAR
}{
TYPE, PyTypeObject *type,
in
t size
}
Py
_
ssize
_
t size
}
Macro version of
\cfunction
{
PyObject
_
NewVar()
}
, to gain performance
at the expense of safety. This does not check
\var
{
type
}
for a
\NULL
{}
value.
...
...
@@ -170,13 +170,13 @@ These macros are used in the definition of \ctype{PyObject} and
\csimplemacro
{
Py
_
TRACE
_
REFS
}
. By default, that macro is not
defined, and
\csimplemacro
{
PyObject
_
HEAD
}
expands to:
\begin{verbatim}
in
t ob
_
refcnt;
Py
_
ssize
_
t ob
_
refcnt;
PyTypeObject *ob
_
type;
\end{verbatim}
When
\csimplemacro
{
Py
_
TRACE
_
REFS
}
is defined, it expands to:
\begin{verbatim}
PyObject *
_
ob
_
next, *
_
ob
_
prev;
in
t ob
_
refcnt;
Py
_
ssize
_
t ob
_
refcnt;
PyTypeObject *ob
_
type;
\end{verbatim}
\end{csimplemacrodesc}
...
...
@@ -383,7 +383,7 @@ objects) \emph{must} have the \member{ob_size} field.
These fields are not inherited by subtypes.
\end{cmemberdesc}
\begin{cmemberdesc}
{
PyObject
}{
in
t
}{
ob
_
refcnt
}
\begin{cmemberdesc}
{
PyObject
}{
Py
_
ssize
_
t
}{
ob
_
refcnt
}
This is the type object's reference count, initialized to
\code
{
1
}
by the
\code
{
PyObject
_
HEAD
_
INIT
}
macro. Note that for statically
allocated type objects, the type's instances (objects whose
...
...
@@ -421,7 +421,7 @@ Foo_Type.ob_type = &PyType_Type;
and in 2.3 and beyond, it is inherited by subtypes.
\end{cmemberdesc}
\begin{cmemberdesc}
{
PyVarObject
}{
in
t
}{
ob
_
size
}
\begin{cmemberdesc}
{
PyVarObject
}{
Py
_
ssize
_
t
}{
ob
_
size
}
For statically allocated type objects, this should be initialized
to zero. For dynamically allocated type objects, this field has a
special internal meaning.
...
...
@@ -457,8 +457,8 @@ Foo_Type.ob_type = &PyType_Type;
This field is not inherited by subtypes.
\end{cmemberdesc}
\begin{cmemberdesc}
{
PyTypeObject
}{
in
t
}{
tp
_
basicsize
}
\cmemberline
{
PyTypeObject
}{
in
t
}{
tp
_
itemsize
}
\begin{cmemberdesc}
{
PyTypeObject
}{
Py
_
ssize
_
t
}{
tp
_
basicsize
}
\cmemberline
{
PyTypeObject
}{
Py
_
ssize
_
t
}{
tp
_
itemsize
}
These fields allow calculating the size in bytes of instances of
the type.
...
...
@@ -1234,7 +1234,7 @@ int tp_init(PyObject *self, PyObject *args, PyObject *kwds)
The function signature is
\begin{verbatim}
PyObject *tp
_
alloc(PyTypeObject *self,
in
t nitems)
PyObject *tp
_
alloc(PyTypeObject *self,
Py
_
ssize
_
t nitems)
\end{verbatim}
The purpose of this function is to separate memory allocation from
...
...
@@ -1386,15 +1386,15 @@ The remaining fields are only defined if the feature test macro
They are documented here for completeness. None of these fields are
inherited by subtypes.
\begin{cmemberdesc}
{
PyTypeObject
}{
in
t
}{
tp
_
allocs
}
\begin{cmemberdesc}
{
PyTypeObject
}{
Py
_
ssize
_
t
}{
tp
_
allocs
}
Number of allocations.
\end{cmemberdesc}
\begin{cmemberdesc}
{
PyTypeObject
}{
in
t
}{
tp
_
frees
}
\begin{cmemberdesc}
{
PyTypeObject
}{
Py
_
ssize
_
t
}{
tp
_
frees
}
Number of frees.
\end{cmemberdesc}
\begin{cmemberdesc}
{
PyTypeObject
}{
in
t
}{
tp
_
maxalloc
}
\begin{cmemberdesc}
{
PyTypeObject
}{
Py
_
ssize
_
t
}{
tp
_
maxalloc
}
Maximum simultaneously allocated objects.
\end{cmemberdesc}
...
...
@@ -1509,8 +1509,8 @@ to be able to test for its presence before using it.}
\member
{
bf
_
getcharbuffer
}
slot is non-
\NULL
.
\end{datadesc}
\begin{ctypedesc}
[getreadbufferproc]
{
int (*get
readbufferproc)
(PyObject *self,
in
t segment, void **ptrptr)
}
\begin{ctypedesc}
[getreadbufferproc]
{
Py
_
ssize
_
t (*
readbufferproc)
(PyObject *self,
Py
_
ssize
_
t segment, void **ptrptr)
}
Return a pointer to a readable segment of the buffer. This function
is allowed to raise an exception, in which case it must return
\code
{
-1
}
. The
\var
{
segment
}
which is passed must be zero or
...
...
@@ -1520,8 +1520,8 @@ to be able to test for its presence before using it.}
pointer to that memory.
\end{ctypedesc}
\begin{ctypedesc}
[getwritebufferproc]
{
int (*get
writebufferproc)
(PyObject *self,
in
t segment, void **ptrptr)
}
\begin{ctypedesc}
[getwritebufferproc]
{
Py
_
ssize
_
t (*
writebufferproc)
(PyObject *self,
Py
_
ssize
_
t segment, void **ptrptr)
}
Return a pointer to a writable memory buffer in
\code
{
*
\var
{
ptrptr
}}
, and the length of that segment as the function
return value. The memory buffer must correspond to buffer segment
...
...
@@ -1535,16 +1535,16 @@ to be able to test for its presence before using it.}
% code.
\end{ctypedesc}
\begin{ctypedesc}
[getsegcountproc]
{
int (*get
segcountproc)
(PyObject *self,
in
t *lenp)
}
\begin{ctypedesc}
[getsegcountproc]
{
Py
_
ssize
_
t (*
segcountproc)
(PyObject *self,
Py
_
ssize
_
t *lenp)
}
Return the number of memory segments which comprise the buffer. If
\var
{
lenp
}
is not
\NULL
, the implementation must report the sum of
the sizes (in bytes) of all segments in
\code
{
*
\var
{
lenp
}}
.
The function cannot fail.
\end{ctypedesc}
\begin{ctypedesc}
[getcharbufferproc]
{
int (*get
charbufferproc)
(PyObject *self,
in
t segment, const char **ptrptr)
}
\begin{ctypedesc}
[getcharbufferproc]
{
Py
_
ssize
_
t (*
charbufferproc)
(PyObject *self,
Py
_
ssize
_
t segment, const char **ptrptr)
}
Return the size of the memory buffer in
\var
{
ptrptr
}
for segment
\var
{
segment
}
.
\code
{
*
\var
{
ptrptr
}}
is set to the memory buffer.
\end{ctypedesc}
...
...
@@ -1599,12 +1599,12 @@ Constructors for container types must conform to two rules:
\end{cfuncdesc}
\begin{cfuncdesc}
{
\var
{
TYPE
}
*
}{
PyObject
_
GC
_
NewVar
}{
TYPE, PyTypeObject *type,
in
t size
}
Py
_
ssize
_
t size
}
Analogous to
\cfunction
{
PyObject
_
NewVar()
}
but for container objects
with the
\constant
{
Py
_
TPFLAGS
_
HAVE
_
GC
}
flag set.
\end{cfuncdesc}
\begin{cfuncdesc}
{
PyVarObject *
}{
PyObject
_
GC
_
Resize
}{
PyVarObject *op,
in
t
}
\begin{cfuncdesc}
{
PyVarObject *
}{
PyObject
_
GC
_
Resize
}{
PyVarObject *op,
Py
_
ssize
_
t
}
Resize an object allocated by
\cfunction
{
PyObject
_
NewVar()
}
. Returns
the resized object or
\NULL
{}
on failure.
\end{cfuncdesc}
...
...
@@ -1633,12 +1633,12 @@ pair of rules:
\cfunction
{
PyObject
_
GC
_
Del()
}
.
\end{enumerate}
\begin{cfuncdesc}
{
void
}{
PyObject
_
GC
_
Del
}{
PyObject
*op
}
\begin{cfuncdesc}
{
void
}{
PyObject
_
GC
_
Del
}{
void
*op
}
Releases memory allocated to an object using
\cfunction
{
PyObject
_
GC
_
New()
}
or
\cfunction
{
PyObject
_
GC
_
NewVar()
}
.
\end{cfuncdesc}
\begin{cfuncdesc}
{
void
}{
PyObject
_
GC
_
UnTrack
}{
PyObject
*op
}
\begin{cfuncdesc}
{
void
}{
PyObject
_
GC
_
UnTrack
}{
void
*op
}
Remove the object
\var
{
op
}
from the set of container objects tracked
by the collector. Note that
\cfunction
{
PyObject
_
GC
_
Track()
}
can be
called again on this object to add it back to the set of tracked
...
...
Doc/api/utilities.tex
Dosyayı görüntüle @
29fafd87
...
...
@@ -8,7 +8,7 @@ values from C values.
\section
{
Operating System Utilities
\label
{
os
}}
\begin{cfuncdesc}
{
int
}{
Py
_
FdIsInteractive
}{
FILE *fp, char *filename
}
\begin{cfuncdesc}
{
int
}{
Py
_
FdIsInteractive
}{
FILE *fp, c
onst c
har *filename
}
Return true (nonzero) if the standard I/O file
\var
{
fp
}
with name
\var
{
filename
}
is deemed interactive. This is the case for files
for which
\samp
{
isatty(fileno(
\var
{
fp
}
))
}
is true. If the global
...
...
@@ -91,7 +91,7 @@ values from C values.
\section
{
Importing Modules
\label
{
importing
}}
\begin{cfuncdesc}
{
PyObject*
}{
PyImport
_
ImportModule
}{
char *name
}
\begin{cfuncdesc}
{
PyObject*
}{
PyImport
_
ImportModule
}{
c
onst c
har *name
}
This is a simplified interface to
\cfunction
{
PyImport
_
ImportModuleEx()
}
below, leaving the
\var
{
globals
}
and
\var
{
locals
}
arguments set to
\NULL
. When the
...
...
@@ -148,7 +148,7 @@ values from C values.
case).
\end{cfuncdesc}
\begin{cfuncdesc}
{
PyObject*
}{
PyImport
_
AddModule
}{
char *name
}
\begin{cfuncdesc}
{
PyObject*
}{
PyImport
_
AddModule
}{
c
onst c
har *name
}
Return the module object corresponding to a module name. The
\var
{
name
}
argument may be of the form
\code
{
package.module
}
.
First check the modules dictionary if there's one there, and if not,
...
...
@@ -369,7 +369,7 @@ Should only non-negative values be written using these routines?
\end{cfuncdesc}
\begin{cfuncdesc}
{
PyObject*
}{
PyMarshal
_
ReadObjectFromString
}{
char *string,
in
t len
}
Py
_
ssize
_
t len
}
Return a Python object from the data stream in a character buffer
containing
\var
{
len
}
bytes pointed to by
\var
{
string
}
. On error,
sets the appropriate exception (
\exception
{
EOFError
}
or
...
...
@@ -687,21 +687,21 @@ format and the format must be exhausted. On success, the
\cfunction
{
PyArg
_
Parse*()
}
functions return true, otherwise they
return false and raise an appropriate exception.
\begin{cfuncdesc}
{
int
}{
PyArg
_
ParseTuple
}{
PyObject *args, char *format,
\begin{cfuncdesc}
{
int
}{
PyArg
_
ParseTuple
}{
PyObject *args, c
onst c
har *format,
\moreargs
}
Parse the parameters of a function that takes only positional
parameters into local variables. Returns true on success; on
failure, it returns false and raises the appropriate exception.
\end{cfuncdesc}
\begin{cfuncdesc}
{
int
}{
PyArg
_
VaParse
}{
PyObject *args, char *format,
\begin{cfuncdesc}
{
int
}{
PyArg
_
VaParse
}{
PyObject *args, c
onst c
har *format,
va
_
list vargs
}
Identical to
\cfunction
{
PyArg
_
ParseTuple()
}
, except that it accepts a
va
_
list rather than a variable number of arguments.
\end{cfuncdesc}
\begin{cfuncdesc}
{
int
}{
PyArg
_
ParseTupleAndKeywords
}{
PyObject *args,
PyObject *kw, char *format, char *keywords[],
PyObject *kw, c
onst c
har *format, char *keywords[],
\moreargs
}
Parse the parameters of a function that takes both positional and
keyword parameters into local variables. Returns true on success;
...
...
@@ -709,13 +709,13 @@ return false and raise an appropriate exception.
\end{cfuncdesc}
\begin{cfuncdesc}
{
int
}{
PyArg
_
VaParseTupleAndKeywords
}{
PyObject *args,
PyObject *kw, char *format, char *keywords[],
PyObject *kw, c
onst c
har *format, char *keywords[],
va
_
list vargs
}
Identical to
\cfunction
{
PyArg
_
ParseTupleAndKeywords()
}
, except that it
accepts a va
_
list rather than a variable number of arguments.
\end{cfuncdesc}
\begin{cfuncdesc}
{
int
}{
PyArg
_
Parse
}{
PyObject *args, char *format,
\begin{cfuncdesc}
{
int
}{
PyArg
_
Parse
}{
PyObject *args, c
onst c
har *format,
\moreargs
}
Function used to deconstruct the argument lists of ``old-style''
functions --- these are functions which use the
...
...
@@ -727,8 +727,8 @@ return false and raise an appropriate exception.
purpose.
\end{cfuncdesc}
\begin{cfuncdesc}
{
int
}{
PyArg
_
UnpackTuple
}{
PyObject *args, char *name,
int min, in
t max,
\moreargs
}
\begin{cfuncdesc}
{
int
}{
PyArg
_
UnpackTuple
}{
PyObject *args, c
onst c
har *name,
Py
_
ssize
_
t min, Py
_
ssize
_
t max,
\moreargs
}
A simpler form of parameter retrieval which does not use a format
string to specify the types of the arguments. Functions which use
this method to retrieve their parameters should be declared as
...
...
@@ -774,7 +774,7 @@ PyArg_ParseTuple(args, "O|O:ref", &object, &callback)
\versionadded
{
2.2
}
\end{cfuncdesc}
\begin{cfuncdesc}
{
PyObject*
}{
Py
_
BuildValue
}{
char *format,
\begin{cfuncdesc}
{
PyObject*
}{
Py
_
BuildValue
}{
c
onst c
har *format,
\moreargs
}
Create a new value based on a format string similar to those
accepted by the
\cfunction
{
PyArg
_
Parse*()
}
family of functions and a
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment
