GNU Info

(python2.1-api.info)String Objects

---

Next: Unicode Objects Prev: Sequence Objects Up: Sequence Objects

---

Enter node , (file) or (file)node

String Objects
--------------

These functions raise `TypeError' when expecting a string parameter and
are called with a non-string parameter.

`PyStringObject'
     This subtype of `PyObject' represents a Python string object.

`PyTypeObject PyString_Type'
     This instance of `PyTypeObject' represents the Python string type;
     it is the same object as `types.TypeType' in the Python layer.  .

`int PyString_Check(PyObject *o)'
     Returns true if the object O is a string object.

`PyObject* PyString_FromString(const char *v)'
     Returns a new string object with the value V on success, and
     `NULL' on failure.  The parameter V must not be `NULL'; it will
     not be checked.

`PyObject* PyString_FromStringAndSize(const char *v, int len)'
     Returns a new string object with the value V and length LEN on
     success, and `NULL' on failure.  If V is `NULL', the contents of
     the string are uninitialized.

`int PyString_Size(PyObject *string)'
     Returns the length of the string in string object STRING.

`int PyString_GET_SIZE(PyObject *string)'
     Macro form of `PyString_Size()' but without error checking.

`char* PyString_AsString(PyObject *string)'
     Returns a null-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.

`char* PyString_AS_STRING(PyObject *string)'
     Macro form of `PyString_AsString()' but without error checking.

`int PyString_AsStringAndSize(PyObject *obj, char **buffer, int *length)'
     Returns a null-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 set to `NULL', the resulting buffer may not
     contain null characters; if it does, the function returns -1 and a
     TypeError is raised.

     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.

`void PyString_Concat(PyObject **string, PyObject *newpart)'
     Creates 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 will be set to `NULL';
     the appropriate exception will be set.

`void PyString_ConcatAndDel(PyObject **string, PyObject *newpart)'
     Creates a new string object in *STRING containing the contents of
     NEWPART appended to STRING.  This version decrements the reference
     count of NEWPART.

`int _PyString_Resize(PyObject **string, int 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.

`PyObject* PyString_Format(PyObject *format, PyObject *args)'
     Returns a new string object from FORMAT and ARGS.  Analogous to
     `FORMAT % ARGS'.  The ARGS argument must be a tuple.

`void 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.)

`PyObject* 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.

`PyObject* PyString_Decode(const char *s, int size, const char *encoding, const char *errors)'
     Create a string object by decoding SIZE bytes of the encoded
     buffer S. ENCODING and ERRORS have the same meaning as the
     parameters of the same name in the unicode() builtin function. The
     codec to be used is looked up using the Python codec registry.
     Returns `NULL' in case an exception was raised by the codec.

`PyObject* PyString_Encode(const Py_UNICODE *s, int size, const char *encoding, const char *errors)'
     Encodes the `Py_UNICODE' buffer of the given size and returns a
     Python string 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.
     Returns `NULL' in case an exception was raised by the codec.

`PyObject* PyString_AsEncodedString(PyObject *unicode, const char *encoding, const char *errors)'
     Encodes a string object and returns the result as Python string
     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.
     Returns `NULL' in case an exception was raised by the codec.