Unicode Type¶

These are the basic Unicode object types used for the Unicode implementation inPython:

Py_UNICODE¶

This type represents the storage type which is used by Python internally asbasis for holding Unicode ordinals. Python’s default builds use a 16-bit typeforPy_UNICODE and store Unicode values internally as UCS2. It is alsopossible to build a UCS4 version of Python (most recent Linux distributions comewith UCS4 builds of Python). These builds then use a 32-bit type forPy_UNICODE and store Unicode data internally as UCS4. On platformswherewchar_t is available and compatible with the chosen PythonUnicode build variant,Py_UNICODE is a typedef alias forwchar_t to enhance native platform compatibility. On all otherplatforms,Py_UNICODE is a typedef alias for eitherunsignedshort (UCS2) orunsignedlong (UCS4).

Note that UCS2 and UCS4 Python builds are not binary compatible. Please keepthis in mind when writing extensions or interfaces.

PyUnicodeObject¶

This subtype ofPyObject represents a Python Unicode object.

PyTypeObjectPyUnicode_Type¶

This instance ofPyTypeObject represents the Python Unicode type. Itis exposed to Python code asunicode andtypes.UnicodeType.

The following APIs are really C macros and can be used to do fast checks and toaccess internal read-only data of Unicode objects:

intPyUnicode_Check(PyObject *o)¶

Return true if the objecto is a Unicode object or an instance of a Unicodesubtype.

Changed in version 2.2:Allowed subtypes to be accepted.

intPyUnicode_CheckExact(PyObject *o)¶

Return true if the objecto is a Unicode object, but not an instance of asubtype.

New in version 2.2.

Py_ssize_tPyUnicode_GET_SIZE(PyObject *o)¶

Return the size of the object.o has to be aPyUnicodeObject (notchecked).

Changed in version 2.5:This function returned anint type. This might require changesin your code for properly supporting 64-bit systems.

Py_ssize_tPyUnicode_GET_DATA_SIZE(PyObject *o)¶

Return the size of the object’s internal buffer in bytes.o has to be aPyUnicodeObject (not checked).

Changed in version 2.5:This function returned anint type. This might require changesin your code for properly supporting 64-bit systems.

Py_UNICODE*PyUnicode_AS_UNICODE(PyObject *o)¶

Return a pointer to the internalPy_UNICODE buffer of the object.ohas to be aPyUnicodeObject (not checked).

const char*PyUnicode_AS_DATA(PyObject *o)¶

Return a pointer to the internal buffer of the object.o has to be aPyUnicodeObject (not checked).

intPyUnicode_ClearFreeList()¶

Clear the free list. Return the total number of freed items.

New in version 2.6.

Unicode Character Properties¶

Unicode provides many different character properties. The most often needed onesare available through these macros which are mapped to C functions depending onthe Python configuration.

intPy_UNICODE_ISSPACE(Py_UNICODE ch)¶

Return1 or0 depending on whetherch is a whitespace character.

intPy_UNICODE_ISLOWER(Py_UNICODE ch)¶

Return1 or0 depending on whetherch is a lowercase character.

intPy_UNICODE_ISUPPER(Py_UNICODE ch)¶

Return1 or0 depending on whetherch is an uppercase character.

intPy_UNICODE_ISTITLE(Py_UNICODE ch)¶

Return1 or0 depending on whetherch is a titlecase character.

intPy_UNICODE_ISLINEBREAK(Py_UNICODE ch)¶

Return1 or0 depending on whetherch is a linebreak character.

intPy_UNICODE_ISDECIMAL(Py_UNICODE ch)¶

Return1 or0 depending on whetherch is a decimal character.

intPy_UNICODE_ISDIGIT(Py_UNICODE ch)¶

Return1 or0 depending on whetherch is a digit character.

intPy_UNICODE_ISNUMERIC(Py_UNICODE ch)¶

Return1 or0 depending on whetherch is a numeric character.

intPy_UNICODE_ISALPHA(Py_UNICODE ch)¶

Return1 or0 depending on whetherch is an alphabetic character.

intPy_UNICODE_ISALNUM(Py_UNICODE ch)¶

Return1 or0 depending on whetherch is an alphanumeric character.

These APIs can be used for fast direct character conversions:

Py_UNICODEPy_UNICODE_TOLOWER(Py_UNICODE ch)¶

Return the characterch converted to lower case.

Py_UNICODEPy_UNICODE_TOUPPER(Py_UNICODE ch)¶

Return the characterch converted to upper case.

Py_UNICODEPy_UNICODE_TOTITLE(Py_UNICODE ch)¶

Return the characterch converted to title case.

intPy_UNICODE_TODECIMAL(Py_UNICODE ch)¶

Return the characterch converted to a decimal positive integer. Return-1 if this is not possible. This macro does not raise exceptions.

intPy_UNICODE_TODIGIT(Py_UNICODE ch)¶

Return the characterch converted to a single digit integer. Return-1 ifthis is not possible. This macro does not raise exceptions.

doublePy_UNICODE_TONUMERIC(Py_UNICODE ch)¶

Return the characterch converted to a double. Return-1.0 if this is notpossible. This macro does not raise exceptions.

Plain Py_UNICODE¶

To create Unicode objects and access their basic sequence properties, use theseAPIs:

PyObject*PyUnicode_FromUnicode(constPy_UNICODE *u, Py_ssize_t size)¶

Return value: New reference.

Create a Unicode object from the Py_UNICODE bufferu of the given size.umay beNULL which causes the contents to be undefined. It is the user’sresponsibility to fill in the needed data. The buffer is copied into the newobject. If the buffer is notNULL, the return value might be a shared object.Therefore, modification of the resulting Unicode object is only allowed whenuisNULL.

Changed in version 2.5:This function used anint type forsize. This might requirechanges in your code for properly supporting 64-bit systems.

PyObject*PyUnicode_FromStringAndSize(const char *u, Py_ssize_t size)¶

Return value: New reference.

Create a Unicode object from the char bufferu. The bytes will be interpretedas being UTF-8 encoded.u may also beNULL whichcauses the contents to be undefined. It is the user’s responsibility to fill inthe needed data. The buffer is copied into the new object. If the buffer is notNULL, the return value might be a shared object. Therefore, modification ofthe resulting Unicode object is only allowed whenu isNULL.

New in version 2.6.

PyObject *PyUnicode_FromString(const char *u)¶

Return value: New reference.

Create a Unicode object from a UTF-8 encoded null-terminated char bufferu.

New in version 2.6.

PyObject*PyUnicode_FromFormat(const char *format, ...)¶

Return value: New reference.

Take a Cprintf()-styleformat string and a variable number ofarguments, calculate the size of the resulting Python unicode string and returna string with the values formatted into it. The variable arguments must be Ctypes and must correspond exactly to the format characters in theformatstring. The following format characters are allowed:

Format Characters	Type	Comment
%%	n/a	The literal % character.
%c	int	A single character,represented as a C int.
%d	int	Exactly equivalent toprintf("%d").
%u	unsigned int	Exactly equivalent toprintf("%u").
%ld	long	Exactly equivalent toprintf("%ld").
%lu	unsigned long	Exactly equivalent toprintf("%lu").
%zd	Py_ssize_t	Exactly equivalent toprintf("%zd").
%zu	size_t	Exactly equivalent toprintf("%zu").
%i	int	Exactly equivalent toprintf("%i").
%x	int	Exactly equivalent toprintf("%x").
%s	char*	A null-terminated C characterarray.
%p	void*	The hex representation of a Cpointer. Mostly equivalent toprintf("%p") except thatit is guaranteed to start withthe literal0x regardlessof what the platform’sprintf yields.
%U	PyObject*	A unicode object.
%V	PyObject*, char *	A unicode object (which may beNULL) and a null-terminatedC character array as a secondparameter (which will be used,if the first parameter isNULL).
%S	PyObject*	The result of callingPyObject_Unicode().
%R	PyObject*	The result of callingPyObject_Repr().

An unrecognized format character causes all the rest of the format string to becopied as-is to the result string, and any extra arguments discarded.

New in version 2.6.

PyObject*PyUnicode_FromFormatV(const char *format, va_list vargs)¶

Return value: New reference.

Identical toPyUnicode_FromFormat() except that it takes exactly twoarguments.

New in version 2.6.

Py_UNICODE*PyUnicode_AsUnicode(PyObject *unicode)¶

Return a read-only pointer to the Unicode object’s internalPy_UNICODE buffer,NULL ifunicode is not a Unicode object.Note that the resultingPy_UNICODE* string may contain embeddednull characters, which would cause the string to be truncated when used inmost C functions.

Py_ssize_tPyUnicode_GetSize(PyObject *unicode)¶

Return the length of the Unicode object.

Changed in version 2.5:This function returned anint type. This might require changesin your code for properly supporting 64-bit systems.

PyObject*PyUnicode_FromEncodedObject(PyObject *obj, const char *encoding, const char *errors)¶

Return value: New reference.

Coerce an encoded objectobj to a Unicode object and return a reference withincremented refcount.

String and other char buffer compatible objects are decoded according to thegiven encoding and using the error handling defined by errors. Both can beNULL to have the interface use the default values (see the next section fordetails).

All other objects, including Unicode objects, cause aTypeError to beset.

The API returnsNULL if there was an error. The caller is responsible fordecref’ing the returned objects.

PyObject*PyUnicode_FromObject(PyObject *obj)¶

Return value: New reference.

Shortcut forPyUnicode_FromEncodedObject(obj,NULL,"strict") which is usedthroughout the interpreter whenever coercion to Unicode is needed.

If the platform supportswchar_t and provides a header file wchar.h,Python can interface directly to this type using the following functions.Support is optimized if Python’s ownPy_UNICODE type is identical tothe system’swchar_t.

wchar_t Support¶

wchar_t support for platforms which support it:

PyObject*PyUnicode_FromWideChar(const wchar_t *w, Py_ssize_t size)¶

Return value: New reference.

Create a Unicode object from thewchar_t bufferw of the givensize.ReturnNULL on failure.

Changed in version 2.5:This function used anint type forsize. This might requirechanges in your code for properly supporting 64-bit systems.

Py_ssize_tPyUnicode_AsWideChar(PyUnicodeObject *unicode, wchar_t *w, Py_ssize_t size)¶

Copy the Unicode object contents into thewchar_t bufferw. At mostsizewchar_t characters are copied (excluding a possibly trailing0-termination character). Return the number ofwchar_t characterscopied or-1 in case of an error. Note that the resultingwchar_tstring may or may not be 0-terminated. It is the responsibility of the callerto make sure that thewchar_t string is 0-terminated in case this isrequired by the application. Also, note that thewchar_t* stringmight contain null characters, which would cause the string to be truncatedwhen used with most C functions.

Changed in version 2.5:This function returned anint type and used aninttype forsize. This might require changes in your code for properlysupporting 64-bit systems.

Generic Codecs¶

These are the generic codec APIs:

PyObject*PyUnicode_Decode(const char *s, Py_ssize_t size, const char *encoding, const char *errors)¶

Return value: New reference.

Create a Unicode object by decodingsize bytes of the encoded strings.encoding anderrors have the same meaning as the parameters of the same namein theunicode() built-in function. The codec to be used is looked upusing the Python codec registry. ReturnNULL if an exception was raised bythe codec.

Changed in version 2.5:This function used anint type forsize. This might requirechanges in your code for properly supporting 64-bit systems.

PyObject*PyUnicode_Encode(constPy_UNICODE *s, Py_ssize_t size, const char *encoding, const char *errors)¶

Return value: New reference.

Encode thePy_UNICODE buffers of the givensize and return a Pythonstring object.encoding anderrors have the same meaning as the parametersof the same name in the Unicodeencode() method. The codecto be used is looked up using the Python codec registry. ReturnNULL ifan exception was raised by the codec.

Changed in version 2.5:This function used anint type forsize. This might requirechanges in your code for properly supporting 64-bit systems.

PyObject*PyUnicode_AsEncodedString(PyObject *unicode, const char *encoding, const char *errors)¶

Return value: New reference.

Encode a Unicode object and return the result as Python string object.encoding anderrors have the same meaning as the parameters of the same namein the Unicodeencode() method. The codec to be used is looked up usingthe Python codec registry. ReturnNULL if an exception was raised by thecodec.

UTF-8 Codecs¶

These are the UTF-8 codec APIs:

PyObject*PyUnicode_DecodeUTF8(const char *s, Py_ssize_t size, const char *errors)¶

Return value: New reference.

Create a Unicode object by decodingsize bytes of the UTF-8 encoded strings. ReturnNULL if an exception was raised by the codec.

Changed in version 2.5:This function used anint type forsize. This might requirechanges in your code for properly supporting 64-bit systems.

PyObject*PyUnicode_DecodeUTF8Stateful(const char *s, Py_ssize_t size, const char *errors, Py_ssize_t *consumed)¶

Return value: New reference.

Ifconsumed isNULL, behave likePyUnicode_DecodeUTF8(). Ifconsumed is notNULL, trailing incomplete UTF-8 byte sequences will not betreated as an error. Those bytes will not be decoded and the number of bytesthat have been decoded will be stored inconsumed.

New in version 2.4.

Changed in version 2.5:This function used anint type forsize. This might requirechanges in your code for properly supporting 64-bit systems.

PyObject*PyUnicode_EncodeUTF8(constPy_UNICODE *s, Py_ssize_t size, const char *errors)¶

Return value: New reference.

Encode thePy_UNICODE buffers of the givensize using UTF-8 and return aPython string object. ReturnNULL if an exception was raised by the codec.

Changed in version 2.5:This function used anint type forsize. This might requirechanges in your code for properly supporting 64-bit systems.

PyObject*PyUnicode_AsUTF8String(PyObject *unicode)¶

Return value: New reference.

Encode a Unicode object using UTF-8 and return the result as Python stringobject. Error handling is “strict”. ReturnNULL if an exception was raisedby the codec.

UTF-32 Codecs¶

These are the UTF-32 codec APIs:

PyObject*PyUnicode_DecodeUTF32(const char *s, Py_ssize_t size, const char *errors, int *byteorder)¶

Decodesize bytes from a UTF-32 encoded buffer string and return thecorresponding Unicode object.errors (if non-NULL) defines the errorhandling. It defaults to “strict”.

Ifbyteorder is non-NULL, the decoder starts decoding using the given byteorder:

*byteorder==-1:littleendian*byteorder==0:nativeorder*byteorder==1:bigendian

If*byteorder is zero, and the first four bytes of the input data are abyte order mark (BOM), the decoder switches to this byte order and the BOM isnot copied into the resulting Unicode string. If*byteorder is-1 or1, any byte order mark is copied to the output.

After completion,*byteorder is set to the current byte order at the endof input data.

In a narrow build code points outside the BMP will be decoded as surrogate pairs.

Ifbyteorder isNULL, the codec starts in native order mode.

ReturnNULL if an exception was raised by the codec.

New in version 2.6.

PyObject*PyUnicode_DecodeUTF32Stateful(const char *s, Py_ssize_t size, const char *errors, int *byteorder, Py_ssize_t *consumed)¶

Ifconsumed isNULL, behave likePyUnicode_DecodeUTF32(). Ifconsumed is notNULL,PyUnicode_DecodeUTF32Stateful() will not treattrailing incomplete UTF-32 byte sequences (such as a number of bytes not divisibleby four) as an error. Those bytes will not be decoded and the number of bytesthat have been decoded will be stored inconsumed.

New in version 2.6.

PyObject*PyUnicode_EncodeUTF32(constPy_UNICODE *s, Py_ssize_t size, const char *errors, int byteorder)¶

Return a Python bytes object holding the UTF-32 encoded value of the Unicodedata ins. Output is written according to the following byte order:

byteorder==-1:littleendianbyteorder==0:nativebyteorder(writesaBOMmark)byteorder==1:bigendian

If byteorder is0, the output string will always start with the Unicode BOMmark (U+FEFF). In the other two modes, no BOM mark is prepended.

IfPy_UNICODE_WIDE is not defined, surrogate pairs will be outputas a single code point.

ReturnNULL if an exception was raised by the codec.

New in version 2.6.

PyObject*PyUnicode_AsUTF32String(PyObject *unicode)¶

Return a Python string using the UTF-32 encoding in native byte order. Thestring always starts with a BOM mark. Error handling is “strict”. ReturnNULL if an exception was raised by the codec.

New in version 2.6.

UTF-16 Codecs¶

These are the UTF-16 codec APIs:

PyObject*PyUnicode_DecodeUTF16(const char *s, Py_ssize_t size, const char *errors, int *byteorder)¶

Return value: New reference.

Decodesize bytes from a UTF-16 encoded buffer string and return thecorresponding Unicode object.errors (if non-NULL) defines the errorhandling. It defaults to “strict”.

Ifbyteorder is non-NULL, the decoder starts decoding using the given byteorder:

*byteorder==-1:littleendian*byteorder==0:nativeorder*byteorder==1:bigendian

If*byteorder is zero, and the first two bytes of the input data are abyte order mark (BOM), the decoder switches to this byte order and the BOM isnot copied into the resulting Unicode string. If*byteorder is-1 or1, any byte order mark is copied to the output (where it will result ineither a\ufeff or a\ufffe character).

After completion,*byteorder is set to the current byte order at the endof input data.

Ifbyteorder isNULL, the codec starts in native order mode.

ReturnNULL if an exception was raised by the codec.

Changed in version 2.5:This function used anint type forsize. This might requirechanges in your code for properly supporting 64-bit systems.

PyObject*PyUnicode_DecodeUTF16Stateful(const char *s, Py_ssize_t size, const char *errors, int *byteorder, Py_ssize_t *consumed)¶

Return value: New reference.

Ifconsumed isNULL, behave likePyUnicode_DecodeUTF16(). Ifconsumed is notNULL,PyUnicode_DecodeUTF16Stateful() will not treattrailing incomplete UTF-16 byte sequences (such as an odd number of bytes or asplit surrogate pair) as an error. Those bytes will not be decoded and thenumber of bytes that have been decoded will be stored inconsumed.

New in version 2.4.

Changed in version 2.5:This function used anint type forsize and anint*type forconsumed. This might require changes in your code forproperly supporting 64-bit systems.

PyObject*PyUnicode_EncodeUTF16(constPy_UNICODE *s, Py_ssize_t size, const char *errors, int byteorder)¶

Return value: New reference.

Return a Python string object holding the UTF-16 encoded value of the Unicodedata ins. Output is written according to the following byte order:

byteorder==-1:littleendianbyteorder==0:nativebyteorder(writesaBOMmark)byteorder==1:bigendian

If byteorder is0, the output string will always start with the Unicode BOMmark (U+FEFF). In the other two modes, no BOM mark is prepended.

IfPy_UNICODE_WIDE is defined, a singlePy_UNICODE value may getrepresented as a surrogate pair. If it is not defined, eachPy_UNICODEvalues is interpreted as a UCS-2 character.

ReturnNULL if an exception was raised by the codec.

Changed in version 2.5:This function used anint type forsize. This might requirechanges in your code for properly supporting 64-bit systems.

PyObject*PyUnicode_AsUTF16String(PyObject *unicode)¶

Return value: New reference.

Return a Python string using the UTF-16 encoding in native byte order. Thestring always starts with a BOM mark. Error handling is “strict”. ReturnNULL if an exception was raised by the codec.

UTF-7 Codecs¶

These are the UTF-7 codec APIs:

PyObject*PyUnicode_DecodeUTF7(const char *s, Py_ssize_t size, const char *errors)¶

Create a Unicode object by decodingsize bytes of the UTF-7 encoded strings. ReturnNULL if an exception was raised by the codec.

PyObject*PyUnicode_DecodeUTF7Stateful(const char *s, Py_ssize_t size, const char *errors, Py_ssize_t *consumed)¶

Ifconsumed isNULL, behave likePyUnicode_DecodeUTF7(). Ifconsumed is notNULL, trailing incomplete UTF-7 base-64 sections will notbe treated as an error. Those bytes will not be decoded and the number ofbytes that have been decoded will be stored inconsumed.

PyObject*PyUnicode_EncodeUTF7(constPy_UNICODE *s, Py_ssize_t size, int base64SetO, int base64WhiteSpace, const char *errors)¶

Encode thePy_UNICODE buffer of the given size using UTF-7 andreturn a Python bytes object. ReturnNULL if an exception was raised bythe codec.

Ifbase64SetO is nonzero, “Set O” (punctuation that has no otherwisespecial meaning) will be encoded in base-64. Ifbase64WhiteSpace isnonzero, whitespace will be encoded in base-64. Both are set to zero for thePython “utf-7” codec.

Unicode-Escape Codecs¶

These are the “Unicode Escape” codec APIs:

PyObject*PyUnicode_DecodeUnicodeEscape(const char *s, Py_ssize_t size, const char *errors)¶

Return value: New reference.

Create a Unicode object by decodingsize bytes of the Unicode-Escape encodedstrings. ReturnNULL if an exception was raised by the codec.

Changed in version 2.5:This function used anint type forsize. This might requirechanges in your code for properly supporting 64-bit systems.

PyObject*PyUnicode_EncodeUnicodeEscape(constPy_UNICODE *s, Py_ssize_t size)¶

Return value: New reference.

Encode thePy_UNICODE buffer of the givensize using Unicode-Escape andreturn a Python string object. ReturnNULL if an exception was raised by thecodec.

Changed in version 2.5:This function used anint type forsize. This might requirechanges in your code for properly supporting 64-bit systems.

PyObject*PyUnicode_AsUnicodeEscapeString(PyObject *unicode)¶

Return value: New reference.

Encode a Unicode object using Unicode-Escape and return the result as Pythonstring object. Error handling is “strict”. ReturnNULL if an exception wasraised by the codec.

Raw-Unicode-Escape Codecs¶

These are the “Raw Unicode Escape” codec APIs:

PyObject*PyUnicode_DecodeRawUnicodeEscape(const char *s, Py_ssize_t size, const char *errors)¶

Return value: New reference.

Create a Unicode object by decodingsize bytes of the Raw-Unicode-Escapeencoded strings. ReturnNULL if an exception was raised by the codec.

Changed in version 2.5:This function used anint type forsize. This might requirechanges in your code for properly supporting 64-bit systems.

PyObject*PyUnicode_EncodeRawUnicodeEscape(constPy_UNICODE *s, Py_ssize_t size, const char *errors)¶

Return value: New reference.

Encode thePy_UNICODE buffer of the givensize using Raw-Unicode-Escapeand return a Python string object. ReturnNULL if an exception was raised bythe codec.

Changed in version 2.5:This function used anint type forsize. This might requirechanges in your code for properly supporting 64-bit systems.

PyObject*PyUnicode_AsRawUnicodeEscapeString(PyObject *unicode)¶

Return value: New reference.

Encode a Unicode object using Raw-Unicode-Escape and return the result asPython string object. Error handling is “strict”. ReturnNULL if an exceptionwas raised by the codec.

Latin-1 Codecs¶

These are the Latin-1 codec APIs: Latin-1 corresponds to the first 256 Unicodeordinals and only these are accepted by the codecs during encoding.

PyObject*PyUnicode_DecodeLatin1(const char *s, Py_ssize_t size, const char *errors)¶

Return value: New reference.

Create a Unicode object by decodingsize bytes of the Latin-1 encoded strings. ReturnNULL if an exception was raised by the codec.

Changed in version 2.5:This function used anint type forsize. This might requirechanges in your code for properly supporting 64-bit systems.

PyObject*PyUnicode_EncodeLatin1(constPy_UNICODE *s, Py_ssize_t size, const char *errors)¶

Return value: New reference.

Encode thePy_UNICODE buffer of the givensize using Latin-1 and returna Python string object. ReturnNULL if an exception was raised by the codec.

Changed in version 2.5:This function used anint type forsize. This might requirechanges in your code for properly supporting 64-bit systems.

PyObject*PyUnicode_AsLatin1String(PyObject *unicode)¶

Return value: New reference.

Encode a Unicode object using Latin-1 and return the result as Python stringobject. Error handling is “strict”. ReturnNULL if an exception was raisedby the codec.

ASCII Codecs¶

These are the ASCII codec APIs. Only 7-bit ASCII data is accepted. All othercodes generate errors.

PyObject*PyUnicode_DecodeASCII(const char *s, Py_ssize_t size, const char *errors)¶

Return value: New reference.

Create a Unicode object by decodingsize bytes of the ASCII encoded strings. ReturnNULL if an exception was raised by the codec.

Changed in version 2.5:This function used anint type forsize. This might requirechanges in your code for properly supporting 64-bit systems.

PyObject*PyUnicode_EncodeASCII(constPy_UNICODE *s, Py_ssize_t size, const char *errors)¶

Return value: New reference.

Encode thePy_UNICODE buffer of the givensize using ASCII and return aPython string object. ReturnNULL if an exception was raised by the codec.

Changed in version 2.5:This function used anint type forsize. This might requirechanges in your code for properly supporting 64-bit systems.

PyObject*PyUnicode_AsASCIIString(PyObject *unicode)¶

Return value: New reference.

Encode a Unicode object using ASCII and return the result as Python stringobject. Error handling is “strict”. ReturnNULL if an exception was raisedby the codec.

Character Map Codecs¶

This codec is special in that it can be used to implement many different codecs(and this is in fact what was done to obtain most of the standard codecsincluded in theencodings package). The codec uses mapping to encode anddecode characters.

Decoding mappings must map single string characters to single Unicodecharacters, integers (which are then interpreted as Unicode ordinals) orNone(meaning “undefined mapping” and causing an error).

Encoding mappings must map single Unicode characters to single stringcharacters, integers (which are then interpreted as Latin-1 ordinals) orNone(meaning “undefined mapping” and causing an error).

The mapping objects provided must only support the __getitem__ mappinginterface.

If a character lookup fails with a LookupError, the character is copied as-ismeaning that its ordinal value will be interpreted as Unicode or Latin-1 ordinalresp. Because of this, mappings only need to contain those mappings which mapcharacters to different code points.

These are the mapping codec APIs:

PyObject*PyUnicode_DecodeCharmap(const char *s, Py_ssize_t size,PyObject *mapping, const char *errors)¶

Return value: New reference.

Create a Unicode object by decodingsize bytes of the encoded strings usingthe givenmapping object. ReturnNULL if an exception was raised by thecodec. Ifmapping isNULL latin-1 decoding will be done. Else it can be adictionary mapping byte or a unicode string, which is treated as a lookup table.Byte values greater that the length of the string and U+FFFE “characters” aretreated as “undefined mapping”.

Changed in version 2.4:Allowed unicode string as mapping argument.

Changed in version 2.5:This function used anint type forsize. This might requirechanges in your code for properly supporting 64-bit systems.

PyObject*PyUnicode_EncodeCharmap(constPy_UNICODE *s, Py_ssize_t size,PyObject *mapping, const char *errors)¶

Return value: New reference.

Encode thePy_UNICODE buffer of the givensize using the givenmapping object and return a Python string object. ReturnNULL if anexception was raised by the codec.

Changed in version 2.5:This function used anint type forsize. This might requirechanges in your code for properly supporting 64-bit systems.

PyObject*PyUnicode_AsCharmapString(PyObject *unicode,PyObject *mapping)¶

Return value: New reference.

Encode a Unicode object using the givenmapping object and return the resultas Python string object. Error handling is “strict”. ReturnNULL if anexception was raised by the codec.

The following codec API is special in that maps Unicode to Unicode.

PyObject*PyUnicode_TranslateCharmap(constPy_UNICODE *s, Py_ssize_t size,PyObject *table, const char *errors)¶

Return value: New reference.

Translate aPy_UNICODE buffer of the givensize by applying acharacter mappingtable to it and return the resulting Unicode object. ReturnNULL when an exception was raised by the codec.

Themapping table must map Unicode ordinal integers to Unicode ordinalintegers orNone (causing deletion of the character).

Mapping tables need only provide the__getitem__() interface; dictionariesand sequences work well. Unmapped character ordinals (ones which cause aLookupError) are left untouched and are copied as-is.

Changed in version 2.5:This function used anint type forsize. This might requirechanges in your code for properly supporting 64-bit systems.

MBCS codecs for Windows¶

These are the MBCS codec APIs. They are currently only available on Windows anduse the Win32 MBCS converters to implement the conversions. Note that MBCS (orDBCS) is a class of encodings, not just one. The target encoding is defined bythe user settings on the machine running the codec.

PyObject*PyUnicode_DecodeMBCS(const char *s, Py_ssize_t size, const char *errors)¶

Return value: New reference.

Create a Unicode object by decodingsize bytes of the MBCS encoded strings.ReturnNULL if an exception was raised by the codec.

Changed in version 2.5:This function used anint type forsize. This might requirechanges in your code for properly supporting 64-bit systems.

PyObject*PyUnicode_DecodeMBCSStateful(const char *s, int size, const char *errors, int *consumed)¶

Ifconsumed isNULL, behave likePyUnicode_DecodeMBCS(). Ifconsumed is notNULL,PyUnicode_DecodeMBCSStateful() will not decodetrailing lead byte and the number of bytes that have been decoded will be storedinconsumed.

New in version 2.5.

PyObject*PyUnicode_EncodeMBCS(constPy_UNICODE *s, Py_ssize_t size, const char *errors)¶

Return value: New reference.

Encode thePy_UNICODE buffer of the givensize using MBCS and return aPython string object. ReturnNULL if an exception was raised by the codec.

Changed in version 2.5:This function used anint type forsize. This might requirechanges in your code for properly supporting 64-bit systems.

PyObject*PyUnicode_AsMBCSString(PyObject *unicode)¶

Return value: New reference.

Encode a Unicode object using MBCS and return the result as Python stringobject. Error handling is “strict”. ReturnNULL if an exception was raisedby the codec.

Methods & Slots¶