Linux server.nvwebsoft.co.in 3.10.0-1160.114.2.el7.x86_64 #1 SMP Wed Mar 20 15:54:52 UTC 2024 x86_64
Apache
: 162.240.12.249 | : 18.119.135.231
202 Domain
8.1.31
nbspublicschool
www.github.com/MadExploits
Terminal
AUTO ROOT
Adminer
Backdoor Destroyer
Linux Exploit
Lock Shell
Lock File
Create User
CREATE RDP
PHP Mailer
BACKCONNECT
UNLOCK SHELL
HASH IDENTIFIER
CPANEL RESET
CREATE WP USER
README
+ Create Folder
+ Create File
/
usr /
share /
doc /
python-docs-2.7.5 /
html /
c-api /
[ HOME SHELL ]
Name
Size
Permission
Action
abstract.html
7.09
KB
-rw-r--r--
allocation.html
16.94
KB
-rw-r--r--
arg.html
55.63
KB
-rw-r--r--
bool.html
9.24
KB
-rw-r--r--
buffer.html
43.94
KB
-rw-r--r--
bytearray.html
13.03
KB
-rw-r--r--
capsule.html
19.04
KB
-rw-r--r--
cell.html
10.36
KB
-rw-r--r--
class.html
10.48
KB
-rw-r--r--
cobject.html
11.06
KB
-rw-r--r--
code.html
10.79
KB
-rw-r--r--
codec.html
18.94
KB
-rw-r--r--
complex.html
19.01
KB
-rw-r--r--
concrete.html
15.16
KB
-rw-r--r--
conversion.html
20.98
KB
-rw-r--r--
datetime.html
23.48
KB
-rw-r--r--
descriptor.html
10.97
KB
-rw-r--r--
dict.html
29.9
KB
-rw-r--r--
exceptions.html
75.95
KB
-rw-r--r--
file.html
21.85
KB
-rw-r--r--
float.html
15.85
KB
-rw-r--r--
function.html
13.16
KB
-rw-r--r--
gcsupport.html
20.25
KB
-rw-r--r--
gen.html
7.92
KB
-rw-r--r--
import.html
32.45
KB
-rw-r--r--
index.html
12.55
KB
-rw-r--r--
init.html
96.34
KB
-rw-r--r--
int.html
18.31
KB
-rw-r--r--
intro.html
62.21
KB
-rw-r--r--
iter.html
9.16
KB
-rw-r--r--
iterator.html
10.9
KB
-rw-r--r--
list.html
22.27
KB
-rw-r--r--
long.html
31.93
KB
-rw-r--r--
mapping.html
14.41
KB
-rw-r--r--
marshal.html
14.77
KB
-rw-r--r--
memory.html
23.17
KB
-rw-r--r--
method.html
12.47
KB
-rw-r--r--
module.html
15.33
KB
-rw-r--r--
none.html
7.39
KB
-rw-r--r--
number.html
43.95
KB
-rw-r--r--
objbuffer.html
11.26
KB
-rw-r--r--
object.html
51.97
KB
-rw-r--r--
objimpl.html
6.9
KB
-rw-r--r--
refcounting.html
11.86
KB
-rw-r--r--
reflection.html
9.82
KB
-rw-r--r--
sequence.html
28.3
KB
-rw-r--r--
set.html
28.22
KB
-rw-r--r--
slice.html
11.19
KB
-rw-r--r--
string.html
33.52
KB
-rw-r--r--
structures.html
30.79
KB
-rw-r--r--
sys.html
19.18
KB
-rw-r--r--
tuple.html
19.49
KB
-rw-r--r--
type.html
12.86
KB
-rw-r--r--
typeobj.html
150.06
KB
-rw-r--r--
unicode.html
105.59
KB
-rw-r--r--
utilities.html
7.23
KB
-rw-r--r--
veryhigh.html
40.2
KB
-rw-r--r--
weakref.html
12.48
KB
-rw-r--r--
Delete
Unzip
Zip
${this.title}
Close
Code Editor : unicode.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>Unicode Objects and Codecs — Python 2.7.5 documentation</title> <link rel="stylesheet" href="../_static/default.css" type="text/css" /> <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT: '../', VERSION: '2.7.5', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', HAS_SOURCE: true }; </script> <script type="text/javascript" src="../_static/jquery.js"></script> <script type="text/javascript" src="../_static/underscore.js"></script> <script type="text/javascript" src="../_static/doctools.js"></script> <script type="text/javascript" src="../_static/sidebar.js"></script> <link rel="search" type="application/opensearchdescription+xml" title="Search within Python 2.7.5 documentation" href="../_static/opensearch.xml"/> <link rel="author" title="About these documents" href="../about.html" /> <link rel="copyright" title="Copyright" href="../copyright.html" /> <link rel="top" title="Python 2.7.5 documentation" href="../index.html" /> <link rel="up" title="Concrete Objects Layer" href="concrete.html" /> <link rel="next" title="Buffers and Memoryview Objects" href="buffer.html" /> <link rel="prev" title="String/Bytes Objects" href="string.html" /> <link rel="shortcut icon" type="image/png" href="../_static/py.png" /> <script type="text/javascript" src="../_static/copybutton.js"></script> </head> <body> <div class="related"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="../genindex.html" title="General Index" accesskey="I">index</a></li> <li class="right" > <a href="../py-modindex.html" title="Python Module Index" >modules</a> |</li> <li class="right" > <a href="buffer.html" title="Buffers and Memoryview Objects" accesskey="N">next</a> |</li> <li class="right" > <a href="string.html" title="String/Bytes Objects" accesskey="P">previous</a> |</li> <li><img src="../_static/py.png" alt="" style="vertical-align: middle; margin-top: -1px"/></li> <li><a href="http://www.python.org/">Python</a> »</li> <li> <a href="../index.html">Python 2.7.5 documentation</a> » </li> <li><a href="index.html" >Python/C API Reference Manual</a> »</li> <li><a href="concrete.html" accesskey="U">Concrete Objects Layer</a> »</li> </ul> </div> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body"> <div class="section" id="unicode-objects-and-codecs"> <span id="unicodeobjects"></span><h1>Unicode Objects and Codecs<a class="headerlink" href="#unicode-objects-and-codecs" title="Permalink to this headline">¶</a></h1> <div class="section" id="unicode-objects"> <h2>Unicode Objects<a class="headerlink" href="#unicode-objects" title="Permalink to this headline">¶</a></h2> <div class="section" id="unicode-type"> <h3>Unicode Type<a class="headerlink" href="#unicode-type" title="Permalink to this headline">¶</a></h3> <p>These are the basic Unicode object types used for the Unicode implementation in Python:</p> <dl class="type"> <dt id="Py_UNICODE"> <tt class="descname">Py_UNICODE</tt><a class="headerlink" href="#Py_UNICODE" title="Permalink to this definition">¶</a></dt> <dd><p>This type represents the storage type which is used by Python internally as basis for holding Unicode ordinals. Python’s default builds use a 16-bit type for <a class="reference internal" href="#Py_UNICODE" title="Py_UNICODE"><tt class="xref c c-type docutils literal"><span class="pre">Py_UNICODE</span></tt></a> and store Unicode values internally as UCS2. It is also possible to build a UCS4 version of Python (most recent Linux distributions come with UCS4 builds of Python). These builds then use a 32-bit type for <a class="reference internal" href="#Py_UNICODE" title="Py_UNICODE"><tt class="xref c c-type docutils literal"><span class="pre">Py_UNICODE</span></tt></a> and store Unicode data internally as UCS4. On platforms where <tt class="xref c c-type docutils literal"><span class="pre">wchar_t</span></tt> is available and compatible with the chosen Python Unicode build variant, <a class="reference internal" href="#Py_UNICODE" title="Py_UNICODE"><tt class="xref c c-type docutils literal"><span class="pre">Py_UNICODE</span></tt></a> is a typedef alias for <tt class="xref c c-type docutils literal"><span class="pre">wchar_t</span></tt> to enhance native platform compatibility. On all other platforms, <a class="reference internal" href="#Py_UNICODE" title="Py_UNICODE"><tt class="xref c c-type docutils literal"><span class="pre">Py_UNICODE</span></tt></a> is a typedef alias for either <tt class="xref c c-type docutils literal"><span class="pre">unsigned</span> <span class="pre">short</span></tt> (UCS2) or <tt class="xref c c-type docutils literal"><span class="pre">unsigned</span> <span class="pre">long</span></tt> (UCS4).</p> </dd></dl> <p>Note that UCS2 and UCS4 Python builds are not binary compatible. Please keep this in mind when writing extensions or interfaces.</p> <dl class="type"> <dt id="PyUnicodeObject"> <tt class="descname">PyUnicodeObject</tt><a class="headerlink" href="#PyUnicodeObject" title="Permalink to this definition">¶</a></dt> <dd><p>This subtype of <a class="reference internal" href="structures.html#PyObject" title="PyObject"><tt class="xref c c-type docutils literal"><span class="pre">PyObject</span></tt></a> represents a Python Unicode object.</p> </dd></dl> <dl class="var"> <dt id="PyUnicode_Type"> <a class="reference internal" href="type.html#PyTypeObject" title="PyTypeObject">PyTypeObject</a> <tt class="descname">PyUnicode_Type</tt><a class="headerlink" href="#PyUnicode_Type" title="Permalink to this definition">¶</a></dt> <dd><p>This instance of <a class="reference internal" href="type.html#PyTypeObject" title="PyTypeObject"><tt class="xref c c-type docutils literal"><span class="pre">PyTypeObject</span></tt></a> represents the Python Unicode type. It is exposed to Python code as <tt class="docutils literal"><span class="pre">unicode</span></tt> and <tt class="docutils literal"><span class="pre">types.UnicodeType</span></tt>.</p> </dd></dl> <p>The following APIs are really C macros and can be used to do fast checks and to access internal read-only data of Unicode objects:</p> <dl class="function"> <dt id="PyUnicode_Check"> int <tt class="descname">PyUnicode_Check</tt><big>(</big><a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> *o</em><big>)</big><a class="headerlink" href="#PyUnicode_Check" title="Permalink to this definition">¶</a></dt> <dd><p>Return true if the object <em>o</em> is a Unicode object or an instance of a Unicode subtype.</p> <p class="versionchanged"> <span class="versionmodified">Changed in version 2.2: </span>Allowed subtypes to be accepted.</p> </dd></dl> <dl class="function"> <dt id="PyUnicode_CheckExact"> int <tt class="descname">PyUnicode_CheckExact</tt><big>(</big><a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> *o</em><big>)</big><a class="headerlink" href="#PyUnicode_CheckExact" title="Permalink to this definition">¶</a></dt> <dd><p>Return true if the object <em>o</em> is a Unicode object, but not an instance of a subtype.</p> <p class="versionadded"> <span class="versionmodified">New in version 2.2.</span></p> </dd></dl> <dl class="function"> <dt id="PyUnicode_GET_SIZE"> Py_ssize_t <tt class="descname">PyUnicode_GET_SIZE</tt><big>(</big><a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> *o</em><big>)</big><a class="headerlink" href="#PyUnicode_GET_SIZE" title="Permalink to this definition">¶</a></dt> <dd><p>Return the size of the object. <em>o</em> has to be a <a class="reference internal" href="#PyUnicodeObject" title="PyUnicodeObject"><tt class="xref c c-type docutils literal"><span class="pre">PyUnicodeObject</span></tt></a> (not checked).</p> <p class="versionchanged"> <span class="versionmodified">Changed in version 2.5: </span>This function returned an <tt class="xref c c-type docutils literal"><span class="pre">int</span></tt> type. This might require changes in your code for properly supporting 64-bit systems.</p> </dd></dl> <dl class="function"> <dt id="PyUnicode_GET_DATA_SIZE"> Py_ssize_t <tt class="descname">PyUnicode_GET_DATA_SIZE</tt><big>(</big><a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> *o</em><big>)</big><a class="headerlink" href="#PyUnicode_GET_DATA_SIZE" title="Permalink to this definition">¶</a></dt> <dd><p>Return the size of the object’s internal buffer in bytes. <em>o</em> has to be a <a class="reference internal" href="#PyUnicodeObject" title="PyUnicodeObject"><tt class="xref c c-type docutils literal"><span class="pre">PyUnicodeObject</span></tt></a> (not checked).</p> <p class="versionchanged"> <span class="versionmodified">Changed in version 2.5: </span>This function returned an <tt class="xref c c-type docutils literal"><span class="pre">int</span></tt> type. This might require changes in your code for properly supporting 64-bit systems.</p> </dd></dl> <dl class="function"> <dt id="PyUnicode_AS_UNICODE"> <a class="reference internal" href="#Py_UNICODE" title="Py_UNICODE">Py_UNICODE</a>* <tt class="descname">PyUnicode_AS_UNICODE</tt><big>(</big><a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> *o</em><big>)</big><a class="headerlink" href="#PyUnicode_AS_UNICODE" title="Permalink to this definition">¶</a></dt> <dd><p>Return a pointer to the internal <a class="reference internal" href="#Py_UNICODE" title="Py_UNICODE"><tt class="xref c c-type docutils literal"><span class="pre">Py_UNICODE</span></tt></a> buffer of the object. <em>o</em> has to be a <a class="reference internal" href="#PyUnicodeObject" title="PyUnicodeObject"><tt class="xref c c-type docutils literal"><span class="pre">PyUnicodeObject</span></tt></a> (not checked).</p> </dd></dl> <dl class="function"> <dt id="PyUnicode_AS_DATA"> const char* <tt class="descname">PyUnicode_AS_DATA</tt><big>(</big><a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> *o</em><big>)</big><a class="headerlink" href="#PyUnicode_AS_DATA" title="Permalink to this definition">¶</a></dt> <dd><p>Return a pointer to the internal buffer of the object. <em>o</em> has to be a <a class="reference internal" href="#PyUnicodeObject" title="PyUnicodeObject"><tt class="xref c c-type docutils literal"><span class="pre">PyUnicodeObject</span></tt></a> (not checked).</p> </dd></dl> <dl class="function"> <dt id="PyUnicode_ClearFreeList"> int <tt class="descname">PyUnicode_ClearFreeList</tt><big>(</big><big>)</big><a class="headerlink" href="#PyUnicode_ClearFreeList" title="Permalink to this definition">¶</a></dt> <dd><p>Clear the free list. Return the total number of freed items.</p> <p class="versionadded"> <span class="versionmodified">New in version 2.6.</span></p> </dd></dl> </div> <div class="section" id="unicode-character-properties"> <h3>Unicode Character Properties<a class="headerlink" href="#unicode-character-properties" title="Permalink to this headline">¶</a></h3> <p>Unicode provides many different character properties. The most often needed ones are available through these macros which are mapped to C functions depending on the Python configuration.</p> <dl class="function"> <dt id="Py_UNICODE_ISSPACE"> int <tt class="descname">Py_UNICODE_ISSPACE</tt><big>(</big><a class="reference internal" href="#Py_UNICODE" title="Py_UNICODE">Py_UNICODE</a><em> ch</em><big>)</big><a class="headerlink" href="#Py_UNICODE_ISSPACE" title="Permalink to this definition">¶</a></dt> <dd><p>Return 1 or 0 depending on whether <em>ch</em> is a whitespace character.</p> </dd></dl> <dl class="function"> <dt id="Py_UNICODE_ISLOWER"> int <tt class="descname">Py_UNICODE_ISLOWER</tt><big>(</big><a class="reference internal" href="#Py_UNICODE" title="Py_UNICODE">Py_UNICODE</a><em> ch</em><big>)</big><a class="headerlink" href="#Py_UNICODE_ISLOWER" title="Permalink to this definition">¶</a></dt> <dd><p>Return 1 or 0 depending on whether <em>ch</em> is a lowercase character.</p> </dd></dl> <dl class="function"> <dt id="Py_UNICODE_ISUPPER"> int <tt class="descname">Py_UNICODE_ISUPPER</tt><big>(</big><a class="reference internal" href="#Py_UNICODE" title="Py_UNICODE">Py_UNICODE</a><em> ch</em><big>)</big><a class="headerlink" href="#Py_UNICODE_ISUPPER" title="Permalink to this definition">¶</a></dt> <dd><p>Return 1 or 0 depending on whether <em>ch</em> is an uppercase character.</p> </dd></dl> <dl class="function"> <dt id="Py_UNICODE_ISTITLE"> int <tt class="descname">Py_UNICODE_ISTITLE</tt><big>(</big><a class="reference internal" href="#Py_UNICODE" title="Py_UNICODE">Py_UNICODE</a><em> ch</em><big>)</big><a class="headerlink" href="#Py_UNICODE_ISTITLE" title="Permalink to this definition">¶</a></dt> <dd><p>Return 1 or 0 depending on whether <em>ch</em> is a titlecase character.</p> </dd></dl> <dl class="function"> <dt id="Py_UNICODE_ISLINEBREAK"> int <tt class="descname">Py_UNICODE_ISLINEBREAK</tt><big>(</big><a class="reference internal" href="#Py_UNICODE" title="Py_UNICODE">Py_UNICODE</a><em> ch</em><big>)</big><a class="headerlink" href="#Py_UNICODE_ISLINEBREAK" title="Permalink to this definition">¶</a></dt> <dd><p>Return 1 or 0 depending on whether <em>ch</em> is a linebreak character.</p> </dd></dl> <dl class="function"> <dt id="Py_UNICODE_ISDECIMAL"> int <tt class="descname">Py_UNICODE_ISDECIMAL</tt><big>(</big><a class="reference internal" href="#Py_UNICODE" title="Py_UNICODE">Py_UNICODE</a><em> ch</em><big>)</big><a class="headerlink" href="#Py_UNICODE_ISDECIMAL" title="Permalink to this definition">¶</a></dt> <dd><p>Return 1 or 0 depending on whether <em>ch</em> is a decimal character.</p> </dd></dl> <dl class="function"> <dt id="Py_UNICODE_ISDIGIT"> int <tt class="descname">Py_UNICODE_ISDIGIT</tt><big>(</big><a class="reference internal" href="#Py_UNICODE" title="Py_UNICODE">Py_UNICODE</a><em> ch</em><big>)</big><a class="headerlink" href="#Py_UNICODE_ISDIGIT" title="Permalink to this definition">¶</a></dt> <dd><p>Return 1 or 0 depending on whether <em>ch</em> is a digit character.</p> </dd></dl> <dl class="function"> <dt id="Py_UNICODE_ISNUMERIC"> int <tt class="descname">Py_UNICODE_ISNUMERIC</tt><big>(</big><a class="reference internal" href="#Py_UNICODE" title="Py_UNICODE">Py_UNICODE</a><em> ch</em><big>)</big><a class="headerlink" href="#Py_UNICODE_ISNUMERIC" title="Permalink to this definition">¶</a></dt> <dd><p>Return 1 or 0 depending on whether <em>ch</em> is a numeric character.</p> </dd></dl> <dl class="function"> <dt id="Py_UNICODE_ISALPHA"> int <tt class="descname">Py_UNICODE_ISALPHA</tt><big>(</big><a class="reference internal" href="#Py_UNICODE" title="Py_UNICODE">Py_UNICODE</a><em> ch</em><big>)</big><a class="headerlink" href="#Py_UNICODE_ISALPHA" title="Permalink to this definition">¶</a></dt> <dd><p>Return 1 or 0 depending on whether <em>ch</em> is an alphabetic character.</p> </dd></dl> <dl class="function"> <dt id="Py_UNICODE_ISALNUM"> int <tt class="descname">Py_UNICODE_ISALNUM</tt><big>(</big><a class="reference internal" href="#Py_UNICODE" title="Py_UNICODE">Py_UNICODE</a><em> ch</em><big>)</big><a class="headerlink" href="#Py_UNICODE_ISALNUM" title="Permalink to this definition">¶</a></dt> <dd><p>Return 1 or 0 depending on whether <em>ch</em> is an alphanumeric character.</p> </dd></dl> <p>These APIs can be used for fast direct character conversions:</p> <dl class="function"> <dt id="Py_UNICODE_TOLOWER"> <a class="reference internal" href="#Py_UNICODE" title="Py_UNICODE">Py_UNICODE</a> <tt class="descname">Py_UNICODE_TOLOWER</tt><big>(</big><a class="reference internal" href="#Py_UNICODE" title="Py_UNICODE">Py_UNICODE</a><em> ch</em><big>)</big><a class="headerlink" href="#Py_UNICODE_TOLOWER" title="Permalink to this definition">¶</a></dt> <dd><p>Return the character <em>ch</em> converted to lower case.</p> </dd></dl> <dl class="function"> <dt id="Py_UNICODE_TOUPPER"> <a class="reference internal" href="#Py_UNICODE" title="Py_UNICODE">Py_UNICODE</a> <tt class="descname">Py_UNICODE_TOUPPER</tt><big>(</big><a class="reference internal" href="#Py_UNICODE" title="Py_UNICODE">Py_UNICODE</a><em> ch</em><big>)</big><a class="headerlink" href="#Py_UNICODE_TOUPPER" title="Permalink to this definition">¶</a></dt> <dd><p>Return the character <em>ch</em> converted to upper case.</p> </dd></dl> <dl class="function"> <dt id="Py_UNICODE_TOTITLE"> <a class="reference internal" href="#Py_UNICODE" title="Py_UNICODE">Py_UNICODE</a> <tt class="descname">Py_UNICODE_TOTITLE</tt><big>(</big><a class="reference internal" href="#Py_UNICODE" title="Py_UNICODE">Py_UNICODE</a><em> ch</em><big>)</big><a class="headerlink" href="#Py_UNICODE_TOTITLE" title="Permalink to this definition">¶</a></dt> <dd><p>Return the character <em>ch</em> converted to title case.</p> </dd></dl> <dl class="function"> <dt id="Py_UNICODE_TODECIMAL"> int <tt class="descname">Py_UNICODE_TODECIMAL</tt><big>(</big><a class="reference internal" href="#Py_UNICODE" title="Py_UNICODE">Py_UNICODE</a><em> ch</em><big>)</big><a class="headerlink" href="#Py_UNICODE_TODECIMAL" title="Permalink to this definition">¶</a></dt> <dd><p>Return the character <em>ch</em> converted to a decimal positive integer. Return <tt class="docutils literal"><span class="pre">-1</span></tt> if this is not possible. This macro does not raise exceptions.</p> </dd></dl> <dl class="function"> <dt id="Py_UNICODE_TODIGIT"> int <tt class="descname">Py_UNICODE_TODIGIT</tt><big>(</big><a class="reference internal" href="#Py_UNICODE" title="Py_UNICODE">Py_UNICODE</a><em> ch</em><big>)</big><a class="headerlink" href="#Py_UNICODE_TODIGIT" title="Permalink to this definition">¶</a></dt> <dd><p>Return the character <em>ch</em> converted to a single digit integer. Return <tt class="docutils literal"><span class="pre">-1</span></tt> if this is not possible. This macro does not raise exceptions.</p> </dd></dl> <dl class="function"> <dt id="Py_UNICODE_TONUMERIC"> double <tt class="descname">Py_UNICODE_TONUMERIC</tt><big>(</big><a class="reference internal" href="#Py_UNICODE" title="Py_UNICODE">Py_UNICODE</a><em> ch</em><big>)</big><a class="headerlink" href="#Py_UNICODE_TONUMERIC" title="Permalink to this definition">¶</a></dt> <dd><p>Return the character <em>ch</em> converted to a double. Return <tt class="docutils literal"><span class="pre">-1.0</span></tt> if this is not possible. This macro does not raise exceptions.</p> </dd></dl> </div> <div class="section" id="plain-py-unicode"> <h3>Plain Py_UNICODE<a class="headerlink" href="#plain-py-unicode" title="Permalink to this headline">¶</a></h3> <p>To create Unicode objects and access their basic sequence properties, use these APIs:</p> <dl class="function"> <dt id="PyUnicode_FromUnicode"> <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a>* <tt class="descname">PyUnicode_FromUnicode</tt><big>(</big>const <a class="reference internal" href="#Py_UNICODE" title="Py_UNICODE">Py_UNICODE</a><em> *u</em>, Py_ssize_t<em> size</em><big>)</big><a class="headerlink" href="#PyUnicode_FromUnicode" title="Permalink to this definition">¶</a></dt> <dd><em class="refcount">Return value: New reference.</em><p>Create a Unicode object from the Py_UNICODE buffer <em>u</em> of the given size. <em>u</em> may be <em>NULL</em> which causes the contents to be undefined. It is the user’s responsibility to fill in the needed data. The buffer is copied into the new object. If the buffer is not <em>NULL</em>, the return value might be a shared object. Therefore, modification of the resulting Unicode object is only allowed when <em>u</em> is <em>NULL</em>.</p> <p class="versionchanged"> <span class="versionmodified">Changed in version 2.5: </span>This function used an <tt class="xref c c-type docutils literal"><span class="pre">int</span></tt> type for <em>size</em>. This might require changes in your code for properly supporting 64-bit systems.</p> </dd></dl> <dl class="function"> <dt id="PyUnicode_FromStringAndSize"> <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a>* <tt class="descname">PyUnicode_FromStringAndSize</tt><big>(</big>const char<em> *u</em>, Py_ssize_t<em> size</em><big>)</big><a class="headerlink" href="#PyUnicode_FromStringAndSize" title="Permalink to this definition">¶</a></dt> <dd><em class="refcount">Return value: New reference.</em><p>Create a Unicode object from the char buffer <em>u</em>. The bytes will be interpreted as being UTF-8 encoded. <em>u</em> may also be <em>NULL</em> which causes the contents to be undefined. It is the user’s responsibility to fill in the needed data. The buffer is copied into the new object. If the buffer is not <em>NULL</em>, the return value might be a shared object. Therefore, modification of the resulting Unicode object is only allowed when <em>u</em> is <em>NULL</em>.</p> <p class="versionadded"> <span class="versionmodified">New in version 2.6.</span></p> </dd></dl> <dl class="function"> <dt id="PyUnicode_FromString"> <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a> *<tt class="descname">PyUnicode_FromString</tt><big>(</big>const char<em> *u</em><big>)</big><a class="headerlink" href="#PyUnicode_FromString" title="Permalink to this definition">¶</a></dt> <dd><em class="refcount">Return value: New reference.</em><p>Create a Unicode object from an UTF-8 encoded null-terminated char buffer <em>u</em>.</p> <p class="versionadded"> <span class="versionmodified">New in version 2.6.</span></p> </dd></dl> <dl class="function"> <dt id="PyUnicode_FromFormat"> <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a>* <tt class="descname">PyUnicode_FromFormat</tt><big>(</big>const char<em> *format</em>, ...<big>)</big><a class="headerlink" href="#PyUnicode_FromFormat" title="Permalink to this definition">¶</a></dt> <dd><em class="refcount">Return value: New reference.</em><p>Take a C <tt class="xref c c-func docutils literal"><span class="pre">printf()</span></tt>-style <em>format</em> string and a variable number of arguments, calculate the size of the resulting Python unicode 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 <em>format</em> string. The following format characters are allowed:</p> <table border="1" class="docutils"> <colgroup> <col width="26%" /> <col width="29%" /> <col width="44%" /> </colgroup> <thead valign="bottom"> <tr class="row-odd"><th class="head">Format Characters</th> <th class="head">Type</th> <th class="head">Comment</th> </tr> </thead> <tbody valign="top"> <tr class="row-even"><td><tt class="xref py py-attr docutils literal"><span class="pre">%%</span></tt></td> <td><em>n/a</em></td> <td>The literal % character.</td> </tr> <tr class="row-odd"><td><tt class="xref py py-attr docutils literal"><span class="pre">%c</span></tt></td> <td>int</td> <td>A single character, represented as an C int.</td> </tr> <tr class="row-even"><td><tt class="xref py py-attr docutils literal"><span class="pre">%d</span></tt></td> <td>int</td> <td>Exactly equivalent to <tt class="docutils literal"><span class="pre">printf("%d")</span></tt>.</td> </tr> <tr class="row-odd"><td><tt class="xref py py-attr docutils literal"><span class="pre">%u</span></tt></td> <td>unsigned int</td> <td>Exactly equivalent to <tt class="docutils literal"><span class="pre">printf("%u")</span></tt>.</td> </tr> <tr class="row-even"><td><tt class="xref py py-attr docutils literal"><span class="pre">%ld</span></tt></td> <td>long</td> <td>Exactly equivalent to <tt class="docutils literal"><span class="pre">printf("%ld")</span></tt>.</td> </tr> <tr class="row-odd"><td><tt class="xref py py-attr docutils literal"><span class="pre">%lu</span></tt></td> <td>unsigned long</td> <td>Exactly equivalent to <tt class="docutils literal"><span class="pre">printf("%lu")</span></tt>.</td> </tr> <tr class="row-even"><td><tt class="xref py py-attr docutils literal"><span class="pre">%zd</span></tt></td> <td>Py_ssize_t</td> <td>Exactly equivalent to <tt class="docutils literal"><span class="pre">printf("%zd")</span></tt>.</td> </tr> <tr class="row-odd"><td><tt class="xref py py-attr docutils literal"><span class="pre">%zu</span></tt></td> <td>size_t</td> <td>Exactly equivalent to <tt class="docutils literal"><span class="pre">printf("%zu")</span></tt>.</td> </tr> <tr class="row-even"><td><tt class="xref py py-attr docutils literal"><span class="pre">%i</span></tt></td> <td>int</td> <td>Exactly equivalent to <tt class="docutils literal"><span class="pre">printf("%i")</span></tt>.</td> </tr> <tr class="row-odd"><td><tt class="xref py py-attr docutils literal"><span class="pre">%x</span></tt></td> <td>int</td> <td>Exactly equivalent to <tt class="docutils literal"><span class="pre">printf("%x")</span></tt>.</td> </tr> <tr class="row-even"><td><tt class="xref py py-attr docutils literal"><span class="pre">%s</span></tt></td> <td>char*</td> <td>A null-terminated C character array.</td> </tr> <tr class="row-odd"><td><tt class="xref py py-attr docutils literal"><span class="pre">%p</span></tt></td> <td>void*</td> <td>The hex representation of a C pointer. Mostly equivalent to <tt class="docutils literal"><span class="pre">printf("%p")</span></tt> except that it is guaranteed to start with the literal <tt class="docutils literal"><span class="pre">0x</span></tt> regardless of what the platform’s <tt class="docutils literal"><span class="pre">printf</span></tt> yields.</td> </tr> <tr class="row-even"><td><tt class="xref py py-attr docutils literal"><span class="pre">%U</span></tt></td> <td>PyObject*</td> <td>A unicode object.</td> </tr> <tr class="row-odd"><td><tt class="xref py py-attr docutils literal"><span class="pre">%V</span></tt></td> <td>PyObject*, char *</td> <td>A unicode object (which may be <em>NULL</em>) and a null-terminated C character array as a second parameter (which will be used, if the first parameter is <em>NULL</em>).</td> </tr> <tr class="row-even"><td><tt class="xref py py-attr docutils literal"><span class="pre">%S</span></tt></td> <td>PyObject*</td> <td>The result of calling <tt class="xref py py-func docutils literal"><span class="pre">PyObject_Unicode()</span></tt>.</td> </tr> <tr class="row-odd"><td><tt class="xref py py-attr docutils literal"><span class="pre">%R</span></tt></td> <td>PyObject*</td> <td>The result of calling <tt class="xref py py-func docutils literal"><span class="pre">PyObject_Repr()</span></tt>.</td> </tr> </tbody> </table> <p>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.</p> <p class="versionadded"> <span class="versionmodified">New in version 2.6.</span></p> </dd></dl> <dl class="function"> <dt id="PyUnicode_FromFormatV"> <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a>* <tt class="descname">PyUnicode_FromFormatV</tt><big>(</big>const char<em> *format</em>, va_list<em> vargs</em><big>)</big><a class="headerlink" href="#PyUnicode_FromFormatV" title="Permalink to this definition">¶</a></dt> <dd><em class="refcount">Return value: New reference.</em><p>Identical to <tt class="xref py py-func docutils literal"><span class="pre">PyUnicode_FromFormat()</span></tt> except that it takes exactly two arguments.</p> <p class="versionadded"> <span class="versionmodified">New in version 2.6.</span></p> </dd></dl> <dl class="function"> <dt id="PyUnicode_AsUnicode"> <a class="reference internal" href="#Py_UNICODE" title="Py_UNICODE">Py_UNICODE</a>* <tt class="descname">PyUnicode_AsUnicode</tt><big>(</big><a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> *unicode</em><big>)</big><a class="headerlink" href="#PyUnicode_AsUnicode" title="Permalink to this definition">¶</a></dt> <dd><p>Return a read-only pointer to the Unicode object’s internal <a class="reference internal" href="#Py_UNICODE" title="Py_UNICODE"><tt class="xref c c-type docutils literal"><span class="pre">Py_UNICODE</span></tt></a> buffer, <em>NULL</em> if <em>unicode</em> is not a Unicode object. Note that the resulting <a class="reference internal" href="#Py_UNICODE" title="Py_UNICODE"><tt class="xref c c-type docutils literal"><span class="pre">Py_UNICODE*</span></tt></a> string may contain embedded null characters, which would cause the string to be truncated when used in most C functions.</p> </dd></dl> <dl class="function"> <dt id="PyUnicode_GetSize"> Py_ssize_t <tt class="descname">PyUnicode_GetSize</tt><big>(</big><a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> *unicode</em><big>)</big><a class="headerlink" href="#PyUnicode_GetSize" title="Permalink to this definition">¶</a></dt> <dd><p>Return the length of the Unicode object.</p> <p class="versionchanged"> <span class="versionmodified">Changed in version 2.5: </span>This function returned an <tt class="xref c c-type docutils literal"><span class="pre">int</span></tt> type. This might require changes in your code for properly supporting 64-bit systems.</p> </dd></dl> <dl class="function"> <dt id="PyUnicode_FromEncodedObject"> <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a>* <tt class="descname">PyUnicode_FromEncodedObject</tt><big>(</big><a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> *obj</em>, const char<em> *encoding</em>, const char<em> *errors</em><big>)</big><a class="headerlink" href="#PyUnicode_FromEncodedObject" title="Permalink to this definition">¶</a></dt> <dd><em class="refcount">Return value: New reference.</em><p>Coerce an encoded object <em>obj</em> to an Unicode object and return a reference with incremented refcount.</p> <p>String and other char buffer compatible objects are decoded according to the given encoding and using the error handling defined by errors. Both can be <em>NULL</em> to have the interface use the default values (see the next section for details).</p> <p>All other objects, including Unicode objects, cause a <a class="reference internal" href="../library/exceptions.html#exceptions.TypeError" title="exceptions.TypeError"><tt class="xref py py-exc docutils literal"><span class="pre">TypeError</span></tt></a> to be set.</p> <p>The API returns <em>NULL</em> if there was an error. The caller is responsible for decref’ing the returned objects.</p> </dd></dl> <dl class="function"> <dt id="PyUnicode_FromObject"> <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a>* <tt class="descname">PyUnicode_FromObject</tt><big>(</big><a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> *obj</em><big>)</big><a class="headerlink" href="#PyUnicode_FromObject" title="Permalink to this definition">¶</a></dt> <dd><em class="refcount">Return value: New reference.</em><p>Shortcut for <tt class="docutils literal"><span class="pre">PyUnicode_FromEncodedObject(obj,</span> <span class="pre">NULL,</span> <span class="pre">"strict")</span></tt> which is used throughout the interpreter whenever coercion to Unicode is needed.</p> </dd></dl> <p>If the platform supports <tt class="xref c c-type docutils literal"><span class="pre">wchar_t</span></tt> and provides a header file wchar.h, Python can interface directly to this type using the following functions. Support is optimized if Python’s own <a class="reference internal" href="#Py_UNICODE" title="Py_UNICODE"><tt class="xref c c-type docutils literal"><span class="pre">Py_UNICODE</span></tt></a> type is identical to the system’s <tt class="xref c c-type docutils literal"><span class="pre">wchar_t</span></tt>.</p> </div> <div class="section" id="wchar-t-support"> <h3>wchar_t Support<a class="headerlink" href="#wchar-t-support" title="Permalink to this headline">¶</a></h3> <p><tt class="xref c c-type docutils literal"><span class="pre">wchar_t</span></tt> support for platforms which support it:</p> <dl class="function"> <dt id="PyUnicode_FromWideChar"> <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a>* <tt class="descname">PyUnicode_FromWideChar</tt><big>(</big>const wchar_t<em> *w</em>, Py_ssize_t<em> size</em><big>)</big><a class="headerlink" href="#PyUnicode_FromWideChar" title="Permalink to this definition">¶</a></dt> <dd><em class="refcount">Return value: New reference.</em><p>Create a Unicode object from the <tt class="xref c c-type docutils literal"><span class="pre">wchar_t</span></tt> buffer <em>w</em> of the given <em>size</em>. Return <em>NULL</em> on failure.</p> <p class="versionchanged"> <span class="versionmodified">Changed in version 2.5: </span>This function used an <tt class="xref c c-type docutils literal"><span class="pre">int</span></tt> type for <em>size</em>. This might require changes in your code for properly supporting 64-bit systems.</p> </dd></dl> <dl class="function"> <dt id="PyUnicode_AsWideChar"> Py_ssize_t <tt class="descname">PyUnicode_AsWideChar</tt><big>(</big><a class="reference internal" href="#PyUnicodeObject" title="PyUnicodeObject">PyUnicodeObject</a><em> *unicode</em>, wchar_t<em> *w</em>, Py_ssize_t<em> size</em><big>)</big><a class="headerlink" href="#PyUnicode_AsWideChar" title="Permalink to this definition">¶</a></dt> <dd><p>Copy the Unicode object contents into the <tt class="xref c c-type docutils literal"><span class="pre">wchar_t</span></tt> buffer <em>w</em>. At most <em>size</em> <tt class="xref c c-type docutils literal"><span class="pre">wchar_t</span></tt> characters are copied (excluding a possibly trailing 0-termination character). Return the number of <tt class="xref c c-type docutils literal"><span class="pre">wchar_t</span></tt> characters copied or -1 in case of an error. Note that the resulting <tt class="xref c c-type docutils literal"><span class="pre">wchar_t</span></tt> string may or may not be 0-terminated. It is the responsibility of the caller to make sure that the <tt class="xref c c-type docutils literal"><span class="pre">wchar_t</span></tt> string is 0-terminated in case this is required by the application. Also, note that the <tt class="xref c c-type docutils literal"><span class="pre">wchar_t*</span></tt> string might contain null characters, which would cause the string to be truncated when used with most C functions.</p> <p class="versionchanged"> <span class="versionmodified">Changed in version 2.5: </span>This function returned an <tt class="xref c c-type docutils literal"><span class="pre">int</span></tt> type and used an <tt class="xref c c-type docutils literal"><span class="pre">int</span></tt> type for <em>size</em>. This might require changes in your code for properly supporting 64-bit systems.</p> </dd></dl> </div> </div> <div class="section" id="built-in-codecs"> <span id="builtincodecs"></span><h2>Built-in Codecs<a class="headerlink" href="#built-in-codecs" title="Permalink to this headline">¶</a></h2> <p>Python provides a set of built-in codecs which are written in C for speed. All of these codecs are directly usable via the following functions.</p> <p>Many of the following APIs take two arguments encoding and errors, and they have the same semantics as the ones of the built-in <a class="reference internal" href="../library/functions.html#unicode" title="unicode"><tt class="xref py py-func docutils literal"><span class="pre">unicode()</span></tt></a> Unicode object constructor.</p> <p>Setting encoding to <em>NULL</em> causes the default encoding to be used which is ASCII. The file system calls should use <tt class="xref c c-data docutils literal"><span class="pre">Py_FileSystemDefaultEncoding</span></tt> as the encoding for file names. This variable should be treated as read-only: on some systems, it will be a pointer to a static string, on others, it will change at run-time (such as when the application invokes setlocale).</p> <p>Error handling is set by errors which may also be set to <em>NULL</em> meaning to use the default handling defined for the codec. Default error handling for all built-in codecs is “strict” (<a class="reference internal" href="../library/exceptions.html#exceptions.ValueError" title="exceptions.ValueError"><tt class="xref py py-exc docutils literal"><span class="pre">ValueError</span></tt></a> is raised).</p> <p>The codecs all use a similar interface. Only deviation from the following generic ones are documented for simplicity.</p> <div class="section" id="generic-codecs"> <h3>Generic Codecs<a class="headerlink" href="#generic-codecs" title="Permalink to this headline">¶</a></h3> <p>These are the generic codec APIs:</p> <dl class="function"> <dt id="PyUnicode_Decode"> <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a>* <tt class="descname">PyUnicode_Decode</tt><big>(</big>const char<em> *s</em>, Py_ssize_t<em> size</em>, const char<em> *encoding</em>, const char<em> *errors</em><big>)</big><a class="headerlink" href="#PyUnicode_Decode" title="Permalink to this definition">¶</a></dt> <dd><em class="refcount">Return value: New reference.</em><p>Create a Unicode object by decoding <em>size</em> bytes of the encoded string <em>s</em>. <em>encoding</em> and <em>errors</em> have the same meaning as the parameters of the same name in the <a class="reference internal" href="../library/functions.html#unicode" title="unicode"><tt class="xref py py-func docutils literal"><span class="pre">unicode()</span></tt></a> built-in function. The codec to be used is looked up using the Python codec registry. Return <em>NULL</em> if an exception was raised by the codec.</p> <p class="versionchanged"> <span class="versionmodified">Changed in version 2.5: </span>This function used an <tt class="xref c c-type docutils literal"><span class="pre">int</span></tt> type for <em>size</em>. This might require changes in your code for properly supporting 64-bit systems.</p> </dd></dl> <dl class="function"> <dt id="PyUnicode_Encode"> <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a>* <tt class="descname">PyUnicode_Encode</tt><big>(</big>const <a class="reference internal" href="#Py_UNICODE" title="Py_UNICODE">Py_UNICODE</a><em> *s</em>, Py_ssize_t<em> size</em>, const char<em> *encoding</em>, const char<em> *errors</em><big>)</big><a class="headerlink" href="#PyUnicode_Encode" title="Permalink to this definition">¶</a></dt> <dd><em class="refcount">Return value: New reference.</em><p>Encode the <a class="reference internal" href="#Py_UNICODE" title="Py_UNICODE"><tt class="xref c c-type docutils literal"><span class="pre">Py_UNICODE</span></tt></a> buffer <em>s</em> of the given <em>size</em> and return a Python string object. <em>encoding</em> and <em>errors</em> have the same meaning as the parameters of the same name in the Unicode <tt class="xref py py-meth docutils literal"><span class="pre">encode()</span></tt> method. The codec to be used is looked up using the Python codec registry. Return <em>NULL</em> if an exception was raised by the codec.</p> <p class="versionchanged"> <span class="versionmodified">Changed in version 2.5: </span>This function used an <tt class="xref c c-type docutils literal"><span class="pre">int</span></tt> type for <em>size</em>. This might require changes in your code for properly supporting 64-bit systems.</p> </dd></dl> <dl class="function"> <dt id="PyUnicode_AsEncodedString"> <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a>* <tt class="descname">PyUnicode_AsEncodedString</tt><big>(</big><a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> *unicode</em>, const char<em> *encoding</em>, const char<em> *errors</em><big>)</big><a class="headerlink" href="#PyUnicode_AsEncodedString" title="Permalink to this definition">¶</a></dt> <dd><em class="refcount">Return value: New reference.</em><p>Encode a Unicode object and return the result as Python string object. <em>encoding</em> and <em>errors</em> have the same meaning as the parameters of the same name in the Unicode <tt class="xref py py-meth docutils literal"><span class="pre">encode()</span></tt> method. The codec to be used is looked up using the Python codec registry. Return <em>NULL</em> if an exception was raised by the codec.</p> </dd></dl> </div> <div class="section" id="utf-8-codecs"> <h3>UTF-8 Codecs<a class="headerlink" href="#utf-8-codecs" title="Permalink to this headline">¶</a></h3> <p>These are the UTF-8 codec APIs:</p> <dl class="function"> <dt id="PyUnicode_DecodeUTF8"> <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a>* <tt class="descname">PyUnicode_DecodeUTF8</tt><big>(</big>const char<em> *s</em>, Py_ssize_t<em> size</em>, const char<em> *errors</em><big>)</big><a class="headerlink" href="#PyUnicode_DecodeUTF8" title="Permalink to this definition">¶</a></dt> <dd><em class="refcount">Return value: New reference.</em><p>Create a Unicode object by decoding <em>size</em> bytes of the UTF-8 encoded string <em>s</em>. Return <em>NULL</em> if an exception was raised by the codec.</p> <p class="versionchanged"> <span class="versionmodified">Changed in version 2.5: </span>This function used an <tt class="xref c c-type docutils literal"><span class="pre">int</span></tt> type for <em>size</em>. This might require changes in your code for properly supporting 64-bit systems.</p> </dd></dl> <dl class="function"> <dt id="PyUnicode_DecodeUTF8Stateful"> <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a>* <tt class="descname">PyUnicode_DecodeUTF8Stateful</tt><big>(</big>const char<em> *s</em>, Py_ssize_t<em> size</em>, const char<em> *errors</em>, Py_ssize_t<em> *consumed</em><big>)</big><a class="headerlink" href="#PyUnicode_DecodeUTF8Stateful" title="Permalink to this definition">¶</a></dt> <dd><em class="refcount">Return value: New reference.</em><p>If <em>consumed</em> is <em>NULL</em>, behave like <a class="reference internal" href="#PyUnicode_DecodeUTF8" title="PyUnicode_DecodeUTF8"><tt class="xref c c-func docutils literal"><span class="pre">PyUnicode_DecodeUTF8()</span></tt></a>. If <em>consumed</em> is not <em>NULL</em>, trailing incomplete UTF-8 byte sequences will not be treated as an error. Those bytes will not be decoded and the number of bytes that have been decoded will be stored in <em>consumed</em>.</p> <p class="versionadded"> <span class="versionmodified">New in version 2.4.</span></p> <p class="versionchanged"> <span class="versionmodified">Changed in version 2.5: </span>This function used an <tt class="xref c c-type docutils literal"><span class="pre">int</span></tt> type for <em>size</em>. This might require changes in your code for properly supporting 64-bit systems.</p> </dd></dl> <dl class="function"> <dt id="PyUnicode_EncodeUTF8"> <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a>* <tt class="descname">PyUnicode_EncodeUTF8</tt><big>(</big>const <a class="reference internal" href="#Py_UNICODE" title="Py_UNICODE">Py_UNICODE</a><em> *s</em>, Py_ssize_t<em> size</em>, const char<em> *errors</em><big>)</big><a class="headerlink" href="#PyUnicode_EncodeUTF8" title="Permalink to this definition">¶</a></dt> <dd><em class="refcount">Return value: New reference.</em><p>Encode the <a class="reference internal" href="#Py_UNICODE" title="Py_UNICODE"><tt class="xref c c-type docutils literal"><span class="pre">Py_UNICODE</span></tt></a> buffer <em>s</em> of the given <em>size</em> using UTF-8 and return a Python string object. Return <em>NULL</em> if an exception was raised by the codec.</p> <p class="versionchanged"> <span class="versionmodified">Changed in version 2.5: </span>This function used an <tt class="xref c c-type docutils literal"><span class="pre">int</span></tt> type for <em>size</em>. This might require changes in your code for properly supporting 64-bit systems.</p> </dd></dl> <dl class="function"> <dt id="PyUnicode_AsUTF8String"> <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a>* <tt class="descname">PyUnicode_AsUTF8String</tt><big>(</big><a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> *unicode</em><big>)</big><a class="headerlink" href="#PyUnicode_AsUTF8String" title="Permalink to this definition">¶</a></dt> <dd><em class="refcount">Return value: New reference.</em><p>Encode a Unicode object using UTF-8 and return the result as Python string object. Error handling is “strict”. Return <em>NULL</em> if an exception was raised by the codec.</p> </dd></dl> </div> <div class="section" id="utf-32-codecs"> <h3>UTF-32 Codecs<a class="headerlink" href="#utf-32-codecs" title="Permalink to this headline">¶</a></h3> <p>These are the UTF-32 codec APIs:</p> <dl class="function"> <dt id="PyUnicode_DecodeUTF32"> <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a>* <tt class="descname">PyUnicode_DecodeUTF32</tt><big>(</big>const char<em> *s</em>, Py_ssize_t<em> size</em>, const char<em> *errors</em>, int<em> *byteorder</em><big>)</big><a class="headerlink" href="#PyUnicode_DecodeUTF32" title="Permalink to this definition">¶</a></dt> <dd><p>Decode <em>size</em> bytes from a UTF-32 encoded buffer string and return the corresponding Unicode object. <em>errors</em> (if non-<em>NULL</em>) defines the error handling. It defaults to “strict”.</p> <p>If <em>byteorder</em> is non-<em>NULL</em>, the decoder starts decoding using the given byte order:</p> <div class="highlight-c"><div class="highlight"><pre><span class="o">*</span><span class="n">byteorder</span> <span class="o">==</span> <span class="o">-</span><span class="mi">1</span><span class="o">:</span> <span class="n">little</span> <span class="n">endian</span> <span class="o">*</span><span class="n">byteorder</span> <span class="o">==</span> <span class="mi">0</span><span class="o">:</span> <span class="n">native</span> <span class="n">order</span> <span class="o">*</span><span class="n">byteorder</span> <span class="o">==</span> <span class="mi">1</span><span class="o">:</span> <span class="n">big</span> <span class="n">endian</span> </pre></div> </div> <p>If <tt class="docutils literal"><span class="pre">*byteorder</span></tt> is zero, and the first four bytes of the input data are a byte order mark (BOM), the decoder switches to this byte order and the BOM is not copied into the resulting Unicode string. If <tt class="docutils literal"><span class="pre">*byteorder</span></tt> is <tt class="docutils literal"><span class="pre">-1</span></tt> or <tt class="docutils literal"><span class="pre">1</span></tt>, any byte order mark is copied to the output.</p> <p>After completion, <em>*byteorder</em> is set to the current byte order at the end of input data.</p> <p>In a narrow build codepoints outside the BMP will be decoded as surrogate pairs.</p> <p>If <em>byteorder</em> is <em>NULL</em>, the codec starts in native order mode.</p> <p>Return <em>NULL</em> if an exception was raised by the codec.</p> <p class="versionadded"> <span class="versionmodified">New in version 2.6.</span></p> </dd></dl> <dl class="function"> <dt id="PyUnicode_DecodeUTF32Stateful"> <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a>* <tt class="descname">PyUnicode_DecodeUTF32Stateful</tt><big>(</big>const char<em> *s</em>, Py_ssize_t<em> size</em>, const char<em> *errors</em>, int<em> *byteorder</em>, Py_ssize_t<em> *consumed</em><big>)</big><a class="headerlink" href="#PyUnicode_DecodeUTF32Stateful" title="Permalink to this definition">¶</a></dt> <dd><p>If <em>consumed</em> is <em>NULL</em>, behave like <a class="reference internal" href="#PyUnicode_DecodeUTF32" title="PyUnicode_DecodeUTF32"><tt class="xref c c-func docutils literal"><span class="pre">PyUnicode_DecodeUTF32()</span></tt></a>. If <em>consumed</em> is not <em>NULL</em>, <a class="reference internal" href="#PyUnicode_DecodeUTF32Stateful" title="PyUnicode_DecodeUTF32Stateful"><tt class="xref c c-func docutils literal"><span class="pre">PyUnicode_DecodeUTF32Stateful()</span></tt></a> will not treat trailing incomplete UTF-32 byte sequences (such as a number of bytes not divisible by four) as an error. Those bytes will not be decoded and the number of bytes that have been decoded will be stored in <em>consumed</em>.</p> <p class="versionadded"> <span class="versionmodified">New in version 2.6.</span></p> </dd></dl> <dl class="function"> <dt id="PyUnicode_EncodeUTF32"> <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a>* <tt class="descname">PyUnicode_EncodeUTF32</tt><big>(</big>const <a class="reference internal" href="#Py_UNICODE" title="Py_UNICODE">Py_UNICODE</a><em> *s</em>, Py_ssize_t<em> size</em>, const char<em> *errors</em>, int<em> byteorder</em><big>)</big><a class="headerlink" href="#PyUnicode_EncodeUTF32" title="Permalink to this definition">¶</a></dt> <dd><p>Return a Python bytes object holding the UTF-32 encoded value of the Unicode data in <em>s</em>. Output is written according to the following byte order:</p> <div class="highlight-c"><div class="highlight"><pre><span class="n">byteorder</span> <span class="o">==</span> <span class="o">-</span><span class="mi">1</span><span class="o">:</span> <span class="n">little</span> <span class="n">endian</span> <span class="n">byteorder</span> <span class="o">==</span> <span class="mi">0</span><span class="o">:</span> <span class="n">native</span> <span class="n">byte</span> <span class="n">order</span> <span class="p">(</span><span class="n">writes</span> <span class="n">a</span> <span class="n">BOM</span> <span class="n">mark</span><span class="p">)</span> <span class="n">byteorder</span> <span class="o">==</span> <span class="mi">1</span><span class="o">:</span> <span class="n">big</span> <span class="n">endian</span> </pre></div> </div> <p>If byteorder is <tt class="docutils literal"><span class="pre">0</span></tt>, the output string will always start with the Unicode BOM mark (U+FEFF). In the other two modes, no BOM mark is prepended.</p> <p>If <em>Py_UNICODE_WIDE</em> is not defined, surrogate pairs will be output as a single codepoint.</p> <p>Return <em>NULL</em> if an exception was raised by the codec.</p> <p class="versionadded"> <span class="versionmodified">New in version 2.6.</span></p> </dd></dl> <dl class="function"> <dt id="PyUnicode_AsUTF32String"> <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a>* <tt class="descname">PyUnicode_AsUTF32String</tt><big>(</big><a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> *unicode</em><big>)</big><a class="headerlink" href="#PyUnicode_AsUTF32String" title="Permalink to this definition">¶</a></dt> <dd><p>Return a Python string using the UTF-32 encoding in native byte order. The string always starts with a BOM mark. Error handling is “strict”. Return <em>NULL</em> if an exception was raised by the codec.</p> <p class="versionadded"> <span class="versionmodified">New in version 2.6.</span></p> </dd></dl> </div> <div class="section" id="utf-16-codecs"> <h3>UTF-16 Codecs<a class="headerlink" href="#utf-16-codecs" title="Permalink to this headline">¶</a></h3> <p>These are the UTF-16 codec APIs:</p> <dl class="function"> <dt id="PyUnicode_DecodeUTF16"> <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a>* <tt class="descname">PyUnicode_DecodeUTF16</tt><big>(</big>const char<em> *s</em>, Py_ssize_t<em> size</em>, const char<em> *errors</em>, int<em> *byteorder</em><big>)</big><a class="headerlink" href="#PyUnicode_DecodeUTF16" title="Permalink to this definition">¶</a></dt> <dd><em class="refcount">Return value: New reference.</em><p>Decode <em>size</em> bytes from a UTF-16 encoded buffer string and return the corresponding Unicode object. <em>errors</em> (if non-<em>NULL</em>) defines the error handling. It defaults to “strict”.</p> <p>If <em>byteorder</em> is non-<em>NULL</em>, the decoder starts decoding using the given byte order:</p> <div class="highlight-c"><div class="highlight"><pre><span class="o">*</span><span class="n">byteorder</span> <span class="o">==</span> <span class="o">-</span><span class="mi">1</span><span class="o">:</span> <span class="n">little</span> <span class="n">endian</span> <span class="o">*</span><span class="n">byteorder</span> <span class="o">==</span> <span class="mi">0</span><span class="o">:</span> <span class="n">native</span> <span class="n">order</span> <span class="o">*</span><span class="n">byteorder</span> <span class="o">==</span> <span class="mi">1</span><span class="o">:</span> <span class="n">big</span> <span class="n">endian</span> </pre></div> </div> <p>If <tt class="docutils literal"><span class="pre">*byteorder</span></tt> is zero, and the first two bytes of the input data are a byte order mark (BOM), the decoder switches to this byte order and the BOM is not copied into the resulting Unicode string. If <tt class="docutils literal"><span class="pre">*byteorder</span></tt> is <tt class="docutils literal"><span class="pre">-1</span></tt> or <tt class="docutils literal"><span class="pre">1</span></tt>, any byte order mark is copied to the output (where it will result in either a <tt class="docutils literal"><span class="pre">\ufeff</span></tt> or a <tt class="docutils literal"><span class="pre">\ufffe</span></tt> character).</p> <p>After completion, <em>*byteorder</em> is set to the current byte order at the end of input data.</p> <p>If <em>byteorder</em> is <em>NULL</em>, the codec starts in native order mode.</p> <p>Return <em>NULL</em> if an exception was raised by the codec.</p> <p class="versionchanged"> <span class="versionmodified">Changed in version 2.5: </span>This function used an <tt class="xref c c-type docutils literal"><span class="pre">int</span></tt> type for <em>size</em>. This might require changes in your code for properly supporting 64-bit systems.</p> </dd></dl> <dl class="function"> <dt id="PyUnicode_DecodeUTF16Stateful"> <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a>* <tt class="descname">PyUnicode_DecodeUTF16Stateful</tt><big>(</big>const char<em> *s</em>, Py_ssize_t<em> size</em>, const char<em> *errors</em>, int<em> *byteorder</em>, Py_ssize_t<em> *consumed</em><big>)</big><a class="headerlink" href="#PyUnicode_DecodeUTF16Stateful" title="Permalink to this definition">¶</a></dt> <dd><em class="refcount">Return value: New reference.</em><p>If <em>consumed</em> is <em>NULL</em>, behave like <a class="reference internal" href="#PyUnicode_DecodeUTF16" title="PyUnicode_DecodeUTF16"><tt class="xref c c-func docutils literal"><span class="pre">PyUnicode_DecodeUTF16()</span></tt></a>. If <em>consumed</em> is not <em>NULL</em>, <a class="reference internal" href="#PyUnicode_DecodeUTF16Stateful" title="PyUnicode_DecodeUTF16Stateful"><tt class="xref c c-func docutils literal"><span class="pre">PyUnicode_DecodeUTF16Stateful()</span></tt></a> will not treat trailing incomplete UTF-16 byte sequences (such as an odd number of bytes or a split surrogate pair) as an error. Those bytes will not be decoded and the number of bytes that have been decoded will be stored in <em>consumed</em>.</p> <p class="versionadded"> <span class="versionmodified">New in version 2.4.</span></p> <p class="versionchanged"> <span class="versionmodified">Changed in version 2.5: </span>This function used an <tt class="xref c c-type docutils literal"><span class="pre">int</span></tt> type for <em>size</em> and an <tt class="xref c c-type docutils literal"><span class="pre">int</span> <span class="pre">*</span></tt> type for <em>consumed</em>. This might require changes in your code for properly supporting 64-bit systems.</p> </dd></dl> <dl class="function"> <dt id="PyUnicode_EncodeUTF16"> <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a>* <tt class="descname">PyUnicode_EncodeUTF16</tt><big>(</big>const <a class="reference internal" href="#Py_UNICODE" title="Py_UNICODE">Py_UNICODE</a><em> *s</em>, Py_ssize_t<em> size</em>, const char<em> *errors</em>, int<em> byteorder</em><big>)</big><a class="headerlink" href="#PyUnicode_EncodeUTF16" title="Permalink to this definition">¶</a></dt> <dd><em class="refcount">Return value: New reference.</em><p>Return a Python string object holding the UTF-16 encoded value of the Unicode data in <em>s</em>. Output is written according to the following byte order:</p> <div class="highlight-c"><div class="highlight"><pre><span class="n">byteorder</span> <span class="o">==</span> <span class="o">-</span><span class="mi">1</span><span class="o">:</span> <span class="n">little</span> <span class="n">endian</span> <span class="n">byteorder</span> <span class="o">==</span> <span class="mi">0</span><span class="o">:</span> <span class="n">native</span> <span class="n">byte</span> <span class="n">order</span> <span class="p">(</span><span class="n">writes</span> <span class="n">a</span> <span class="n">BOM</span> <span class="n">mark</span><span class="p">)</span> <span class="n">byteorder</span> <span class="o">==</span> <span class="mi">1</span><span class="o">:</span> <span class="n">big</span> <span class="n">endian</span> </pre></div> </div> <p>If byteorder is <tt class="docutils literal"><span class="pre">0</span></tt>, the output string will always start with the Unicode BOM mark (U+FEFF). In the other two modes, no BOM mark is prepended.</p> <p>If <em>Py_UNICODE_WIDE</em> is defined, a single <a class="reference internal" href="#Py_UNICODE" title="Py_UNICODE"><tt class="xref c c-type docutils literal"><span class="pre">Py_UNICODE</span></tt></a> value may get represented as a surrogate pair. If it is not defined, each <a class="reference internal" href="#Py_UNICODE" title="Py_UNICODE"><tt class="xref c c-type docutils literal"><span class="pre">Py_UNICODE</span></tt></a> values is interpreted as an UCS-2 character.</p> <p>Return <em>NULL</em> if an exception was raised by the codec.</p> <p class="versionchanged"> <span class="versionmodified">Changed in version 2.5: </span>This function used an <tt class="xref c c-type docutils literal"><span class="pre">int</span></tt> type for <em>size</em>. This might require changes in your code for properly supporting 64-bit systems.</p> </dd></dl> <dl class="function"> <dt id="PyUnicode_AsUTF16String"> <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a>* <tt class="descname">PyUnicode_AsUTF16String</tt><big>(</big><a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> *unicode</em><big>)</big><a class="headerlink" href="#PyUnicode_AsUTF16String" title="Permalink to this definition">¶</a></dt> <dd><em class="refcount">Return value: New reference.</em><p>Return a Python string using the UTF-16 encoding in native byte order. The string always starts with a BOM mark. Error handling is “strict”. Return <em>NULL</em> if an exception was raised by the codec.</p> </dd></dl> </div> <div class="section" id="utf-7-codecs"> <h3>UTF-7 Codecs<a class="headerlink" href="#utf-7-codecs" title="Permalink to this headline">¶</a></h3> <p>These are the UTF-7 codec APIs:</p> <dl class="function"> <dt id="PyUnicode_DecodeUTF7"> <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a>* <tt class="descname">PyUnicode_DecodeUTF7</tt><big>(</big>const char<em> *s</em>, Py_ssize_t<em> size</em>, const char<em> *errors</em><big>)</big><a class="headerlink" href="#PyUnicode_DecodeUTF7" title="Permalink to this definition">¶</a></dt> <dd><p>Create a Unicode object by decoding <em>size</em> bytes of the UTF-7 encoded string <em>s</em>. Return <em>NULL</em> if an exception was raised by the codec.</p> </dd></dl> <dl class="function"> <dt id="PyUnicode_DecodeUTF7Stateful"> <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a>* <tt class="descname">PyUnicode_DecodeUTF7Stateful</tt><big>(</big>const char<em> *s</em>, Py_ssize_t<em> size</em>, const char<em> *errors</em>, Py_ssize_t<em> *consumed</em><big>)</big><a class="headerlink" href="#PyUnicode_DecodeUTF7Stateful" title="Permalink to this definition">¶</a></dt> <dd><p>If <em>consumed</em> is <em>NULL</em>, behave like <a class="reference internal" href="#PyUnicode_DecodeUTF7" title="PyUnicode_DecodeUTF7"><tt class="xref c c-func docutils literal"><span class="pre">PyUnicode_DecodeUTF7()</span></tt></a>. If <em>consumed</em> is not <em>NULL</em>, trailing incomplete UTF-7 base-64 sections will not be treated as an error. Those bytes will not be decoded and the number of bytes that have been decoded will be stored in <em>consumed</em>.</p> </dd></dl> <dl class="function"> <dt id="PyUnicode_EncodeUTF7"> <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a>* <tt class="descname">PyUnicode_EncodeUTF7</tt><big>(</big>const <a class="reference internal" href="#Py_UNICODE" title="Py_UNICODE">Py_UNICODE</a><em> *s</em>, Py_ssize_t<em> size</em>, int<em> base64SetO</em>, int<em> base64WhiteSpace</em>, const char<em> *errors</em><big>)</big><a class="headerlink" href="#PyUnicode_EncodeUTF7" title="Permalink to this definition">¶</a></dt> <dd><p>Encode the <a class="reference internal" href="#Py_UNICODE" title="Py_UNICODE"><tt class="xref c c-type docutils literal"><span class="pre">Py_UNICODE</span></tt></a> buffer of the given size using UTF-7 and return a Python bytes object. Return <em>NULL</em> if an exception was raised by the codec.</p> <p>If <em>base64SetO</em> is nonzero, “Set O” (punctuation that has no otherwise special meaning) will be encoded in base-64. If <em>base64WhiteSpace</em> is nonzero, whitespace will be encoded in base-64. Both are set to zero for the Python “utf-7” codec.</p> </dd></dl> </div> <div class="section" id="unicode-escape-codecs"> <h3>Unicode-Escape Codecs<a class="headerlink" href="#unicode-escape-codecs" title="Permalink to this headline">¶</a></h3> <p>These are the “Unicode Escape” codec APIs:</p> <dl class="function"> <dt id="PyUnicode_DecodeUnicodeEscape"> <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a>* <tt class="descname">PyUnicode_DecodeUnicodeEscape</tt><big>(</big>const char<em> *s</em>, Py_ssize_t<em> size</em>, const char<em> *errors</em><big>)</big><a class="headerlink" href="#PyUnicode_DecodeUnicodeEscape" title="Permalink to this definition">¶</a></dt> <dd><em class="refcount">Return value: New reference.</em><p>Create a Unicode object by decoding <em>size</em> bytes of the Unicode-Escape encoded string <em>s</em>. Return <em>NULL</em> if an exception was raised by the codec.</p> <p class="versionchanged"> <span class="versionmodified">Changed in version 2.5: </span>This function used an <tt class="xref c c-type docutils literal"><span class="pre">int</span></tt> type for <em>size</em>. This might require changes in your code for properly supporting 64-bit systems.</p> </dd></dl> <dl class="function"> <dt id="PyUnicode_EncodeUnicodeEscape"> <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a>* <tt class="descname">PyUnicode_EncodeUnicodeEscape</tt><big>(</big>const <a class="reference internal" href="#Py_UNICODE" title="Py_UNICODE">Py_UNICODE</a><em> *s</em>, Py_ssize_t<em> size</em><big>)</big><a class="headerlink" href="#PyUnicode_EncodeUnicodeEscape" title="Permalink to this definition">¶</a></dt> <dd><em class="refcount">Return value: New reference.</em><p>Encode the <a class="reference internal" href="#Py_UNICODE" title="Py_UNICODE"><tt class="xref c c-type docutils literal"><span class="pre">Py_UNICODE</span></tt></a> buffer of the given <em>size</em> using Unicode-Escape and return a Python string object. Return <em>NULL</em> if an exception was raised by the codec.</p> <p class="versionchanged"> <span class="versionmodified">Changed in version 2.5: </span>This function used an <tt class="xref c c-type docutils literal"><span class="pre">int</span></tt> type for <em>size</em>. This might require changes in your code for properly supporting 64-bit systems.</p> </dd></dl> <dl class="function"> <dt id="PyUnicode_AsUnicodeEscapeString"> <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a>* <tt class="descname">PyUnicode_AsUnicodeEscapeString</tt><big>(</big><a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> *unicode</em><big>)</big><a class="headerlink" href="#PyUnicode_AsUnicodeEscapeString" title="Permalink to this definition">¶</a></dt> <dd><em class="refcount">Return value: New reference.</em><p>Encode a Unicode object using Unicode-Escape and return the result as Python string object. Error handling is “strict”. Return <em>NULL</em> if an exception was raised by the codec.</p> </dd></dl> </div> <div class="section" id="raw-unicode-escape-codecs"> <h3>Raw-Unicode-Escape Codecs<a class="headerlink" href="#raw-unicode-escape-codecs" title="Permalink to this headline">¶</a></h3> <p>These are the “Raw Unicode Escape” codec APIs:</p> <dl class="function"> <dt id="PyUnicode_DecodeRawUnicodeEscape"> <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a>* <tt class="descname">PyUnicode_DecodeRawUnicodeEscape</tt><big>(</big>const char<em> *s</em>, Py_ssize_t<em> size</em>, const char<em> *errors</em><big>)</big><a class="headerlink" href="#PyUnicode_DecodeRawUnicodeEscape" title="Permalink to this definition">¶</a></dt> <dd><em class="refcount">Return value: New reference.</em><p>Create a Unicode object by decoding <em>size</em> bytes of the Raw-Unicode-Escape encoded string <em>s</em>. Return <em>NULL</em> if an exception was raised by the codec.</p> <p class="versionchanged"> <span class="versionmodified">Changed in version 2.5: </span>This function used an <tt class="xref c c-type docutils literal"><span class="pre">int</span></tt> type for <em>size</em>. This might require changes in your code for properly supporting 64-bit systems.</p> </dd></dl> <dl class="function"> <dt id="PyUnicode_EncodeRawUnicodeEscape"> <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a>* <tt class="descname">PyUnicode_EncodeRawUnicodeEscape</tt><big>(</big>const <a class="reference internal" href="#Py_UNICODE" title="Py_UNICODE">Py_UNICODE</a><em> *s</em>, Py_ssize_t<em> size</em>, const char<em> *errors</em><big>)</big><a class="headerlink" href="#PyUnicode_EncodeRawUnicodeEscape" title="Permalink to this definition">¶</a></dt> <dd><em class="refcount">Return value: New reference.</em><p>Encode the <a class="reference internal" href="#Py_UNICODE" title="Py_UNICODE"><tt class="xref c c-type docutils literal"><span class="pre">Py_UNICODE</span></tt></a> buffer of the given <em>size</em> using Raw-Unicode-Escape and return a Python string object. Return <em>NULL</em> if an exception was raised by the codec.</p> <p class="versionchanged"> <span class="versionmodified">Changed in version 2.5: </span>This function used an <tt class="xref c c-type docutils literal"><span class="pre">int</span></tt> type for <em>size</em>. This might require changes in your code for properly supporting 64-bit systems.</p> </dd></dl> <dl class="function"> <dt id="PyUnicode_AsRawUnicodeEscapeString"> <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a>* <tt class="descname">PyUnicode_AsRawUnicodeEscapeString</tt><big>(</big><a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> *unicode</em><big>)</big><a class="headerlink" href="#PyUnicode_AsRawUnicodeEscapeString" title="Permalink to this definition">¶</a></dt> <dd><em class="refcount">Return value: New reference.</em><p>Encode a Unicode object using Raw-Unicode-Escape and return the result as Python string object. Error handling is “strict”. Return <em>NULL</em> if an exception was raised by the codec.</p> </dd></dl> </div> <div class="section" id="latin-1-codecs"> <h3>Latin-1 Codecs<a class="headerlink" href="#latin-1-codecs" title="Permalink to this headline">¶</a></h3> <p>These are the Latin-1 codec APIs: Latin-1 corresponds to the first 256 Unicode ordinals and only these are accepted by the codecs during encoding.</p> <dl class="function"> <dt id="PyUnicode_DecodeLatin1"> <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a>* <tt class="descname">PyUnicode_DecodeLatin1</tt><big>(</big>const char<em> *s</em>, Py_ssize_t<em> size</em>, const char<em> *errors</em><big>)</big><a class="headerlink" href="#PyUnicode_DecodeLatin1" title="Permalink to this definition">¶</a></dt> <dd><em class="refcount">Return value: New reference.</em><p>Create a Unicode object by decoding <em>size</em> bytes of the Latin-1 encoded string <em>s</em>. Return <em>NULL</em> if an exception was raised by the codec.</p> <p class="versionchanged"> <span class="versionmodified">Changed in version 2.5: </span>This function used an <tt class="xref c c-type docutils literal"><span class="pre">int</span></tt> type for <em>size</em>. This might require changes in your code for properly supporting 64-bit systems.</p> </dd></dl> <dl class="function"> <dt id="PyUnicode_EncodeLatin1"> <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a>* <tt class="descname">PyUnicode_EncodeLatin1</tt><big>(</big>const <a class="reference internal" href="#Py_UNICODE" title="Py_UNICODE">Py_UNICODE</a><em> *s</em>, Py_ssize_t<em> size</em>, const char<em> *errors</em><big>)</big><a class="headerlink" href="#PyUnicode_EncodeLatin1" title="Permalink to this definition">¶</a></dt> <dd><em class="refcount">Return value: New reference.</em><p>Encode the <a class="reference internal" href="#Py_UNICODE" title="Py_UNICODE"><tt class="xref c c-type docutils literal"><span class="pre">Py_UNICODE</span></tt></a> buffer of the given <em>size</em> using Latin-1 and return a Python string object. Return <em>NULL</em> if an exception was raised by the codec.</p> <p class="versionchanged"> <span class="versionmodified">Changed in version 2.5: </span>This function used an <tt class="xref c c-type docutils literal"><span class="pre">int</span></tt> type for <em>size</em>. This might require changes in your code for properly supporting 64-bit systems.</p> </dd></dl> <dl class="function"> <dt id="PyUnicode_AsLatin1String"> <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a>* <tt class="descname">PyUnicode_AsLatin1String</tt><big>(</big><a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> *unicode</em><big>)</big><a class="headerlink" href="#PyUnicode_AsLatin1String" title="Permalink to this definition">¶</a></dt> <dd><em class="refcount">Return value: New reference.</em><p>Encode a Unicode object using Latin-1 and return the result as Python string object. Error handling is “strict”. Return <em>NULL</em> if an exception was raised by the codec.</p> </dd></dl> </div> <div class="section" id="ascii-codecs"> <h3>ASCII Codecs<a class="headerlink" href="#ascii-codecs" title="Permalink to this headline">¶</a></h3> <p>These are the ASCII codec APIs. Only 7-bit ASCII data is accepted. All other codes generate errors.</p> <dl class="function"> <dt id="PyUnicode_DecodeASCII"> <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a>* <tt class="descname">PyUnicode_DecodeASCII</tt><big>(</big>const char<em> *s</em>, Py_ssize_t<em> size</em>, const char<em> *errors</em><big>)</big><a class="headerlink" href="#PyUnicode_DecodeASCII" title="Permalink to this definition">¶</a></dt> <dd><em class="refcount">Return value: New reference.</em><p>Create a Unicode object by decoding <em>size</em> bytes of the ASCII encoded string <em>s</em>. Return <em>NULL</em> if an exception was raised by the codec.</p> <p class="versionchanged"> <span class="versionmodified">Changed in version 2.5: </span>This function used an <tt class="xref c c-type docutils literal"><span class="pre">int</span></tt> type for <em>size</em>. This might require changes in your code for properly supporting 64-bit systems.</p> </dd></dl> <dl class="function"> <dt id="PyUnicode_EncodeASCII"> <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a>* <tt class="descname">PyUnicode_EncodeASCII</tt><big>(</big>const <a class="reference internal" href="#Py_UNICODE" title="Py_UNICODE">Py_UNICODE</a><em> *s</em>, Py_ssize_t<em> size</em>, const char<em> *errors</em><big>)</big><a class="headerlink" href="#PyUnicode_EncodeASCII" title="Permalink to this definition">¶</a></dt> <dd><em class="refcount">Return value: New reference.</em><p>Encode the <a class="reference internal" href="#Py_UNICODE" title="Py_UNICODE"><tt class="xref c c-type docutils literal"><span class="pre">Py_UNICODE</span></tt></a> buffer of the given <em>size</em> using ASCII and return a Python string object. Return <em>NULL</em> if an exception was raised by the codec.</p> <p class="versionchanged"> <span class="versionmodified">Changed in version 2.5: </span>This function used an <tt class="xref c c-type docutils literal"><span class="pre">int</span></tt> type for <em>size</em>. This might require changes in your code for properly supporting 64-bit systems.</p> </dd></dl> <dl class="function"> <dt id="PyUnicode_AsASCIIString"> <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a>* <tt class="descname">PyUnicode_AsASCIIString</tt><big>(</big><a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> *unicode</em><big>)</big><a class="headerlink" href="#PyUnicode_AsASCIIString" title="Permalink to this definition">¶</a></dt> <dd><em class="refcount">Return value: New reference.</em><p>Encode a Unicode object using ASCII and return the result as Python string object. Error handling is “strict”. Return <em>NULL</em> if an exception was raised by the codec.</p> </dd></dl> </div> <div class="section" id="character-map-codecs"> <h3>Character Map Codecs<a class="headerlink" href="#character-map-codecs" title="Permalink to this headline">¶</a></h3> <p>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 codecs included in the <tt class="xref py py-mod docutils literal"><span class="pre">encodings</span></tt> package). The codec uses mapping to encode and decode characters.</p> <p>Decoding mappings must map single string characters to single Unicode characters, integers (which are then interpreted as Unicode ordinals) or None (meaning “undefined mapping” and causing an error).</p> <p>Encoding mappings must map single Unicode characters to single string characters, integers (which are then interpreted as Latin-1 ordinals) or None (meaning “undefined mapping” and causing an error).</p> <p>The mapping objects provided must only support the __getitem__ mapping interface.</p> <p>If a character lookup fails with a LookupError, the character is copied as-is meaning that its ordinal value will be interpreted as Unicode or Latin-1 ordinal resp. Because of this, mappings only need to contain those mappings which map characters to different code points.</p> <p>These are the mapping codec APIs:</p> <dl class="function"> <dt id="PyUnicode_DecodeCharmap"> <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a>* <tt class="descname">PyUnicode_DecodeCharmap</tt><big>(</big>const char<em> *s</em>, Py_ssize_t<em> size</em>, <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> *mapping</em>, const char<em> *errors</em><big>)</big><a class="headerlink" href="#PyUnicode_DecodeCharmap" title="Permalink to this definition">¶</a></dt> <dd><em class="refcount">Return value: New reference.</em><p>Create a Unicode object by decoding <em>size</em> bytes of the encoded string <em>s</em> using the given <em>mapping</em> object. Return <em>NULL</em> if an exception was raised by the codec. If <em>mapping</em> is <em>NULL</em> latin-1 decoding will be done. Else it can be a dictionary 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” are treated as “undefined mapping”.</p> <p class="versionchanged"> <span class="versionmodified">Changed in version 2.4: </span>Allowed unicode string as mapping argument.</p> <p class="versionchanged"> <span class="versionmodified">Changed in version 2.5: </span>This function used an <tt class="xref c c-type docutils literal"><span class="pre">int</span></tt> type for <em>size</em>. This might require changes in your code for properly supporting 64-bit systems.</p> </dd></dl> <dl class="function"> <dt id="PyUnicode_EncodeCharmap"> <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a>* <tt class="descname">PyUnicode_EncodeCharmap</tt><big>(</big>const <a class="reference internal" href="#Py_UNICODE" title="Py_UNICODE">Py_UNICODE</a><em> *s</em>, Py_ssize_t<em> size</em>, <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> *mapping</em>, const char<em> *errors</em><big>)</big><a class="headerlink" href="#PyUnicode_EncodeCharmap" title="Permalink to this definition">¶</a></dt> <dd><em class="refcount">Return value: New reference.</em><p>Encode the <a class="reference internal" href="#Py_UNICODE" title="Py_UNICODE"><tt class="xref c c-type docutils literal"><span class="pre">Py_UNICODE</span></tt></a> buffer of the given <em>size</em> using the given <em>mapping</em> object and return a Python string object. Return <em>NULL</em> if an exception was raised by the codec.</p> <p class="versionchanged"> <span class="versionmodified">Changed in version 2.5: </span>This function used an <tt class="xref c c-type docutils literal"><span class="pre">int</span></tt> type for <em>size</em>. This might require changes in your code for properly supporting 64-bit systems.</p> </dd></dl> <dl class="function"> <dt id="PyUnicode_AsCharmapString"> <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a>* <tt class="descname">PyUnicode_AsCharmapString</tt><big>(</big><a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> *unicode</em>, <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> *mapping</em><big>)</big><a class="headerlink" href="#PyUnicode_AsCharmapString" title="Permalink to this definition">¶</a></dt> <dd><em class="refcount">Return value: New reference.</em><p>Encode a Unicode object using the given <em>mapping</em> object and return the result as Python string object. Error handling is “strict”. Return <em>NULL</em> if an exception was raised by the codec.</p> </dd></dl> <p>The following codec API is special in that maps Unicode to Unicode.</p> <dl class="function"> <dt id="PyUnicode_TranslateCharmap"> <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a>* <tt class="descname">PyUnicode_TranslateCharmap</tt><big>(</big>const <a class="reference internal" href="#Py_UNICODE" title="Py_UNICODE">Py_UNICODE</a><em> *s</em>, Py_ssize_t<em> size</em>, <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> *table</em>, const char<em> *errors</em><big>)</big><a class="headerlink" href="#PyUnicode_TranslateCharmap" title="Permalink to this definition">¶</a></dt> <dd><em class="refcount">Return value: New reference.</em><p>Translate a <a class="reference internal" href="#Py_UNICODE" title="Py_UNICODE"><tt class="xref c c-type docutils literal"><span class="pre">Py_UNICODE</span></tt></a> buffer of the given <em>size</em> by applying a character mapping <em>table</em> to it and return the resulting Unicode object. Return <em>NULL</em> when an exception was raised by the codec.</p> <p>The <em>mapping</em> table must map Unicode ordinal integers to Unicode ordinal integers or None (causing deletion of the character).</p> <p>Mapping tables need only provide the <a class="reference internal" href="../reference/datamodel.html#object.__getitem__" title="object.__getitem__"><tt class="xref py py-meth docutils literal"><span class="pre">__getitem__()</span></tt></a> interface; dictionaries and sequences work well. Unmapped character ordinals (ones which cause a <a class="reference internal" href="../library/exceptions.html#exceptions.LookupError" title="exceptions.LookupError"><tt class="xref py py-exc docutils literal"><span class="pre">LookupError</span></tt></a>) are left untouched and are copied as-is.</p> <p class="versionchanged"> <span class="versionmodified">Changed in version 2.5: </span>This function used an <tt class="xref c c-type docutils literal"><span class="pre">int</span></tt> type for <em>size</em>. This might require changes in your code for properly supporting 64-bit systems.</p> </dd></dl> </div> <div class="section" id="mbcs-codecs-for-windows"> <h3>MBCS codecs for Windows<a class="headerlink" href="#mbcs-codecs-for-windows" title="Permalink to this headline">¶</a></h3> <p>These are the MBCS codec APIs. They are currently only available on Windows and use the Win32 MBCS converters to implement the conversions. Note that MBCS (or DBCS) is a class of encodings, not just one. The target encoding is defined by the user settings on the machine running the codec.</p> <dl class="function"> <dt id="PyUnicode_DecodeMBCS"> <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a>* <tt class="descname">PyUnicode_DecodeMBCS</tt><big>(</big>const char<em> *s</em>, Py_ssize_t<em> size</em>, const char<em> *errors</em><big>)</big><a class="headerlink" href="#PyUnicode_DecodeMBCS" title="Permalink to this definition">¶</a></dt> <dd><em class="refcount">Return value: New reference.</em><p>Create a Unicode object by decoding <em>size</em> bytes of the MBCS encoded string <em>s</em>. Return <em>NULL</em> if an exception was raised by the codec.</p> <p class="versionchanged"> <span class="versionmodified">Changed in version 2.5: </span>This function used an <tt class="xref c c-type docutils literal"><span class="pre">int</span></tt> type for <em>size</em>. This might require changes in your code for properly supporting 64-bit systems.</p> </dd></dl> <dl class="function"> <dt id="PyUnicode_DecodeMBCSStateful"> <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a>* <tt class="descname">PyUnicode_DecodeMBCSStateful</tt><big>(</big>const char<em> *s</em>, int<em> size</em>, const char<em> *errors</em>, int<em> *consumed</em><big>)</big><a class="headerlink" href="#PyUnicode_DecodeMBCSStateful" title="Permalink to this definition">¶</a></dt> <dd><p>If <em>consumed</em> is <em>NULL</em>, behave like <a class="reference internal" href="#PyUnicode_DecodeMBCS" title="PyUnicode_DecodeMBCS"><tt class="xref c c-func docutils literal"><span class="pre">PyUnicode_DecodeMBCS()</span></tt></a>. If <em>consumed</em> is not <em>NULL</em>, <a class="reference internal" href="#PyUnicode_DecodeMBCSStateful" title="PyUnicode_DecodeMBCSStateful"><tt class="xref c c-func docutils literal"><span class="pre">PyUnicode_DecodeMBCSStateful()</span></tt></a> will not decode trailing lead byte and the number of bytes that have been decoded will be stored in <em>consumed</em>.</p> <p class="versionadded"> <span class="versionmodified">New in version 2.5.</span></p> </dd></dl> <dl class="function"> <dt id="PyUnicode_EncodeMBCS"> <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a>* <tt class="descname">PyUnicode_EncodeMBCS</tt><big>(</big>const <a class="reference internal" href="#Py_UNICODE" title="Py_UNICODE">Py_UNICODE</a><em> *s</em>, Py_ssize_t<em> size</em>, const char<em> *errors</em><big>)</big><a class="headerlink" href="#PyUnicode_EncodeMBCS" title="Permalink to this definition">¶</a></dt> <dd><em class="refcount">Return value: New reference.</em><p>Encode the <a class="reference internal" href="#Py_UNICODE" title="Py_UNICODE"><tt class="xref c c-type docutils literal"><span class="pre">Py_UNICODE</span></tt></a> buffer of the given <em>size</em> using MBCS and return a Python string object. Return <em>NULL</em> if an exception was raised by the codec.</p> <p class="versionchanged"> <span class="versionmodified">Changed in version 2.5: </span>This function used an <tt class="xref c c-type docutils literal"><span class="pre">int</span></tt> type for <em>size</em>. This might require changes in your code for properly supporting 64-bit systems.</p> </dd></dl> <dl class="function"> <dt id="PyUnicode_AsMBCSString"> <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a>* <tt class="descname">PyUnicode_AsMBCSString</tt><big>(</big><a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> *unicode</em><big>)</big><a class="headerlink" href="#PyUnicode_AsMBCSString" title="Permalink to this definition">¶</a></dt> <dd><em class="refcount">Return value: New reference.</em><p>Encode a Unicode object using MBCS and return the result as Python string object. Error handling is “strict”. Return <em>NULL</em> if an exception was raised by the codec.</p> </dd></dl> </div> <div class="section" id="methods-slots"> <h3>Methods & Slots<a class="headerlink" href="#methods-slots" title="Permalink to this headline">¶</a></h3> </div> </div> <div class="section" id="methods-and-slot-functions"> <span id="unicodemethodsandslots"></span><h2>Methods and Slot Functions<a class="headerlink" href="#methods-and-slot-functions" title="Permalink to this headline">¶</a></h2> <p>The following APIs are capable of handling Unicode objects and strings on input (we refer to them as strings in the descriptions) and return Unicode objects or integers as appropriate.</p> <p>They all return <em>NULL</em> or <tt class="docutils literal"><span class="pre">-1</span></tt> if an exception occurs.</p> <dl class="function"> <dt id="PyUnicode_Concat"> <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a>* <tt class="descname">PyUnicode_Concat</tt><big>(</big><a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> *left</em>, <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> *right</em><big>)</big><a class="headerlink" href="#PyUnicode_Concat" title="Permalink to this definition">¶</a></dt> <dd><em class="refcount">Return value: New reference.</em><p>Concat two strings giving a new Unicode string.</p> </dd></dl> <dl class="function"> <dt id="PyUnicode_Split"> <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a>* <tt class="descname">PyUnicode_Split</tt><big>(</big><a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> *s</em>, <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> *sep</em>, Py_ssize_t<em> maxsplit</em><big>)</big><a class="headerlink" href="#PyUnicode_Split" title="Permalink to this definition">¶</a></dt> <dd><em class="refcount">Return value: New reference.</em><p>Split a string giving a list of Unicode strings. If <em>sep</em> is <em>NULL</em>, splitting will be done at all whitespace substrings. Otherwise, splits occur at the given separator. At most <em>maxsplit</em> splits will be done. If negative, no limit is set. Separators are not included in the resulting list.</p> <p class="versionchanged"> <span class="versionmodified">Changed in version 2.5: </span>This function used an <tt class="xref c c-type docutils literal"><span class="pre">int</span></tt> type for <em>maxsplit</em>. This might require changes in your code for properly supporting 64-bit systems.</p> </dd></dl> <dl class="function"> <dt id="PyUnicode_Splitlines"> <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a>* <tt class="descname">PyUnicode_Splitlines</tt><big>(</big><a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> *s</em>, int<em> keepend</em><big>)</big><a class="headerlink" href="#PyUnicode_Splitlines" title="Permalink to this definition">¶</a></dt> <dd><em class="refcount">Return value: New reference.</em><p>Split a Unicode string at line breaks, returning a list of Unicode strings. CRLF is considered to be one line break. If <em>keepend</em> is 0, the Line break characters are not included in the resulting strings.</p> </dd></dl> <dl class="function"> <dt id="PyUnicode_Translate"> <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a>* <tt class="descname">PyUnicode_Translate</tt><big>(</big><a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> *str</em>, <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> *table</em>, const char<em> *errors</em><big>)</big><a class="headerlink" href="#PyUnicode_Translate" title="Permalink to this definition">¶</a></dt> <dd><em class="refcount">Return value: New reference.</em><p>Translate a string by applying a character mapping table to it and return the resulting Unicode object.</p> <p>The mapping table must map Unicode ordinal integers to Unicode ordinal integers or None (causing deletion of the character).</p> <p>Mapping tables need only provide the <a class="reference internal" href="../reference/datamodel.html#object.__getitem__" title="object.__getitem__"><tt class="xref py py-meth docutils literal"><span class="pre">__getitem__()</span></tt></a> interface; dictionaries and sequences work well. Unmapped character ordinals (ones which cause a <a class="reference internal" href="../library/exceptions.html#exceptions.LookupError" title="exceptions.LookupError"><tt class="xref py py-exc docutils literal"><span class="pre">LookupError</span></tt></a>) are left untouched and are copied as-is.</p> <p><em>errors</em> has the usual meaning for codecs. It may be <em>NULL</em> which indicates to use the default error handling.</p> </dd></dl> <dl class="function"> <dt id="PyUnicode_Join"> <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a>* <tt class="descname">PyUnicode_Join</tt><big>(</big><a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> *separator</em>, <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> *seq</em><big>)</big><a class="headerlink" href="#PyUnicode_Join" title="Permalink to this definition">¶</a></dt> <dd><em class="refcount">Return value: New reference.</em><p>Join a sequence of strings using the given <em>separator</em> and return the resulting Unicode string.</p> </dd></dl> <dl class="function"> <dt id="PyUnicode_Tailmatch"> int <tt class="descname">PyUnicode_Tailmatch</tt><big>(</big><a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> *str</em>, <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> *substr</em>, Py_ssize_t<em> start</em>, Py_ssize_t<em> end</em>, int<em> direction</em><big>)</big><a class="headerlink" href="#PyUnicode_Tailmatch" title="Permalink to this definition">¶</a></dt> <dd><p>Return 1 if <em>substr</em> matches <tt class="docutils literal"><span class="pre">str[start:end]</span></tt> at the given tail end (<em>direction</em> == -1 means to do a prefix match, <em>direction</em> == 1 a suffix match), 0 otherwise. Return <tt class="docutils literal"><span class="pre">-1</span></tt> if an error occurred.</p> <p class="versionchanged"> <span class="versionmodified">Changed in version 2.5: </span>This function used an <tt class="xref c c-type docutils literal"><span class="pre">int</span></tt> type for <em>start</em> and <em>end</em>. This might require changes in your code for properly supporting 64-bit systems.</p> </dd></dl> <dl class="function"> <dt id="PyUnicode_Find"> Py_ssize_t <tt class="descname">PyUnicode_Find</tt><big>(</big><a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> *str</em>, <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> *substr</em>, Py_ssize_t<em> start</em>, Py_ssize_t<em> end</em>, int<em> direction</em><big>)</big><a class="headerlink" href="#PyUnicode_Find" title="Permalink to this definition">¶</a></dt> <dd><p>Return the first position of <em>substr</em> in <tt class="docutils literal"><span class="pre">str[start:end]</span></tt> using the given <em>direction</em> (<em>direction</em> == 1 means to do a forward search, <em>direction</em> == -1 a backward search). The return value is the index of the first match; a value of <tt class="docutils literal"><span class="pre">-1</span></tt> indicates that no match was found, and <tt class="docutils literal"><span class="pre">-2</span></tt> indicates that an error occurred and an exception has been set.</p> <p class="versionchanged"> <span class="versionmodified">Changed in version 2.5: </span>This function used an <tt class="xref c c-type docutils literal"><span class="pre">int</span></tt> type for <em>start</em> and <em>end</em>. This might require changes in your code for properly supporting 64-bit systems.</p> </dd></dl> <dl class="function"> <dt id="PyUnicode_Count"> Py_ssize_t <tt class="descname">PyUnicode_Count</tt><big>(</big><a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> *str</em>, <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> *substr</em>, Py_ssize_t<em> start</em>, Py_ssize_t<em> end</em><big>)</big><a class="headerlink" href="#PyUnicode_Count" title="Permalink to this definition">¶</a></dt> <dd><p>Return the number of non-overlapping occurrences of <em>substr</em> in <tt class="docutils literal"><span class="pre">str[start:end]</span></tt>. Return <tt class="docutils literal"><span class="pre">-1</span></tt> if an error occurred.</p> <p class="versionchanged"> <span class="versionmodified">Changed in version 2.5: </span>This function returned an <tt class="xref c c-type docutils literal"><span class="pre">int</span></tt> type and used an <tt class="xref c c-type docutils literal"><span class="pre">int</span></tt> type for <em>start</em> and <em>end</em>. This might require changes in your code for properly supporting 64-bit systems.</p> </dd></dl> <dl class="function"> <dt id="PyUnicode_Replace"> <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a>* <tt class="descname">PyUnicode_Replace</tt><big>(</big><a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> *str</em>, <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> *substr</em>, <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> *replstr</em>, Py_ssize_t<em> maxcount</em><big>)</big><a class="headerlink" href="#PyUnicode_Replace" title="Permalink to this definition">¶</a></dt> <dd><em class="refcount">Return value: New reference.</em><p>Replace at most <em>maxcount</em> occurrences of <em>substr</em> in <em>str</em> with <em>replstr</em> and return the resulting Unicode object. <em>maxcount</em> == -1 means replace all occurrences.</p> <p class="versionchanged"> <span class="versionmodified">Changed in version 2.5: </span>This function used an <tt class="xref c c-type docutils literal"><span class="pre">int</span></tt> type for <em>maxcount</em>. This might require changes in your code for properly supporting 64-bit systems.</p> </dd></dl> <dl class="function"> <dt id="PyUnicode_Compare"> int <tt class="descname">PyUnicode_Compare</tt><big>(</big><a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> *left</em>, <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> *right</em><big>)</big><a class="headerlink" href="#PyUnicode_Compare" title="Permalink to this definition">¶</a></dt> <dd><p>Compare two strings and return -1, 0, 1 for less than, equal, and greater than, respectively.</p> </dd></dl> <dl class="function"> <dt id="PyUnicode_RichCompare"> int <tt class="descname">PyUnicode_RichCompare</tt><big>(</big><a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> *left</em>, <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> *right</em>, int<em> op</em><big>)</big><a class="headerlink" href="#PyUnicode_RichCompare" title="Permalink to this definition">¶</a></dt> <dd><p>Rich compare two unicode strings and return one of the following:</p> <ul class="simple"> <li><tt class="docutils literal"><span class="pre">NULL</span></tt> in case an exception was raised</li> <li><tt class="xref py py-const docutils literal"><span class="pre">Py_True</span></tt> or <tt class="xref py py-const docutils literal"><span class="pre">Py_False</span></tt> for successful comparisons</li> <li><tt class="xref py py-const docutils literal"><span class="pre">Py_NotImplemented</span></tt> in case the type combination is unknown</li> </ul> <p>Note that <tt class="xref py py-const docutils literal"><span class="pre">Py_EQ</span></tt> and <tt class="xref py py-const docutils literal"><span class="pre">Py_NE</span></tt> comparisons can cause a <a class="reference internal" href="../library/exceptions.html#exceptions.UnicodeWarning" title="exceptions.UnicodeWarning"><tt class="xref py py-exc docutils literal"><span class="pre">UnicodeWarning</span></tt></a> in case the conversion of the arguments to Unicode fails with a <a class="reference internal" href="../library/exceptions.html#exceptions.UnicodeDecodeError" title="exceptions.UnicodeDecodeError"><tt class="xref py py-exc docutils literal"><span class="pre">UnicodeDecodeError</span></tt></a>.</p> <p>Possible values for <em>op</em> are <tt class="xref py py-const docutils literal"><span class="pre">Py_GT</span></tt>, <tt class="xref py py-const docutils literal"><span class="pre">Py_GE</span></tt>, <tt class="xref py py-const docutils literal"><span class="pre">Py_EQ</span></tt>, <tt class="xref py py-const docutils literal"><span class="pre">Py_NE</span></tt>, <tt class="xref py py-const docutils literal"><span class="pre">Py_LT</span></tt>, and <tt class="xref py py-const docutils literal"><span class="pre">Py_LE</span></tt>.</p> </dd></dl> <dl class="function"> <dt id="PyUnicode_Format"> <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a>* <tt class="descname">PyUnicode_Format</tt><big>(</big><a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> *format</em>, <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> *args</em><big>)</big><a class="headerlink" href="#PyUnicode_Format" title="Permalink to this definition">¶</a></dt> <dd><em class="refcount">Return value: New reference.</em><p>Return a new string object from <em>format</em> and <em>args</em>; this is analogous to <tt class="docutils literal"><span class="pre">format</span> <span class="pre">%</span> <span class="pre">args</span></tt>. The <em>args</em> argument must be a tuple.</p> </dd></dl> <dl class="function"> <dt id="PyUnicode_Contains"> int <tt class="descname">PyUnicode_Contains</tt><big>(</big><a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> *container</em>, <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> *element</em><big>)</big><a class="headerlink" href="#PyUnicode_Contains" title="Permalink to this definition">¶</a></dt> <dd><p>Check whether <em>element</em> is contained in <em>container</em> and return true or false accordingly.</p> <p><em>element</em> has to coerce to a one element Unicode string. <tt class="docutils literal"><span class="pre">-1</span></tt> is returned if there was an error.</p> </dd></dl> </div> </div> </div> </div> </div> <div class="sphinxsidebar"> <div class="sphinxsidebarwrapper"> <h3><a href="../contents.html">Table Of Contents</a></h3> <ul> <li><a class="reference internal" href="#">Unicode Objects and Codecs</a><ul> <li><a class="reference internal" href="#unicode-objects">Unicode Objects</a><ul> <li><a class="reference internal" href="#unicode-type">Unicode Type</a></li> <li><a class="reference internal" href="#unicode-character-properties">Unicode Character Properties</a></li> <li><a class="reference internal" href="#plain-py-unicode">Plain Py_UNICODE</a></li> <li><a class="reference internal" href="#wchar-t-support">wchar_t Support</a></li> </ul> </li> <li><a class="reference internal" href="#built-in-codecs">Built-in Codecs</a><ul> <li><a class="reference internal" href="#generic-codecs">Generic Codecs</a></li> <li><a class="reference internal" href="#utf-8-codecs">UTF-8 Codecs</a></li> <li><a class="reference internal" href="#utf-32-codecs">UTF-32 Codecs</a></li> <li><a class="reference internal" href="#utf-16-codecs">UTF-16 Codecs</a></li> <li><a class="reference internal" href="#utf-7-codecs">UTF-7 Codecs</a></li> <li><a class="reference internal" href="#unicode-escape-codecs">Unicode-Escape Codecs</a></li> <li><a class="reference internal" href="#raw-unicode-escape-codecs">Raw-Unicode-Escape Codecs</a></li> <li><a class="reference internal" href="#latin-1-codecs">Latin-1 Codecs</a></li> <li><a class="reference internal" href="#ascii-codecs">ASCII Codecs</a></li> <li><a class="reference internal" href="#character-map-codecs">Character Map Codecs</a></li> <li><a class="reference internal" href="#mbcs-codecs-for-windows">MBCS codecs for Windows</a></li> <li><a class="reference internal" href="#methods-slots">Methods & Slots</a></li> </ul> </li> <li><a class="reference internal" href="#methods-and-slot-functions">Methods and Slot Functions</a></li> </ul> </li> </ul> <h4>Previous topic</h4> <p class="topless"><a href="string.html" title="previous chapter">String/Bytes Objects</a></p> <h4>Next topic</h4> <p class="topless"><a href="buffer.html" title="next chapter">Buffers and Memoryview Objects</a></p> <h3>This Page</h3> <ul class="this-page-menu"> <li><a href="../bugs.html">Report a Bug</a></li> <li><a href="../_sources/c-api/unicode.txt" rel="nofollow">Show Source</a></li> </ul> <div id="searchbox" style="display: none"> <h3>Quick search</h3> <form class="search" action="../search.html" method="get"> <input type="text" name="q" /> <input type="submit" value="Go" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> <p class="searchtip" style="font-size: 90%"> Enter search terms or a module, class or function name. </p> </div> <script type="text/javascript">$('#searchbox').show(0);</script> </div> </div> <div class="clearer"></div> </div> <div class="related"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="../genindex.html" title="General Index" >index</a></li> <li class="right" > <a href="../py-modindex.html" title="Python Module Index" >modules</a> |</li> <li class="right" > <a href="buffer.html" title="Buffers and Memoryview Objects" >next</a> |</li> <li class="right" > <a href="string.html" title="String/Bytes Objects" >previous</a> |</li> <li><img src="../_static/py.png" alt="" style="vertical-align: middle; margin-top: -1px"/></li> <li><a href="http://www.python.org/">Python</a> »</li> <li> <a href="../index.html">Python 2.7.5 documentation</a> » </li> <li><a href="index.html" >Python/C API Reference Manual</a> »</li> <li><a href="concrete.html" >Concrete Objects Layer</a> »</li> </ul> </div> <div class="footer"> © <a href="../copyright.html">Copyright</a> 1990-2020, Python Software Foundation. <br /> The Python Software Foundation is a non-profit corporation. <a href="http://www.python.org/psf/donations/">Please donate.</a> <br /> Last updated on Oct 13, 2020. <a href="../bugs.html">Found a bug</a>? <br /> Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3. </div> </body> </html>
Close
