These functions raise
TypeError
when expecting a string parameter and are called with a non-string parameter.
注意
These functions have been renamed to PyBytes_* in Python 3.x. Unless otherwise noted, the PyBytes functions available in 3.x are aliased to their PyString_* equivalents to help porting.
PyString_Type
¶
此实例的
PyTypeObject
represents the Python string type; it is the same object as
str
and
types.StringType
in the Python layer..
PyString_Check
(
PyObject
*o
)
¶
Return true if the object o is a string object or an instance of a subtype of the string type.
2.2 版改变： Allowed subtypes to be accepted.
PyString_CheckExact
(
PyObject
*o
)
¶
Return true if the object o is a string object, but not an instance of a subtype of the string type.
2.2 版新增。
PyString_FromString
(
const char
*v
)
¶
Return a new string object with a copy of the string v as value on success, and NULL on failure. The parameter v 不得为 NULL ; it will not be checked.
PyString_FromStringAndSize
(
const char
*v
, Py_ssize_t
len
)
¶
Return a new string object with a copy of the string v as value and length len on success, and NULL on failure. If v is NULL , the contents of the string are uninitialized.
Changed in version 2.5:
This function used an
int
type for
len
. This might require changes in your code for properly supporting 64-bit systems.
PyString_FromFormat
(
const char
*format
, ...
)
¶
Take a C
printf()
-style
format
string and a variable number of arguments, calculate the size of the resulting Python string and return a string with the values formatted into it. The variable arguments must be C types and must correspond exactly to the format characters in the
format
string. The following format characters are allowed:
|
格式字符 |
类型 |
注释 |
|---|---|---|
|
|
n/a |
The literal % character. |
|
|
int | A single character, represented as a C int. |
|
|
int |
Exactly equivalent to
|
|
|
无符号 int |
Exactly equivalent to
|
|
|
long |
Exactly equivalent to
|
|
|
unsigned long |
Exactly equivalent to
|
|
|
long long |
Exactly equivalent to
|
|
|
unsigned long long |
Exactly equivalent to
|
|
|
Py_ssize_t |
Exactly equivalent to
|
|
|
size_t |
Exactly equivalent to
|
|
|
int |
Exactly equivalent to
|
|
|
int |
Exactly equivalent to
|
|
|
char* | A null-terminated C character array. |
|
|
void* |
The hex representation of a C pointer. Mostly equivalent to
|
An unrecognized format character causes all the rest of the format string to be copied as-is to the result string, and any extra arguments discarded.
注意
The
“%lld”
and
“%llu”
format specifiers are only available when
HAVE_LONG_LONG
有定义。
2.7 版改变： 支持 “%lld” and “%llu” added.
PyString_FromFormatV
(
const char
*format
, va_list
vargs
)
¶
等同于
PyString_FromFormat()
except that it takes exactly two arguments.
PyString_Size
(
PyObject
*string
)
¶
Return the length of the string in string object string .
Changed in version 2.5:
This function returned an
int
type. This might require changes in your code for properly supporting 64-bit systems.
PyString_GET_SIZE
(
PyObject
*string
)
¶
Macro form of
PyString_Size()
but without error checking.
Changed in version 2.5:
This macro returned an
int
type. This might require changes in your code for properly supporting 64-bit systems.
PyString_AsString
(
PyObject
*string
)
¶
Return a NUL-terminated representation of the contents of
string
. The pointer refers to the internal buffer of
string
, not a copy. The data must not be modified in any way, unless the string was just created using
PyString_FromStringAndSize(NULL, size)
. It must not be deallocated. If
string
is a Unicode object, this function computes the default encoding of
string
and operates on that. If
string
is not a string object at all,
PyString_AsString()
返回
NULL
and raises
TypeError
.
PyString_AS_STRING
(
PyObject
*string
)
¶
Macro form of
PyString_AsString()
but without error checking. Only string objects are supported; no Unicode objects should be passed.
PyString_AsStringAndSize
(
PyObject
*obj
, char
**buffer
, Py_ssize_t
*length
)
¶
Return a NUL-terminated representation of the contents of the object obj through the output variables buffer and length .
The function accepts both string and Unicode objects as input. For Unicode objects it returns the default encoded version of the object. If
length
is
NULL
, the resulting buffer may not contain NUL characters; if it does, the function returns
-1
和
TypeError
被引发。
The buffer refers to an internal string buffer of
obj
, not a copy. The data must not be modified in any way, unless the string was just created using
PyString_FromStringAndSize(NULL, size)
. It must not be deallocated. If
string
is a Unicode object, this function computes the default encoding of
string
and operates on that. If
string
is not a string object at all,
PyString_AsStringAndSize()
返回
-1
and raises
TypeError
.
Changed in version 2.5:
This function used an
int *
type for
length
. This might require changes in your code for properly supporting 64-bit systems.
PyString_Concat
(
PyObject
**string
,
PyObject
*newpart
)
¶
Create a new string object in *string containing the contents of newpart appended to string ; the caller will own the new reference. The reference to the old value of string will be stolen. If the new string cannot be created, the old reference to string will still be discarded and the value of *string 会被设为 NULL ; the appropriate exception will be set.
PyString_ConcatAndDel
(
PyObject
**string
,
PyObject
*newpart
)
¶
Create a new string object in *string containing the contents of newpart appended to string . This version decrements the reference count of newpart .
_PyString_Resize
(
PyObject
**string
, Py_ssize_t
newsize
)
¶
A way to resize a string object even though it is “immutable”. Only use this to build up a brand new string object; don’t use this if the string may already be known in other parts of the code. It is an error to call this function if the refcount on the input string object is not one. Pass the address of an existing string object as an lvalue (it may be written into), and the new size desired. On success,
*string
holds the resized string object and
0
is returned; the address in
*string
may differ from its input value. If the reallocation fails, the original string object at
*string
is deallocated,
*string
被设为
NULL
, a memory exception is set, and
-1
被返回。
Changed in version 2.5:
This function used an
int
type for
newsize
. This might require changes in your code for properly supporting 64-bit systems.
PyString_Format
(
PyObject
*format
,
PyObject
*args
)
¶
Return a new string object from
format
and
args
. Analogous to
format %
args
。
args
argument must be a tuple or dict.
PyString_InternInPlace
(
PyObject
**string
)
¶
Intern the argument *string in place. The argument must be the address of a pointer variable pointing to a Python string object. If there is an existing interned string that is the same as *string , it sets *string to it (decrementing the reference count of the old string object and incrementing the reference count of the interned string object), otherwise it leaves *string alone and interns it (incrementing its reference count). (Clarification: even though there is a lot of talk about reference counts, think of this function as reference-count-neutral; you own the object after the call if and only if you owned it before the call.)
注意
This function is not available in 3.x and does not have a PyBytes alias.
PyString_InternFromString
(
const char
*v
)
¶
A combination of
PyString_FromString()
and
PyString_InternInPlace()
, returning either a new string object that has been interned, or a new (“owned”) reference to an earlier interned string object with the same value.
注意
This function is not available in 3.x and does not have a PyBytes alias.
PyString_Decode
(
const char
*s
, Py_ssize_t
size
, const char
*encoding
, const char
*errors
)
¶
Create an object by decoding
size
bytes of the encoded buffer
s
使用注册编解码器为
encoding
.
encoding
and
errors
have the same meaning as the parameters of the same name in the
unicode()
built-in function. The codec to be used is looked up using the Python codec registry. Return
NULL
if an exception was raised by the codec.
注意
This function is not available in 3.x and does not have a PyBytes alias.
Changed in version 2.5:
This function used an
int
type for
size
. This might require changes in your code for properly supporting 64-bit systems.
PyString_AsDecodedObject
(
PyObject
*str
, const char
*encoding
, const char
*errors
)
¶
Decode a string object by passing it to the codec registered for
encoding
and return the result as Python object.
encoding
and
errors
have the same meaning as the parameters of the same name in the string
encode()
method. The codec to be used is looked up using the Python codec registry. Return
NULL
if an exception was raised by the codec.
注意
This function is not available in 3.x and does not have a PyBytes alias.
PyString_Encode
(
const char
*s
, Py_ssize_t
size
, const char
*encoding
, const char
*errors
)
¶
编码
char
buffer of the given size by passing it to the codec registered for
encoding
and return a Python object.
encoding
and
errors
have the same meaning as the parameters of the same name in the string
encode()
method. The codec to be used is looked up using the Python codec registry. Return
NULL
if an exception was raised by the codec.
注意
This function is not available in 3.x and does not have a PyBytes alias.
Changed in version 2.5:
This function used an
int
type for
size
. This might require changes in your code for properly supporting 64-bit systems.
PyString_AsEncodedObject
(
PyObject
*str
, const char
*encoding
, const char
*errors
)
¶
Encode a string object using the codec registered for
encoding
and return the result as Python object.
encoding
and
errors
have the same meaning as the parameters of the same name in the string
encode()
method. The codec to be used is looked up using the Python codec registry. Return
NULL
if an exception was raised by the codec.
注意
This function is not available in 3.x and does not have a PyBytes alias.