e0c641195b27425bb056ac56f8953d24

Edit file

File name : unicode.html

Content :

<!DOCTYPE html>

<title>Unicode Objects and Codecs &#8212; Python 3.10.12 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">
 
 <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
 <link rel="stylesheet" type="text/css" href="../_static/pydoctheme.css?2022.1" />
 
 <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
 <script src="../_static/jquery.js"></script>
 <script src="../_static/underscore.js"></script>
 <script src="../_static/doctools.js"></script>
 
 <script src="../_static/sidebar.js"></script>
 
 <link rel="search" type="application/opensearchdescription+xml"
 title="Search within Python 3.10.12 documentation"
 href="../_static/opensearch.xml"/>
 <link rel="author" title="About these documents" href="../about.html" />
 <link rel="index" title="Index" href="../genindex.html" />
 <link rel="search" title="Search" href="../search.html" />
 <link rel="copyright" title="Copyright" href="../copyright.html" />
 <link rel="next" title="Tuple Objects" href="tuple.html" />
 <link rel="prev" title="Byte Array Objects" href="bytearray.html" />
 <link rel="canonical" href="file:///usr/share/doc/python3.10/html/c-api/unicode.html" />

</head>
<body>
<div class="mobile-nav">
 <input type="checkbox" id="menuToggler" class="toggler__input" aria-controls="navigation"
 aria-pressed="false" aria-expanded="false" role="button" aria-label="Menu" />
 <label for="menuToggler" class="toggler__label">
 
 </label>
 <nav class="nav-content" role="navigation">
 <a href="https://www.python.org/" class="nav-logo">
 <img src="../_static/py.svg" alt="Logo"/>
 </a>
 <div class="version_switcher_placeholder"></div>
 <form role="search" class="search" action="../search.html" method="get">
 <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" class="search-icon">
 <path fill-rule="nonzero"
 d="M15.5 14h-.79l-.28-.27a6.5 6.5 0 001.48-5.34c-.47-2.78-2.79-5-5.59-5.34a6.505 6.505 0 00-7.27 7.27c.34 2.8 2.56 5.12 5.34 5.59a6.5 6.5 0 005.34-1.48l.27.28v.79l4.25 4.25c.41.41 1.08.41 1.49 0 .41-.41.41-1.08 0-1.49L15.5 14zm-6 0C7.01 14 5 11.99 5 9.5S7.01 5 9.5 5 14 7.01 14 9.5 11.99 14 9.5 14z" fill="#444"></path>
 </svg>
 <input type="text" name="q" aria-label="Quick search"/>
 <input type="submit" value="Go"/>
 </form>
 </nav>
 <div class="menu-wrapper">
 <nav class="menu" role="navigation" aria-label="main navigation">
 <div class="language_switcher_placeholder"></div>
 <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="#creating-and-accessing-unicode-strings">Creating and accessing Unicode strings</a></li>
<li><a class="reference internal" href="#deprecated-py-unicode-apis">Deprecated Py_UNICODE APIs</a></li>
<li><a class="reference internal" href="#locale-encoding">Locale Encoding</a></li>
<li><a class="reference internal" href="#file-system-encoding">File System Encoding</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 &amp; Slots</a></li>
</ul>
</li>
<li><a class="reference internal" href="#methods-and-slot-functions">Methods and Slot Functions</a></li>
</ul>
</li>
</ul>

<div class="related" role="navigation" aria-label="related navigation">
 <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="tuple.html" title="Tuple Objects"
 accesskey="N">next</a> |</li>
 <li class="right" >
 <a href="bytearray.html" title="Byte Array Objects"
 accesskey="P">previous</a> |</li>

<li><img src="../_static/py.svg" alt="python logo" style="vertical-align: middle; margin-top: -1px"/></li>
 <li><a href="https://www.python.org/">Python</a> &#187;</li>
 <li class="switchers">
 <div class="language_switcher_placeholder"></div>
 <div class="version_switcher_placeholder"></div>
 </li>
 <li>
 
 </li>
 <li id="cpython-language-and-version">
 <a href="../index.html">3.10.12 Documentation</a> &#187;
 </li>

<li class="nav-item nav-item-1"><a href="index.html" >Python/C API Reference Manual</a> &#187;</li>
 <li class="nav-item nav-item-2"><a href="concrete.html" accesskey="U">Concrete Objects Layer</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href="">Unicode Objects and Codecs</a></li>
 <li class="right">

<div class="document">
 <div class="documentwrapper">
 <div class="bodywrapper">
 <div class="body" role="main">
 
 <section id="unicode-objects-and-codecs">
<h1>Unicode Objects and Codecs<a class="headerlink" href="#unicode-objects-and-codecs" title="Permalink to this headline">¶</a></h1>
<section id="unicode-objects">
<h2>Unicode Objects<a class="headerlink" href="#unicode-objects" title="Permalink to this headline">¶</a></h2>
Since the implementation of <a class="pep reference external" href="https://www.python.org/dev/peps/pep-0393">PEP 393</a> in Python 3.3, Unicode objects internally
use a variety of representations, in order to allow handling the complete range
of Unicode characters while staying memory efficient. There are special cases
for strings where all code points are below 128, 256, or 65536; otherwise, code
points must be below 1114112 (which is the full Unicode range).
<a class="reference internal" href="#c.Py_UNICODE" title="Py_UNICODE">Py_UNICODE</a>* and UTF-8 representations are created on demand and cached
in the Unicode object. The <a class="reference internal" href="#c.Py_UNICODE" title="Py_UNICODE">Py_UNICODE</a>* representation is deprecated
and inefficient.
Due to the transition between the old APIs and the new APIs, Unicode objects
can internally be in two states depending on how they were created:
<ul class="simple">
<li>“canonical” Unicode objects are all objects created by a non-deprecated
Unicode API. They use the most efficient representation allowed by the
implementation.</li>
<li>“legacy” Unicode objects have been created through one of the deprecated
APIs (typically <a class="reference internal" href="#c.PyUnicode_FromUnicode" title="PyUnicode_FromUnicode"><code class="xref c c-func docutils literal notranslate">PyUnicode_FromUnicode()</code></a>) and only bear the
<a class="reference internal" href="#c.Py_UNICODE" title="Py_UNICODE">Py_UNICODE</a>* representation; you will have to call
<a class="reference internal" href="#c.PyUnicode_READY" title="PyUnicode_READY"><code class="xref c c-func docutils literal notranslate">PyUnicode_READY()</code></a> on them before calling any other API.</li>
</ul>
<div class="admonition note">
Note
The “legacy” Unicode object will be removed in Python 3.12 with deprecated
APIs. All Unicode objects will be “canonical” since then. See <a class="pep reference external" href="https://www.python.org/dev/peps/pep-0623">PEP 623</a>
for more information.
</div>
<section id="unicode-type">
<h3>Unicode Type<a class="headerlink" href="#unicode-type" title="Permalink to this headline">¶</a></h3>
These are the basic Unicode object types used for the Unicode implementation in
Python:
<dl class="c type">
<dt class="sig sig-object c" id="c.Py_UCS4">
type Py_UCS4<a class="headerlink" href="#c.Py_UCS4" title="Permalink to this definition">¶</a> </dt>
<dt class="sig sig-object c" id="c.Py_UCS2">
type Py_UCS2<a class="headerlink" href="#c.Py_UCS2" title="Permalink to this definition">¶</a> </dt>
<dt class="sig sig-object c" id="c.Py_UCS1">
type Py_UCS1<a class="headerlink" href="#c.Py_UCS1" title="Permalink to this definition">¶</a> </dt>
<dd> Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.These types are typedefs for unsigned integer types wide enough to contain
characters of 32 bits, 16 bits and 8 bits, respectively. When dealing with
single Unicode characters, use <a class="reference internal" href="#c.Py_UCS4" title="Py_UCS4"><code class="xref c c-type docutils literal notranslate">Py_UCS4</code></a>.
<div class="versionadded">
New in version 3.3.
</div>
</dd></dl>

<dl class="c type">
<dt class="sig sig-object c" id="c.Py_UNICODE">
type Py_UNICODE<a class="headerlink" href="#c.Py_UNICODE" title="Permalink to this definition">¶</a> </dt>
<dd>This is a typedef of wchar_t, which is a 16-bit type or 32-bit type
depending on the platform.
<div class="versionchanged">
Changed in version 3.3: In previous versions, this was a 16-bit type or a 32-bit type depending on
whether you selected a “narrow” or “wide” Unicode version of Python at
build time.
</div>
</dd></dl>

<dl class="c type">
<dt class="sig sig-object c" id="c.PyASCIIObject">
type PyASCIIObject<a class="headerlink" href="#c.PyASCIIObject" title="Permalink to this definition">¶</a> </dt>
<dt class="sig sig-object c" id="c.PyCompactUnicodeObject">
type PyCompactUnicodeObject<a class="headerlink" href="#c.PyCompactUnicodeObject" title="Permalink to this definition">¶</a> </dt>
<dt class="sig sig-object c" id="c.PyUnicodeObject">
type PyUnicodeObject<a class="headerlink" href="#c.PyUnicodeObject" title="Permalink to this definition">¶</a> </dt>
<dd>These subtypes of <a class="reference internal" href="structures.html#c.PyObject" title="PyObject"><code class="xref c c-type docutils literal notranslate">PyObject</code></a> represent a Python Unicode object. In
almost all cases, they shouldn’t be used directly, since all API functions
that deal with Unicode objects take and return <a class="reference internal" href="structures.html#c.PyObject" title="PyObject"><code class="xref c c-type docutils literal notranslate">PyObject</code></a> pointers.
<div class="versionadded">
New in version 3.3.
</div>
</dd></dl>

<dl class="c var">
<dt class="sig sig-object c" id="c.PyUnicode_Type">
<a class="reference internal" href="type.html#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a> PyUnicode_Type<a class="headerlink" href="#c.PyUnicode_Type" title="Permalink to this definition">¶</a> </dt>
<dd> Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.This instance of <a class="reference internal" href="type.html#c.PyTypeObject" title="PyTypeObject"><code class="xref c c-type docutils literal notranslate">PyTypeObject</code></a> represents the Python Unicode type. It
is exposed to Python code as <code class="docutils literal notranslate">str</code>.
</dd></dl>

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:
<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_Check">
int PyUnicode_Check(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o)<a class="headerlink" href="#c.PyUnicode_Check" title="Permalink to this definition">¶</a> </dt>
<dd>Return true if the object o is a Unicode object or an instance of a Unicode
subtype. This function always succeeds.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_CheckExact">
int PyUnicode_CheckExact(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o)<a class="headerlink" href="#c.PyUnicode_CheckExact" title="Permalink to this definition">¶</a> </dt>
<dd>Return true if the object o is a Unicode object, but not an instance of a
subtype. This function always succeeds.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_READY">
int PyUnicode_READY(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o)<a class="headerlink" href="#c.PyUnicode_READY" title="Permalink to this definition">¶</a> </dt>
<dd>Ensure the string object o is in the “canonical” representation. This is
required before using any of the access macros described below.
Returns <code class="docutils literal notranslate">0</code> on success and <code class="docutils literal notranslate">-1</code> with an exception set on failure, which in
particular happens if memory allocation fails.
<div class="versionadded">
New in version 3.3.
</div>
<div class="deprecated-removed">
Deprecated since version 3.10, will be removed in version 3.12: This API will be removed with <a class="reference internal" href="#c.PyUnicode_FromUnicode" title="PyUnicode_FromUnicode"><code class="xref c c-func docutils literal notranslate">PyUnicode_FromUnicode()</code></a>.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_GET_LENGTH">
<a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> PyUnicode_GET_LENGTH(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o)<a class="headerlink" href="#c.PyUnicode_GET_LENGTH" title="Permalink to this definition">¶</a> </dt>
<dd>Return the length of the Unicode string, in code points. o has to be a
Unicode object in the “canonical” representation (not checked).
<div class="versionadded">
New in version 3.3.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_1BYTE_DATA">
<a class="reference internal" href="#c.Py_UCS1" title="Py_UCS1">Py_UCS1</a> *PyUnicode_1BYTE_DATA(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o)<a class="headerlink" href="#c.PyUnicode_1BYTE_DATA" title="Permalink to this definition">¶</a> </dt>
<dt class="sig sig-object c" id="c.PyUnicode_2BYTE_DATA">
<a class="reference internal" href="#c.Py_UCS2" title="Py_UCS2">Py_UCS2</a> *PyUnicode_2BYTE_DATA(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o)<a class="headerlink" href="#c.PyUnicode_2BYTE_DATA" title="Permalink to this definition">¶</a> </dt>
<dt class="sig sig-object c" id="c.PyUnicode_4BYTE_DATA">
<a class="reference internal" href="#c.Py_UCS4" title="Py_UCS4">Py_UCS4</a> *PyUnicode_4BYTE_DATA(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o)<a class="headerlink" href="#c.PyUnicode_4BYTE_DATA" title="Permalink to this definition">¶</a> </dt>
<dd>Return a pointer to the canonical representation cast to UCS1, UCS2 or UCS4
integer types for direct character access. No checks are performed if the
canonical representation has the correct character size; use
<a class="reference internal" href="#c.PyUnicode_KIND" title="PyUnicode_KIND"><code class="xref c c-func docutils literal notranslate">PyUnicode_KIND()</code></a> to select the right macro. Make sure
<a class="reference internal" href="#c.PyUnicode_READY" title="PyUnicode_READY"><code class="xref c c-func docutils literal notranslate">PyUnicode_READY()</code></a> has been called before accessing this.
<div class="versionadded">
New in version 3.3.
</div>
</dd></dl>

<dl class="c macro">
<dt class="sig sig-object c" id="c.PyUnicode_WCHAR_KIND">
PyUnicode_WCHAR_KIND<a class="headerlink" href="#c.PyUnicode_WCHAR_KIND" title="Permalink to this definition">¶</a> </dt>
<dt class="sig sig-object c" id="c.PyUnicode_1BYTE_KIND">
PyUnicode_1BYTE_KIND<a class="headerlink" href="#c.PyUnicode_1BYTE_KIND" title="Permalink to this definition">¶</a> </dt>
<dt class="sig sig-object c" id="c.PyUnicode_2BYTE_KIND">
PyUnicode_2BYTE_KIND<a class="headerlink" href="#c.PyUnicode_2BYTE_KIND" title="Permalink to this definition">¶</a> </dt>
<dt class="sig sig-object c" id="c.PyUnicode_4BYTE_KIND">
PyUnicode_4BYTE_KIND<a class="headerlink" href="#c.PyUnicode_4BYTE_KIND" title="Permalink to this definition">¶</a> </dt>
<dd>Return values of the <a class="reference internal" href="#c.PyUnicode_KIND" title="PyUnicode_KIND"><code class="xref c c-func docutils literal notranslate">PyUnicode_KIND()</code></a> macro.
<div class="versionadded">
New in version 3.3.
</div>
<div class="deprecated-removed">
Deprecated since version 3.10, will be removed in version 3.12: <code class="docutils literal notranslate">PyUnicode_WCHAR_KIND</code> is deprecated.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_KIND">
unsigned int PyUnicode_KIND(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o)<a class="headerlink" href="#c.PyUnicode_KIND" title="Permalink to this definition">¶</a> </dt>
<dd>Return one of the PyUnicode kind constants (see above) that indicate how many
bytes per character this Unicode object uses to store its data. o has to
be a Unicode object in the “canonical” representation (not checked).
<div class="versionadded">
New in version 3.3.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_DATA">
void *PyUnicode_DATA(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o)<a class="headerlink" href="#c.PyUnicode_DATA" title="Permalink to this definition">¶</a> </dt>
<dd>Return a void pointer to the raw Unicode buffer. o has to be a Unicode
object in the “canonical” representation (not checked).
<div class="versionadded">
New in version 3.3.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_WRITE">
void PyUnicode_WRITE(int kind, void *data, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> index, <a class="reference internal" href="#c.Py_UCS4" title="Py_UCS4">Py_UCS4</a> value)<a class="headerlink" href="#c.PyUnicode_WRITE" title="Permalink to this definition">¶</a> </dt>
<dd>Write into a canonical representation data (as obtained with
<a class="reference internal" href="#c.PyUnicode_DATA" title="PyUnicode_DATA"><code class="xref c c-func docutils literal notranslate">PyUnicode_DATA()</code></a>). This macro does not do any sanity checks and is
intended for usage in loops. The caller should cache the kind value and
data pointer as obtained from other macro calls. index is the index in
the string (starts at 0) and value is the new code point value which should
be written to that location.
<div class="versionadded">
New in version 3.3.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_READ">
<a class="reference internal" href="#c.Py_UCS4" title="Py_UCS4">Py_UCS4</a> PyUnicode_READ(int kind, void *data, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> index)<a class="headerlink" href="#c.PyUnicode_READ" title="Permalink to this definition">¶</a> </dt>
<dd>Read a code point from a canonical representation data (as obtained with
<a class="reference internal" href="#c.PyUnicode_DATA" title="PyUnicode_DATA"><code class="xref c c-func docutils literal notranslate">PyUnicode_DATA()</code></a>). No checks or ready calls are performed.
<div class="versionadded">
New in version 3.3.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_READ_CHAR">
<a class="reference internal" href="#c.Py_UCS4" title="Py_UCS4">Py_UCS4</a> PyUnicode_READ_CHAR(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> index)<a class="headerlink" href="#c.PyUnicode_READ_CHAR" title="Permalink to this definition">¶</a> </dt>
<dd>Read a character from a Unicode object o, which must be in the “canonical”
representation. This is less efficient than <a class="reference internal" href="#c.PyUnicode_READ" title="PyUnicode_READ"><code class="xref c c-func docutils literal notranslate">PyUnicode_READ()</code></a> if you
do multiple consecutive reads.
<div class="versionadded">
New in version 3.3.
</div>
</dd></dl>

<dl class="c macro">
<dt class="sig sig-object c" id="c.PyUnicode_MAX_CHAR_VALUE">
PyUnicode_MAX_CHAR_VALUE(o)<a class="headerlink" href="#c.PyUnicode_MAX_CHAR_VALUE" title="Permalink to this definition">¶</a> </dt>
<dd>Return the maximum code point that is suitable for creating another string
based on o, which must be in the “canonical” representation. This is
always an approximation but more efficient than iterating over the string.
<div class="versionadded">
New in version 3.3.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_GET_SIZE">
<a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> PyUnicode_GET_SIZE(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o)<a class="headerlink" href="#c.PyUnicode_GET_SIZE" title="Permalink to this definition">¶</a> </dt>
<dd>Return the size of the deprecated <a class="reference internal" href="#c.Py_UNICODE" title="Py_UNICODE"><code class="xref c c-type docutils literal notranslate">Py_UNICODE</code></a> representation, in
code units (this includes surrogate pairs as 2 units). o has to be a
Unicode object (not checked).
<div class="deprecated-removed">
Deprecated since version 3.3, will be removed in version 3.12: Part of the old-style Unicode API, please migrate to using
<a class="reference internal" href="#c.PyUnicode_GET_LENGTH" title="PyUnicode_GET_LENGTH"><code class="xref c c-func docutils literal notranslate">PyUnicode_GET_LENGTH()</code></a>.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_GET_DATA_SIZE">
<a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> PyUnicode_GET_DATA_SIZE(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o)<a class="headerlink" href="#c.PyUnicode_GET_DATA_SIZE" title="Permalink to this definition">¶</a> </dt>
<dd>Return the size of the deprecated <a class="reference internal" href="#c.Py_UNICODE" title="Py_UNICODE"><code class="xref c c-type docutils literal notranslate">Py_UNICODE</code></a> representation in
bytes. o has to be a Unicode object (not checked).
<div class="deprecated-removed">
Deprecated since version 3.3, will be removed in version 3.12: Part of the old-style Unicode API, please migrate to using
<a class="reference internal" href="#c.PyUnicode_GET_LENGTH" title="PyUnicode_GET_LENGTH"><code class="xref c c-func docutils literal notranslate">PyUnicode_GET_LENGTH()</code></a>.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_AS_UNICODE">
<a class="reference internal" href="#c.Py_UNICODE" title="Py_UNICODE">Py_UNICODE</a> *PyUnicode_AS_UNICODE(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o)<a class="headerlink" href="#c.PyUnicode_AS_UNICODE" title="Permalink to this definition">¶</a> </dt>
<dt class="sig sig-object c" id="c.PyUnicode_AS_DATA">
const char *PyUnicode_AS_DATA(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o)<a class="headerlink" href="#c.PyUnicode_AS_DATA" title="Permalink to this definition">¶</a> </dt>
<dd>Return a pointer to a <a class="reference internal" href="#c.Py_UNICODE" title="Py_UNICODE"><code class="xref c c-type docutils literal notranslate">Py_UNICODE</code></a> representation of the object. The
returned buffer is always terminated with an extra null code point. It
may also contain embedded null code points, which would cause the string
to be truncated when used in most C functions. The <code class="docutils literal notranslate">AS_DATA</code> form
casts the pointer to const char*. The o argument has to be
a Unicode object (not checked).
<div class="versionchanged">
Changed in version 3.3: This macro is now inefficient – because in many cases the
<a class="reference internal" href="#c.Py_UNICODE" title="Py_UNICODE"><code class="xref c c-type docutils literal notranslate">Py_UNICODE</code></a> representation does not exist and needs to be created
– and can fail (return <code class="docutils literal notranslate">NULL</code> with an exception set). Try to port the
code to use the new <code class="xref c c-func docutils literal notranslate">PyUnicode_nBYTE_DATA()</code> macros or use
<a class="reference internal" href="#c.PyUnicode_WRITE" title="PyUnicode_WRITE"><code class="xref c c-func docutils literal notranslate">PyUnicode_WRITE()</code></a> or <a class="reference internal" href="#c.PyUnicode_READ" title="PyUnicode_READ"><code class="xref c c-func docutils literal notranslate">PyUnicode_READ()</code></a>.
</div>
<div class="deprecated-removed">
Deprecated since version 3.3, will be removed in version 3.12: Part of the old-style Unicode API, please migrate to using the
<code class="xref c c-func docutils literal notranslate">PyUnicode_nBYTE_DATA()</code> family of macros.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_IsIdentifier">
int PyUnicode_IsIdentifier(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o)<a class="headerlink" href="#c.PyUnicode_IsIdentifier" title="Permalink to this definition">¶</a> </dt>
<dd> Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Return <code class="docutils literal notranslate">1</code> if the string is a valid identifier according to the language
definition, section <a class="reference internal" href="../reference/lexical_analysis.html#identifiers">Identifiers and keywords</a>. Return <code class="docutils literal notranslate">0</code> otherwise.
<div class="versionchanged">
Changed in version 3.9: The function does not call <a class="reference internal" href="sys.html#c.Py_FatalError" title="Py_FatalError"><code class="xref c c-func docutils literal notranslate">Py_FatalError()</code></a> anymore if the string
is not ready.
</div>
</dd></dl>

</section>
<section id="unicode-character-properties">
<h3>Unicode Character Properties<a class="headerlink" href="#unicode-character-properties" title="Permalink to this headline">¶</a></h3>
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.
<dl class="c function">
<dt class="sig sig-object c" id="c.Py_UNICODE_ISSPACE">
int Py_UNICODE_ISSPACE(<a class="reference internal" href="#c.Py_UCS4" title="Py_UCS4">Py_UCS4</a> ch)<a class="headerlink" href="#c.Py_UNICODE_ISSPACE" title="Permalink to this definition">¶</a> </dt>
<dd>Return <code class="docutils literal notranslate">1</code> or <code class="docutils literal notranslate">0</code> depending on whether ch is a whitespace character.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.Py_UNICODE_ISLOWER">
int Py_UNICODE_ISLOWER(<a class="reference internal" href="#c.Py_UCS4" title="Py_UCS4">Py_UCS4</a> ch)<a class="headerlink" href="#c.Py_UNICODE_ISLOWER" title="Permalink to this definition">¶</a> </dt>
<dd>Return <code class="docutils literal notranslate">1</code> or <code class="docutils literal notranslate">0</code> depending on whether ch is a lowercase character.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.Py_UNICODE_ISUPPER">
int Py_UNICODE_ISUPPER(<a class="reference internal" href="#c.Py_UCS4" title="Py_UCS4">Py_UCS4</a> ch)<a class="headerlink" href="#c.Py_UNICODE_ISUPPER" title="Permalink to this definition">¶</a> </dt>
<dd>Return <code class="docutils literal notranslate">1</code> or <code class="docutils literal notranslate">0</code> depending on whether ch is an uppercase character.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.Py_UNICODE_ISTITLE">
int Py_UNICODE_ISTITLE(<a class="reference internal" href="#c.Py_UCS4" title="Py_UCS4">Py_UCS4</a> ch)<a class="headerlink" href="#c.Py_UNICODE_ISTITLE" title="Permalink to this definition">¶</a> </dt>
<dd>Return <code class="docutils literal notranslate">1</code> or <code class="docutils literal notranslate">0</code> depending on whether ch is a titlecase character.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.Py_UNICODE_ISLINEBREAK">
int Py_UNICODE_ISLINEBREAK(<a class="reference internal" href="#c.Py_UCS4" title="Py_UCS4">Py_UCS4</a> ch)<a class="headerlink" href="#c.Py_UNICODE_ISLINEBREAK" title="Permalink to this definition">¶</a> </dt>
<dd>Return <code class="docutils literal notranslate">1</code> or <code class="docutils literal notranslate">0</code> depending on whether ch is a linebreak character.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.Py_UNICODE_ISDECIMAL">
int Py_UNICODE_ISDECIMAL(<a class="reference internal" href="#c.Py_UCS4" title="Py_UCS4">Py_UCS4</a> ch)<a class="headerlink" href="#c.Py_UNICODE_ISDECIMAL" title="Permalink to this definition">¶</a> </dt>
<dd>Return <code class="docutils literal notranslate">1</code> or <code class="docutils literal notranslate">0</code> depending on whether ch is a decimal character.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.Py_UNICODE_ISDIGIT">
int Py_UNICODE_ISDIGIT(<a class="reference internal" href="#c.Py_UCS4" title="Py_UCS4">Py_UCS4</a> ch)<a class="headerlink" href="#c.Py_UNICODE_ISDIGIT" title="Permalink to this definition">¶</a> </dt>
<dd>Return <code class="docutils literal notranslate">1</code> or <code class="docutils literal notranslate">0</code> depending on whether ch is a digit character.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.Py_UNICODE_ISNUMERIC">
int Py_UNICODE_ISNUMERIC(<a class="reference internal" href="#c.Py_UCS4" title="Py_UCS4">Py_UCS4</a> ch)<a class="headerlink" href="#c.Py_UNICODE_ISNUMERIC" title="Permalink to this definition">¶</a> </dt>
<dd>Return <code class="docutils literal notranslate">1</code> or <code class="docutils literal notranslate">0</code> depending on whether ch is a numeric character.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.Py_UNICODE_ISALPHA">
int Py_UNICODE_ISALPHA(<a class="reference internal" href="#c.Py_UCS4" title="Py_UCS4">Py_UCS4</a> ch)<a class="headerlink" href="#c.Py_UNICODE_ISALPHA" title="Permalink to this definition">¶</a> </dt>
<dd>Return <code class="docutils literal notranslate">1</code> or <code class="docutils literal notranslate">0</code> depending on whether ch is an alphabetic character.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.Py_UNICODE_ISALNUM">
int Py_UNICODE_ISALNUM(<a class="reference internal" href="#c.Py_UCS4" title="Py_UCS4">Py_UCS4</a> ch)<a class="headerlink" href="#c.Py_UNICODE_ISALNUM" title="Permalink to this definition">¶</a> </dt>
<dd>Return <code class="docutils literal notranslate">1</code> or <code class="docutils literal notranslate">0</code> depending on whether ch is an alphanumeric character.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.Py_UNICODE_ISPRINTABLE">
int Py_UNICODE_ISPRINTABLE(<a class="reference internal" href="#c.Py_UCS4" title="Py_UCS4">Py_UCS4</a> ch)<a class="headerlink" href="#c.Py_UNICODE_ISPRINTABLE" title="Permalink to this definition">¶</a> </dt>
<dd>Return <code class="docutils literal notranslate">1</code> or <code class="docutils literal notranslate">0</code> depending on whether ch is a printable character.
Nonprintable characters are those characters defined in the Unicode character
database as “Other” or “Separator”, excepting the ASCII space (0x20) which is
considered printable. (Note that printable characters in this context are
those which should not be escaped when <a class="reference internal" href="../library/functions.html#repr" title="repr"><code class="xref py py-func docutils literal notranslate">repr()</code></a> is invoked on a string.
It has no bearing on the handling of strings written to <a class="reference internal" href="../library/sys.html#sys.stdout" title="sys.stdout"><code class="xref py py-data docutils literal notranslate">sys.stdout</code></a> or
<a class="reference internal" href="../library/sys.html#sys.stderr" title="sys.stderr"><code class="xref py py-data docutils literal notranslate">sys.stderr</code></a>.)
</dd></dl>

These APIs can be used for fast direct character conversions:
<dl class="c function">
<dt class="sig sig-object c" id="c.Py_UNICODE_TOLOWER">
<a class="reference internal" href="#c.Py_UCS4" title="Py_UCS4">Py_UCS4</a> Py_UNICODE_TOLOWER(<a class="reference internal" href="#c.Py_UCS4" title="Py_UCS4">Py_UCS4</a> ch)<a class="headerlink" href="#c.Py_UNICODE_TOLOWER" title="Permalink to this definition">¶</a> </dt>
<dd>Return the character ch converted to lower case.
<div class="deprecated">
Deprecated since version 3.3: This function uses simple case mappings.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.Py_UNICODE_TOUPPER">
<a class="reference internal" href="#c.Py_UCS4" title="Py_UCS4">Py_UCS4</a> Py_UNICODE_TOUPPER(<a class="reference internal" href="#c.Py_UCS4" title="Py_UCS4">Py_UCS4</a> ch)<a class="headerlink" href="#c.Py_UNICODE_TOUPPER" title="Permalink to this definition">¶</a> </dt>
<dd>Return the character ch converted to upper case.
<div class="deprecated">
Deprecated since version 3.3: This function uses simple case mappings.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.Py_UNICODE_TOTITLE">
<a class="reference internal" href="#c.Py_UCS4" title="Py_UCS4">Py_UCS4</a> Py_UNICODE_TOTITLE(<a class="reference internal" href="#c.Py_UCS4" title="Py_UCS4">Py_UCS4</a> ch)<a class="headerlink" href="#c.Py_UNICODE_TOTITLE" title="Permalink to this definition">¶</a> </dt>
<dd>Return the character ch converted to title case.
<div class="deprecated">
Deprecated since version 3.3: This function uses simple case mappings.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.Py_UNICODE_TODECIMAL">
int Py_UNICODE_TODECIMAL(<a class="reference internal" href="#c.Py_UCS4" title="Py_UCS4">Py_UCS4</a> ch)<a class="headerlink" href="#c.Py_UNICODE_TODECIMAL" title="Permalink to this definition">¶</a> </dt>
<dd>Return the character ch converted to a decimal positive integer. Return
<code class="docutils literal notranslate">-1</code> if this is not possible. This macro does not raise exceptions.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.Py_UNICODE_TODIGIT">
int Py_UNICODE_TODIGIT(<a class="reference internal" href="#c.Py_UCS4" title="Py_UCS4">Py_UCS4</a> ch)<a class="headerlink" href="#c.Py_UNICODE_TODIGIT" title="Permalink to this definition">¶</a> </dt>
<dd>Return the character ch converted to a single digit integer. Return <code class="docutils literal notranslate">-1</code> if
this is not possible. This macro does not raise exceptions.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.Py_UNICODE_TONUMERIC">
double Py_UNICODE_TONUMERIC(<a class="reference internal" href="#c.Py_UCS4" title="Py_UCS4">Py_UCS4</a> ch)<a class="headerlink" href="#c.Py_UNICODE_TONUMERIC" title="Permalink to this definition">¶</a> </dt>
<dd>Return the character ch converted to a double. Return <code class="docutils literal notranslate">-1.0</code> if this is not
possible. This macro does not raise exceptions.
</dd></dl>

These APIs can be used to work with surrogates:
<dl class="c macro">
<dt class="sig sig-object c" id="c.Py_UNICODE_IS_SURROGATE">
Py_UNICODE_IS_SURROGATE(ch)<a class="headerlink" href="#c.Py_UNICODE_IS_SURROGATE" title="Permalink to this definition">¶</a> </dt>
<dd>Check if ch is a surrogate (<code class="docutils literal notranslate">0xD800 &lt;= ch &lt;= 0xDFFF</code>).
</dd></dl>

<dl class="c macro">
<dt class="sig sig-object c" id="c.Py_UNICODE_IS_HIGH_SURROGATE">
Py_UNICODE_IS_HIGH_SURROGATE(ch)<a class="headerlink" href="#c.Py_UNICODE_IS_HIGH_SURROGATE" title="Permalink to this definition">¶</a> </dt>
<dd>Check if ch is a high surrogate (<code class="docutils literal notranslate">0xD800 &lt;= ch &lt;= 0xDBFF</code>).
</dd></dl>

<dl class="c macro">
<dt class="sig sig-object c" id="c.Py_UNICODE_IS_LOW_SURROGATE">
Py_UNICODE_IS_LOW_SURROGATE(ch)<a class="headerlink" href="#c.Py_UNICODE_IS_LOW_SURROGATE" title="Permalink to this definition">¶</a> </dt>
<dd>Check if ch is a low surrogate (<code class="docutils literal notranslate">0xDC00 &lt;= ch &lt;= 0xDFFF</code>).
</dd></dl>

<dl class="c macro">
<dt class="sig sig-object c" id="c.Py_UNICODE_JOIN_SURROGATES">
Py_UNICODE_JOIN_SURROGATES(high, low)<a class="headerlink" href="#c.Py_UNICODE_JOIN_SURROGATES" title="Permalink to this definition">¶</a> </dt>
<dd>Join two surrogate characters and return a single Py_UCS4 value.
high and low are respectively the leading and trailing surrogates in a
surrogate pair.
</dd></dl>

</section>
<section id="creating-and-accessing-unicode-strings">
<h3>Creating and accessing Unicode strings<a class="headerlink" href="#creating-and-accessing-unicode-strings" title="Permalink to this headline">¶</a></h3>
To create Unicode objects and access their basic sequence properties, use these
APIs:
<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_New">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyUnicode_New(<a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> size, <a class="reference internal" href="#c.Py_UCS4" title="Py_UCS4">Py_UCS4</a> maxchar)<a class="headerlink" href="#c.PyUnicode_New" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference.Create a new Unicode object. maxchar should be the true maximum code point
to be placed in the string. As an approximation, it can be rounded up to the
nearest value in the sequence 127, 255, 65535, 1114111.
This is the recommended way to allocate a new Unicode object. Objects
created using this function are not resizable.
<div class="versionadded">
New in version 3.3.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_FromKindAndData">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyUnicode_FromKindAndData(int kind, const void *buffer, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> size)<a class="headerlink" href="#c.PyUnicode_FromKindAndData" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference.Create a new Unicode object with the given kind (possible values are
<a class="reference internal" href="#c.PyUnicode_1BYTE_KIND" title="PyUnicode_1BYTE_KIND"><code class="xref c c-macro docutils literal notranslate">PyUnicode_1BYTE_KIND</code></a> etc., as returned by
<a class="reference internal" href="#c.PyUnicode_KIND" title="PyUnicode_KIND"><code class="xref c c-func docutils literal notranslate">PyUnicode_KIND()</code></a>). The buffer must point to an array of size
units of 1, 2 or 4 bytes per character, as given by the kind.
<div class="versionadded">
New in version 3.3.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_FromStringAndSize">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyUnicode_FromStringAndSize(const char *u, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> size)<a class="headerlink" href="#c.PyUnicode_FromStringAndSize" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference. Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Create a Unicode object from the char buffer u. The bytes will be
interpreted as being UTF-8 encoded. The buffer is copied into the new
object. If the buffer is not <code class="docutils literal notranslate">NULL</code>, the return value might be a shared
object, i.e. modification of the data is not allowed.
If u is <code class="docutils literal notranslate">NULL</code>, this function behaves like <a class="reference internal" href="#c.PyUnicode_FromUnicode" title="PyUnicode_FromUnicode"><code class="xref c c-func docutils literal notranslate">PyUnicode_FromUnicode()</code></a>
with the buffer set to <code class="docutils literal notranslate">NULL</code>. This usage is deprecated in favor of
<a class="reference internal" href="#c.PyUnicode_New" title="PyUnicode_New"><code class="xref c c-func docutils literal notranslate">PyUnicode_New()</code></a>, and will be removed in Python 3.12.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_FromString">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyUnicode_FromString(const char *u)<a class="headerlink" href="#c.PyUnicode_FromString" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference. Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Create a Unicode object from a UTF-8 encoded null-terminated char buffer
u.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_FromFormat">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyUnicode_FromFormat(const char *format, ...)<a class="headerlink" href="#c.PyUnicode_FromFormat" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference. Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Take a C <code class="xref c c-func docutils literal notranslate">printf()</code>-style format 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 format
ASCII-encoded string. The following format characters are allowed:
<table class="docutils align-default">
<colgroup>
<col style="width: 26%" />
<col style="width: 28%" />
<col style="width: 46%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head">Format Characters</th>
<th class="head">Type</th>
<th class="head">Comment</th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><code class="xref py py-attr docutils literal notranslate">%%</code></td>
<td>n/a</td>
<td>The literal % character.</td>
</tr>
<tr class="row-odd"><td><code class="xref py py-attr docutils literal notranslate">%c</code></td>
<td>int</td>
<td>A single character,
represented as a C int.</td>
</tr>
<tr class="row-even"><td><code class="xref py py-attr docutils literal notranslate">%d</code></td>
<td>int</td>
<td>Equivalent to
<code class="docutils literal notranslate">printf(&quot;%d&quot;)</code>. <a class="footnote-reference brackets" href="#id14" id="id1">1</a></td>
</tr>
<tr class="row-odd"><td><code class="xref py py-attr docutils literal notranslate">%u</code></td>
<td>unsigned int</td>
<td>Equivalent to
<code class="docutils literal notranslate">printf(&quot;%u&quot;)</code>. <a class="footnote-reference brackets" href="#id14" id="id2">1</a></td>
</tr>
<tr class="row-even"><td><code class="xref py py-attr docutils literal notranslate">%ld</code></td>
<td>long</td>
<td>Equivalent to
<code class="docutils literal notranslate">printf(&quot;%ld&quot;)</code>. <a class="footnote-reference brackets" href="#id14" id="id3">1</a></td>
</tr>
<tr class="row-odd"><td><code class="xref py py-attr docutils literal notranslate">%li</code></td>
<td>long</td>
<td>Equivalent to
<code class="docutils literal notranslate">printf(&quot;%li&quot;)</code>. <a class="footnote-reference brackets" href="#id14" id="id4">1</a></td>
</tr>
<tr class="row-even"><td><code class="xref py py-attr docutils literal notranslate">%lu</code></td>
<td>unsigned long</td>
<td>Equivalent to
<code class="docutils literal notranslate">printf(&quot;%lu&quot;)</code>. <a class="footnote-reference brackets" href="#id14" id="id5">1</a></td>
</tr>
<tr class="row-odd"><td><code class="xref py py-attr docutils literal notranslate">%lld</code></td>
<td>long long</td>
<td>Equivalent to
<code class="docutils literal notranslate">printf(&quot;%lld&quot;)</code>. <a class="footnote-reference brackets" href="#id14" id="id6">1</a></td>
</tr>
<tr class="row-even"><td><code class="xref py py-attr docutils literal notranslate">%lli</code></td>
<td>long long</td>
<td>Equivalent to
<code class="docutils literal notranslate">printf(&quot;%lli&quot;)</code>. <a class="footnote-reference brackets" href="#id14" id="id7">1</a></td>
</tr>
<tr class="row-odd"><td><code class="xref py py-attr docutils literal notranslate">%llu</code></td>
<td>unsigned long long</td>
<td>Equivalent to
<code class="docutils literal notranslate">printf(&quot;%llu&quot;)</code>. <a class="footnote-reference brackets" href="#id14" id="id8">1</a></td>
</tr>
<tr class="row-even"><td><code class="xref py py-attr docutils literal notranslate">%zd</code></td>
<td><a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t"><code class="xref c c-type docutils literal notranslate">Py_ssize_t</code></a></td>
<td>Equivalent to
<code class="docutils literal notranslate">printf(&quot;%zd&quot;)</code>. <a class="footnote-reference brackets" href="#id14" id="id9">1</a></td>
</tr>
<tr class="row-odd"><td><code class="xref py py-attr docutils literal notranslate">%zi</code></td>
<td><a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t"><code class="xref c c-type docutils literal notranslate">Py_ssize_t</code></a></td>
<td>Equivalent to
<code class="docutils literal notranslate">printf(&quot;%zi&quot;)</code>. <a class="footnote-reference brackets" href="#id14" id="id10">1</a></td>
</tr>
<tr class="row-even"><td><code class="xref py py-attr docutils literal notranslate">%zu</code></td>
<td>size_t</td>
<td>Equivalent to
<code class="docutils literal notranslate">printf(&quot;%zu&quot;)</code>. <a class="footnote-reference brackets" href="#id14" id="id11">1</a></td>
</tr>
<tr class="row-odd"><td><code class="xref py py-attr docutils literal notranslate">%i</code></td>
<td>int</td>
<td>Equivalent to
<code class="docutils literal notranslate">printf(&quot;%i&quot;)</code>. <a class="footnote-reference brackets" href="#id14" id="id12">1</a></td>
</tr>
<tr class="row-even"><td><code class="xref py py-attr docutils literal notranslate">%x</code></td>
<td>int</td>
<td>Equivalent to
<code class="docutils literal notranslate">printf(&quot;%x&quot;)</code>. <a class="footnote-reference brackets" href="#id14" id="id13">1</a></td>
</tr>
<tr class="row-odd"><td><code class="xref py py-attr docutils literal notranslate">%s</code></td>
<td>const char*</td>
<td>A null-terminated C character
array.</td>
</tr>
<tr class="row-even"><td><code class="xref py py-attr docutils literal notranslate">%p</code></td>
<td>const void*</td>
<td>The hex representation of a C
pointer. Mostly equivalent to
<code class="docutils literal notranslate">printf(&quot;%p&quot;)</code> except that
it is guaranteed to start with
the literal <code class="docutils literal notranslate">0x</code> regardless
of what the platform’s
<code class="docutils literal notranslate">printf</code> yields.</td>
</tr>
<tr class="row-odd"><td><code class="xref py py-attr docutils literal notranslate">%A</code></td>
<td>PyObject*</td>
<td>The result of calling
<a class="reference internal" href="../library/functions.html#ascii" title="ascii"><code class="xref py py-func docutils literal notranslate">ascii()</code></a>.</td>
</tr>
<tr class="row-even"><td><code class="xref py py-attr docutils literal notranslate">%U</code></td>
<td>PyObject*</td>
<td>A Unicode object.</td>
</tr>
<tr class="row-odd"><td><code class="xref py py-attr docutils literal notranslate">%V</code></td>
<td>PyObject*,
const char*</td>
<td>A Unicode object (which may be
<code class="docutils literal notranslate">NULL</code>) and a null-terminated
C character array as a second
parameter (which will be used,
if the first parameter is
<code class="docutils literal notranslate">NULL</code>).</td>
</tr>
<tr class="row-even"><td><code class="xref py py-attr docutils literal notranslate">%S</code></td>
<td>PyObject*</td>
<td>The result of calling
<a class="reference internal" href="object.html#c.PyObject_Str" title="PyObject_Str"><code class="xref c c-func docutils literal notranslate">PyObject_Str()</code></a>.</td>
</tr>
<tr class="row-odd"><td><code class="xref py py-attr docutils literal notranslate">%R</code></td>
<td>PyObject*</td>
<td>The result of calling
<a class="reference internal" href="object.html#c.PyObject_Repr" title="PyObject_Repr"><code class="xref c c-func docutils literal notranslate">PyObject_Repr()</code></a>.</td>
</tr>
</tbody>
</table>
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.
<div class="admonition note">
Note
The width formatter unit is number of characters rather than bytes.
The precision formatter unit is number of bytes for <code class="docutils literal notranslate">&quot;%s&quot;</code> and
<code class="docutils literal notranslate">&quot;%V&quot;</code> (if the <code class="docutils literal notranslate">PyObject*</code> argument is <code class="docutils literal notranslate">NULL</code>), and a number of
characters for <code class="docutils literal notranslate">&quot;%A&quot;</code>, <code class="docutils literal notranslate">&quot;%U&quot;</code>, <code class="docutils literal notranslate">&quot;%S&quot;</code>, <code class="docutils literal notranslate">&quot;%R&quot;</code> and <code class="docutils literal notranslate">&quot;%V&quot;</code>
(if the <code class="docutils literal notranslate">PyObject*</code> argument is not <code class="docutils literal notranslate">NULL</code>).
</div>
<dl class="footnote brackets">
<dt class="label" id="id14">1(<a href="#id1">1</a>,<a href="#id2">2</a>,<a href="#id3">3</a>,<a href="#id4">4</a>,<a href="#id5">5</a>,<a href="#id6">6</a>,<a href="#id7">7</a>,<a href="#id8">8</a>,<a href="#id9">9</a>,<a href="#id10">10</a>,<a href="#id11">11</a>,<a href="#id12">12</a>,<a href="#id13">13</a>)</dt>
<dd>For integer specifiers (d, u, ld, li, lu, lld, lli, llu, zd, zi,
zu, i, x): the 0-conversion flag has effect even when a precision is given.
</dd>
</dl>
<div class="versionchanged">
Changed in version 3.2: Support for <code class="docutils literal notranslate">&quot;%lld&quot;</code> and <code class="docutils literal notranslate">&quot;%llu&quot;</code> added.
</div>
<div class="versionchanged">
Changed in version 3.3: Support for <code class="docutils literal notranslate">&quot;%li&quot;</code>, <code class="docutils literal notranslate">&quot;%lli&quot;</code> and <code class="docutils literal notranslate">&quot;%zi&quot;</code> added.
</div>
<div class="versionchanged">
Changed in version 3.4: Support width and precision formatter for <code class="docutils literal notranslate">&quot;%s&quot;</code>, <code class="docutils literal notranslate">&quot;%A&quot;</code>, <code class="docutils literal notranslate">&quot;%U&quot;</code>,
<code class="docutils literal notranslate">&quot;%V&quot;</code>, <code class="docutils literal notranslate">&quot;%S&quot;</code>, <code class="docutils literal notranslate">&quot;%R&quot;</code> added.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_FromFormatV">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyUnicode_FromFormatV(const char *format, va_list vargs)<a class="headerlink" href="#c.PyUnicode_FromFormatV" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference. Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Identical to <a class="reference internal" href="#c.PyUnicode_FromFormat" title="PyUnicode_FromFormat"><code class="xref c c-func docutils literal notranslate">PyUnicode_FromFormat()</code></a> except that it takes exactly two
arguments.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_FromEncodedObject">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyUnicode_FromEncodedObject(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *obj, const char *encoding, const char *errors)<a class="headerlink" href="#c.PyUnicode_FromEncodedObject" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference. Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Decode an encoded object obj to a Unicode object.
<a class="reference internal" href="../library/stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate">bytes</code></a>, <a class="reference internal" href="../library/stdtypes.html#bytearray" title="bytearray"><code class="xref py py-class docutils literal notranslate">bytearray</code></a> and other
<a class="reference internal" href="../glossary.html#term-bytes-like-object">bytes-like objects</a>
are decoded according to the given encoding and using the error handling
defined by errors. Both can be <code class="docutils literal notranslate">NULL</code> to have the interface use the default
values (see <a class="reference internal" href="#builtincodecs">Built-in Codecs</a> for details).
All other objects, including Unicode objects, cause a <a class="reference internal" href="../library/exceptions.html#TypeError" title="TypeError"><code class="xref py py-exc docutils literal notranslate">TypeError</code></a> to be
set.
The API returns <code class="docutils literal notranslate">NULL</code> if there was an error. The caller is responsible for
decref’ing the returned objects.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_GetLength">
<a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> PyUnicode_GetLength(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *unicode)<a class="headerlink" href="#c.PyUnicode_GetLength" title="Permalink to this definition">¶</a> </dt>
<dd> Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a> since version 3.7.Return the length of the Unicode object, in code points.
<div class="versionadded">
New in version 3.3.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_CopyCharacters">
<a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> PyUnicode_CopyCharacters(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *to, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> to_start, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *from, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> from_start, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> how_many)<a class="headerlink" href="#c.PyUnicode_CopyCharacters" title="Permalink to this definition">¶</a> </dt>
<dd>Copy characters from one Unicode object into another. This function performs
character conversion when necessary and falls back to <code class="xref c c-func docutils literal notranslate">memcpy()</code> if
possible. Returns <code class="docutils literal notranslate">-1</code> and sets an exception on error, otherwise returns
the number of copied characters.
<div class="versionadded">
New in version 3.3.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_Fill">
<a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> PyUnicode_Fill(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *unicode, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> start, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> length, <a class="reference internal" href="#c.Py_UCS4" title="Py_UCS4">Py_UCS4</a> fill_char)<a class="headerlink" href="#c.PyUnicode_Fill" title="Permalink to this definition">¶</a> </dt>
<dd>Fill a string with a character: write fill_char into
<code class="docutils literal notranslate">unicode[start:start+length]</code>.
Fail if fill_char is bigger than the string maximum character, or if the
string has more than 1 reference.
Return the number of written character, or return <code class="docutils literal notranslate">-1</code> and raise an
exception on error.
<div class="versionadded">
New in version 3.3.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_WriteChar">
int PyUnicode_WriteChar(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *unicode, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> index, <a class="reference internal" href="#c.Py_UCS4" title="Py_UCS4">Py_UCS4</a> character)<a class="headerlink" href="#c.PyUnicode_WriteChar" title="Permalink to this definition">¶</a> </dt>
<dd> Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a> since version 3.7.Write a character to a string. The string must have been created through
<a class="reference internal" href="#c.PyUnicode_New" title="PyUnicode_New"><code class="xref c c-func docutils literal notranslate">PyUnicode_New()</code></a>. Since Unicode strings are supposed to be immutable,
the string must not be shared, or have been hashed yet.
This function checks that unicode is a Unicode object, that the index is
not out of bounds, and that the object can be modified safely (i.e. that it
its reference count is one).
<div class="versionadded">
New in version 3.3.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_ReadChar">
<a class="reference internal" href="#c.Py_UCS4" title="Py_UCS4">Py_UCS4</a> PyUnicode_ReadChar(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *unicode, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> index)<a class="headerlink" href="#c.PyUnicode_ReadChar" title="Permalink to this definition">¶</a> </dt>
<dd> Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a> since version 3.7.Read a character from a string. This function checks that unicode is a
Unicode object and the index is not out of bounds, in contrast to the macro
version <a class="reference internal" href="#c.PyUnicode_READ_CHAR" title="PyUnicode_READ_CHAR"><code class="xref c c-func docutils literal notranslate">PyUnicode_READ_CHAR()</code></a>.
<div class="versionadded">
New in version 3.3.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_Substring">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyUnicode_Substring(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *str, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> start, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> end)<a class="headerlink" href="#c.PyUnicode_Substring" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference. Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a> since version 3.7.Return a substring of str, from character index start (included) to
character index end (excluded). Negative indices are not supported.
<div class="versionadded">
New in version 3.3.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_AsUCS4">
<a class="reference internal" href="#c.Py_UCS4" title="Py_UCS4">Py_UCS4</a> *PyUnicode_AsUCS4(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *u, <a class="reference internal" href="#c.Py_UCS4" title="Py_UCS4">Py_UCS4</a> *buffer, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> buflen, int copy_null)<a class="headerlink" href="#c.PyUnicode_AsUCS4" title="Permalink to this definition">¶</a> </dt>
<dd> Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a> since version 3.7.Copy the string u into a UCS4 buffer, including a null character, if
copy_null is set. Returns <code class="docutils literal notranslate">NULL</code> and sets an exception on error (in
particular, a <a class="reference internal" href="../library/exceptions.html#SystemError" title="SystemError"><code class="xref py py-exc docutils literal notranslate">SystemError</code></a> if buflen is smaller than the length of
u). buffer is returned on success.
<div class="versionadded">
New in version 3.3.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_AsUCS4Copy">
<a class="reference internal" href="#c.Py_UCS4" title="Py_UCS4">Py_UCS4</a> *PyUnicode_AsUCS4Copy(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *u)<a class="headerlink" href="#c.PyUnicode_AsUCS4Copy" title="Permalink to this definition">¶</a> </dt>
<dd> Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a> since version 3.7.Copy the string u into a new UCS4 buffer that is allocated using
<a class="reference internal" href="memory.html#c.PyMem_Malloc" title="PyMem_Malloc"><code class="xref c c-func docutils literal notranslate">PyMem_Malloc()</code></a>. If this fails, <code class="docutils literal notranslate">NULL</code> is returned with a
<a class="reference internal" href="../library/exceptions.html#MemoryError" title="MemoryError"><code class="xref py py-exc docutils literal notranslate">MemoryError</code></a> set. The returned buffer always has an extra
null code point appended.
<div class="versionadded">
New in version 3.3.
</div>
</dd></dl>

</section>
<section id="deprecated-py-unicode-apis">
<h3>Deprecated Py_UNICODE APIs<a class="headerlink" href="#deprecated-py-unicode-apis" title="Permalink to this headline">¶</a></h3>
<div class="deprecated-removed">
Deprecated since version 3.3, will be removed in version 3.12.
</div>
These API functions are deprecated with the implementation of <a class="pep reference external" href="https://www.python.org/dev/peps/pep-0393">PEP 393</a>.
Extension modules can continue using them, as they will not be removed in Python
3.x, but need to be aware that their use can now cause performance and memory hits.
<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_FromUnicode">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyUnicode_FromUnicode(const <a class="reference internal" href="#c.Py_UNICODE" title="Py_UNICODE">Py_UNICODE</a> *u, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> size)<a class="headerlink" href="#c.PyUnicode_FromUnicode" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference.Create a Unicode object from the Py_UNICODE buffer u of the given size. u
may be <code class="docutils literal notranslate">NULL</code> 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 <code class="docutils literal notranslate">NULL</code>, the return value might be a shared object.
Therefore, modification of the resulting Unicode object is only allowed when
u is <code class="docutils literal notranslate">NULL</code>.
If the buffer is <code class="docutils literal notranslate">NULL</code>, <a class="reference internal" href="#c.PyUnicode_READY" title="PyUnicode_READY"><code class="xref c c-func docutils literal notranslate">PyUnicode_READY()</code></a> must be called once the
string content has been filled before using any of the access macros such as
<a class="reference internal" href="#c.PyUnicode_KIND" title="PyUnicode_KIND"><code class="xref c c-func docutils literal notranslate">PyUnicode_KIND()</code></a>.
<div class="deprecated-removed">
Deprecated since version 3.3, will be removed in version 3.12: Part of the old-style Unicode API, please migrate to using
<a class="reference internal" href="#c.PyUnicode_FromKindAndData" title="PyUnicode_FromKindAndData"><code class="xref c c-func docutils literal notranslate">PyUnicode_FromKindAndData()</code></a>, <a class="reference internal" href="#c.PyUnicode_FromWideChar" title="PyUnicode_FromWideChar"><code class="xref c c-func docutils literal notranslate">PyUnicode_FromWideChar()</code></a>, or
<a class="reference internal" href="#c.PyUnicode_New" title="PyUnicode_New"><code class="xref c c-func docutils literal notranslate">PyUnicode_New()</code></a>.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_AsUnicode">
<a class="reference internal" href="#c.Py_UNICODE" title="Py_UNICODE">Py_UNICODE</a> *PyUnicode_AsUnicode(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *unicode)<a class="headerlink" href="#c.PyUnicode_AsUnicode" title="Permalink to this definition">¶</a> </dt>
<dd>Return a read-only pointer to the Unicode object’s internal
<a class="reference internal" href="#c.Py_UNICODE" title="Py_UNICODE"><code class="xref c c-type docutils literal notranslate">Py_UNICODE</code></a> buffer, or <code class="docutils literal notranslate">NULL</code> on error. This will create the
<a class="reference internal" href="#c.Py_UNICODE" title="Py_UNICODE">Py_UNICODE</a>* representation of the object if it is not yet
available. The buffer is always terminated with an extra null code point.
Note that the resulting <a class="reference internal" href="#c.Py_UNICODE" title="Py_UNICODE"><code class="xref c c-type docutils literal notranslate">Py_UNICODE</code></a> string may also contain
embedded null code points, which would cause the string to be truncated when
used in most C functions.
<div class="deprecated-removed">
Deprecated since version 3.3, will be removed in version 3.12: Part of the old-style Unicode API, please migrate to using
<a class="reference internal" href="#c.PyUnicode_AsUCS4" title="PyUnicode_AsUCS4"><code class="xref c c-func docutils literal notranslate">PyUnicode_AsUCS4()</code></a>, <a class="reference internal" href="#c.PyUnicode_AsWideChar" title="PyUnicode_AsWideChar"><code class="xref c c-func docutils literal notranslate">PyUnicode_AsWideChar()</code></a>,
<a class="reference internal" href="#c.PyUnicode_ReadChar" title="PyUnicode_ReadChar"><code class="xref c c-func docutils literal notranslate">PyUnicode_ReadChar()</code></a> or similar new APIs.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_TransformDecimalToASCII">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyUnicode_TransformDecimalToASCII(<a class="reference internal" href="#c.Py_UNICODE" title="Py_UNICODE">Py_UNICODE</a> *s, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> size)<a class="headerlink" href="#c.PyUnicode_TransformDecimalToASCII" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference.Create a Unicode object by replacing all decimal digits in
<a class="reference internal" href="#c.Py_UNICODE" title="Py_UNICODE"><code class="xref c c-type docutils literal notranslate">Py_UNICODE</code></a> buffer of the given size by ASCII digits 0–9
according to their decimal value. Return <code class="docutils literal notranslate">NULL</code> if an exception occurs.
<div class="deprecated-removed">
Deprecated since version 3.3, will be removed in version 3.11: Part of the old-style <a class="reference internal" href="#c.Py_UNICODE" title="Py_UNICODE"><code class="xref c c-type docutils literal notranslate">Py_UNICODE</code></a> API; please migrate to using
<a class="reference internal" href="#c.Py_UNICODE_TODECIMAL" title="Py_UNICODE_TODECIMAL"><code class="xref c c-func docutils literal notranslate">Py_UNICODE_TODECIMAL()</code></a>.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_AsUnicodeAndSize">
<a class="reference internal" href="#c.Py_UNICODE" title="Py_UNICODE">Py_UNICODE</a> *PyUnicode_AsUnicodeAndSize(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *unicode, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> *size)<a class="headerlink" href="#c.PyUnicode_AsUnicodeAndSize" title="Permalink to this definition">¶</a> </dt>
<dd>Like <a class="reference internal" href="#c.PyUnicode_AsUnicode" title="PyUnicode_AsUnicode"><code class="xref c c-func docutils literal notranslate">PyUnicode_AsUnicode()</code></a>, but also saves the <a class="reference internal" href="#c.Py_UNICODE" title="Py_UNICODE"><code class="xref c c-func docutils literal notranslate">Py_UNICODE()</code></a>
array length (excluding the extra null terminator) in size.
Note that the resulting <a class="reference internal" href="#c.Py_UNICODE" title="Py_UNICODE">Py_UNICODE</a>* string
may contain embedded null code points, which would cause the string to be
truncated when used in most C functions.
<div class="versionadded">
New in version 3.3.
</div>
<div class="deprecated-removed">
Deprecated since version 3.3, will be removed in version 3.12: Part of the old-style Unicode API, please migrate to using
<a class="reference internal" href="#c.PyUnicode_AsUCS4" title="PyUnicode_AsUCS4"><code class="xref c c-func docutils literal notranslate">PyUnicode_AsUCS4()</code></a>, <a class="reference internal" href="#c.PyUnicode_AsWideChar" title="PyUnicode_AsWideChar"><code class="xref c c-func docutils literal notranslate">PyUnicode_AsWideChar()</code></a>,
<a class="reference internal" href="#c.PyUnicode_ReadChar" title="PyUnicode_ReadChar"><code class="xref c c-func docutils literal notranslate">PyUnicode_ReadChar()</code></a> or similar new APIs.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_GetSize">
<a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> PyUnicode_GetSize(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *unicode)<a class="headerlink" href="#c.PyUnicode_GetSize" title="Permalink to this definition">¶</a> </dt>
<dd> Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Return the size of the deprecated <a class="reference internal" href="#c.Py_UNICODE" title="Py_UNICODE"><code class="xref c c-type docutils literal notranslate">Py_UNICODE</code></a> representation, in
code units (this includes surrogate pairs as 2 units).
<div class="deprecated-removed">
Deprecated since version 3.3, will be removed in version 3.12: Part of the old-style Unicode API, please migrate to using
<a class="reference internal" href="#c.PyUnicode_GET_LENGTH" title="PyUnicode_GET_LENGTH"><code class="xref c c-func docutils literal notranslate">PyUnicode_GET_LENGTH()</code></a>.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_FromObject">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyUnicode_FromObject(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *obj)<a class="headerlink" href="#c.PyUnicode_FromObject" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference. Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Copy an instance of a Unicode subtype to a new true Unicode object if
necessary. If obj is already a true Unicode object (not a subtype),
return the reference with incremented refcount.
Objects other than Unicode or its subtypes will cause a <a class="reference internal" href="../library/exceptions.html#TypeError" title="TypeError"><code class="xref py py-exc docutils literal notranslate">TypeError</code></a>.
</dd></dl>

</section>
<section id="locale-encoding">
<h3>Locale Encoding<a class="headerlink" href="#locale-encoding" title="Permalink to this headline">¶</a></h3>
The current locale encoding can be used to decode text from the operating
system.
<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_DecodeLocaleAndSize">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyUnicode_DecodeLocaleAndSize(const char *str, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> len, const char *errors)<a class="headerlink" href="#c.PyUnicode_DecodeLocaleAndSize" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference. Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a> since version 3.7.Decode a string from UTF-8 on Android and VxWorks, or from the current
locale encoding on other platforms. The supported
error handlers are <code class="docutils literal notranslate">&quot;strict&quot;</code> and <code class="docutils literal notranslate">&quot;surrogateescape&quot;</code>
(<a class="pep reference external" href="https://www.python.org/dev/peps/pep-0383">PEP 383</a>). The decoder uses <code class="docutils literal notranslate">&quot;strict&quot;</code> error handler if
errors is <code class="docutils literal notranslate">NULL</code>. str must end with a null character but
cannot contain embedded null characters.
Use <a class="reference internal" href="#c.PyUnicode_DecodeFSDefaultAndSize" title="PyUnicode_DecodeFSDefaultAndSize"><code class="xref c c-func docutils literal notranslate">PyUnicode_DecodeFSDefaultAndSize()</code></a> to decode a string from
<code class="xref c c-data docutils literal notranslate">Py_FileSystemDefaultEncoding</code> (the locale encoding read at
Python startup).
This function ignores the <a class="reference internal" href="../library/os.html#utf8-mode">Python UTF-8 Mode</a>.
<div class="admonition seealso">
See also
The <a class="reference internal" href="sys.html#c.Py_DecodeLocale" title="Py_DecodeLocale"><code class="xref c c-func docutils literal notranslate">Py_DecodeLocale()</code></a> function.
</div>
<div class="versionadded">
New in version 3.3.
</div>
<div class="versionchanged">
Changed in version 3.7: The function now also uses the current locale encoding for the
<code class="docutils literal notranslate">surrogateescape</code> error handler, except on Android. Previously, <a class="reference internal" href="sys.html#c.Py_DecodeLocale" title="Py_DecodeLocale"><code class="xref c c-func docutils literal notranslate">Py_DecodeLocale()</code></a>
was used for the <code class="docutils literal notranslate">surrogateescape</code>, and the current locale encoding was
used for <code class="docutils literal notranslate">strict</code>.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_DecodeLocale">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyUnicode_DecodeLocale(const char *str, const char *errors)<a class="headerlink" href="#c.PyUnicode_DecodeLocale" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference. Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a> since version 3.7.Similar to <a class="reference internal" href="#c.PyUnicode_DecodeLocaleAndSize" title="PyUnicode_DecodeLocaleAndSize"><code class="xref c c-func docutils literal notranslate">PyUnicode_DecodeLocaleAndSize()</code></a>, but compute the string
length using <code class="xref c c-func docutils literal notranslate">strlen()</code>.
<div class="versionadded">
New in version 3.3.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_EncodeLocale">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyUnicode_EncodeLocale(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *unicode, const char *errors)<a class="headerlink" href="#c.PyUnicode_EncodeLocale" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference. Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a> since version 3.7.Encode a Unicode object to UTF-8 on Android and VxWorks, or to the current
locale encoding on other platforms. The
supported error handlers are <code class="docutils literal notranslate">&quot;strict&quot;</code> and <code class="docutils literal notranslate">&quot;surrogateescape&quot;</code>
(<a class="pep reference external" href="https://www.python.org/dev/peps/pep-0383">PEP 383</a>). The encoder uses <code class="docutils literal notranslate">&quot;strict&quot;</code> error handler if
errors is <code class="docutils literal notranslate">NULL</code>. Return a <a class="reference internal" href="../library/stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate">bytes</code></a> object. unicode cannot
contain embedded null characters.
Use <a class="reference internal" href="#c.PyUnicode_EncodeFSDefault" title="PyUnicode_EncodeFSDefault"><code class="xref c c-func docutils literal notranslate">PyUnicode_EncodeFSDefault()</code></a> to encode a string to
<code class="xref c c-data docutils literal notranslate">Py_FileSystemDefaultEncoding</code> (the locale encoding read at
Python startup).
This function ignores the <a class="reference internal" href="../library/os.html#utf8-mode">Python UTF-8 Mode</a>.
<div class="admonition seealso">
See also
The <a class="reference internal" href="sys.html#c.Py_EncodeLocale" title="Py_EncodeLocale"><code class="xref c c-func docutils literal notranslate">Py_EncodeLocale()</code></a> function.
</div>
<div class="versionadded">
New in version 3.3.
</div>
<div class="versionchanged">
Changed in version 3.7: The function now also uses the current locale encoding for the
<code class="docutils literal notranslate">surrogateescape</code> error handler, except on Android. Previously,
<a class="reference internal" href="sys.html#c.Py_EncodeLocale" title="Py_EncodeLocale"><code class="xref c c-func docutils literal notranslate">Py_EncodeLocale()</code></a>
was used for the <code class="docutils literal notranslate">surrogateescape</code>, and the current locale encoding was
used for <code class="docutils literal notranslate">strict</code>.
</div>
</dd></dl>

</section>
<section id="file-system-encoding">
<h3>File System Encoding<a class="headerlink" href="#file-system-encoding" title="Permalink to this headline">¶</a></h3>
To encode and decode file names and other environment strings,
<code class="xref c c-data docutils literal notranslate">Py_FileSystemDefaultEncoding</code> should be used as the encoding, and
<code class="xref c c-data docutils literal notranslate">Py_FileSystemDefaultEncodeErrors</code> should be used as the error handler
(<a class="pep reference external" href="https://www.python.org/dev/peps/pep-0383">PEP 383</a> and <a class="pep reference external" href="https://www.python.org/dev/peps/pep-0529">PEP 529</a>). To encode file names to <a class="reference internal" href="../library/stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate">bytes</code></a> during
argument parsing, the <code class="docutils literal notranslate">&quot;O&amp;&quot;</code> converter should be used, passing
<a class="reference internal" href="#c.PyUnicode_FSConverter" title="PyUnicode_FSConverter"><code class="xref c c-func docutils literal notranslate">PyUnicode_FSConverter()</code></a> as the conversion function:
<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_FSConverter">
int PyUnicode_FSConverter(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *obj, void *result)<a class="headerlink" href="#c.PyUnicode_FSConverter" title="Permalink to this definition">¶</a> </dt>
<dd> Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.ParseTuple converter: encode <a class="reference internal" href="../library/stdtypes.html#str" title="str"><code class="xref py py-class docutils literal notranslate">str</code></a> objects – obtained directly or
through the <a class="reference internal" href="../library/os.html#os.PathLike" title="os.PathLike"><code class="xref py py-class docutils literal notranslate">os.PathLike</code></a> interface – to <a class="reference internal" href="../library/stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate">bytes</code></a> using
<a class="reference internal" href="#c.PyUnicode_EncodeFSDefault" title="PyUnicode_EncodeFSDefault"><code class="xref c c-func docutils literal notranslate">PyUnicode_EncodeFSDefault()</code></a>; <a class="reference internal" href="../library/stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate">bytes</code></a> objects are output as-is.
result must be a <a class="reference internal" href="bytes.html#c.PyBytesObject" title="PyBytesObject">PyBytesObject</a>* which must be released when it is
no longer used.
<div class="versionadded">
New in version 3.1.
</div>
<div class="versionchanged">
Changed in version 3.6: Accepts a <a class="reference internal" href="../glossary.html#term-path-like-object">path-like object</a>.
</div>
</dd></dl>

To decode file names to <a class="reference internal" href="../library/stdtypes.html#str" title="str"><code class="xref py py-class docutils literal notranslate">str</code></a> during argument parsing, the <code class="docutils literal notranslate">&quot;O&amp;&quot;</code>
converter should be used, passing <a class="reference internal" href="#c.PyUnicode_FSDecoder" title="PyUnicode_FSDecoder"><code class="xref c c-func docutils literal notranslate">PyUnicode_FSDecoder()</code></a> as the
conversion function:
<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_FSDecoder">
int PyUnicode_FSDecoder(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *obj, void *result)<a class="headerlink" href="#c.PyUnicode_FSDecoder" title="Permalink to this definition">¶</a> </dt>
<dd> Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.ParseTuple converter: decode <a class="reference internal" href="../library/stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate">bytes</code></a> objects – obtained either
directly or indirectly through the <a class="reference internal" href="../library/os.html#os.PathLike" title="os.PathLike"><code class="xref py py-class docutils literal notranslate">os.PathLike</code></a> interface – to
<a class="reference internal" href="../library/stdtypes.html#str" title="str"><code class="xref py py-class docutils literal notranslate">str</code></a> using <a class="reference internal" href="#c.PyUnicode_DecodeFSDefaultAndSize" title="PyUnicode_DecodeFSDefaultAndSize"><code class="xref c c-func docutils literal notranslate">PyUnicode_DecodeFSDefaultAndSize()</code></a>; <a class="reference internal" href="../library/stdtypes.html#str" title="str"><code class="xref py py-class docutils literal notranslate">str</code></a>
objects are output as-is. result must be a <a class="reference internal" href="#c.PyUnicodeObject" title="PyUnicodeObject">PyUnicodeObject</a>* which
must be released when it is no longer used.
<div class="versionadded">
New in version 3.2.
</div>
<div class="versionchanged">
Changed in version 3.6: Accepts a <a class="reference internal" href="../glossary.html#term-path-like-object">path-like object</a>.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_DecodeFSDefaultAndSize">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyUnicode_DecodeFSDefaultAndSize(const char *s, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> size)<a class="headerlink" href="#c.PyUnicode_DecodeFSDefaultAndSize" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference. Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Decode a string from the <a class="reference internal" href="../glossary.html#term-filesystem-encoding-and-error-handler">filesystem encoding and error handler</a>.
If <code class="xref c c-data docutils literal notranslate">Py_FileSystemDefaultEncoding</code> is not set, fall back to the
locale encoding.
<code class="xref c c-data docutils literal notranslate">Py_FileSystemDefaultEncoding</code> is initialized at startup from the
locale encoding and cannot be modified later. If you need to decode a string
from the current locale encoding, use
<a class="reference internal" href="#c.PyUnicode_DecodeLocaleAndSize" title="PyUnicode_DecodeLocaleAndSize"><code class="xref c c-func docutils literal notranslate">PyUnicode_DecodeLocaleAndSize()</code></a>.
<div class="admonition seealso">
See also
The <a class="reference internal" href="sys.html#c.Py_DecodeLocale" title="Py_DecodeLocale"><code class="xref c c-func docutils literal notranslate">Py_DecodeLocale()</code></a> function.
</div>
<div class="versionchanged">
Changed in version 3.6: Use <code class="xref c c-data docutils literal notranslate">Py_FileSystemDefaultEncodeErrors</code> error handler.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_DecodeFSDefault">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyUnicode_DecodeFSDefault(const char *s)<a class="headerlink" href="#c.PyUnicode_DecodeFSDefault" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference. Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Decode a null-terminated string from the <a class="reference internal" href="../glossary.html#term-filesystem-encoding-and-error-handler">filesystem encoding and
error handler</a>.
If <code class="xref c c-data docutils literal notranslate">Py_FileSystemDefaultEncoding</code> is not set, fall back to the
locale encoding.
Use <a class="reference internal" href="#c.PyUnicode_DecodeFSDefaultAndSize" title="PyUnicode_DecodeFSDefaultAndSize"><code class="xref c c-func docutils literal notranslate">PyUnicode_DecodeFSDefaultAndSize()</code></a> if you know the string length.
<div class="versionchanged">
Changed in version 3.6: Use <code class="xref c c-data docutils literal notranslate">Py_FileSystemDefaultEncodeErrors</code> error handler.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_EncodeFSDefault">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyUnicode_EncodeFSDefault(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *unicode)<a class="headerlink" href="#c.PyUnicode_EncodeFSDefault" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference. Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Encode a Unicode object to <code class="xref c c-data docutils literal notranslate">Py_FileSystemDefaultEncoding</code> with the
<code class="xref c c-data docutils literal notranslate">Py_FileSystemDefaultEncodeErrors</code> error handler, and return
<a class="reference internal" href="../library/stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate">bytes</code></a>. Note that the resulting <a class="reference internal" href="../library/stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate">bytes</code></a> object may contain
null bytes.
If <code class="xref c c-data docutils literal notranslate">Py_FileSystemDefaultEncoding</code> is not set, fall back to the
locale encoding.
<code class="xref c c-data docutils literal notranslate">Py_FileSystemDefaultEncoding</code> is initialized at startup from the
locale encoding and cannot be modified later. If you need to encode a string
to the current locale encoding, use <a class="reference internal" href="#c.PyUnicode_EncodeLocale" title="PyUnicode_EncodeLocale"><code class="xref c c-func docutils literal notranslate">PyUnicode_EncodeLocale()</code></a>.
<div class="admonition seealso">
See also
The <a class="reference internal" href="sys.html#c.Py_EncodeLocale" title="Py_EncodeLocale"><code class="xref c c-func docutils literal notranslate">Py_EncodeLocale()</code></a> function.
</div>
<div class="versionadded">
New in version 3.2.
</div>
<div class="versionchanged">
Changed in version 3.6: Use <code class="xref c c-data docutils literal notranslate">Py_FileSystemDefaultEncodeErrors</code> error handler.
</div>
</dd></dl>

</section>
<section id="wchar-t-support">
<h3>wchar_t Support<a class="headerlink" href="#wchar-t-support" title="Permalink to this headline">¶</a></h3>
wchar_t support for platforms which support it:
<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_FromWideChar">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyUnicode_FromWideChar(const wchar_t *w, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> size)<a class="headerlink" href="#c.PyUnicode_FromWideChar" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference. Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Create a Unicode object from the wchar_t buffer w of the given size.
Passing <code class="docutils literal notranslate">-1</code> as the size indicates that the function must itself compute the length,
using wcslen.
Return <code class="docutils literal notranslate">NULL</code> on failure.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_AsWideChar">
<a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> PyUnicode_AsWideChar(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *unicode, wchar_t *w, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> size)<a class="headerlink" href="#c.PyUnicode_AsWideChar" title="Permalink to this definition">¶</a> </dt>
<dd> Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Copy the Unicode object contents into the wchar_t buffer w. At most
size wchar_t characters are copied (excluding a possibly trailing
null termination character). Return the number of wchar_t characters
copied or <code class="docutils literal notranslate">-1</code> in case of an error. Note that the resulting wchar_t*
string may or may not be null-terminated. It is the responsibility of the caller
to make sure that the wchar_t* string is null-terminated in case this is
required by the application. Also, note that the wchar_t* string
might contain null characters, which would cause the string to be truncated
when used with most C functions.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_AsWideCharString">
wchar_t *PyUnicode_AsWideCharString(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *unicode, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> *size)<a class="headerlink" href="#c.PyUnicode_AsWideCharString" title="Permalink to this definition">¶</a> </dt>
<dd> Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a> since version 3.7.Convert the Unicode object to a wide character string. The output string
always ends with a null character. If size is not <code class="docutils literal notranslate">NULL</code>, write the number
of wide characters (excluding the trailing null termination character) into
*size. Note that the resulting wchar_t string might contain
null characters, which would cause the string to be truncated when used with
most C functions. If size is <code class="docutils literal notranslate">NULL</code> and the wchar_t* string
contains null characters a <a class="reference internal" href="../library/exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate">ValueError</code></a> is raised.
Returns a buffer allocated by <code class="xref c c-func docutils literal notranslate">PyMem_Alloc()</code> (use
<a class="reference internal" href="memory.html#c.PyMem_Free" title="PyMem_Free"><code class="xref c c-func docutils literal notranslate">PyMem_Free()</code></a> to free it) on success. On error, returns <code class="docutils literal notranslate">NULL</code>
and *size is undefined. Raises a <a class="reference internal" href="../library/exceptions.html#MemoryError" title="MemoryError"><code class="xref py py-exc docutils literal notranslate">MemoryError</code></a> if memory allocation
is failed.
<div class="versionadded">
New in version 3.2.
</div>
<div class="versionchanged">
Changed in version 3.7: Raises a <a class="reference internal" href="../library/exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate">ValueError</code></a> if size is <code class="docutils literal notranslate">NULL</code> and the wchar_t*
string contains null characters.
</div>
</dd></dl>

</section>
</section>
<section id="built-in-codecs">
<h2>Built-in Codecs<a class="headerlink" href="#built-in-codecs" title="Permalink to this headline">¶</a></h2>
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.
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/stdtypes.html#str" title="str"><code class="xref py py-func docutils literal notranslate">str()</code></a> string object
constructor.
Setting encoding to <code class="docutils literal notranslate">NULL</code> causes the default encoding to be used
which is UTF-8. The file system calls should use
<a class="reference internal" href="#c.PyUnicode_FSConverter" title="PyUnicode_FSConverter"><code class="xref c c-func docutils literal notranslate">PyUnicode_FSConverter()</code></a> for encoding file names. This uses the
variable <code class="xref c c-data docutils literal notranslate">Py_FileSystemDefaultEncoding</code> internally. 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).
Error handling is set by errors which may also be set to <code class="docutils literal notranslate">NULL</code> 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#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate">ValueError</code></a> is raised).
The codecs all use a similar interface. Only deviations from the following
generic ones are documented for simplicity.
<section id="generic-codecs">
<h3>Generic Codecs<a class="headerlink" href="#generic-codecs" title="Permalink to this headline">¶</a></h3>
These are the generic codec APIs:
<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_Decode">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyUnicode_Decode(const char *s, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> size, const char *encoding, const char *errors)<a class="headerlink" href="#c.PyUnicode_Decode" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference. Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Create a Unicode object by decoding size bytes of the encoded string s.
encoding and errors have the same meaning as the parameters of the same name
in the <a class="reference internal" href="../library/stdtypes.html#str" title="str"><code class="xref py py-func docutils literal notranslate">str()</code></a> built-in function. The codec to be used is looked up
using the Python codec registry. Return <code class="docutils literal notranslate">NULL</code> if an exception was raised by
the codec.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_AsEncodedString">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyUnicode_AsEncodedString(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *unicode, const char *encoding, const char *errors)<a class="headerlink" href="#c.PyUnicode_AsEncodedString" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference. Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Encode a Unicode object and return the result as Python bytes object.
encoding and errors have the same meaning as the parameters of the same
name in the Unicode <a class="reference internal" href="../library/stdtypes.html#str.encode" title="str.encode"><code class="xref py py-meth docutils literal notranslate">encode()</code></a> method. The codec to be used is looked up
using the Python codec registry. Return <code class="docutils literal notranslate">NULL</code> if an exception was raised by
the codec.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_Encode">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyUnicode_Encode(const <a class="reference internal" href="#c.Py_UNICODE" title="Py_UNICODE">Py_UNICODE</a> *s, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> size, const char *encoding, const char *errors)<a class="headerlink" href="#c.PyUnicode_Encode" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference.Encode the <a class="reference internal" href="#c.Py_UNICODE" title="Py_UNICODE"><code class="xref c c-type docutils literal notranslate">Py_UNICODE</code></a> buffer s of the given size and return a Python
bytes object. encoding and errors have the same meaning as the
parameters of the same name in the Unicode <a class="reference internal" href="../library/stdtypes.html#str.encode" title="str.encode"><code class="xref py py-meth docutils literal notranslate">encode()</code></a> method. The codec
to be used is looked up using the Python codec registry. Return <code class="docutils literal notranslate">NULL</code> if an
exception was raised by the codec.
<div class="deprecated-removed">
Deprecated since version 3.3, will be removed in version 3.11: Part of the old-style <a class="reference internal" href="#c.Py_UNICODE" title="Py_UNICODE"><code class="xref c c-type docutils literal notranslate">Py_UNICODE</code></a> API; please migrate to using
<a class="reference internal" href="#c.PyUnicode_AsEncodedString" title="PyUnicode_AsEncodedString"><code class="xref c c-func docutils literal notranslate">PyUnicode_AsEncodedString()</code></a>.
</div>
</dd></dl>

</section>
<section id="utf-8-codecs">
<h3>UTF-8 Codecs<a class="headerlink" href="#utf-8-codecs" title="Permalink to this headline">¶</a></h3>
These are the UTF-8 codec APIs:
<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_DecodeUTF8">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyUnicode_DecodeUTF8(const char *s, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> size, const char *errors)<a class="headerlink" href="#c.PyUnicode_DecodeUTF8" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference. Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Create a Unicode object by decoding size bytes of the UTF-8 encoded string
s. Return <code class="docutils literal notranslate">NULL</code> if an exception was raised by the codec.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_DecodeUTF8Stateful">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyUnicode_DecodeUTF8Stateful(const char *s, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> size, const char *errors, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> *consumed)<a class="headerlink" href="#c.PyUnicode_DecodeUTF8Stateful" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference. Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.If consumed is <code class="docutils literal notranslate">NULL</code>, behave like <a class="reference internal" href="#c.PyUnicode_DecodeUTF8" title="PyUnicode_DecodeUTF8"><code class="xref c c-func docutils literal notranslate">PyUnicode_DecodeUTF8()</code></a>. If
consumed is not <code class="docutils literal notranslate">NULL</code>, 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 consumed.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_AsUTF8String">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyUnicode_AsUTF8String(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *unicode)<a class="headerlink" href="#c.PyUnicode_AsUTF8String" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference. Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Encode a Unicode object using UTF-8 and return the result as Python bytes
object. Error handling is “strict”. Return <code class="docutils literal notranslate">NULL</code> if an exception was
raised by the codec.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_AsUTF8AndSize">
const char *PyUnicode_AsUTF8AndSize(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *unicode, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> *size)<a class="headerlink" href="#c.PyUnicode_AsUTF8AndSize" title="Permalink to this definition">¶</a> </dt>
<dd> Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a> since version 3.10.Return a pointer to the UTF-8 encoding of the Unicode object, and
store the size of the encoded representation (in bytes) in size. The
size argument can be <code class="docutils literal notranslate">NULL</code>; in this case no size will be stored. The
returned buffer always has an extra null byte appended (not included in
size), regardless of whether there are any other null code points.
In the case of an error, <code class="docutils literal notranslate">NULL</code> is returned with an exception set and no
size is stored.
This caches the UTF-8 representation of the string in the Unicode object, and
subsequent calls will return a pointer to the same buffer. The caller is not
responsible for deallocating the buffer. The buffer is deallocated and
pointers to it become invalid when the Unicode object is garbage collected.
<div class="versionadded">
New in version 3.3.
</div>
<div class="versionchanged">
Changed in version 3.7: The return type is now <code class="docutils literal notranslate">const char *</code> rather of <code class="docutils literal notranslate">char *</code>.
</div>
<div class="versionchanged">
Changed in version 3.10: This function is a part of the <a class="reference internal" href="stable.html#stable">limited API</a>.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_AsUTF8">
const char *PyUnicode_AsUTF8(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *unicode)<a class="headerlink" href="#c.PyUnicode_AsUTF8" title="Permalink to this definition">¶</a> </dt>
<dd>As <a class="reference internal" href="#c.PyUnicode_AsUTF8AndSize" title="PyUnicode_AsUTF8AndSize"><code class="xref c c-func docutils literal notranslate">PyUnicode_AsUTF8AndSize()</code></a>, but does not store the size.
<div class="versionadded">
New in version 3.3.
</div>
<div class="versionchanged">
Changed in version 3.7: The return type is now <code class="docutils literal notranslate">const char *</code> rather of <code class="docutils literal notranslate">char *</code>.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_EncodeUTF8">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyUnicode_EncodeUTF8(const <a class="reference internal" href="#c.Py_UNICODE" title="Py_UNICODE">Py_UNICODE</a> *s, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> size, const char *errors)<a class="headerlink" href="#c.PyUnicode_EncodeUTF8" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference.Encode the <a class="reference internal" href="#c.Py_UNICODE" title="Py_UNICODE"><code class="xref c c-type docutils literal notranslate">Py_UNICODE</code></a> buffer s of the given size using UTF-8 and
return a Python bytes object. Return <code class="docutils literal notranslate">NULL</code> if an exception was raised by
the codec.
<div class="deprecated-removed">
Deprecated since version 3.3, will be removed in version 3.11: Part of the old-style <a class="reference internal" href="#c.Py_UNICODE" title="Py_UNICODE"><code class="xref c c-type docutils literal notranslate">Py_UNICODE</code></a> API; please migrate to using
<a class="reference internal" href="#c.PyUnicode_AsUTF8String" title="PyUnicode_AsUTF8String"><code class="xref c c-func docutils literal notranslate">PyUnicode_AsUTF8String()</code></a>, <a class="reference internal" href="#c.PyUnicode_AsUTF8AndSize" title="PyUnicode_AsUTF8AndSize"><code class="xref c c-func docutils literal notranslate">PyUnicode_AsUTF8AndSize()</code></a> or
<a class="reference internal" href="#c.PyUnicode_AsEncodedString" title="PyUnicode_AsEncodedString"><code class="xref c c-func docutils literal notranslate">PyUnicode_AsEncodedString()</code></a>.
</div>
</dd></dl>

</section>
<section id="utf-32-codecs">
<h3>UTF-32 Codecs<a class="headerlink" href="#utf-32-codecs" title="Permalink to this headline">¶</a></h3>
These are the UTF-32 codec APIs:
<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_DecodeUTF32">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyUnicode_DecodeUTF32(const char *s, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> size, const char *errors, int *byteorder)<a class="headerlink" href="#c.PyUnicode_DecodeUTF32" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference. Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Decode size bytes from a UTF-32 encoded buffer string and return the
corresponding Unicode object. errors (if non-<code class="docutils literal notranslate">NULL</code>) defines the error
handling. It defaults to “strict”.
If byteorder is non-<code class="docutils literal notranslate">NULL</code>, the decoder starts decoding using the given byte
order:
<div class="highlight-c notranslate"><div class="highlight"><pre>*byteorder == -1: little endian
*byteorder == 0: native order
*byteorder == 1: big endian
</pre></div>
</div>
If <code class="docutils literal notranslate">*byteorder</code> 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 <code class="docutils literal notranslate">*byteorder</code> is <code class="docutils literal notranslate">-1</code> or
<code class="docutils literal notranslate">1</code>, any byte order mark is copied to the output.
After completion, *byteorder is set to the current byte order at the end
of input data.
If byteorder is <code class="docutils literal notranslate">NULL</code>, the codec starts in native order mode.
Return <code class="docutils literal notranslate">NULL</code> if an exception was raised by the codec.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_DecodeUTF32Stateful">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyUnicode_DecodeUTF32Stateful(const char *s, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> size, const char *errors, int *byteorder, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> *consumed)<a class="headerlink" href="#c.PyUnicode_DecodeUTF32Stateful" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference. Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.If consumed is <code class="docutils literal notranslate">NULL</code>, behave like <a class="reference internal" href="#c.PyUnicode_DecodeUTF32" title="PyUnicode_DecodeUTF32"><code class="xref c c-func docutils literal notranslate">PyUnicode_DecodeUTF32()</code></a>. If
consumed is not <code class="docutils literal notranslate">NULL</code>, <a class="reference internal" href="#c.PyUnicode_DecodeUTF32Stateful" title="PyUnicode_DecodeUTF32Stateful"><code class="xref c c-func docutils literal notranslate">PyUnicode_DecodeUTF32Stateful()</code></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 consumed.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_AsUTF32String">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyUnicode_AsUTF32String(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *unicode)<a class="headerlink" href="#c.PyUnicode_AsUTF32String" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference. Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Return a Python byte string using the UTF-32 encoding in native byte
order. The string always starts with a BOM mark. Error handling is “strict”.
Return <code class="docutils literal notranslate">NULL</code> if an exception was raised by the codec.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_EncodeUTF32">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyUnicode_EncodeUTF32(const <a class="reference internal" href="#c.Py_UNICODE" title="Py_UNICODE">Py_UNICODE</a> *s, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> size, const char *errors, int byteorder)<a class="headerlink" href="#c.PyUnicode_EncodeUTF32" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference.Return a Python bytes object holding the UTF-32 encoded value of the Unicode
data in s. Output is written according to the following byte order:
<div class="highlight-c notranslate"><div class="highlight"><pre>byteorder == -1: little endian
byteorder == 0: native byte order (writes a BOM mark)
byteorder == 1: big endian
</pre></div>
</div>
If byteorder is <code class="docutils literal notranslate">0</code>, the output string will always start with the Unicode BOM
mark (U+FEFF). In the other two modes, no BOM mark is prepended.
If <code class="docutils literal notranslate">Py_UNICODE_WIDE</code> is not defined, surrogate pairs will be output
as a single code point.
Return <code class="docutils literal notranslate">NULL</code> if an exception was raised by the codec.
<div class="deprecated-removed">
Deprecated since version 3.3, will be removed in version 3.11: Part of the old-style <a class="reference internal" href="#c.Py_UNICODE" title="Py_UNICODE"><code class="xref c c-type docutils literal notranslate">Py_UNICODE</code></a> API; please migrate to using
<a class="reference internal" href="#c.PyUnicode_AsUTF32String" title="PyUnicode_AsUTF32String"><code class="xref c c-func docutils literal notranslate">PyUnicode_AsUTF32String()</code></a> or <a class="reference internal" href="#c.PyUnicode_AsEncodedString" title="PyUnicode_AsEncodedString"><code class="xref c c-func docutils literal notranslate">PyUnicode_AsEncodedString()</code></a>.
</div>
</dd></dl>

</section>
<section id="utf-16-codecs">
<h3>UTF-16 Codecs<a class="headerlink" href="#utf-16-codecs" title="Permalink to this headline">¶</a></h3>
These are the UTF-16 codec APIs:
<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_DecodeUTF16">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyUnicode_DecodeUTF16(const char *s, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> size, const char *errors, int *byteorder)<a class="headerlink" href="#c.PyUnicode_DecodeUTF16" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference. Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Decode size bytes from a UTF-16 encoded buffer string and return the
corresponding Unicode object. errors (if non-<code class="docutils literal notranslate">NULL</code>) defines the error
handling. It defaults to “strict”.
If byteorder is non-<code class="docutils literal notranslate">NULL</code>, the decoder starts decoding using the given byte
order:
<div class="highlight-c notranslate"><div class="highlight"><pre>*byteorder == -1: little endian
*byteorder == 0: native order
*byteorder == 1: big endian
</pre></div>
</div>
If <code class="docutils literal notranslate">*byteorder</code> 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 <code class="docutils literal notranslate">*byteorder</code> is <code class="docutils literal notranslate">-1</code> or
<code class="docutils literal notranslate">1</code>, any byte order mark is copied to the output (where it will result in
either a <code class="docutils literal notranslate">\ufeff</code> or a <code class="docutils literal notranslate">\ufffe</code> character).
After completion, <code class="docutils literal notranslate">*byteorder</code> is set to the current byte order at the end
of input data.
If byteorder is <code class="docutils literal notranslate">NULL</code>, the codec starts in native order mode.
Return <code class="docutils literal notranslate">NULL</code> if an exception was raised by the codec.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_DecodeUTF16Stateful">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyUnicode_DecodeUTF16Stateful(const char *s, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> size, const char *errors, int *byteorder, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> *consumed)<a class="headerlink" href="#c.PyUnicode_DecodeUTF16Stateful" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference. Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.If consumed is <code class="docutils literal notranslate">NULL</code>, behave like <a class="reference internal" href="#c.PyUnicode_DecodeUTF16" title="PyUnicode_DecodeUTF16"><code class="xref c c-func docutils literal notranslate">PyUnicode_DecodeUTF16()</code></a>. If
consumed is not <code class="docutils literal notranslate">NULL</code>, <a class="reference internal" href="#c.PyUnicode_DecodeUTF16Stateful" title="PyUnicode_DecodeUTF16Stateful"><code class="xref c c-func docutils literal notranslate">PyUnicode_DecodeUTF16Stateful()</code></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 consumed.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_AsUTF16String">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyUnicode_AsUTF16String(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *unicode)<a class="headerlink" href="#c.PyUnicode_AsUTF16String" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference. Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Return a Python byte string using the UTF-16 encoding in native byte
order. The string always starts with a BOM mark. Error handling is “strict”.
Return <code class="docutils literal notranslate">NULL</code> if an exception was raised by the codec.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_EncodeUTF16">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyUnicode_EncodeUTF16(const <a class="reference internal" href="#c.Py_UNICODE" title="Py_UNICODE">Py_UNICODE</a> *s, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> size, const char *errors, int byteorder)<a class="headerlink" href="#c.PyUnicode_EncodeUTF16" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference.Return a Python bytes object holding the UTF-16 encoded value of the Unicode
data in s. Output is written according to the following byte order:
<div class="highlight-c notranslate"><div class="highlight"><pre>byteorder == -1: little endian
byteorder == 0: native byte order (writes a BOM mark)
byteorder == 1: big endian
</pre></div>
</div>
If byteorder is <code class="docutils literal notranslate">0</code>, the output string will always start with the Unicode BOM
mark (U+FEFF). In the other two modes, no BOM mark is prepended.
If <code class="docutils literal notranslate">Py_UNICODE_WIDE</code> is defined, a single <a class="reference internal" href="#c.Py_UNICODE" title="Py_UNICODE"><code class="xref c c-type docutils literal notranslate">Py_UNICODE</code></a> value may get
represented as a surrogate pair. If it is not defined, each <a class="reference internal" href="#c.Py_UNICODE" title="Py_UNICODE"><code class="xref c c-type docutils literal notranslate">Py_UNICODE</code></a>
values is interpreted as a UCS-2 character.
Return <code class="docutils literal notranslate">NULL</code> if an exception was raised by the codec.
<div class="deprecated-removed">
Deprecated since version 3.3, will be removed in version 3.11: Part of the old-style <a class="reference internal" href="#c.Py_UNICODE" title="Py_UNICODE"><code class="xref c c-type docutils literal notranslate">Py_UNICODE</code></a> API; please migrate to using
<a class="reference internal" href="#c.PyUnicode_AsUTF16String" title="PyUnicode_AsUTF16String"><code class="xref c c-func docutils literal notranslate">PyUnicode_AsUTF16String()</code></a> or <a class="reference internal" href="#c.PyUnicode_AsEncodedString" title="PyUnicode_AsEncodedString"><code class="xref c c-func docutils literal notranslate">PyUnicode_AsEncodedString()</code></a>.
</div>
</dd></dl>

</section>
<section id="utf-7-codecs">
<h3>UTF-7 Codecs<a class="headerlink" href="#utf-7-codecs" title="Permalink to this headline">¶</a></h3>
These are the UTF-7 codec APIs:
<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_DecodeUTF7">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyUnicode_DecodeUTF7(const char *s, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> size, const char *errors)<a class="headerlink" href="#c.PyUnicode_DecodeUTF7" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference. Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Create a Unicode object by decoding size bytes of the UTF-7 encoded string
s. Return <code class="docutils literal notranslate">NULL</code> if an exception was raised by the codec.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_DecodeUTF7Stateful">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyUnicode_DecodeUTF7Stateful(const char *s, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> size, const char *errors, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> *consumed)<a class="headerlink" href="#c.PyUnicode_DecodeUTF7Stateful" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference. Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.If consumed is <code class="docutils literal notranslate">NULL</code>, behave like <a class="reference internal" href="#c.PyUnicode_DecodeUTF7" title="PyUnicode_DecodeUTF7"><code class="xref c c-func docutils literal notranslate">PyUnicode_DecodeUTF7()</code></a>. If
consumed is not <code class="docutils literal notranslate">NULL</code>, 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 consumed.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_EncodeUTF7">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyUnicode_EncodeUTF7(const <a class="reference internal" href="#c.Py_UNICODE" title="Py_UNICODE">Py_UNICODE</a> *s, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> size, int base64SetO, int base64WhiteSpace, const char *errors)<a class="headerlink" href="#c.PyUnicode_EncodeUTF7" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference.Encode the <a class="reference internal" href="#c.Py_UNICODE" title="Py_UNICODE"><code class="xref c c-type docutils literal notranslate">Py_UNICODE</code></a> buffer of the given size using UTF-7 and
return a Python bytes object. Return <code class="docutils literal notranslate">NULL</code> if an exception was raised by
the codec.
If base64SetO is nonzero, “Set O” (punctuation that has no otherwise
special meaning) will be encoded in base-64. If base64WhiteSpace is
nonzero, whitespace will be encoded in base-64. Both are set to zero for the
Python “utf-7” codec.
<div class="deprecated-removed">
Deprecated since version 3.3, will be removed in version 3.11: Part of the old-style <a class="reference internal" href="#c.Py_UNICODE" title="Py_UNICODE"><code class="xref c c-type docutils literal notranslate">Py_UNICODE</code></a> API; please migrate to using
<a class="reference internal" href="#c.PyUnicode_AsEncodedString" title="PyUnicode_AsEncodedString"><code class="xref c c-func docutils literal notranslate">PyUnicode_AsEncodedString()</code></a>.
</div>
</dd></dl>

</section>
<section id="unicode-escape-codecs">
<h3>Unicode-Escape Codecs<a class="headerlink" href="#unicode-escape-codecs" title="Permalink to this headline">¶</a></h3>
These are the “Unicode Escape” codec APIs:
<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_DecodeUnicodeEscape">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyUnicode_DecodeUnicodeEscape(const char *s, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> size, const char *errors)<a class="headerlink" href="#c.PyUnicode_DecodeUnicodeEscape" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference. Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Create a Unicode object by decoding size bytes of the Unicode-Escape encoded
string s. Return <code class="docutils literal notranslate">NULL</code> if an exception was raised by the codec.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_AsUnicodeEscapeString">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyUnicode_AsUnicodeEscapeString(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *unicode)<a class="headerlink" href="#c.PyUnicode_AsUnicodeEscapeString" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference. Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Encode a Unicode object using Unicode-Escape and return the result as a
bytes object. Error handling is “strict”. Return <code class="docutils literal notranslate">NULL</code> if an exception was
raised by the codec.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_EncodeUnicodeEscape">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyUnicode_EncodeUnicodeEscape(const <a class="reference internal" href="#c.Py_UNICODE" title="Py_UNICODE">Py_UNICODE</a> *s, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> size)<a class="headerlink" href="#c.PyUnicode_EncodeUnicodeEscape" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference.Encode the <a class="reference internal" href="#c.Py_UNICODE" title="Py_UNICODE"><code class="xref c c-type docutils literal notranslate">Py_UNICODE</code></a> buffer of the given size using Unicode-Escape and
return a bytes object. Return <code class="docutils literal notranslate">NULL</code> if an exception was raised by the codec.
<div class="deprecated-removed">
Deprecated since version 3.3, will be removed in version 3.11: Part of the old-style <a class="reference internal" href="#c.Py_UNICODE" title="Py_UNICODE"><code class="xref c c-type docutils literal notranslate">Py_UNICODE</code></a> API; please migrate to using
<a class="reference internal" href="#c.PyUnicode_AsUnicodeEscapeString" title="PyUnicode_AsUnicodeEscapeString"><code class="xref c c-func docutils literal notranslate">PyUnicode_AsUnicodeEscapeString()</code></a>.
</div>
</dd></dl>

</section>
<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>
These are the “Raw Unicode Escape” codec APIs:
<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_DecodeRawUnicodeEscape">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyUnicode_DecodeRawUnicodeEscape(const char *s, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> size, const char *errors)<a class="headerlink" href="#c.PyUnicode_DecodeRawUnicodeEscape" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference. Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Create a Unicode object by decoding size bytes of the Raw-Unicode-Escape
encoded string s. Return <code class="docutils literal notranslate">NULL</code> if an exception was raised by the codec.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_AsRawUnicodeEscapeString">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyUnicode_AsRawUnicodeEscapeString(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *unicode)<a class="headerlink" href="#c.PyUnicode_AsRawUnicodeEscapeString" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference. Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Encode a Unicode object using Raw-Unicode-Escape and return the result as
a bytes object. Error handling is “strict”. Return <code class="docutils literal notranslate">NULL</code> if an exception
was raised by the codec.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_EncodeRawUnicodeEscape">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyUnicode_EncodeRawUnicodeEscape(const <a class="reference internal" href="#c.Py_UNICODE" title="Py_UNICODE">Py_UNICODE</a> *s, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> size)<a class="headerlink" href="#c.PyUnicode_EncodeRawUnicodeEscape" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference.Encode the <a class="reference internal" href="#c.Py_UNICODE" title="Py_UNICODE"><code class="xref c c-type docutils literal notranslate">Py_UNICODE</code></a> buffer of the given size using Raw-Unicode-Escape
and return a bytes object. Return <code class="docutils literal notranslate">NULL</code> if an exception was raised by the codec.
<div class="deprecated-removed">
Deprecated since version 3.3, will be removed in version 3.11: Part of the old-style <a class="reference internal" href="#c.Py_UNICODE" title="Py_UNICODE"><code class="xref c c-type docutils literal notranslate">Py_UNICODE</code></a> API; please migrate to using
<a class="reference internal" href="#c.PyUnicode_AsRawUnicodeEscapeString" title="PyUnicode_AsRawUnicodeEscapeString"><code class="xref c c-func docutils literal notranslate">PyUnicode_AsRawUnicodeEscapeString()</code></a> or
<a class="reference internal" href="#c.PyUnicode_AsEncodedString" title="PyUnicode_AsEncodedString"><code class="xref c c-func docutils literal notranslate">PyUnicode_AsEncodedString()</code></a>.
</div>
</dd></dl>

</section>
<section id="latin-1-codecs">
<h3>Latin-1 Codecs<a class="headerlink" href="#latin-1-codecs" title="Permalink to this headline">¶</a></h3>
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.
<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_DecodeLatin1">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyUnicode_DecodeLatin1(const char *s, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> size, const char *errors)<a class="headerlink" href="#c.PyUnicode_DecodeLatin1" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference. Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Create a Unicode object by decoding size bytes of the Latin-1 encoded string
s. Return <code class="docutils literal notranslate">NULL</code> if an exception was raised by the codec.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_AsLatin1String">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyUnicode_AsLatin1String(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *unicode)<a class="headerlink" href="#c.PyUnicode_AsLatin1String" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference. Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Encode a Unicode object using Latin-1 and return the result as Python bytes
object. Error handling is “strict”. Return <code class="docutils literal notranslate">NULL</code> if an exception was
raised by the codec.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_EncodeLatin1">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyUnicode_EncodeLatin1(const <a class="reference internal" href="#c.Py_UNICODE" title="Py_UNICODE">Py_UNICODE</a> *s, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> size, const char *errors)<a class="headerlink" href="#c.PyUnicode_EncodeLatin1" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference.Encode the <a class="reference internal" href="#c.Py_UNICODE" title="Py_UNICODE"><code class="xref c c-type docutils literal notranslate">Py_UNICODE</code></a> buffer of the given size using Latin-1 and
return a Python bytes object. Return <code class="docutils literal notranslate">NULL</code> if an exception was raised by
the codec.
<div class="deprecated-removed">
Deprecated since version 3.3, will be removed in version 3.11: Part of the old-style <a class="reference internal" href="#c.Py_UNICODE" title="Py_UNICODE"><code class="xref c c-type docutils literal notranslate">Py_UNICODE</code></a> API; please migrate to using
<a class="reference internal" href="#c.PyUnicode_AsLatin1String" title="PyUnicode_AsLatin1String"><code class="xref c c-func docutils literal notranslate">PyUnicode_AsLatin1String()</code></a> or
<a class="reference internal" href="#c.PyUnicode_AsEncodedString" title="PyUnicode_AsEncodedString"><code class="xref c c-func docutils literal notranslate">PyUnicode_AsEncodedString()</code></a>.
</div>
</dd></dl>

</section>
<section id="ascii-codecs">
<h3>ASCII Codecs<a class="headerlink" href="#ascii-codecs" title="Permalink to this headline">¶</a></h3>
These are the ASCII codec APIs. Only 7-bit ASCII data is accepted. All other
codes generate errors.
<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_DecodeASCII">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyUnicode_DecodeASCII(const char *s, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> size, const char *errors)<a class="headerlink" href="#c.PyUnicode_DecodeASCII" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference. Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Create a Unicode object by decoding size bytes of the ASCII encoded string
s. Return <code class="docutils literal notranslate">NULL</code> if an exception was raised by the codec.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_AsASCIIString">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyUnicode_AsASCIIString(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *unicode)<a class="headerlink" href="#c.PyUnicode_AsASCIIString" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference. Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Encode a Unicode object using ASCII and return the result as Python bytes
object. Error handling is “strict”. Return <code class="docutils literal notranslate">NULL</code> if an exception was
raised by the codec.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_EncodeASCII">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyUnicode_EncodeASCII(const <a class="reference internal" href="#c.Py_UNICODE" title="Py_UNICODE">Py_UNICODE</a> *s, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> size, const char *errors)<a class="headerlink" href="#c.PyUnicode_EncodeASCII" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference.Encode the <a class="reference internal" href="#c.Py_UNICODE" title="Py_UNICODE"><code class="xref c c-type docutils literal notranslate">Py_UNICODE</code></a> buffer of the given size using ASCII and
return a Python bytes object. Return <code class="docutils literal notranslate">NULL</code> if an exception was raised by
the codec.
<div class="deprecated-removed">
Deprecated since version 3.3, will be removed in version 3.11: Part of the old-style <a class="reference internal" href="#c.Py_UNICODE" title="Py_UNICODE"><code class="xref c c-type docutils literal notranslate">Py_UNICODE</code></a> API; please migrate to using
<a class="reference internal" href="#c.PyUnicode_AsASCIIString" title="PyUnicode_AsASCIIString"><code class="xref c c-func docutils literal notranslate">PyUnicode_AsASCIIString()</code></a> or
<a class="reference internal" href="#c.PyUnicode_AsEncodedString" title="PyUnicode_AsEncodedString"><code class="xref c c-func docutils literal notranslate">PyUnicode_AsEncodedString()</code></a>.
</div>
</dd></dl>

</section>
<section id="character-map-codecs">
<h3>Character Map Codecs<a class="headerlink" href="#character-map-codecs" title="Permalink to this headline">¶</a></h3>
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 <code class="xref py py-mod docutils literal notranslate">encodings</code> package). The codec uses mappings to encode and
decode characters. The mapping objects provided must support the
<code class="xref py py-meth docutils literal notranslate">__getitem__()</code> mapping interface; dictionaries and sequences work well.
These are the mapping codec APIs:
<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_DecodeCharmap">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyUnicode_DecodeCharmap(const char *data, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> size, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *mapping, const char *errors)<a class="headerlink" href="#c.PyUnicode_DecodeCharmap" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference. Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Create a Unicode object by decoding size bytes of the encoded string s
using the given mapping object. Return <code class="docutils literal notranslate">NULL</code> if an exception was raised
by the codec.
If mapping is <code class="docutils literal notranslate">NULL</code>, Latin-1 decoding will be applied. Else
mapping must map bytes ordinals (integers in the range from 0 to 255)
to Unicode strings, integers (which are then interpreted as Unicode
ordinals) or <code class="docutils literal notranslate">None</code>. Unmapped data bytes – ones which cause a
<a class="reference internal" href="../library/exceptions.html#LookupError" title="LookupError"><code class="xref py py-exc docutils literal notranslate">LookupError</code></a>, as well as ones which get mapped to <code class="docutils literal notranslate">None</code>,
<code class="docutils literal notranslate">0xFFFE</code> or <code class="docutils literal notranslate">'\ufffe'</code>, are treated as undefined mappings and cause
an error.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_AsCharmapString">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyUnicode_AsCharmapString(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *unicode, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *mapping)<a class="headerlink" href="#c.PyUnicode_AsCharmapString" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference. Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Encode a Unicode object using the given mapping object and return the
result as a bytes object. Error handling is “strict”. Return <code class="docutils literal notranslate">NULL</code> if an
exception was raised by the codec.
The mapping object must map Unicode ordinal integers to bytes objects,
integers in the range from 0 to 255 or <code class="docutils literal notranslate">None</code>. Unmapped character
ordinals (ones which cause a <a class="reference internal" href="../library/exceptions.html#LookupError" title="LookupError"><code class="xref py py-exc docutils literal notranslate">LookupError</code></a>) as well as mapped to
<code class="docutils literal notranslate">None</code> are treated as “undefined mapping” and cause an error.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_EncodeCharmap">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyUnicode_EncodeCharmap(const <a class="reference internal" href="#c.Py_UNICODE" title="Py_UNICODE">Py_UNICODE</a> *s, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> size, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *mapping, const char *errors)<a class="headerlink" href="#c.PyUnicode_EncodeCharmap" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference.Encode the <a class="reference internal" href="#c.Py_UNICODE" title="Py_UNICODE"><code class="xref c c-type docutils literal notranslate">Py_UNICODE</code></a> buffer of the given size using the given
mapping object and return the result as a bytes object. Return <code class="docutils literal notranslate">NULL</code> if
an exception was raised by the codec.
<div class="deprecated-removed">
Deprecated since version 3.3, will be removed in version 3.11: Part of the old-style <a class="reference internal" href="#c.Py_UNICODE" title="Py_UNICODE"><code class="xref c c-type docutils literal notranslate">Py_UNICODE</code></a> API; please migrate to using
<a class="reference internal" href="#c.PyUnicode_AsCharmapString" title="PyUnicode_AsCharmapString"><code class="xref c c-func docutils literal notranslate">PyUnicode_AsCharmapString()</code></a> or
<a class="reference internal" href="#c.PyUnicode_AsEncodedString" title="PyUnicode_AsEncodedString"><code class="xref c c-func docutils literal notranslate">PyUnicode_AsEncodedString()</code></a>.
</div>
</dd></dl>

The following codec API is special in that maps Unicode to Unicode.
<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_Translate">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyUnicode_Translate(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *str, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *table, const char *errors)<a class="headerlink" href="#c.PyUnicode_Translate" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference. Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Translate a string by applying a character mapping table to it and return the
resulting Unicode object. Return <code class="docutils literal notranslate">NULL</code> if an exception was raised by the
codec.
The mapping table must map Unicode ordinal integers to Unicode ordinal integers
or <code class="docutils literal notranslate">None</code> (causing deletion of the character).
Mapping tables need only provide the <code class="xref py py-meth docutils literal notranslate">__getitem__()</code> interface; dictionaries
and sequences work well. Unmapped character ordinals (ones which cause a
<a class="reference internal" href="../library/exceptions.html#LookupError" title="LookupError"><code class="xref py py-exc docutils literal notranslate">LookupError</code></a>) are left untouched and are copied as-is.
errors has the usual meaning for codecs. It may be <code class="docutils literal notranslate">NULL</code> which indicates to
use the default error handling.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_TranslateCharmap">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyUnicode_TranslateCharmap(const <a class="reference internal" href="#c.Py_UNICODE" title="Py_UNICODE">Py_UNICODE</a> *s, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> size, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *mapping, const char *errors)<a class="headerlink" href="#c.PyUnicode_TranslateCharmap" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference.Translate a <a class="reference internal" href="#c.Py_UNICODE" title="Py_UNICODE"><code class="xref c c-type docutils literal notranslate">Py_UNICODE</code></a> buffer of the given size by applying a
character mapping table to it and return the resulting Unicode object.
Return <code class="docutils literal notranslate">NULL</code> when an exception was raised by the codec.
<div class="deprecated-removed">
Deprecated since version 3.3, will be removed in version 3.11: Part of the old-style <a class="reference internal" href="#c.Py_UNICODE" title="Py_UNICODE"><code class="xref c c-type docutils literal notranslate">Py_UNICODE</code></a> API; please migrate to using
<a class="reference internal" href="#c.PyUnicode_Translate" title="PyUnicode_Translate"><code class="xref c c-func docutils literal notranslate">PyUnicode_Translate()</code></a>. or <a class="reference internal" href="codec.html#codec-registry">generic codec based API</a>
</div>
</dd></dl>

</section>
<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>
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.
<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_DecodeMBCS">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyUnicode_DecodeMBCS(const char *s, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> size, const char *errors)<a class="headerlink" href="#c.PyUnicode_DecodeMBCS" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference. Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a> on Windows since version 3.7.Create a Unicode object by decoding size bytes of the MBCS encoded string s.
Return <code class="docutils literal notranslate">NULL</code> if an exception was raised by the codec.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_DecodeMBCSStateful">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyUnicode_DecodeMBCSStateful(const char *s, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> size, const char *errors, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> *consumed)<a class="headerlink" href="#c.PyUnicode_DecodeMBCSStateful" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference. Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a> on Windows since version 3.7.If consumed is <code class="docutils literal notranslate">NULL</code>, behave like <a class="reference internal" href="#c.PyUnicode_DecodeMBCS" title="PyUnicode_DecodeMBCS"><code class="xref c c-func docutils literal notranslate">PyUnicode_DecodeMBCS()</code></a>. If
consumed is not <code class="docutils literal notranslate">NULL</code>, <a class="reference internal" href="#c.PyUnicode_DecodeMBCSStateful" title="PyUnicode_DecodeMBCSStateful"><code class="xref c c-func docutils literal notranslate">PyUnicode_DecodeMBCSStateful()</code></a> will not decode
trailing lead byte and the number of bytes that have been decoded will be stored
in consumed.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_AsMBCSString">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyUnicode_AsMBCSString(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *unicode)<a class="headerlink" href="#c.PyUnicode_AsMBCSString" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference. Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a> on Windows since version 3.7.Encode a Unicode object using MBCS and return the result as Python bytes
object. Error handling is “strict”. Return <code class="docutils literal notranslate">NULL</code> if an exception was
raised by the codec.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_EncodeCodePage">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyUnicode_EncodeCodePage(int code_page, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *unicode, const char *errors)<a class="headerlink" href="#c.PyUnicode_EncodeCodePage" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference. Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a> on Windows since version 3.7.Encode the Unicode object using the specified code page and return a Python
bytes object. Return <code class="docutils literal notranslate">NULL</code> if an exception was raised by the codec. Use
<code class="xref c c-data docutils literal notranslate">CP_ACP</code> code page to get the MBCS encoder.
<div class="versionadded">
New in version 3.3.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_EncodeMBCS">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyUnicode_EncodeMBCS(const <a class="reference internal" href="#c.Py_UNICODE" title="Py_UNICODE">Py_UNICODE</a> *s, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> size, const char *errors)<a class="headerlink" href="#c.PyUnicode_EncodeMBCS" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference.Encode the <a class="reference internal" href="#c.Py_UNICODE" title="Py_UNICODE"><code class="xref c c-type docutils literal notranslate">Py_UNICODE</code></a> buffer of the given size using MBCS and return
a Python bytes object. Return <code class="docutils literal notranslate">NULL</code> if an exception was raised by the
codec.
<div class="deprecated-removed">
Deprecated since version 3.3, will be removed in version 4.0: Part of the old-style <a class="reference internal" href="#c.Py_UNICODE" title="Py_UNICODE"><code class="xref c c-type docutils literal notranslate">Py_UNICODE</code></a> API; please migrate to using
<a class="reference internal" href="#c.PyUnicode_AsMBCSString" title="PyUnicode_AsMBCSString"><code class="xref c c-func docutils literal notranslate">PyUnicode_AsMBCSString()</code></a>, <a class="reference internal" href="#c.PyUnicode_EncodeCodePage" title="PyUnicode_EncodeCodePage"><code class="xref c c-func docutils literal notranslate">PyUnicode_EncodeCodePage()</code></a> or
<a class="reference internal" href="#c.PyUnicode_AsEncodedString" title="PyUnicode_AsEncodedString"><code class="xref c c-func docutils literal notranslate">PyUnicode_AsEncodedString()</code></a>.
</div>
</dd></dl>

</section>
<section id="methods-slots">
<h3>Methods &amp; Slots<a class="headerlink" href="#methods-slots" title="Permalink to this headline">¶</a></h3>
</section>
</section>
<section id="methods-and-slot-functions">
<h2>Methods and Slot Functions<a class="headerlink" href="#methods-and-slot-functions" title="Permalink to this headline">¶</a></h2>
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.
They all return <code class="docutils literal notranslate">NULL</code> or <code class="docutils literal notranslate">-1</code> if an exception occurs.
<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_Concat">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyUnicode_Concat(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *left, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *right)<a class="headerlink" href="#c.PyUnicode_Concat" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference. Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Concat two strings giving a new Unicode string.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_Split">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyUnicode_Split(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *s, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *sep, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> maxsplit)<a class="headerlink" href="#c.PyUnicode_Split" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference. Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Split a string giving a list of Unicode strings. If sep is <code class="docutils literal notranslate">NULL</code>, splitting
will be done at all whitespace substrings. Otherwise, splits occur at the given
separator. At most maxsplit splits will be done. If negative, no limit is
set. Separators are not included in the resulting list.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_Splitlines">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyUnicode_Splitlines(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *s, int keepend)<a class="headerlink" href="#c.PyUnicode_Splitlines" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference. Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Split a Unicode string at line breaks, returning a list of Unicode strings.
CRLF is considered to be one line break. If keepend is <code class="docutils literal notranslate">0</code>, the line break
characters are not included in the resulting strings.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_Join">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyUnicode_Join(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *separator, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *seq)<a class="headerlink" href="#c.PyUnicode_Join" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference. Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Join a sequence of strings using the given separator and return the resulting
Unicode string.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_Tailmatch">
<a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> PyUnicode_Tailmatch(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *str, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *substr, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> start, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> end, int direction)<a class="headerlink" href="#c.PyUnicode_Tailmatch" title="Permalink to this definition">¶</a> </dt>
<dd> Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Return <code class="docutils literal notranslate">1</code> if substr matches <code class="docutils literal notranslate">str[start:end]</code> at the given tail end
(direction == <code class="docutils literal notranslate">-1</code> means to do a prefix match, direction == <code class="docutils literal notranslate">1</code> a suffix match),
<code class="docutils literal notranslate">0</code> otherwise. Return <code class="docutils literal notranslate">-1</code> if an error occurred.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_Find">
<a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> PyUnicode_Find(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *str, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *substr, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> start, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> end, int direction)<a class="headerlink" href="#c.PyUnicode_Find" title="Permalink to this definition">¶</a> </dt>
<dd> Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Return the first position of substr in <code class="docutils literal notranslate">str[start:end]</code> using the given
direction (direction == <code class="docutils literal notranslate">1</code> means to do a forward search, direction == <code class="docutils literal notranslate">-1</code> a
backward search). The return value is the index of the first match; a value of
<code class="docutils literal notranslate">-1</code> indicates that no match was found, and <code class="docutils literal notranslate">-2</code> indicates that an error
occurred and an exception has been set.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_FindChar">
<a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> PyUnicode_FindChar(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *str, <a class="reference internal" href="#c.Py_UCS4" title="Py_UCS4">Py_UCS4</a> ch, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> start, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> end, int direction)<a class="headerlink" href="#c.PyUnicode_FindChar" title="Permalink to this definition">¶</a> </dt>
<dd> Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a> since version 3.7.Return the first position of the character ch in <code class="docutils literal notranslate">str[start:end]</code> using
the given direction (direction == <code class="docutils literal notranslate">1</code> means to do a forward search,
direction == <code class="docutils literal notranslate">-1</code> a backward search). The return value is the index of the
first match; a value of <code class="docutils literal notranslate">-1</code> indicates that no match was found, and <code class="docutils literal notranslate">-2</code>
indicates that an error occurred and an exception has been set.
<div class="versionadded">
New in version 3.3.
</div>
<div class="versionchanged">
Changed in version 3.7: start and end are now adjusted to behave like <code class="docutils literal notranslate">str[start:end]</code>.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_Count">
<a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> PyUnicode_Count(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *str, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *substr, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> start, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> end)<a class="headerlink" href="#c.PyUnicode_Count" title="Permalink to this definition">¶</a> </dt>
<dd> Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Return the number of non-overlapping occurrences of substr in
<code class="docutils literal notranslate">str[start:end]</code>. Return <code class="docutils literal notranslate">-1</code> if an error occurred.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_Replace">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyUnicode_Replace(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *str, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *substr, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *replstr, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> maxcount)<a class="headerlink" href="#c.PyUnicode_Replace" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference. Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Replace at most maxcount occurrences of substr in str with replstr and
return the resulting Unicode object. maxcount == <code class="docutils literal notranslate">-1</code> means replace all
occurrences.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_Compare">
int PyUnicode_Compare(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *left, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *right)<a class="headerlink" href="#c.PyUnicode_Compare" title="Permalink to this definition">¶</a> </dt>
<dd> Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Compare two strings and return <code class="docutils literal notranslate">-1</code>, <code class="docutils literal notranslate">0</code>, <code class="docutils literal notranslate">1</code> for less than, equal, and greater than,
respectively.
This function returns <code class="docutils literal notranslate">-1</code> upon failure, so one should call
<a class="reference internal" href="exceptions.html#c.PyErr_Occurred" title="PyErr_Occurred"><code class="xref c c-func docutils literal notranslate">PyErr_Occurred()</code></a> to check for errors.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_CompareWithASCIIString">
int PyUnicode_CompareWithASCIIString(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *uni, const char *string)<a class="headerlink" href="#c.PyUnicode_CompareWithASCIIString" title="Permalink to this definition">¶</a> </dt>
<dd> Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Compare a Unicode object, uni, with string and return <code class="docutils literal notranslate">-1</code>, <code class="docutils literal notranslate">0</code>, <code class="docutils literal notranslate">1</code> for less
than, equal, and greater than, respectively. It is best to pass only
ASCII-encoded strings, but the function interprets the input string as
ISO-8859-1 if it contains non-ASCII characters.
This function does not raise exceptions.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_RichCompare">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyUnicode_RichCompare(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *left, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *right, int op)<a class="headerlink" href="#c.PyUnicode_RichCompare" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference. Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Rich compare two Unicode strings and return one of the following:
<ul class="simple">
<li><code class="docutils literal notranslate">NULL</code> in case an exception was raised</li>
<li><code class="xref py py-const docutils literal notranslate">Py_True</code> or <code class="xref py py-const docutils literal notranslate">Py_False</code> for successful comparisons</li>
<li><code class="xref py py-const docutils literal notranslate">Py_NotImplemented</code> in case the type combination is unknown</li>
</ul>
Possible values for op are <code class="xref py py-const docutils literal notranslate">Py_GT</code>, <code class="xref py py-const docutils literal notranslate">Py_GE</code>, <code class="xref py py-const docutils literal notranslate">Py_EQ</code>,
<code class="xref py py-const docutils literal notranslate">Py_NE</code>, <code class="xref py py-const docutils literal notranslate">Py_LT</code>, and <code class="xref py py-const docutils literal notranslate">Py_LE</code>.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_Format">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyUnicode_Format(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *format, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *args)<a class="headerlink" href="#c.PyUnicode_Format" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference. Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Return a new string object from format and args; this is analogous to
<code class="docutils literal notranslate">format % args</code>.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_Contains">
int PyUnicode_Contains(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *container, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *element)<a class="headerlink" href="#c.PyUnicode_Contains" title="Permalink to this definition">¶</a> </dt>
<dd> Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Check whether element is contained in container and return true or false
accordingly.
element has to coerce to a one element Unicode string. <code class="docutils literal notranslate">-1</code> is returned
if there was an error.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_InternInPlace">
void PyUnicode_InternInPlace(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> **string)<a class="headerlink" href="#c.PyUnicode_InternInPlace" title="Permalink to this definition">¶</a> </dt>
<dd> Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Intern the argument *string in place. The argument must be the address of a
pointer variable pointing to a Python Unicode string object. If there is an
existing interned string that is the same as *string, it sets *string to
it (decrementing the reference count of the old string object and incrementing
the reference count of the interned string object), otherwise it leaves
*string alone and interns it (incrementing its reference count).
(Clarification: even though there is a lot of talk about reference counts, think
of this function as reference-count-neutral; you own the object after the call
if and only if you owned it before the call.)
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyUnicode_InternFromString">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyUnicode_InternFromString(const char *v)<a class="headerlink" href="#c.PyUnicode_InternFromString" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference. Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.A combination of <a class="reference internal" href="#c.PyUnicode_FromString" title="PyUnicode_FromString"><code class="xref c c-func docutils literal notranslate">PyUnicode_FromString()</code></a> and
<a class="reference internal" href="#c.PyUnicode_InternInPlace" title="PyUnicode_InternInPlace"><code class="xref c c-func docutils literal notranslate">PyUnicode_InternInPlace()</code></a>, returning either a new Unicode string
object that has been interned, or a new (“owned”) reference to an earlier
interned string object with the same value.
</dd></dl>

</section>
</section>

<div class="clearer"></div>
 </div>
 </div>
 </div>
 <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
 <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="#creating-and-accessing-unicode-strings">Creating and accessing Unicode strings</a></li>
<li><a class="reference internal" href="#deprecated-py-unicode-apis">Deprecated Py_UNICODE APIs</a></li>
<li><a class="reference internal" href="#locale-encoding">Locale Encoding</a></li>
<li><a class="reference internal" href="#file-system-encoding">File System Encoding</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 &amp; 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>
 <a href="bytearray.html"
 title="previous chapter">Byte Array Objects</a>
 <h4>Next topic</h4>
 <a href="tuple.html"
 title="next chapter">Tuple Objects</a>
 <div role="note" aria-label="source link">
 <h3>This Page</h3>
 <ul class="this-page-menu">
 <li><a href="../bugs.html">Report a Bug</a></li>
 <li>
 <a href="https://github.com/python/cpython/blob/3.10/Doc/c-api/unicode.rst"
 rel="nofollow">Show Source
 </a>
 </li>
 </ul>
 </div>
 </div>
 </div>
 <div class="clearer"></div>
 </div> 
 <div class="related" role="navigation" aria-label="related navigation">
 <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="tuple.html" title="Tuple Objects"
 >next</a> |</li>
 <li class="right" >
 <a href="bytearray.html" title="Byte Array Objects"
 >previous</a> |</li>

<li class="nav-item nav-item-1"><a href="index.html" >Python/C API Reference Manual</a> &#187;</li>
 <li class="nav-item nav-item-2"><a href="concrete.html" >Concrete Objects Layer</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href="">Unicode Objects and Codecs</a></li>
 <li class="right">

<div class="inline-search" role="search">
 <form class="inline-search" action="../search.html" method="get">
 <input placeholder="Quick search" aria-label="Quick search" 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>
 </div>
 |
 </li>
 
 </ul>
 </div> 
 <div class="footer">
 &copy; <a href="../copyright.html">Copyright</a> 2001-2025, Python Software Foundation.
 
 This page is licensed under the Python Software Foundation License Version 2.
 
 Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.
 
 See <a href="/license.html">History and License</a> for more information.

The Python Software Foundation is a non-profit corporation.
<a href="https://www.python.org/psf/donations/">Please donate.</a>

Last updated on February 04, 2025.
 <a href="/bugs.html">Found a bug</a>?

Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.3.2.
 </div>

</body>
</html>