Baoding-FenShuaJiang
/
Green_GoodERP18_FSJ_Standard
Watch 1
Star 0
Wiki 捐赠
gooderp18绿色标准版
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Tree: 0f75e31513
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '0f75e31513'
${ noResults }
Green_GoodERP18_FSJ_Standard/python/Doc/html/c-api/codec.html

491 lines
42KB
Raw Blame History 

  1. <!DOCTYPE html>

  2. 

  3. <html lang="en" data-content_root="../">

  4.   <head>

  5.     <meta charset="utf-8" />

  6.     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

  7. <meta property="og:title" content="Codec registry and support functions" />

  8. <meta property="og:type" content="website" />

  9. <meta property="og:url" content="https://docs.python.org/3/c-api/codec.html" />

  10. <meta property="og:site_name" content="Python documentation" />

  11. <meta property="og:description" content="Codec lookup API: In the following functions, the encoding string is looked up converted to all lower-case characters, which makes encodings looked up through this mechanism effectively case-insens..." />

  12. <meta property="og:image" content="https://docs.python.org/3/_static/og-image.png" />

  13. <meta property="og:image:alt" content="Python documentation" />

  14. <meta name="description" content="Codec lookup API: In the following functions, the encoding string is looked up converted to all lower-case characters, which makes encodings looked up through this mechanism effectively case-insens..." />

  15. <meta property="og:image:width" content="200" />

  16. <meta property="og:image:height" content="200" />

  17. <meta name="theme-color" content="#3776ab" />

  18. 

  19.     <title>Codec registry and support functions &#8212; Python 3.12.3 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">

  20.     

  21.     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />

  22.     <link rel="stylesheet" type="text/css" href="../_static/pydoctheme.css?v=bb723527" />

  23.     <link id="pygments_dark_css" media="(prefers-color-scheme: dark)" rel="stylesheet" type="text/css" href="../_static/pygments_dark.css?v=b20cc3f5" />

  24.     

  25.     <script src="../_static/documentation_options.js?v=2c828074"></script>

  26.     <script src="../_static/doctools.js?v=888ff710"></script>

  27.     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>

  28.     

  29.     <script src="../_static/sidebar.js"></script>

  30.     

  31.     <link rel="search" type="application/opensearchdescription+xml"

  32.           title="Search within Python 3.12.3 documentation"

  33.           href="../_static/opensearch.xml"/>

  34.     <link rel="author" title="About these documents" href="../about.html" />

  35.     <link rel="index" title="Index" href="../genindex.html" />

  36.     <link rel="search" title="Search" href="../search.html" />

  37.     <link rel="copyright" title="Copyright" href="../copyright.html" />

  38.     <link rel="next" title="Support for Perf Maps" href="perfmaps.html" />

  39.     <link rel="prev" title="Reflection" href="reflection.html" />

  40.     <link rel="canonical" href="https://docs.python.org/3/c-api/codec.html" />

  41.     

  42.       

  43.     

  44. 

  45.     

  46.     <style>

  47.       @media only screen {

  48.         table.full-width-table {

  49.             width: 100%;

  50.         }

  51.       }

  52.     </style>

  53. <link rel="stylesheet" href="../_static/pydoctheme_dark.css" media="(prefers-color-scheme: dark)" id="pydoctheme_dark_css">

  54.     <link rel="shortcut icon" type="image/png" href="../_static/py.svg" />

  55.             <script type="text/javascript" src="../_static/copybutton.js"></script>

  56.             <script type="text/javascript" src="../_static/menu.js"></script>

  57.             <script type="text/javascript" src="../_static/search-focus.js"></script>

  58.             <script type="text/javascript" src="../_static/themetoggle.js"></script> 

  59. 

  60.   </head>

  61. <body>

  62. <div class="mobile-nav">

  63.     <input type="checkbox" id="menuToggler" class="toggler__input" aria-controls="navigation"

  64.            aria-pressed="false" aria-expanded="false" role="button" aria-label="Menu" />

  65.     <nav class="nav-content" role="navigation">

  66.         <label for="menuToggler" class="toggler__label">

  67.             <span></span>

  68.         </label>

  69.         <span class="nav-items-wrapper">

  70.             <a href="https://www.python.org/" class="nav-logo">

  71.                 <img src="../_static/py.svg" alt="Python logo"/>

  72.             </a>

  73.             <span class="version_switcher_placeholder"></span>

  74.             <form role="search" class="search" action="../search.html" method="get">

  75.                 <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" class="search-icon">

  76.                     <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>

  77.                 </svg>

  78.                 <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" />

  79.                 <input type="submit" value="Go"/>

  80.             </form>

  81.         </span>

  82.     </nav>

  83.     <div class="menu-wrapper">

  84.         <nav class="menu" role="navigation" aria-label="main navigation">

  85.             <div class="language_switcher_placeholder"></div>

  86.             

  87. <label class="theme-selector-label">

  88.     Theme

  89.     <select class="theme-selector" oninput="activateTheme(this.value)">

  90.         <option value="auto" selected>Auto</option>

  91.         <option value="light">Light</option>

  92.         <option value="dark">Dark</option>

  93.     </select>

  94. </label>

  95.   <div>

  96.     <h3><a href="../contents.html">Table of Contents</a></h3>

  97.     <ul>

  98. <li><a class="reference internal" href="#">Codec registry and support functions</a><ul>

  99. <li><a class="reference internal" href="#codec-lookup-api">Codec lookup API</a></li>

  100. <li><a class="reference internal" href="#registry-api-for-unicode-encoding-error-handlers">Registry API for Unicode encoding error handlers</a></li>

  101. </ul>

  102. </li>

  103. </ul>

  104. 

  105.   </div>

  106.   <div>

  107.     <h4>Previous topic</h4>

  108.     <p class="topless"><a href="reflection.html"

  109.                           title="previous chapter">Reflection</a></p>

  110.   </div>

  111.   <div>

  112.     <h4>Next topic</h4>

  113.     <p class="topless"><a href="perfmaps.html"

  114.                           title="next chapter">Support for Perf Maps</a></p>

  115.   </div>

  116.   <div role="note" aria-label="source link">

  117.     <h3>This Page</h3>

  118.     <ul class="this-page-menu">

  119.       <li><a href="../bugs.html">Report a Bug</a></li>

  120.       <li>

  121.         <a href="https://github.com/python/cpython/blob/main/Doc/c-api/codec.rst"

  122.             rel="nofollow">Show Source

  123.         </a>

  124.       </li>

  125.     </ul>

  126.   </div>

  127.         </nav>

  128.     </div>

  129. </div>

  130. 

  131.   

  132.     <div class="related" role="navigation" aria-label="related navigation">

  133.       <h3>Navigation</h3>

  134.       <ul>

  135.         <li class="right" style="margin-right: 10px">

  136.           <a href="../genindex.html" title="General Index"

  137.              accesskey="I">index</a></li>

  138.         <li class="right" >

  139.           <a href="../py-modindex.html" title="Python Module Index"

  140.              >modules</a> |</li>

  141.         <li class="right" >

  142.           <a href="perfmaps.html" title="Support for Perf Maps"

  143.              accesskey="N">next</a> |</li>

  144.         <li class="right" >

  145.           <a href="reflection.html" title="Reflection"

  146.              accesskey="P">previous</a> |</li>

  147. 

  148.           <li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"/></li>

  149.           <li><a href="https://www.python.org/">Python</a> &#187;</li>

  150.           <li class="switchers">

  151.             <div class="language_switcher_placeholder"></div>

  152.             <div class="version_switcher_placeholder"></div>

  153.           </li>

  154.           <li>

  155.               

  156.           </li>

  157.     <li id="cpython-language-and-version">

  158.       <a href="../index.html">3.12.3 Documentation</a> &#187;

  159.     </li>

  160. 

  161.           <li class="nav-item nav-item-1"><a href="index.html" >Python/C API Reference Manual</a> &#187;</li>

  162.           <li class="nav-item nav-item-2"><a href="utilities.html" accesskey="U">Utilities</a> &#187;</li>

  163.         <li class="nav-item nav-item-this"><a href="">Codec registry and support functions</a></li>

  164.                 <li class="right">

  165.                     

  166. 

  167.     <div class="inline-search" role="search">

  168.         <form class="inline-search" action="../search.html" method="get">

  169.           <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box" />

  170.           <input type="submit" value="Go" />

  171.         </form>

  172.     </div>

  173.                      |

  174.                 </li>

  175.             <li class="right">

  176. <label class="theme-selector-label">

  177.     Theme

  178.     <select class="theme-selector" oninput="activateTheme(this.value)">

  179.         <option value="auto" selected>Auto</option>

  180.         <option value="light">Light</option>

  181.         <option value="dark">Dark</option>

  182.     </select>

  183. </label> |</li>

  184.             

  185.       </ul>

  186.     </div>    

  187. 

  188.     <div class="document">

  189.       <div class="documentwrapper">

  190.         <div class="bodywrapper">

  191.           <div class="body" role="main">

  192.             

  193.   <section id="codec-registry-and-support-functions">

  194. <span id="codec-registry"></span><h1>Codec registry and support functions<a class="headerlink" href="#codec-registry-and-support-functions" title="Link to this heading">¶</a></h1>

  195. <dl class="c function">

  196. <dt class="sig sig-object c" id="c.PyCodec_Register">

  197. <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PyCodec_Register</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="structures.html#c.PyObject" title="PyObject"><span class="n"><span class="pre">PyObject</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">search_function</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyCodec_Register" title="Link to this definition">¶</a><br /></dt>

  198. <dd><em class="stableabi"> Part of the <a class="reference internal" href="stable.html#stable"><span class="std std-ref">Stable ABI</span></a>.</em><p>Register a new codec search function.</p>

  199. <p>As side effect, this tries to load the <code class="xref py py-mod docutils literal notranslate"><span class="pre">encodings</span></code> package, if not yet

  200. done, to make sure that it is always first in the list of search functions.</p>

  201. </dd></dl>

  202. 

  203. <dl class="c function">

  204. <dt class="sig sig-object c" id="c.PyCodec_Unregister">

  205. <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PyCodec_Unregister</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="structures.html#c.PyObject" title="PyObject"><span class="n"><span class="pre">PyObject</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">search_function</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyCodec_Unregister" title="Link to this definition">¶</a><br /></dt>

  206. <dd><em class="stableabi"> Part of the <a class="reference internal" href="stable.html#stable"><span class="std std-ref">Stable ABI</span></a> since version 3.10.</em><p>Unregister a codec search function and clear the registry’s cache.

  207. If the search function is not registered, do nothing.

  208. Return 0 on success. Raise an exception and return -1 on error.</p>

  209. <div class="versionadded">

  210. <p><span class="versionmodified added">New in version 3.10.</span></p>

  211. </div>

  212. </dd></dl>

  213. 

  214. <dl class="c function">

  215. <dt class="sig sig-object c" id="c.PyCodec_KnownEncoding">

  216. <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PyCodec_KnownEncoding</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">encoding</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyCodec_KnownEncoding" title="Link to this definition">¶</a><br /></dt>

  217. <dd><em class="stableabi"> Part of the <a class="reference internal" href="stable.html#stable"><span class="std std-ref">Stable ABI</span></a>.</em><p>Return <code class="docutils literal notranslate"><span class="pre">1</span></code> or <code class="docutils literal notranslate"><span class="pre">0</span></code> depending on whether there is a registered codec for

  218. the given <em>encoding</em>.  This function always succeeds.</p>

  219. </dd></dl>

  220. 

  221. <dl class="c function">

  222. <dt class="sig sig-object c" id="c.PyCodec_Encode">

  223. <a class="reference internal" href="structures.html#c.PyObject" title="PyObject"><span class="n"><span class="pre">PyObject</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">PyCodec_Encode</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="structures.html#c.PyObject" title="PyObject"><span class="n"><span class="pre">PyObject</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">object</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">encoding</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">errors</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyCodec_Encode" title="Link to this definition">¶</a><br /></dt>

  224. <dd><em class="refcount">Return value: New reference.</em><em class="stableabi"> Part of the <a class="reference internal" href="stable.html#stable"><span class="std std-ref">Stable ABI</span></a>.</em><p>Generic codec based encoding API.</p>

  225. <p><em>object</em> is passed through the encoder function found for the given

  226. <em>encoding</em> using the error handling method defined by <em>errors</em>.  <em>errors</em> may

  227. be <code class="docutils literal notranslate"><span class="pre">NULL</span></code> to use the default method defined for the codec.  Raises a

  228. <a class="reference internal" href="../library/exceptions.html#LookupError" title="LookupError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">LookupError</span></code></a> if no encoder can be found.</p>

  229. </dd></dl>

  230. 

  231. <dl class="c function">

  232. <dt class="sig sig-object c" id="c.PyCodec_Decode">

  233. <a class="reference internal" href="structures.html#c.PyObject" title="PyObject"><span class="n"><span class="pre">PyObject</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">PyCodec_Decode</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="structures.html#c.PyObject" title="PyObject"><span class="n"><span class="pre">PyObject</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">object</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">encoding</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">errors</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyCodec_Decode" title="Link to this definition">¶</a><br /></dt>

  234. <dd><em class="refcount">Return value: New reference.</em><em class="stableabi"> Part of the <a class="reference internal" href="stable.html#stable"><span class="std std-ref">Stable ABI</span></a>.</em><p>Generic codec based decoding API.</p>

  235. <p><em>object</em> is passed through the decoder function found for the given

  236. <em>encoding</em> using the error handling method defined by <em>errors</em>.  <em>errors</em> may

  237. be <code class="docutils literal notranslate"><span class="pre">NULL</span></code> to use the default method defined for the codec.  Raises a

  238. <a class="reference internal" href="../library/exceptions.html#LookupError" title="LookupError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">LookupError</span></code></a> if no encoder can be found.</p>

  239. </dd></dl>

  240. 

  241. <section id="codec-lookup-api">

  242. <h2>Codec lookup API<a class="headerlink" href="#codec-lookup-api" title="Link to this heading">¶</a></h2>

  243. <p>In the following functions, the <em>encoding</em> string is looked up converted to all

  244. lower-case characters, which makes encodings looked up through this mechanism

  245. effectively case-insensitive.  If no codec is found, a <a class="reference internal" href="../library/exceptions.html#KeyError" title="KeyError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">KeyError</span></code></a> is set

  246. and <code class="docutils literal notranslate"><span class="pre">NULL</span></code> returned.</p>

  247. <dl class="c function">

  248. <dt class="sig sig-object c" id="c.PyCodec_Encoder">

  249. <a class="reference internal" href="structures.html#c.PyObject" title="PyObject"><span class="n"><span class="pre">PyObject</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">PyCodec_Encoder</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">encoding</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyCodec_Encoder" title="Link to this definition">¶</a><br /></dt>

  250. <dd><em class="refcount">Return value: New reference.</em><em class="stableabi"> Part of the <a class="reference internal" href="stable.html#stable"><span class="std std-ref">Stable ABI</span></a>.</em><p>Get an encoder function for the given <em>encoding</em>.</p>

  251. </dd></dl>

  252. 

  253. <dl class="c function">

  254. <dt class="sig sig-object c" id="c.PyCodec_Decoder">

  255. <a class="reference internal" href="structures.html#c.PyObject" title="PyObject"><span class="n"><span class="pre">PyObject</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">PyCodec_Decoder</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">encoding</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyCodec_Decoder" title="Link to this definition">¶</a><br /></dt>

  256. <dd><em class="refcount">Return value: New reference.</em><em class="stableabi"> Part of the <a class="reference internal" href="stable.html#stable"><span class="std std-ref">Stable ABI</span></a>.</em><p>Get a decoder function for the given <em>encoding</em>.</p>

  257. </dd></dl>

  258. 

  259. <dl class="c function">

  260. <dt class="sig sig-object c" id="c.PyCodec_IncrementalEncoder">

  261. <a class="reference internal" href="structures.html#c.PyObject" title="PyObject"><span class="n"><span class="pre">PyObject</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">PyCodec_IncrementalEncoder</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">encoding</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">errors</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyCodec_IncrementalEncoder" title="Link to this definition">¶</a><br /></dt>

  262. <dd><em class="refcount">Return value: New reference.</em><em class="stableabi"> Part of the <a class="reference internal" href="stable.html#stable"><span class="std std-ref">Stable ABI</span></a>.</em><p>Get an <a class="reference internal" href="../library/codecs.html#codecs.IncrementalEncoder" title="codecs.IncrementalEncoder"><code class="xref py py-class docutils literal notranslate"><span class="pre">IncrementalEncoder</span></code></a> object for the given <em>encoding</em>.</p>

  263. </dd></dl>

  264. 

  265. <dl class="c function">

  266. <dt class="sig sig-object c" id="c.PyCodec_IncrementalDecoder">

  267. <a class="reference internal" href="structures.html#c.PyObject" title="PyObject"><span class="n"><span class="pre">PyObject</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">PyCodec_IncrementalDecoder</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">encoding</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">errors</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyCodec_IncrementalDecoder" title="Link to this definition">¶</a><br /></dt>

  268. <dd><em class="refcount">Return value: New reference.</em><em class="stableabi"> Part of the <a class="reference internal" href="stable.html#stable"><span class="std std-ref">Stable ABI</span></a>.</em><p>Get an <a class="reference internal" href="../library/codecs.html#codecs.IncrementalDecoder" title="codecs.IncrementalDecoder"><code class="xref py py-class docutils literal notranslate"><span class="pre">IncrementalDecoder</span></code></a> object for the given <em>encoding</em>.</p>

  269. </dd></dl>

  270. 

  271. <dl class="c function">

  272. <dt class="sig sig-object c" id="c.PyCodec_StreamReader">

  273. <a class="reference internal" href="structures.html#c.PyObject" title="PyObject"><span class="n"><span class="pre">PyObject</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">PyCodec_StreamReader</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">encoding</span></span>, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject"><span class="n"><span class="pre">PyObject</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">stream</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">errors</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyCodec_StreamReader" title="Link to this definition">¶</a><br /></dt>

  274. <dd><em class="refcount">Return value: New reference.</em><em class="stableabi"> Part of the <a class="reference internal" href="stable.html#stable"><span class="std std-ref">Stable ABI</span></a>.</em><p>Get a <a class="reference internal" href="../library/codecs.html#codecs.StreamReader" title="codecs.StreamReader"><code class="xref py py-class docutils literal notranslate"><span class="pre">StreamReader</span></code></a> factory function for the given <em>encoding</em>.</p>

  275. </dd></dl>

  276. 

  277. <dl class="c function">

  278. <dt class="sig sig-object c" id="c.PyCodec_StreamWriter">

  279. <a class="reference internal" href="structures.html#c.PyObject" title="PyObject"><span class="n"><span class="pre">PyObject</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">PyCodec_StreamWriter</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">encoding</span></span>, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject"><span class="n"><span class="pre">PyObject</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">stream</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">errors</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyCodec_StreamWriter" title="Link to this definition">¶</a><br /></dt>

  280. <dd><em class="refcount">Return value: New reference.</em><em class="stableabi"> Part of the <a class="reference internal" href="stable.html#stable"><span class="std std-ref">Stable ABI</span></a>.</em><p>Get a <a class="reference internal" href="../library/codecs.html#codecs.StreamWriter" title="codecs.StreamWriter"><code class="xref py py-class docutils literal notranslate"><span class="pre">StreamWriter</span></code></a> factory function for the given <em>encoding</em>.</p>

  281. </dd></dl>

  282. 

  283. </section>

  284. <section id="registry-api-for-unicode-encoding-error-handlers">

  285. <h2>Registry API for Unicode encoding error handlers<a class="headerlink" href="#registry-api-for-unicode-encoding-error-handlers" title="Link to this heading">¶</a></h2>

  286. <dl class="c function">

  287. <dt class="sig sig-object c" id="c.PyCodec_RegisterError">

  288. <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PyCodec_RegisterError</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">name</span></span>, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject"><span class="n"><span class="pre">PyObject</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">error</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyCodec_RegisterError" title="Link to this definition">¶</a><br /></dt>

  289. <dd><em class="stableabi"> Part of the <a class="reference internal" href="stable.html#stable"><span class="std std-ref">Stable ABI</span></a>.</em><p>Register the error handling callback function <em>error</em> under the given <em>name</em>.

  290. This callback function will be called by a codec when it encounters

  291. unencodable characters/undecodable bytes and <em>name</em> is specified as the error

  292. parameter in the call to the encode/decode function.</p>

  293. <p>The callback gets a single argument, an instance of

  294. <a class="reference internal" href="../library/exceptions.html#UnicodeEncodeError" title="UnicodeEncodeError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">UnicodeEncodeError</span></code></a>, <a class="reference internal" href="../library/exceptions.html#UnicodeDecodeError" title="UnicodeDecodeError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">UnicodeDecodeError</span></code></a> or

  295. <a class="reference internal" href="../library/exceptions.html#UnicodeTranslateError" title="UnicodeTranslateError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">UnicodeTranslateError</span></code></a> that holds information about the problematic

  296. sequence of characters or bytes and their offset in the original string (see

  297. <a class="reference internal" href="exceptions.html#unicodeexceptions"><span class="std std-ref">Unicode Exception Objects</span></a> for functions to extract this information).  The

  298. callback must either raise the given exception, or return a two-item tuple

  299. containing the replacement for the problematic sequence, and an integer

  300. giving the offset in the original string at which encoding/decoding should be

  301. resumed.</p>

  302. <p>Return <code class="docutils literal notranslate"><span class="pre">0</span></code> on success, <code class="docutils literal notranslate"><span class="pre">-1</span></code> on error.</p>

  303. </dd></dl>

  304. 

  305. <dl class="c function">

  306. <dt class="sig sig-object c" id="c.PyCodec_LookupError">

  307. <a class="reference internal" href="structures.html#c.PyObject" title="PyObject"><span class="n"><span class="pre">PyObject</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">PyCodec_LookupError</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">name</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyCodec_LookupError" title="Link to this definition">¶</a><br /></dt>

  308. <dd><em class="refcount">Return value: New reference.</em><em class="stableabi"> Part of the <a class="reference internal" href="stable.html#stable"><span class="std std-ref">Stable ABI</span></a>.</em><p>Lookup the error handling callback function registered under <em>name</em>.  As a

  309. special case <code class="docutils literal notranslate"><span class="pre">NULL</span></code> can be passed, in which case the error handling callback

  310. for “strict” will be returned.</p>

  311. </dd></dl>

  312. 

  313. <dl class="c function">

  314. <dt class="sig sig-object c" id="c.PyCodec_StrictErrors">

  315. <a class="reference internal" href="structures.html#c.PyObject" title="PyObject"><span class="n"><span class="pre">PyObject</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">PyCodec_StrictErrors</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="structures.html#c.PyObject" title="PyObject"><span class="n"><span class="pre">PyObject</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">exc</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyCodec_StrictErrors" title="Link to this definition">¶</a><br /></dt>

  316. <dd><em class="refcount">Return value: Always NULL.</em><em class="stableabi"> Part of the <a class="reference internal" href="stable.html#stable"><span class="std std-ref">Stable ABI</span></a>.</em><p>Raise <em>exc</em> as an exception.</p>

  317. </dd></dl>

  318. 

  319. <dl class="c function">

  320. <dt class="sig sig-object c" id="c.PyCodec_IgnoreErrors">

  321. <a class="reference internal" href="structures.html#c.PyObject" title="PyObject"><span class="n"><span class="pre">PyObject</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">PyCodec_IgnoreErrors</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="structures.html#c.PyObject" title="PyObject"><span class="n"><span class="pre">PyObject</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">exc</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyCodec_IgnoreErrors" title="Link to this definition">¶</a><br /></dt>

  322. <dd><em class="refcount">Return value: New reference.</em><em class="stableabi"> Part of the <a class="reference internal" href="stable.html#stable"><span class="std std-ref">Stable ABI</span></a>.</em><p>Ignore the unicode error, skipping the faulty input.</p>

  323. </dd></dl>

  324. 

  325. <dl class="c function">

  326. <dt class="sig sig-object c" id="c.PyCodec_ReplaceErrors">

  327. <a class="reference internal" href="structures.html#c.PyObject" title="PyObject"><span class="n"><span class="pre">PyObject</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">PyCodec_ReplaceErrors</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="structures.html#c.PyObject" title="PyObject"><span class="n"><span class="pre">PyObject</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">exc</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyCodec_ReplaceErrors" title="Link to this definition">¶</a><br /></dt>

  328. <dd><em class="refcount">Return value: New reference.</em><em class="stableabi"> Part of the <a class="reference internal" href="stable.html#stable"><span class="std std-ref">Stable ABI</span></a>.</em><p>Replace the unicode encode error with <code class="docutils literal notranslate"><span class="pre">?</span></code> or <code class="docutils literal notranslate"><span class="pre">U+FFFD</span></code>.</p>

  329. </dd></dl>

  330. 

  331. <dl class="c function">

  332. <dt class="sig sig-object c" id="c.PyCodec_XMLCharRefReplaceErrors">

  333. <a class="reference internal" href="structures.html#c.PyObject" title="PyObject"><span class="n"><span class="pre">PyObject</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">PyCodec_XMLCharRefReplaceErrors</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="structures.html#c.PyObject" title="PyObject"><span class="n"><span class="pre">PyObject</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">exc</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyCodec_XMLCharRefReplaceErrors" title="Link to this definition">¶</a><br /></dt>

  334. <dd><em class="refcount">Return value: New reference.</em><em class="stableabi"> Part of the <a class="reference internal" href="stable.html#stable"><span class="std std-ref">Stable ABI</span></a>.</em><p>Replace the unicode encode error with XML character references.</p>

  335. </dd></dl>

  336. 

  337. <dl class="c function">

  338. <dt class="sig sig-object c" id="c.PyCodec_BackslashReplaceErrors">

  339. <a class="reference internal" href="structures.html#c.PyObject" title="PyObject"><span class="n"><span class="pre">PyObject</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">PyCodec_BackslashReplaceErrors</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="structures.html#c.PyObject" title="PyObject"><span class="n"><span class="pre">PyObject</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">exc</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyCodec_BackslashReplaceErrors" title="Link to this definition">¶</a><br /></dt>

  340. <dd><em class="refcount">Return value: New reference.</em><em class="stableabi"> Part of the <a class="reference internal" href="stable.html#stable"><span class="std std-ref">Stable ABI</span></a>.</em><p>Replace the unicode encode error with backslash escapes (<code class="docutils literal notranslate"><span class="pre">\x</span></code>, <code class="docutils literal notranslate"><span class="pre">\u</span></code> and

  341. <code class="docutils literal notranslate"><span class="pre">\U</span></code>).</p>

  342. </dd></dl>

  343. 

  344. <dl class="c function">

  345. <dt class="sig sig-object c" id="c.PyCodec_NameReplaceErrors">

  346. <a class="reference internal" href="structures.html#c.PyObject" title="PyObject"><span class="n"><span class="pre">PyObject</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">PyCodec_NameReplaceErrors</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="structures.html#c.PyObject" title="PyObject"><span class="n"><span class="pre">PyObject</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">exc</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyCodec_NameReplaceErrors" title="Link to this definition">¶</a><br /></dt>

  347. <dd><em class="refcount">Return value: New reference.</em><em class="stableabi"> Part of the <a class="reference internal" href="stable.html#stable"><span class="std std-ref">Stable ABI</span></a> since version 3.7.</em><p>Replace the unicode encode error with <code class="docutils literal notranslate"><span class="pre">\N{...}</span></code> escapes.</p>

  348. <div class="versionadded">

  349. <p><span class="versionmodified added">New in version 3.5.</span></p>

  350. </div>

  351. </dd></dl>

  352. 

  353. </section>

  354. </section>

  355. 

  356. 

  357.             <div class="clearer"></div>

  358.           </div>

  359.         </div>

  360.       </div>

  361.       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">

  362.         <div class="sphinxsidebarwrapper">

  363.   <div>

  364.     <h3><a href="../contents.html">Table of Contents</a></h3>

  365.     <ul>

  366. <li><a class="reference internal" href="#">Codec registry and support functions</a><ul>

  367. <li><a class="reference internal" href="#codec-lookup-api">Codec lookup API</a></li>

  368. <li><a class="reference internal" href="#registry-api-for-unicode-encoding-error-handlers">Registry API for Unicode encoding error handlers</a></li>

  369. </ul>

  370. </li>

  371. </ul>

  372. 

  373.   </div>

  374.   <div>

  375.     <h4>Previous topic</h4>

  376.     <p class="topless"><a href="reflection.html"

  377.                           title="previous chapter">Reflection</a></p>

  378.   </div>

  379.   <div>

  380.     <h4>Next topic</h4>

  381.     <p class="topless"><a href="perfmaps.html"

  382.                           title="next chapter">Support for Perf Maps</a></p>

  383.   </div>

  384.   <div role="note" aria-label="source link">

  385.     <h3>This Page</h3>

  386.     <ul class="this-page-menu">

  387.       <li><a href="../bugs.html">Report a Bug</a></li>

  388.       <li>

  389.         <a href="https://github.com/python/cpython/blob/main/Doc/c-api/codec.rst"

  390.             rel="nofollow">Show Source

  391.         </a>

  392.       </li>

  393.     </ul>

  394.   </div>

  395.         </div>

  396. <div id="sidebarbutton" title="Collapse sidebar">

  397. <span>«</span>

  398. </div>

  399. 

  400.       </div>

  401.       <div class="clearer"></div>

  402.     </div>  

  403.     <div class="related" role="navigation" aria-label="related navigation">

  404.       <h3>Navigation</h3>

  405.       <ul>

  406.         <li class="right" style="margin-right: 10px">

  407.           <a href="../genindex.html" title="General Index"

  408.              >index</a></li>

  409.         <li class="right" >

  410.           <a href="../py-modindex.html" title="Python Module Index"

  411.              >modules</a> |</li>

  412.         <li class="right" >

  413.           <a href="perfmaps.html" title="Support for Perf Maps"

  414.              >next</a> |</li>

  415.         <li class="right" >

  416.           <a href="reflection.html" title="Reflection"

  417.              >previous</a> |</li>

  418. 

  419.           <li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"/></li>

  420.           <li><a href="https://www.python.org/">Python</a> &#187;</li>

  421.           <li class="switchers">

  422.             <div class="language_switcher_placeholder"></div>

  423.             <div class="version_switcher_placeholder"></div>

  424.           </li>

  425.           <li>

  426.               

  427.           </li>

  428.     <li id="cpython-language-and-version">

  429.       <a href="../index.html">3.12.3 Documentation</a> &#187;

  430.     </li>

  431. 

  432.           <li class="nav-item nav-item-1"><a href="index.html" >Python/C API Reference Manual</a> &#187;</li>

  433.           <li class="nav-item nav-item-2"><a href="utilities.html" >Utilities</a> &#187;</li>

  434.         <li class="nav-item nav-item-this"><a href="">Codec registry and support functions</a></li>

  435.                 <li class="right">

  436.                     

  437. 

  438.     <div class="inline-search" role="search">

  439.         <form class="inline-search" action="../search.html" method="get">

  440.           <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box" />

  441.           <input type="submit" value="Go" />

  442.         </form>

  443.     </div>

  444.                      |

  445.                 </li>

  446.             <li class="right">

  447. <label class="theme-selector-label">

  448.     Theme

  449.     <select class="theme-selector" oninput="activateTheme(this.value)">

  450.         <option value="auto" selected>Auto</option>

  451.         <option value="light">Light</option>

  452.         <option value="dark">Dark</option>

  453.     </select>

  454. </label> |</li>

  455.             

  456.       </ul>

  457.     </div>  

  458.     <div class="footer">

  459.     &copy; 

  460.       <a href="../copyright.html">

  461.     

  462.     Copyright

  463.     

  464.       </a>

  465.      2001-2024, Python Software Foundation.

  466.     <br />

  467.     This page is licensed under the Python Software Foundation License Version 2.

  468.     <br />

  469.     Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.

  470.     <br />

  471.     

  472.       See <a href="/license.html">History and License</a> for more information.<br />

  473.     

  474.     

  475.     <br />

  476. 

  477.     The Python Software Foundation is a non-profit corporation.

  478. <a href="https://www.python.org/psf/donations/">Please donate.</a>

  479. <br />

  480.     <br />

  481.       Last updated on Apr 09, 2024 (13:47 UTC).

  482.     

  483.       <a href="/bugs.html">Found a bug</a>?

  484.     

  485.     <br />

  486. 

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

  488.     </div>

  489. 

  490.   </body>

  491. </html>
上海开阖软件有限公司 沪ICP备12045867号-1