CINXE.COM

<!DOCTYPE html> <html lang="en" data-content_root="../"> <head> <meta charset="utf-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" /> <meta property="og:title" content="Unicode Objects and Codecs" /> <meta property="og:type" content="website" /> <meta property="og:url" content="https://docs.python.org/3/c-api/unicode.html" /> <meta property="og:site_name" content="Python documentation" /> <meta property="og:description" content="Unicode Objects: Since the implementation of PEP 393 in Python 3.3, Unicode objects internally use a variety of representations, in order to allow handling the complete range of Unicode characters ..." /> <meta property="og:image" content="https://docs.python.org/3/_static/og-image.png" /> <meta property="og:image:alt" content="Python documentation" /> <meta name="description" content="Unicode Objects: Since the implementation of PEP 393 in Python 3.3, Unicode objects internally use a variety of representations, in order to allow handling the complete range of Unicode characters ..." /> <meta property="og:image:width" content="200" /> <meta property="og:image:height" content="200" /> <meta name="theme-color" content="#3776ab" /> <title>Unicode Objects and Codecs — Python 3.13.0 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0"> <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" /> <link rel="stylesheet" type="text/css" href="../_static/pydoctheme.css?v=41b4f12d" /> <link rel="stylesheet" type="text/css" href="../_static/sidebar-wrap.css?v=65806c5a" /> <link id="pygments_dark_css" media="(prefers-color-scheme: dark)" rel="stylesheet" type="text/css" href="../_static/pygments_dark.css?v=b20cc3f5" /> <script src="../_static/documentation_options.js?v=6aaf4047"></script> <script src="../_static/doctools.js?v=9bcbadda"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/sidebar.js"></script> <link rel="search" type="application/opensearchdescription+xml" title="Search within Python 3.13.0 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" /> <script defer data-domain="docs.python.org" src="https://plausible.io/js/script.js"></script> <link rel="canonical" href="https://docs.python.org/3/c-api/unicode.html" /> <style> @media only screen { table.full-width-table { width: 100%; } } </style> <link rel="stylesheet" href="../_static/pydoctheme_dark.css" media="(prefers-color-scheme: dark)" id="pydoctheme_dark_css"> <link rel="shortcut icon" type="image/png" href="../_static/py.svg" /> <script type="text/javascript" src="../_static/copybutton.js"></script> <script type="text/javascript" src="../_static/menu.js"></script> <script type="text/javascript" src="../_static/search-focus.js"></script> <script type="text/javascript" src="../_static/themetoggle.js"></script> <script type="text/javascript" src="../_static/rtd_switcher.js"></script> <meta name="readthedocs-addons-api-version" content="1"> </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" /> <nav class="nav-content" role="navigation"> <label for="menuToggler" class="toggler__label"> </label> <a href="https://www.python.org/" class="nav-logo"> <img src="../_static/py.svg" alt="Python logo"/> </a> <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" fill="currentColor" 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"></path> </svg> <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" /> <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> <label class="theme-selector-label"> Theme <select class="theme-selector" oninput="activateTheme(this.value)"> <option value="auto" selected>Auto</option> <option value="light">Light</option> <option value="dark">Dark</option> </select> </label> <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="#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 & 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> <div> <h4>Previous topic</h4> <a href="bytearray.html" title="previous chapter">Byte Array Objects</a> </div> <div> <h4>Next topic</h4> <a href="tuple.html" title="next chapter">Tuple Objects</a> </div> <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/main/Doc/c-api/unicode.rst" rel="nofollow">Show Source </a> </li> </ul> </div> </nav> </div> </div> <div class="related" role="navigation" aria-label="Related"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="../genindex.html" title="General Index" accesskey="I">index</a></li> <li class="right" > <a href="../py-modindex.html" title="Python Module Index" >modules</a> |</li> <li class="right" > <a href="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> »</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.13.0 Documentation</a> » </li> <li class="nav-item nav-item-1"><a href="index.html" >Python/C API Reference Manual</a> »</li> <li class="nav-item nav-item-2"><a href="concrete.html" accesskey="U">Concrete Objects Layer</a> »</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="search" name="q" id="search-box" /> <input type="submit" value="Go" /> </form> </div> | </li> <li class="right"> <label class="theme-selector-label"> Theme <select class="theme-selector" oninput="activateTheme(this.value)"> <option value="auto" selected>Auto</option> <option value="light">Light</option> <option value="dark">Dark</option> </select> </label> |</li> </ul> </div> <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="Link to this heading">¶</a></h1> <section id="unicode-objects"> <h2>Unicode Objects<a class="headerlink" href="#unicode-objects" title="Link to this heading">¶</a></h2> Since the implementation of <a class="pep reference external" href="https://peps.python.org/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). UTF-8 representation is created on demand and cached in the Unicode object. <div class="admonition note"> Note 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 has been removed since Python 3.12 with deprecated APIs. See <a class="pep reference external" href="https://peps.python.org/pep-0623/">PEP 623</a> for more information. </div> <section id="unicode-type"> <h3>Unicode Type<a class="headerlink" href="#unicode-type" title="Link to this heading">¶</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="Link 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="Link 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="Link 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"> Added 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="Link to this definition">¶</a> </dt> <dd>This is a typedef of <code class="xref c c-type docutils literal notranslate">wchar_t</code>, 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> <div class="deprecated-removed"> Deprecated since version 3.13, will be removed in version 3.15. </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="Link to this definition">¶</a> </dt> <dt class="sig sig-object c" id="c.PyCompactUnicodeObject"> type PyCompactUnicodeObject<a class="headerlink" href="#c.PyCompactUnicodeObject" title="Link to this definition">¶</a> </dt> <dt class="sig sig-object c" id="c.PyUnicodeObject"> type PyUnicodeObject<a class="headerlink" href="#c.PyUnicodeObject" title="Link 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"> Added 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="Link 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 C macros and static inlined functions for fast checks and access to 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> *obj)<a class="headerlink" href="#c.PyUnicode_Check" title="Link to this definition">¶</a> </dt> <dd>Return true if the object obj 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> *obj)<a class="headerlink" href="#c.PyUnicode_CheckExact" title="Link to this definition">¶</a> </dt> <dd>Return true if the object obj 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> *unicode)<a class="headerlink" href="#c.PyUnicode_READY" title="Link to this definition">¶</a> </dt> <dd>Returns <code class="docutils literal notranslate">0</code>. This API is kept only for backward compatibility. <div class="versionadded"> Added in version 3.3. </div> <div class="deprecated"> Deprecated since version 3.10: This API does nothing since Python 3.12. </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> *unicode)<a class="headerlink" href="#c.PyUnicode_GET_LENGTH" title="Link to this definition">¶</a> </dt> <dd>Return the length of the Unicode string, in code points. unicode has to be a Unicode object in the “canonical” representation (not checked). <div class="versionadded"> Added 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> *unicode)<a class="headerlink" href="#c.PyUnicode_1BYTE_DATA" title="Link 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> *unicode)<a class="headerlink" href="#c.PyUnicode_2BYTE_DATA" title="Link 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> *unicode)<a class="headerlink" href="#c.PyUnicode_4BYTE_DATA" title="Link 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 function. <div class="versionadded"> Added in version 3.3. </div> </dd></dl> <dl class="c macro"> <dt class="sig sig-object c" id="c.PyUnicode_1BYTE_KIND"> PyUnicode_1BYTE_KIND<a class="headerlink" href="#c.PyUnicode_1BYTE_KIND" title="Link 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="Link 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="Link 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"> Added in version 3.3. </div> <div class="versionchanged"> Changed in version 3.12: <code class="docutils literal notranslate">PyUnicode_WCHAR_KIND</code> has been removed. </div> </dd></dl> <dl class="c function"> <dt class="sig sig-object c" id="c.PyUnicode_KIND"> int PyUnicode_KIND(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *unicode)<a class="headerlink" href="#c.PyUnicode_KIND" title="Link 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. unicode has to be a Unicode object in the “canonical” representation (not checked). <div class="versionadded"> Added 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> *unicode)<a class="headerlink" href="#c.PyUnicode_DATA" title="Link to this definition">¶</a> </dt> <dd>Return a void pointer to the raw Unicode buffer. unicode has to be a Unicode object in the “canonical” representation (not checked). <div class="versionadded"> Added 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="Link 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 function performs no sanity checks, and is intended for usage in loops. The caller should cache the kind value and data pointer as obtained from other 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"> Added 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="Link 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"> Added 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> *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_READ_CHAR" title="Link to this definition">¶</a> </dt> <dd>Read a character from a Unicode object unicode, 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"> Added in version 3.3. </div> </dd></dl> <dl class="c function"> <dt class="sig sig-object c" id="c.PyUnicode_MAX_CHAR_VALUE"> <a class="reference internal" href="#c.Py_UCS4" title="Py_UCS4">Py_UCS4</a> PyUnicode_MAX_CHAR_VALUE(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *unicode)<a class="headerlink" href="#c.PyUnicode_MAX_CHAR_VALUE" title="Link to this definition">¶</a> </dt> <dd>Return the maximum code point that is suitable for creating another string based on unicode, which must be in the “canonical” representation. This is always an approximation but more efficient than iterating over the string. <div class="versionadded"> Added in version 3.3. </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> *unicode)<a class="headerlink" href="#c.PyUnicode_IsIdentifier" title="Link 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="Link to this heading">¶</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="Link 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="Link 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="Link 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="Link 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="Link 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="Link 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="Link 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="Link 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="Link 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="Link 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="Link 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="Link to this definition">¶</a> </dt> <dd>Return the character ch converted to lower case. </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="Link to this definition">¶</a> </dt> <dd>Return the character ch converted to upper case. </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="Link to this definition">¶</a> </dt> <dd>Return the character ch converted to title case. </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="Link 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 function 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="Link 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 function 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="Link 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 function does not raise exceptions. </dd></dl> These APIs can be used to work with surrogates: <dl class="c function"> <dt class="sig sig-object c" id="c.Py_UNICODE_IS_SURROGATE"> int Py_UNICODE_IS_SURROGATE(<a class="reference internal" href="#c.Py_UCS4" title="Py_UCS4">Py_UCS4</a> ch)<a class="headerlink" href="#c.Py_UNICODE_IS_SURROGATE" title="Link to this definition">¶</a> </dt> <dd>Check if ch is a surrogate (<code class="docutils literal notranslate">0xD800 <= ch <= 0xDFFF</code>). </dd></dl> <dl class="c function"> <dt class="sig sig-object c" id="c.Py_UNICODE_IS_HIGH_SURROGATE"> int Py_UNICODE_IS_HIGH_SURROGATE(<a class="reference internal" href="#c.Py_UCS4" title="Py_UCS4">Py_UCS4</a> ch)<a class="headerlink" href="#c.Py_UNICODE_IS_HIGH_SURROGATE" title="Link to this definition">¶</a> </dt> <dd>Check if ch is a high surrogate (<code class="docutils literal notranslate">0xD800 <= ch <= 0xDBFF</code>). </dd></dl> <dl class="c function"> <dt class="sig sig-object c" id="c.Py_UNICODE_IS_LOW_SURROGATE"> int Py_UNICODE_IS_LOW_SURROGATE(<a class="reference internal" href="#c.Py_UCS4" title="Py_UCS4">Py_UCS4</a> ch)<a class="headerlink" href="#c.Py_UNICODE_IS_LOW_SURROGATE" title="Link to this definition">¶</a> </dt> <dd>Check if ch is a low surrogate (<code class="docutils literal notranslate">0xDC00 <= ch <= 0xDFFF</code>). </dd></dl> <dl class="c function"> <dt class="sig sig-object c" id="c.Py_UNICODE_JOIN_SURROGATES"> <a class="reference internal" href="#c.Py_UCS4" title="Py_UCS4">Py_UCS4</a> Py_UNICODE_JOIN_SURROGATES(<a class="reference internal" href="#c.Py_UCS4" title="Py_UCS4">Py_UCS4</a> high, <a class="reference internal" href="#c.Py_UCS4" title="Py_UCS4">Py_UCS4</a> low)<a class="headerlink" href="#c.Py_UNICODE_JOIN_SURROGATES" title="Link to this definition">¶</a> </dt> <dd>Join two surrogate code points and return a single <a class="reference internal" href="#c.Py_UCS4" title="Py_UCS4"><code class="xref c c-type docutils literal notranslate">Py_UCS4</code></a> value. high and low are respectively the leading and trailing surrogates in a surrogate pair. high must be in the range [0xD800; 0xDBFF] and low must be in the range [0xDC00; 0xDFFF]. </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="Link to this heading">¶</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="Link 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. On error, set an exception and return <code class="docutils literal notranslate">NULL</code>. <div class="versionadded"> Added 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="Link 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. If necessary, the input buffer is copied and transformed into the canonical representation. For example, if the buffer is a UCS4 string (<a class="reference internal" href="#c.PyUnicode_4BYTE_KIND" title="PyUnicode_4BYTE_KIND"><code class="xref c c-macro docutils literal notranslate">PyUnicode_4BYTE_KIND</code></a>) and it consists only of codepoints in the UCS1 range, it will be transformed into UCS1 (<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>). <div class="versionadded"> Added 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 *str, <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="Link 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 str. The bytes will be interpreted as being UTF-8 encoded. The buffer is copied into the new object. The return value might be a shared object, i.e. modification of the data is not allowed. This function raises <a class="reference internal" href="../library/exceptions.html#SystemError" title="SystemError"><code class="xref py py-exc docutils literal notranslate">SystemError</code></a> when: <ul class="simple"> <li>size < 0,</li> <li>str is <code class="docutils literal notranslate">NULL</code> and size > 0</li> </ul> <div class="versionchanged"> Changed in version 3.12: str == <code class="docutils literal notranslate">NULL</code> with size > 0 is not allowed anymore. </div> </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 *str)<a class="headerlink" href="#c.PyUnicode_FromString" title="Link 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 str. </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="Link 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. A conversion specifier contains two or more characters and has the following components, which must occur in this order: <ol class="arabic simple"> <li>The <code class="docutils literal notranslate">'%'</code> character, which marks the start of the specifier.</li> <li>Conversion flags (optional), which affect the result of some conversion types.</li> <li>Minimum field width (optional). If specified as an <code class="docutils literal notranslate">'*'</code> (asterisk), the actual width is given in the next argument, which must be of type int, and the object to convert comes after the minimum field width and optional precision.</li> <li>Precision (optional), given as a <code class="docutils literal notranslate">'.'</code> (dot) followed by the precision. If specified as <code class="docutils literal notranslate">'*'</code> (an asterisk), the actual precision is given in the next argument, which must be of type int, and the value to convert comes after the precision.</li> <li>Length modifier (optional).</li> <li>Conversion type.</li> </ol> The conversion flag characters are: <table class="docutils align-default"> <thead> <tr class="row-odd"><th class="head">Flag</th> <th class="head">Meaning</th> </tr> </thead> <tbody> <tr class="row-even"><td><code class="docutils literal notranslate">0</code></td> <td>The conversion will be zero padded for numeric values.</td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate">-</code></td> <td>The converted value is left adjusted (overrides the <code class="docutils literal notranslate">0</code> flag if both are given).</td> </tr> </tbody> </table> The length modifiers for following integer conversions (<code class="docutils literal notranslate">d</code>, <code class="docutils literal notranslate">i</code>, <code class="docutils literal notranslate">o</code>, <code class="docutils literal notranslate">u</code>, <code class="docutils literal notranslate">x</code>, or <code class="docutils literal notranslate">X</code>) specify the type of the argument (int by default): <table class="docutils align-default"> <thead> <tr class="row-odd"><th class="head">Modifier</th> <th class="head">Types</th> </tr> </thead> <tbody> <tr class="row-even"><td><code class="docutils literal notranslate">l</code></td> <td>long or unsigned long</td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate">ll</code></td> <td>long long or unsigned long long</td> </tr> <tr class="row-even"><td><code class="docutils literal notranslate">j</code></td> <td><code class="xref c c-type docutils literal notranslate">intmax_t</code> or <code class="xref c c-type docutils literal notranslate">uintmax_t</code></td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate">z</code></td> <td><code class="xref c c-type docutils literal notranslate">size_t</code> or <code class="xref c c-type docutils literal notranslate">ssize_t</code></td> </tr> <tr class="row-even"><td><code class="docutils literal notranslate">t</code></td> <td><code class="xref c c-type docutils literal notranslate">ptrdiff_t</code></td> </tr> </tbody> </table> The length modifier <code class="docutils literal notranslate">l</code> for following conversions <code class="docutils literal notranslate">s</code> or <code class="docutils literal notranslate">V</code> specify that the type of the argument is const wchar_t*. The conversion specifiers are: <table class="docutils align-default"> <thead> <tr class="row-odd"><th class="head">Conversion Specifier</th> <th class="head">Type</th> <th class="head">Comment</th> </tr> </thead> <tbody> <tr class="row-even"><td><code class="docutils literal notranslate">%</code></td> <td>n/a</td> <td>The literal <code class="docutils literal notranslate">%</code> character.</td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate">d</code>, <code class="docutils literal notranslate">i</code></td> <td>Specified by the length modifier</td> <td>The decimal representation of a signed C integer.</td> </tr> <tr class="row-even"><td><code class="docutils literal notranslate">u</code></td> <td>Specified by the length modifier</td> <td>The decimal representation of an unsigned C integer.</td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate">o</code></td> <td>Specified by the length modifier</td> <td>The octal representation of an unsigned C integer.</td> </tr> <tr class="row-even"><td><code class="docutils literal notranslate">x</code></td> <td>Specified by the length modifier</td> <td>The hexadecimal representation of an unsigned C integer (lowercase).</td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate">X</code></td> <td>Specified by the length modifier</td> <td>The hexadecimal representation of an unsigned C integer (uppercase).</td> </tr> <tr class="row-even"><td><code class="docutils literal notranslate">c</code></td> <td>int</td> <td>A single character.</td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate">s</code></td> <td>const char* or const wchar_t*</td> <td>A null-terminated C character array.</td> </tr> <tr class="row-even"><td><code class="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("%p")</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="docutils literal notranslate">A</code></td> <td><a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a>*</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="docutils literal notranslate">U</code></td> <td><a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a>*</td> <td>A Unicode object.</td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate">V</code></td> <td><a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a>*, const char* or const wchar_t*</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="docutils literal notranslate">S</code></td> <td><a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a>*</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="docutils literal notranslate">R</code></td> <td><a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a>*</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> <tr class="row-even"><td><code class="docutils literal notranslate">T</code></td> <td><a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a>*</td> <td>Get the fully qualified name of an object type; call <a class="reference internal" href="type.html#c.PyType_GetFullyQualifiedName" title="PyType_GetFullyQualifiedName"><code class="xref c c-func docutils literal notranslate">PyType_GetFullyQualifiedName()</code></a>.</td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate">#T</code></td> <td><a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a>*</td> <td>Similar to <code class="docutils literal notranslate">T</code> format, but use a colon (<code class="docutils literal notranslate">:</code>) as separator between the module name and the qualified name.</td> </tr> <tr class="row-even"><td><code class="docutils literal notranslate">N</code></td> <td><a class="reference internal" href="type.html#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a>*</td> <td>Get the fully qualified name of a type; call <a class="reference internal" href="type.html#c.PyType_GetFullyQualifiedName" title="PyType_GetFullyQualifiedName"><code class="xref c c-func docutils literal notranslate">PyType_GetFullyQualifiedName()</code></a>.</td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate">#N</code></td> <td><a class="reference internal" href="type.html#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a>*</td> <td>Similar to <code class="docutils literal notranslate">N</code> format, but use a colon (<code class="docutils literal notranslate">:</code>) as separator between the module name and the qualified name.</td> </tr> </tbody> </table> <div class="admonition note"> Note The width formatter unit is number of characters rather than bytes. The precision formatter unit is number of bytes or <code class="xref c c-type docutils literal notranslate">wchar_t</code> items (if the length modifier <code class="docutils literal notranslate">l</code> is used) for <code class="docutils literal notranslate">"%s"</code> and <code class="docutils literal notranslate">"%V"</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">"%A"</code>, <code class="docutils literal notranslate">"%U"</code>, <code class="docutils literal notranslate">"%S"</code>, <code class="docutils literal notranslate">"%R"</code> and <code class="docutils literal notranslate">"%V"</code> (if the <code class="docutils literal notranslate">PyObject*</code> argument is not <code class="docutils literal notranslate">NULL</code>). </div> <div class="admonition note"> Note Unlike to C <code class="xref c c-func docutils literal notranslate">printf()</code> the <code class="docutils literal notranslate">0</code> flag has effect even when a precision is given for integer conversions (<code class="docutils literal notranslate">d</code>, <code class="docutils literal notranslate">i</code>, <code class="docutils literal notranslate">u</code>, <code class="docutils literal notranslate">o</code>, <code class="docutils literal notranslate">x</code>, or <code class="docutils literal notranslate">X</code>). </div> <div class="versionchanged"> Changed in version 3.2: Support for <code class="docutils literal notranslate">"%lld"</code> and <code class="docutils literal notranslate">"%llu"</code> added. </div> <div class="versionchanged"> Changed in version 3.3: Support for <code class="docutils literal notranslate">"%li"</code>, <code class="docutils literal notranslate">"%lli"</code> and <code class="docutils literal notranslate">"%zi"</code> added. </div> <div class="versionchanged"> Changed in version 3.4: Support width and precision formatter for <code class="docutils literal notranslate">"%s"</code>, <code class="docutils literal notranslate">"%A"</code>, <code class="docutils literal notranslate">"%U"</code>, <code class="docutils literal notranslate">"%V"</code>, <code class="docutils literal notranslate">"%S"</code>, <code class="docutils literal notranslate">"%R"</code> added. </div> <div class="versionchanged"> Changed in version 3.12: Support for conversion specifiers <code class="docutils literal notranslate">o</code> and <code class="docutils literal notranslate">X</code>. Support for length modifiers <code class="docutils literal notranslate">j</code> and <code class="docutils literal notranslate">t</code>. Length modifiers are now applied to all integer conversions. Length modifier <code class="docutils literal notranslate">l</code> is now applied to conversion specifiers <code class="docutils literal notranslate">s</code> and <code class="docutils literal notranslate">V</code>. Support for variable width and precision <code class="docutils literal notranslate">*</code>. Support for flag <code class="docutils literal notranslate">-</code>. An unrecognized format character now sets a <a class="reference internal" href="../library/exceptions.html#SystemError" title="SystemError"><code class="xref py py-exc docutils literal notranslate">SystemError</code></a>. In previous versions it caused all the rest of the format string to be copied as-is to the result string, and any extra arguments discarded. </div> <div class="versionchanged"> Changed in version 3.13: Support for <code class="docutils literal notranslate">%T</code>, <code class="docutils literal notranslate">%#T</code>, <code class="docutils literal notranslate">%N</code> and <code class="docutils literal notranslate">%#N</code> formats 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="Link 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_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="Link 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 a new <a class="reference internal" href="../glossary.html#term-strong-reference">strong reference</a> to the object. 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> <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="Link 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="Link 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. On error, set an exception and return <code class="docutils literal notranslate">-1</code>. <div class="versionadded"> Added 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="Link 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"> Added 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="Link 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"> Added 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="Link 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). Return <code class="docutils literal notranslate">0</code> on success, <code class="docutils literal notranslate">-1</code> on error with an exception set. <div class="versionadded"> Added 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="Link 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 <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>, which performs no error checking. Return character on success, <code class="docutils literal notranslate">-1</code> on error with an exception set. <div class="versionadded"> Added 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> *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> end)<a class="headerlink" href="#c.PyUnicode_Substring" title="Link 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 unicode, from character index start (included) to character index end (excluded). Negative indices are not supported. On error, set an exception and return <code class="docutils literal notranslate">NULL</code>. <div class="versionadded"> Added 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> *unicode, <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="Link 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 unicode 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 unicode). buffer is returned on success. <div class="versionadded"> Added 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> *unicode)<a class="headerlink" href="#c.PyUnicode_AsUCS4Copy" title="Link 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 unicode 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"> Added in version 3.3. </div> </dd></dl> </section> <section id="locale-encoding"> <h3>Locale Encoding<a class="headerlink" href="#locale-encoding" title="Link to this heading">¶</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> length, const char *errors)<a class="headerlink" href="#c.PyUnicode_DecodeLocaleAndSize" title="Link 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">"strict"</code> and <code class="docutils literal notranslate">"surrogateescape"</code> (<a class="pep reference external" href="https://peps.python.org/pep-0383/">PEP 383</a>). The decoder uses <code class="docutils literal notranslate">"strict"</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 the <a class="reference internal" href="../glossary.html#term-filesystem-encoding-and-error-handler">filesystem encoding and error handler</a>. 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"> Added 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="Link 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"> Added 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="Link 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">"strict"</code> and <code class="docutils literal notranslate">"surrogateescape"</code> (<a class="pep reference external" href="https://peps.python.org/pep-0383/">PEP 383</a>). The encoder uses <code class="docutils literal notranslate">"strict"</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 the <a class="reference internal" href="../glossary.html#term-filesystem-encoding-and-error-handler">filesystem encoding and error handler</a>. 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"> Added 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="Link to this heading">¶</a></h3> Functions encoding to and decoding from the <a class="reference internal" href="../glossary.html#term-filesystem-encoding-and-error-handler">filesystem encoding and error handler</a> (<a class="pep reference external" href="https://peps.python.org/pep-0383/">PEP 383</a> and <a class="pep reference external" href="https://peps.python.org/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">"O&"</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="Link 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"> Added 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">"O&"</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="Link 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"> Added 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 *str, <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="Link 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 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: The <a class="reference internal" href="../glossary.html#term-filesystem-encoding-and-error-handler">filesystem error handler</a> is now used. </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 *str)<a class="headerlink" href="#c.PyUnicode_DecodeFSDefault" title="Link 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 the string length is known, 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>. <div class="versionchanged"> Changed in version 3.6: The <a class="reference internal" href="../glossary.html#term-filesystem-encoding-and-error-handler">filesystem error handler</a> is now used. </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="Link 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 the <a class="reference internal" href="../glossary.html#term-filesystem-encoding-and-error-handler">filesystem encoding and error handler</a>, 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 can contain null bytes. 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"> Added in version 3.2. </div> <div class="versionchanged"> Changed in version 3.6: The <a class="reference internal" href="../glossary.html#term-filesystem-encoding-and-error-handler">filesystem error handler</a> is now used. </div> </dd></dl> </section> <section id="wchar-t-support"> <h3>wchar_t Support<a class="headerlink" href="#wchar-t-support" title="Link to this heading">¶</a></h3> <code class="xref c c-type docutils literal notranslate">wchar_t</code> 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 *wstr, <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="Link 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 <code class="xref c c-type docutils literal notranslate">wchar_t</code> buffer wstr 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 <code class="xref c c-func docutils literal notranslate">wcslen()</code>. 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 *wstr, <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="Link 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 <code class="xref c c-type docutils literal notranslate">wchar_t</code> buffer wstr. At most size <code class="xref c c-type docutils literal notranslate">wchar_t</code> characters are copied (excluding a possibly trailing null termination character). Return the number of <code class="xref c c-type docutils literal notranslate">wchar_t</code> characters copied or <code class="docutils literal notranslate">-1</code> in case of an error. When wstr is <code class="docutils literal notranslate">NULL</code>, instead return the size that would be required to store all of unicode including a terminating null. 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="Link 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 <code class="xref c c-type docutils literal notranslate">wchar_t</code> 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 <a class="reference internal" href="memory.html#c.PyMem_New" title="PyMem_New"><code class="xref c c-macro docutils literal notranslate">PyMem_New</code></a> (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"> Added 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="Link to this heading">¶</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 <a class="reference internal" href="../glossary.html#term-filesystem-encoding-and-error-handler">filesystem encoding and error handler</a> internally. 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="Link to this heading">¶</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 *str, <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="Link 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 str. 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="Link 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> </section> <section id="utf-8-codecs"> <h3>UTF-8 Codecs<a class="headerlink" href="#utf-8-codecs" title="Link to this heading">¶</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 *str, <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="Link 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 str. 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 *str, <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="Link 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="Link 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. The function fails if the string contains surrogate code points (<code class="docutils literal notranslate">U+D800</code> - <code class="docutils literal notranslate">U+DFFF</code>). </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="Link 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. On error, set an exception, set size to <code class="docutils literal notranslate">-1</code> (if it’s not NULL) and return <code class="docutils literal notranslate">NULL</code>. The function fails if the string contains surrogate code points (<code class="docutils literal notranslate">U+D800</code> - <code class="docutils literal notranslate">U+DFFF</code>). 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"> Added 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#limited-c-api">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="Link 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"> Added 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> </section> <section id="utf-32-codecs"> <h3>UTF-32 Codecs<a class="headerlink" href="#utf-32-codecs" title="Link to this heading">¶</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 *str, <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="Link 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 *str, <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="Link 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="Link 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> </section> <section id="utf-16-codecs"> <h3>UTF-16 Codecs<a class="headerlink" href="#utf-16-codecs" title="Link to this heading">¶</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 *str, <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="Link 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 *str, <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="Link 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="Link 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> </section> <section id="utf-7-codecs"> <h3>UTF-7 Codecs<a class="headerlink" href="#utf-7-codecs" title="Link to this heading">¶</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 *str, <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="Link 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 str. 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 *str, <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="Link 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> </section> <section id="unicode-escape-codecs"> <h3>Unicode-Escape Codecs<a class="headerlink" href="#unicode-escape-codecs" title="Link to this heading">¶</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 *str, <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="Link 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 str. 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="Link 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> </section> <section id="raw-unicode-escape-codecs"> <h3>Raw-Unicode-Escape Codecs<a class="headerlink" href="#raw-unicode-escape-codecs" title="Link to this heading">¶</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 *str, <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="Link 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 str. 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="Link 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> </section> <section id="latin-1-codecs"> <h3>Latin-1 Codecs<a class="headerlink" href="#latin-1-codecs" title="Link to this heading">¶</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 *str, <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="Link 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 str. 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="Link 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> </section> <section id="ascii-codecs"> <h3>ASCII Codecs<a class="headerlink" href="#ascii-codecs" title="Link to this heading">¶</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 *str, <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="Link 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 str. 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="Link 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> </section> <section id="character-map-codecs"> <h3>Character Map Codecs<a class="headerlink" href="#character-map-codecs" title="Link to this heading">¶</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 <a class="reference internal" href="../reference/datamodel.html#object.__getitem__" title="object.__getitem__"><code class="xref py py-meth docutils literal notranslate">__getitem__()</code></a> 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 *str, <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="structures.html#c.PyObject" title="PyObject">PyObject</a> *mapping, const char *errors)<a class="headerlink" href="#c.PyUnicode_DecodeCharmap" title="Link 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 str 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="Link 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> 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> *unicode, <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="Link 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 <a class="reference internal" href="../reference/datamodel.html#object.__getitem__" title="object.__getitem__"><code class="xref py py-meth docutils literal notranslate">__getitem__()</code></a> 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> </section> <section id="mbcs-codecs-for-windows"> <h3>MBCS codecs for Windows<a class="headerlink" href="#mbcs-codecs-for-windows" title="Link to this heading">¶</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 *str, <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="Link 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 str. 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 *str, <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="Link 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="Link 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="Link 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-macro docutils literal notranslate">CP_ACP</code> code page to get the MBCS encoder. <div class="versionadded"> Added in version 3.3. </div> </dd></dl> </section> <section id="methods-slots"> <h3>Methods & Slots<a class="headerlink" href="#methods-slots" title="Link to this heading">¶</a></h3> </section> </section> <section id="methods-and-slot-functions"> <h2>Methods and Slot Functions<a class="headerlink" href="#methods-and-slot-functions" title="Link to this heading">¶</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="Link 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> *unicode, <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="Link 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> *unicode, int keepends)<a class="headerlink" href="#c.PyUnicode_Splitlines" title="Link 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 keepends 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="Link 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> *unicode, <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="Link 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">unicode[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> *unicode, <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="Link 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">unicode[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> *unicode, <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="Link 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">unicode[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"> Added 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">unicode[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> *unicode, <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="Link 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">unicode[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> *unicode, <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="Link 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 unicode 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="Link 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_EqualToUTF8AndSize"> int PyUnicode_EqualToUTF8AndSize(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *unicode, const char *string, <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_EqualToUTF8AndSize" title="Link to this definition">¶</a> </dt> <dd> Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a> since version 3.13.Compare a Unicode object with a char buffer which is interpreted as being UTF-8 or ASCII encoded and return true (<code class="docutils literal notranslate">1</code>) if they are equal, or false (<code class="docutils literal notranslate">0</code>) otherwise. If the Unicode object contains surrogate code points (<code class="docutils literal notranslate">U+D800</code> - <code class="docutils literal notranslate">U+DFFF</code>) or the C string is not valid UTF-8, false (<code class="docutils literal notranslate">0</code>) is returned. This function does not raise exceptions. <div class="versionadded"> Added in version 3.13. </div> </dd></dl> <dl class="c function"> <dt class="sig sig-object c" id="c.PyUnicode_EqualToUTF8"> int PyUnicode_EqualToUTF8(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *unicode, const char *string)<a class="headerlink" href="#c.PyUnicode_EqualToUTF8" title="Link to this definition">¶</a> </dt> <dd> Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a> since version 3.13.Similar to <a class="reference internal" href="#c.PyUnicode_EqualToUTF8AndSize" title="PyUnicode_EqualToUTF8AndSize"><code class="xref c c-func docutils literal notranslate">PyUnicode_EqualToUTF8AndSize()</code></a>, but compute string length using <code class="xref c c-func docutils literal notranslate">strlen()</code>. If the Unicode object contains null characters, false (<code class="docutils literal notranslate">0</code>) is returned. <div class="versionadded"> Added in version 3.13. </div> </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> *unicode, const char *string)<a class="headerlink" href="#c.PyUnicode_CompareWithASCIIString" title="Link to this definition">¶</a> </dt> <dd> Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Compare a Unicode object, unicode, 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="Link 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><a class="reference internal" href="bool.html#c.Py_True" title="Py_True"><code class="xref c c-data docutils literal notranslate">Py_True</code></a> or <a class="reference internal" href="bool.html#c.Py_False" title="Py_False"><code class="xref c c-data docutils literal notranslate">Py_False</code></a> for successful comparisons</li> <li><a class="reference internal" href="object.html#c.Py_NotImplemented" title="Py_NotImplemented"><code class="xref c c-data docutils literal notranslate">Py_NotImplemented</code></a> in case the type combination is unknown</li> </ul> Possible values for op are <a class="reference internal" href="typeobj.html#c.Py_GT" title="Py_GT"><code class="xref c c-macro docutils literal notranslate">Py_GT</code></a>, <a class="reference internal" href="typeobj.html#c.Py_GE" title="Py_GE"><code class="xref c c-macro docutils literal notranslate">Py_GE</code></a>, <a class="reference internal" href="typeobj.html#c.Py_EQ" title="Py_EQ"><code class="xref c c-macro docutils literal notranslate">Py_EQ</code></a>, <a class="reference internal" href="typeobj.html#c.Py_NE" title="Py_NE"><code class="xref c c-macro docutils literal notranslate">Py_NE</code></a>, <a class="reference internal" href="typeobj.html#c.Py_LT" title="Py_LT"><code class="xref c c-macro docutils literal notranslate">Py_LT</code></a>, and <a class="reference internal" href="typeobj.html#c.Py_LE" title="Py_LE"><code class="xref c c-macro docutils literal notranslate">Py_LE</code></a>. </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="Link 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> *unicode, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *substr)<a class="headerlink" href="#c.PyUnicode_Contains" title="Link to this definition">¶</a> </dt> <dd> Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Check whether substr is contained in unicode and return true or false accordingly. substr 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> **p_unicode)<a class="headerlink" href="#c.PyUnicode_InternInPlace" title="Link to this definition">¶</a> </dt> <dd> Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Intern the argument *<a class="reference internal" href="#c.PyUnicode_InternInPlace" title="p_unicode">p_unicode</a> 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 *<a class="reference internal" href="#c.PyUnicode_InternInPlace" title="p_unicode">p_unicode</a>, it sets *<a class="reference internal" href="#c.PyUnicode_InternInPlace" title="p_unicode">p_unicode</a> to it (releasing the reference to the old string object and creating a new <a class="reference internal" href="../glossary.html#term-strong-reference">strong reference</a> to the interned string object), otherwise it leaves *<a class="reference internal" href="#c.PyUnicode_InternInPlace" title="p_unicode">p_unicode</a> alone and interns it. (Clarification: even though there is a lot of talk about references, think of this function as reference-neutral. You must own the object you pass in; after the call you no longer own the passed-in reference, but you newly own the result.) This function never raises an exception. On error, it leaves its argument unchanged without interning it. Instances of subclasses of <a class="reference internal" href="../library/stdtypes.html#str" title="str"><code class="xref py py-class docutils literal notranslate">str</code></a> may not be interned, that is, <a class="reference internal" href="#c.PyUnicode_CheckExact" title="PyUnicode_CheckExact">PyUnicode_CheckExact</a>(*<a class="reference internal" href="#c.PyUnicode_InternInPlace" title="p_unicode">p_unicode</a>) must be true. If it is not, then – as with any other error – the argument is left unchanged. Note that interned strings are not “immortal”. You must keep a reference to the result to benefit from interning. </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 *str)<a class="headerlink" href="#c.PyUnicode_InternFromString" title="Link 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>, meant for statically allocated strings. Return a new (“owned”) reference to either a new Unicode string object that has been interned, or an earlier interned string object with the same value. Python may keep a reference to the result, or make it <a class="reference internal" href="../glossary.html#term-immortal">immortal</a>, preventing it from being garbage-collected promptly. For interning an unbounded number of different strings, such as ones coming from user input, prefer calling <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> directly. <div class="impl-detail compound"> CPython implementation detail: Strings interned this way are made <a class="reference internal" href="../glossary.html#term-immortal">immortal</a>. </div> </dd></dl> </section> </section> <div class="clearer"></div> </div> </div> </div> <div class="sphinxsidebar" role="navigation" aria-label="Main"> <div class="sphinxsidebarwrapper"> <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="#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 & 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> <div> <h4>Previous topic</h4> <a href="bytearray.html" title="previous chapter">Byte Array Objects</a> </div> <div> <h4>Next topic</h4> <a href="tuple.html" title="next chapter">Tuple Objects</a> </div> <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/main/Doc/c-api/unicode.rst" rel="nofollow">Show Source </a> </li> </ul> </div> </div> <div id="sidebarbutton" title="Collapse sidebar"> « </div> </div> <div class="clearer"></div> </div> <div class="related" role="navigation" aria-label="Related"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="../genindex.html" title="General Index" >index</a></li> <li class="right" > <a href="../py-modindex.html" title="Python Module Index" >modules</a> |</li> <li class="right" > <a href="tuple.html" title="Tuple Objects" >next</a> |</li> <li class="right" > <a href="bytearray.html" title="Byte Array Objects" >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> »</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.13.0 Documentation</a> » </li> <li class="nav-item nav-item-1"><a href="index.html" >Python/C API Reference Manual</a> »</li> <li class="nav-item nav-item-2"><a href="concrete.html" >Concrete Objects Layer</a> »</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="search" name="q" id="search-box" /> <input type="submit" value="Go" /> </form> </div> | </li> <li class="right"> <label class="theme-selector-label"> Theme <select class="theme-selector" oninput="activateTheme(this.value)"> <option value="auto" selected>Auto</option> <option value="light">Light</option> <option value="dark">Dark</option> </select> </label> |</li> </ul> </div> <div class="footer"> © <a href="../copyright.html"> Copyright </a> 2001-2024, 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 Nov 24, 2024 (17:50 UTC). <a href="/bugs.html">Found a bug</a>? Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3. </div> <script type="text/javascript" src="../_static/switchers.js"></script> </body> </html>