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.

497 lines
35KB

  1. <!DOCTYPE html>
  2. <html lang="en" data-content_root="../">
  3. <head>
  4. <meta charset="utf-8" />
  5. <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
  6. <meta property="og:title" content="binascii — Convert between binary and ASCII" />
  7. <meta property="og:type" content="website" />
  8. <meta property="og:url" content="https://docs.python.org/3/library/binascii.html" />
  9. <meta property="og:site_name" content="Python documentation" />
  10. <meta property="og:description" content="The binascii module contains a number of methods to convert between binary and various ASCII-encoded binary representations. Normally, you will not use these functions directly but use wrapper modu..." />
  11. <meta property="og:image" content="https://docs.python.org/3/_static/og-image.png" />
  12. <meta property="og:image:alt" content="Python documentation" />
  13. <meta name="description" content="The binascii module contains a number of methods to convert between binary and various ASCII-encoded binary representations. Normally, you will not use these functions directly but use wrapper modu..." />
  14. <meta property="og:image:width" content="200" />
  15. <meta property="og:image:height" content="200" />
  16. <meta name="theme-color" content="#3776ab" />
  17. <title>binascii — Convert between binary and ASCII &#8212; Python 3.12.3 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">
  18. <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
  19. <link rel="stylesheet" type="text/css" href="../_static/pydoctheme.css?v=bb723527" />
  20. <link id="pygments_dark_css" media="(prefers-color-scheme: dark)" rel="stylesheet" type="text/css" href="../_static/pygments_dark.css?v=b20cc3f5" />
  21. <script src="../_static/documentation_options.js?v=2c828074"></script>
  22. <script src="../_static/doctools.js?v=888ff710"></script>
  23. <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
  24. <script src="../_static/sidebar.js"></script>
  25. <link rel="search" type="application/opensearchdescription+xml"
  26. title="Search within Python 3.12.3 documentation"
  27. href="../_static/opensearch.xml"/>
  28. <link rel="author" title="About these documents" href="../about.html" />
  29. <link rel="index" title="Index" href="../genindex.html" />
  30. <link rel="search" title="Search" href="../search.html" />
  31. <link rel="copyright" title="Copyright" href="../copyright.html" />
  32. <link rel="next" title="quopri — Encode and decode MIME quoted-printable data" href="quopri.html" />
  33. <link rel="prev" title="base64 — Base16, Base32, Base64, Base85 Data Encodings" href="base64.html" />
  34. <link rel="canonical" href="https://docs.python.org/3/library/binascii.html" />
  35. <style>
  36. @media only screen {
  37. table.full-width-table {
  38. width: 100%;
  39. }
  40. }
  41. </style>
  42. <link rel="stylesheet" href="../_static/pydoctheme_dark.css" media="(prefers-color-scheme: dark)" id="pydoctheme_dark_css">
  43. <link rel="shortcut icon" type="image/png" href="../_static/py.svg" />
  44. <script type="text/javascript" src="../_static/copybutton.js"></script>
  45. <script type="text/javascript" src="../_static/menu.js"></script>
  46. <script type="text/javascript" src="../_static/search-focus.js"></script>
  47. <script type="text/javascript" src="../_static/themetoggle.js"></script>
  48. </head>
  49. <body>
  50. <div class="mobile-nav">
  51. <input type="checkbox" id="menuToggler" class="toggler__input" aria-controls="navigation"
  52. aria-pressed="false" aria-expanded="false" role="button" aria-label="Menu" />
  53. <nav class="nav-content" role="navigation">
  54. <label for="menuToggler" class="toggler__label">
  55. <span></span>
  56. </label>
  57. <span class="nav-items-wrapper">
  58. <a href="https://www.python.org/" class="nav-logo">
  59. <img src="../_static/py.svg" alt="Python logo"/>
  60. </a>
  61. <span class="version_switcher_placeholder"></span>
  62. <form role="search" class="search" action="../search.html" method="get">
  63. <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" class="search-icon">
  64. <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>
  65. </svg>
  66. <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" />
  67. <input type="submit" value="Go"/>
  68. </form>
  69. </span>
  70. </nav>
  71. <div class="menu-wrapper">
  72. <nav class="menu" role="navigation" aria-label="main navigation">
  73. <div class="language_switcher_placeholder"></div>
  74. <label class="theme-selector-label">
  75. Theme
  76. <select class="theme-selector" oninput="activateTheme(this.value)">
  77. <option value="auto" selected>Auto</option>
  78. <option value="light">Light</option>
  79. <option value="dark">Dark</option>
  80. </select>
  81. </label>
  82. <div>
  83. <h4>Previous topic</h4>
  84. <p class="topless"><a href="base64.html"
  85. title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">base64</span></code> — Base16, Base32, Base64, Base85 Data Encodings</a></p>
  86. </div>
  87. <div>
  88. <h4>Next topic</h4>
  89. <p class="topless"><a href="quopri.html"
  90. title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">quopri</span></code> — Encode and decode MIME quoted-printable data</a></p>
  91. </div>
  92. <div role="note" aria-label="source link">
  93. <h3>This Page</h3>
  94. <ul class="this-page-menu">
  95. <li><a href="../bugs.html">Report a Bug</a></li>
  96. <li>
  97. <a href="https://github.com/python/cpython/blob/main/Doc/library/binascii.rst"
  98. rel="nofollow">Show Source
  99. </a>
  100. </li>
  101. </ul>
  102. </div>
  103. </nav>
  104. </div>
  105. </div>
  106. <div class="related" role="navigation" aria-label="related navigation">
  107. <h3>Navigation</h3>
  108. <ul>
  109. <li class="right" style="margin-right: 10px">
  110. <a href="../genindex.html" title="General Index"
  111. accesskey="I">index</a></li>
  112. <li class="right" >
  113. <a href="../py-modindex.html" title="Python Module Index"
  114. >modules</a> |</li>
  115. <li class="right" >
  116. <a href="quopri.html" title="quopri — Encode and decode MIME quoted-printable data"
  117. accesskey="N">next</a> |</li>
  118. <li class="right" >
  119. <a href="base64.html" title="base64 — Base16, Base32, Base64, Base85 Data Encodings"
  120. accesskey="P">previous</a> |</li>
  121. <li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"/></li>
  122. <li><a href="https://www.python.org/">Python</a> &#187;</li>
  123. <li class="switchers">
  124. <div class="language_switcher_placeholder"></div>
  125. <div class="version_switcher_placeholder"></div>
  126. </li>
  127. <li>
  128. </li>
  129. <li id="cpython-language-and-version">
  130. <a href="../index.html">3.12.3 Documentation</a> &#187;
  131. </li>
  132. <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>
  133. <li class="nav-item nav-item-2"><a href="netdata.html" accesskey="U">Internet Data Handling</a> &#187;</li>
  134. <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">binascii</span></code> — Convert between binary and ASCII</a></li>
  135. <li class="right">
  136. <div class="inline-search" role="search">
  137. <form class="inline-search" action="../search.html" method="get">
  138. <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box" />
  139. <input type="submit" value="Go" />
  140. </form>
  141. </div>
  142. |
  143. </li>
  144. <li class="right">
  145. <label class="theme-selector-label">
  146. Theme
  147. <select class="theme-selector" oninput="activateTheme(this.value)">
  148. <option value="auto" selected>Auto</option>
  149. <option value="light">Light</option>
  150. <option value="dark">Dark</option>
  151. </select>
  152. </label> |</li>
  153. </ul>
  154. </div>
  155. <div class="document">
  156. <div class="documentwrapper">
  157. <div class="bodywrapper">
  158. <div class="body" role="main">
  159. <section id="module-binascii">
  160. <span id="binascii-convert-between-binary-and-ascii"></span><h1><a class="reference internal" href="#module-binascii" title="binascii: Tools for converting between binary and various ASCII-encoded binary representations."><code class="xref py py-mod docutils literal notranslate"><span class="pre">binascii</span></code></a> — Convert between binary and ASCII<a class="headerlink" href="#module-binascii" title="Link to this heading">¶</a></h1>
  161. <hr class="docutils" id="index-0" />
  162. <p>The <a class="reference internal" href="#module-binascii" title="binascii: Tools for converting between binary and various ASCII-encoded binary representations."><code class="xref py py-mod docutils literal notranslate"><span class="pre">binascii</span></code></a> module contains a number of methods to convert between
  163. binary and various ASCII-encoded binary representations. Normally, you will not
  164. use these functions directly but use wrapper modules like <a class="reference internal" href="uu.html#module-uu" title="uu: Encode and decode files in uuencode format. (deprecated)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">uu</span></code></a> or
  165. <a class="reference internal" href="base64.html#module-base64" title="base64: RFC 4648: Base16, Base32, Base64 Data Encodings; Base85 and Ascii85"><code class="xref py py-mod docutils literal notranslate"><span class="pre">base64</span></code></a> instead. The <a class="reference internal" href="#module-binascii" title="binascii: Tools for converting between binary and various ASCII-encoded binary representations."><code class="xref py py-mod docutils literal notranslate"><span class="pre">binascii</span></code></a> module contains
  166. low-level functions written in C for greater speed that are used by the
  167. higher-level modules.</p>
  168. <div class="admonition note">
  169. <p class="admonition-title">Note</p>
  170. <p><code class="docutils literal notranslate"><span class="pre">a2b_*</span></code> functions accept Unicode strings containing only ASCII characters.
  171. Other functions only accept <a class="reference internal" href="../glossary.html#term-bytes-like-object"><span class="xref std std-term">bytes-like objects</span></a> (such as
  172. <a class="reference internal" href="stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate"><span class="pre">bytes</span></code></a>, <a class="reference internal" href="stdtypes.html#bytearray" title="bytearray"><code class="xref py py-class docutils literal notranslate"><span class="pre">bytearray</span></code></a> and other objects that support the buffer
  173. protocol).</p>
  174. <div class="versionchanged">
  175. <p><span class="versionmodified changed">Changed in version 3.3: </span>ASCII-only unicode strings are now accepted by the <code class="docutils literal notranslate"><span class="pre">a2b_*</span></code> functions.</p>
  176. </div>
  177. </div>
  178. <p>The <a class="reference internal" href="#module-binascii" title="binascii: Tools for converting between binary and various ASCII-encoded binary representations."><code class="xref py py-mod docutils literal notranslate"><span class="pre">binascii</span></code></a> module defines the following functions:</p>
  179. <dl class="py function">
  180. <dt class="sig sig-object py" id="binascii.a2b_uu">
  181. <span class="sig-prename descclassname"><span class="pre">binascii.</span></span><span class="sig-name descname"><span class="pre">a2b_uu</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#binascii.a2b_uu" title="Link to this definition">¶</a></dt>
  182. <dd><p>Convert a single line of uuencoded data back to binary and return the binary
  183. data. Lines normally contain 45 (binary) bytes, except for the last line. Line
  184. data may be followed by whitespace.</p>
  185. </dd></dl>
  186. <dl class="py function">
  187. <dt class="sig sig-object py" id="binascii.b2a_uu">
  188. <span class="sig-prename descclassname"><span class="pre">binascii.</span></span><span class="sig-name descname"><span class="pre">b2a_uu</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">backtick</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#binascii.b2a_uu" title="Link to this definition">¶</a></dt>
  189. <dd><p>Convert binary data to a line of ASCII characters, the return value is the
  190. converted line, including a newline char. The length of <em>data</em> should be at most
  191. 45. If <em>backtick</em> is true, zeros are represented by <code class="docutils literal notranslate"><span class="pre">'`'</span></code> instead of spaces.</p>
  192. <div class="versionchanged">
  193. <p><span class="versionmodified changed">Changed in version 3.7: </span>Added the <em>backtick</em> parameter.</p>
  194. </div>
  195. </dd></dl>
  196. <dl class="py function">
  197. <dt class="sig sig-object py" id="binascii.a2b_base64">
  198. <span class="sig-prename descclassname"><span class="pre">binascii.</span></span><span class="sig-name descname"><span class="pre">a2b_base64</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">strict_mode</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#binascii.a2b_base64" title="Link to this definition">¶</a></dt>
  199. <dd><p>Convert a block of base64 data back to binary and return the binary data. More
  200. than one line may be passed at a time.</p>
  201. <p>If <em>strict_mode</em> is true, only valid base64 data will be converted. Invalid base64
  202. data will raise <a class="reference internal" href="#binascii.Error" title="binascii.Error"><code class="xref py py-exc docutils literal notranslate"><span class="pre">binascii.Error</span></code></a>.</p>
  203. <p>Valid base64:</p>
  204. <ul class="simple">
  205. <li><p>Conforms to <span class="target" id="index-1"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc3548.html"><strong>RFC 3548</strong></a>.</p></li>
  206. <li><p>Contains only characters from the base64 alphabet.</p></li>
  207. <li><p>Contains no excess data after padding (including excess padding, newlines, etc.).</p></li>
  208. <li><p>Does not start with a padding.</p></li>
  209. </ul>
  210. <div class="versionchanged">
  211. <p><span class="versionmodified changed">Changed in version 3.11: </span>Added the <em>strict_mode</em> parameter.</p>
  212. </div>
  213. </dd></dl>
  214. <dl class="py function">
  215. <dt class="sig sig-object py" id="binascii.b2a_base64">
  216. <span class="sig-prename descclassname"><span class="pre">binascii.</span></span><span class="sig-name descname"><span class="pre">b2a_base64</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">newline</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#binascii.b2a_base64" title="Link to this definition">¶</a></dt>
  217. <dd><p>Convert binary data to a line of ASCII characters in base64 coding. The return
  218. value is the converted line, including a newline char if <em>newline</em> is
  219. true. The output of this function conforms to <span class="target" id="index-2"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc3548.html"><strong>RFC 3548</strong></a>.</p>
  220. <div class="versionchanged">
  221. <p><span class="versionmodified changed">Changed in version 3.6: </span>Added the <em>newline</em> parameter.</p>
  222. </div>
  223. </dd></dl>
  224. <dl class="py function">
  225. <dt class="sig sig-object py" id="binascii.a2b_qp">
  226. <span class="sig-prename descclassname"><span class="pre">binascii.</span></span><span class="sig-name descname"><span class="pre">a2b_qp</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">header</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#binascii.a2b_qp" title="Link to this definition">¶</a></dt>
  227. <dd><p>Convert a block of quoted-printable data back to binary and return the binary
  228. data. More than one line may be passed at a time. If the optional argument
  229. <em>header</em> is present and true, underscores will be decoded as spaces.</p>
  230. </dd></dl>
  231. <dl class="py function">
  232. <dt class="sig sig-object py" id="binascii.b2a_qp">
  233. <span class="sig-prename descclassname"><span class="pre">binascii.</span></span><span class="sig-name descname"><span class="pre">b2a_qp</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">quotetabs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">istext</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">header</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#binascii.b2a_qp" title="Link to this definition">¶</a></dt>
  234. <dd><p>Convert binary data to a line(s) of ASCII characters in quoted-printable
  235. encoding. The return value is the converted line(s). If the optional argument
  236. <em>quotetabs</em> is present and true, all tabs and spaces will be encoded. If the
  237. optional argument <em>istext</em> is present and true, newlines are not encoded but
  238. trailing whitespace will be encoded. If the optional argument <em>header</em> is
  239. present and true, spaces will be encoded as underscores per <span class="target" id="index-3"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc1522.html"><strong>RFC 1522</strong></a>. If the
  240. optional argument <em>header</em> is present and false, newline characters will be
  241. encoded as well; otherwise linefeed conversion might corrupt the binary data
  242. stream.</p>
  243. </dd></dl>
  244. <dl class="py function">
  245. <dt class="sig sig-object py" id="binascii.crc_hqx">
  246. <span class="sig-prename descclassname"><span class="pre">binascii.</span></span><span class="sig-name descname"><span class="pre">crc_hqx</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#binascii.crc_hqx" title="Link to this definition">¶</a></dt>
  247. <dd><p>Compute a 16-bit CRC value of <em>data</em>, starting with <em>value</em> as the
  248. initial CRC, and return the result. This uses the CRC-CCITT polynomial
  249. <em>x</em><sup>16</sup> + <em>x</em><sup>12</sup> + <em>x</em><sup>5</sup> + 1, often represented as
  250. 0x1021. This CRC is used in the binhex4 format.</p>
  251. </dd></dl>
  252. <dl class="py function">
  253. <dt class="sig sig-object py" id="binascii.crc32">
  254. <span class="sig-prename descclassname"><span class="pre">binascii.</span></span><span class="sig-name descname"><span class="pre">crc32</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em><span class="optional">[</span>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#binascii.crc32" title="Link to this definition">¶</a></dt>
  255. <dd><p>Compute CRC-32, the unsigned 32-bit checksum of <em>data</em>, starting with an
  256. initial CRC of <em>value</em>. The default initial CRC is zero. The algorithm
  257. is consistent with the ZIP file checksum. Since the algorithm is designed for
  258. use as a checksum algorithm, it is not suitable for use as a general hash
  259. algorithm. Use as follows:</p>
  260. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="nb">print</span><span class="p">(</span><span class="n">binascii</span><span class="o">.</span><span class="n">crc32</span><span class="p">(</span><span class="sa">b</span><span class="s2">&quot;hello world&quot;</span><span class="p">))</span>
  261. <span class="c1"># Or, in two pieces:</span>
  262. <span class="n">crc</span> <span class="o">=</span> <span class="n">binascii</span><span class="o">.</span><span class="n">crc32</span><span class="p">(</span><span class="sa">b</span><span class="s2">&quot;hello&quot;</span><span class="p">)</span>
  263. <span class="n">crc</span> <span class="o">=</span> <span class="n">binascii</span><span class="o">.</span><span class="n">crc32</span><span class="p">(</span><span class="sa">b</span><span class="s2">&quot; world&quot;</span><span class="p">,</span> <span class="n">crc</span><span class="p">)</span>
  264. <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;crc32 = </span><span class="si">{:#010x}</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">crc</span><span class="p">))</span>
  265. </pre></div>
  266. </div>
  267. <div class="versionchanged">
  268. <p><span class="versionmodified changed">Changed in version 3.0: </span>The result is always unsigned.</p>
  269. </div>
  270. </dd></dl>
  271. <dl class="py function">
  272. <dt class="sig sig-object py" id="binascii.b2a_hex">
  273. <span class="sig-prename descclassname"><span class="pre">binascii.</span></span><span class="sig-name descname"><span class="pre">b2a_hex</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em><span class="optional">[</span>, <em class="sig-param"><span class="n"><span class="pre">sep</span></span></em><span class="optional">[</span>, <em class="sig-param"><span class="n"><span class="pre">bytes_per_sep=1</span></span></em><span class="optional">]</span><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#binascii.b2a_hex" title="Link to this definition">¶</a></dt>
  274. <dt class="sig sig-object py" id="binascii.hexlify">
  275. <span class="sig-prename descclassname"><span class="pre">binascii.</span></span><span class="sig-name descname"><span class="pre">hexlify</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em><span class="optional">[</span>, <em class="sig-param"><span class="n"><span class="pre">sep</span></span></em><span class="optional">[</span>, <em class="sig-param"><span class="n"><span class="pre">bytes_per_sep=1</span></span></em><span class="optional">]</span><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#binascii.hexlify" title="Link to this definition">¶</a></dt>
  276. <dd><p>Return the hexadecimal representation of the binary <em>data</em>. Every byte of
  277. <em>data</em> is converted into the corresponding 2-digit hex representation. The
  278. returned bytes object is therefore twice as long as the length of <em>data</em>.</p>
  279. <p>Similar functionality (but returning a text string) is also conveniently
  280. accessible using the <a class="reference internal" href="stdtypes.html#bytes.hex" title="bytes.hex"><code class="xref py py-meth docutils literal notranslate"><span class="pre">bytes.hex()</span></code></a> method.</p>
  281. <p>If <em>sep</em> is specified, it must be a single character str or bytes object.
  282. It will be inserted in the output after every <em>bytes_per_sep</em> input bytes.
  283. Separator placement is counted from the right end of the output by default,
  284. if you wish to count from the left, supply a negative <em>bytes_per_sep</em> value.</p>
  285. <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">binascii</span>
  286. <span class="gp">&gt;&gt;&gt; </span><span class="n">binascii</span><span class="o">.</span><span class="n">b2a_hex</span><span class="p">(</span><span class="sa">b</span><span class="s1">&#39;</span><span class="se">\xb9\x01\xef</span><span class="s1">&#39;</span><span class="p">)</span>
  287. <span class="go">b&#39;b901ef&#39;</span>
  288. <span class="gp">&gt;&gt;&gt; </span><span class="n">binascii</span><span class="o">.</span><span class="n">hexlify</span><span class="p">(</span><span class="sa">b</span><span class="s1">&#39;</span><span class="se">\xb9\x01\xef</span><span class="s1">&#39;</span><span class="p">,</span> <span class="s1">&#39;-&#39;</span><span class="p">)</span>
  289. <span class="go">b&#39;b9-01-ef&#39;</span>
  290. <span class="gp">&gt;&gt;&gt; </span><span class="n">binascii</span><span class="o">.</span><span class="n">b2a_hex</span><span class="p">(</span><span class="sa">b</span><span class="s1">&#39;</span><span class="se">\xb9\x01\xef</span><span class="s1">&#39;</span><span class="p">,</span> <span class="sa">b</span><span class="s1">&#39;_&#39;</span><span class="p">,</span> <span class="mi">2</span><span class="p">)</span>
  291. <span class="go">b&#39;b9_01ef&#39;</span>
  292. <span class="gp">&gt;&gt;&gt; </span><span class="n">binascii</span><span class="o">.</span><span class="n">b2a_hex</span><span class="p">(</span><span class="sa">b</span><span class="s1">&#39;</span><span class="se">\xb9\x01\xef</span><span class="s1">&#39;</span><span class="p">,</span> <span class="sa">b</span><span class="s1">&#39; &#39;</span><span class="p">,</span> <span class="o">-</span><span class="mi">2</span><span class="p">)</span>
  293. <span class="go">b&#39;b901 ef&#39;</span>
  294. </pre></div>
  295. </div>
  296. <div class="versionchanged">
  297. <p><span class="versionmodified changed">Changed in version 3.8: </span>The <em>sep</em> and <em>bytes_per_sep</em> parameters were added.</p>
  298. </div>
  299. </dd></dl>
  300. <dl class="py function">
  301. <dt class="sig sig-object py" id="binascii.a2b_hex">
  302. <span class="sig-prename descclassname"><span class="pre">binascii.</span></span><span class="sig-name descname"><span class="pre">a2b_hex</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">hexstr</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#binascii.a2b_hex" title="Link to this definition">¶</a></dt>
  303. <dt class="sig sig-object py" id="binascii.unhexlify">
  304. <span class="sig-prename descclassname"><span class="pre">binascii.</span></span><span class="sig-name descname"><span class="pre">unhexlify</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">hexstr</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#binascii.unhexlify" title="Link to this definition">¶</a></dt>
  305. <dd><p>Return the binary data represented by the hexadecimal string <em>hexstr</em>. This
  306. function is the inverse of <a class="reference internal" href="#binascii.b2a_hex" title="binascii.b2a_hex"><code class="xref py py-func docutils literal notranslate"><span class="pre">b2a_hex()</span></code></a>. <em>hexstr</em> must contain an even number
  307. of hexadecimal digits (which can be upper or lower case), otherwise an
  308. <a class="reference internal" href="#binascii.Error" title="binascii.Error"><code class="xref py py-exc docutils literal notranslate"><span class="pre">Error</span></code></a> exception is raised.</p>
  309. <p>Similar functionality (accepting only text string arguments, but more
  310. liberal towards whitespace) is also accessible using the
  311. <a class="reference internal" href="stdtypes.html#bytes.fromhex" title="bytes.fromhex"><code class="xref py py-meth docutils literal notranslate"><span class="pre">bytes.fromhex()</span></code></a> class method.</p>
  312. </dd></dl>
  313. <dl class="py exception">
  314. <dt class="sig sig-object py" id="binascii.Error">
  315. <em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">binascii.</span></span><span class="sig-name descname"><span class="pre">Error</span></span><a class="headerlink" href="#binascii.Error" title="Link to this definition">¶</a></dt>
  316. <dd><p>Exception raised on errors. These are usually programming errors.</p>
  317. </dd></dl>
  318. <dl class="py exception">
  319. <dt class="sig sig-object py" id="binascii.Incomplete">
  320. <em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">binascii.</span></span><span class="sig-name descname"><span class="pre">Incomplete</span></span><a class="headerlink" href="#binascii.Incomplete" title="Link to this definition">¶</a></dt>
  321. <dd><p>Exception raised on incomplete data. These are usually not programming errors,
  322. but may be handled by reading a little more data and trying again.</p>
  323. </dd></dl>
  324. <div class="admonition seealso">
  325. <p class="admonition-title">See also</p>
  326. <dl class="simple">
  327. <dt>Module <a class="reference internal" href="base64.html#module-base64" title="base64: RFC 4648: Base16, Base32, Base64 Data Encodings; Base85 and Ascii85"><code class="xref py py-mod docutils literal notranslate"><span class="pre">base64</span></code></a></dt><dd><p>Support for RFC compliant base64-style encoding in base 16, 32, 64,
  328. and 85.</p>
  329. </dd>
  330. <dt>Module <a class="reference internal" href="uu.html#module-uu" title="uu: Encode and decode files in uuencode format. (deprecated)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">uu</span></code></a></dt><dd><p>Support for UU encoding used on Unix.</p>
  331. </dd>
  332. <dt>Module <a class="reference internal" href="quopri.html#module-quopri" title="quopri: Encode and decode files using the MIME quoted-printable encoding."><code class="xref py py-mod docutils literal notranslate"><span class="pre">quopri</span></code></a></dt><dd><p>Support for quoted-printable encoding used in MIME email messages.</p>
  333. </dd>
  334. </dl>
  335. </div>
  336. </section>
  337. <div class="clearer"></div>
  338. </div>
  339. </div>
  340. </div>
  341. <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
  342. <div class="sphinxsidebarwrapper">
  343. <div>
  344. <h4>Previous topic</h4>
  345. <p class="topless"><a href="base64.html"
  346. title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">base64</span></code> — Base16, Base32, Base64, Base85 Data Encodings</a></p>
  347. </div>
  348. <div>
  349. <h4>Next topic</h4>
  350. <p class="topless"><a href="quopri.html"
  351. title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">quopri</span></code> — Encode and decode MIME quoted-printable data</a></p>
  352. </div>
  353. <div role="note" aria-label="source link">
  354. <h3>This Page</h3>
  355. <ul class="this-page-menu">
  356. <li><a href="../bugs.html">Report a Bug</a></li>
  357. <li>
  358. <a href="https://github.com/python/cpython/blob/main/Doc/library/binascii.rst"
  359. rel="nofollow">Show Source
  360. </a>
  361. </li>
  362. </ul>
  363. </div>
  364. </div>
  365. <div id="sidebarbutton" title="Collapse sidebar">
  366. <span>«</span>
  367. </div>
  368. </div>
  369. <div class="clearer"></div>
  370. </div>
  371. <div class="related" role="navigation" aria-label="related navigation">
  372. <h3>Navigation</h3>
  373. <ul>
  374. <li class="right" style="margin-right: 10px">
  375. <a href="../genindex.html" title="General Index"
  376. >index</a></li>
  377. <li class="right" >
  378. <a href="../py-modindex.html" title="Python Module Index"
  379. >modules</a> |</li>
  380. <li class="right" >
  381. <a href="quopri.html" title="quopri — Encode and decode MIME quoted-printable data"
  382. >next</a> |</li>
  383. <li class="right" >
  384. <a href="base64.html" title="base64 — Base16, Base32, Base64, Base85 Data Encodings"
  385. >previous</a> |</li>
  386. <li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"/></li>
  387. <li><a href="https://www.python.org/">Python</a> &#187;</li>
  388. <li class="switchers">
  389. <div class="language_switcher_placeholder"></div>
  390. <div class="version_switcher_placeholder"></div>
  391. </li>
  392. <li>
  393. </li>
  394. <li id="cpython-language-and-version">
  395. <a href="../index.html">3.12.3 Documentation</a> &#187;
  396. </li>
  397. <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>
  398. <li class="nav-item nav-item-2"><a href="netdata.html" >Internet Data Handling</a> &#187;</li>
  399. <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">binascii</span></code> — Convert between binary and ASCII</a></li>
  400. <li class="right">
  401. <div class="inline-search" role="search">
  402. <form class="inline-search" action="../search.html" method="get">
  403. <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box" />
  404. <input type="submit" value="Go" />
  405. </form>
  406. </div>
  407. |
  408. </li>
  409. <li class="right">
  410. <label class="theme-selector-label">
  411. Theme
  412. <select class="theme-selector" oninput="activateTheme(this.value)">
  413. <option value="auto" selected>Auto</option>
  414. <option value="light">Light</option>
  415. <option value="dark">Dark</option>
  416. </select>
  417. </label> |</li>
  418. </ul>
  419. </div>
  420. <div class="footer">
  421. &copy;
  422. <a href="../copyright.html">
  423. Copyright
  424. </a>
  425. 2001-2024, Python Software Foundation.
  426. <br />
  427. This page is licensed under the Python Software Foundation License Version 2.
  428. <br />
  429. Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.
  430. <br />
  431. See <a href="/license.html">History and License</a> for more information.<br />
  432. <br />
  433. The Python Software Foundation is a non-profit corporation.
  434. <a href="https://www.python.org/psf/donations/">Please donate.</a>
  435. <br />
  436. <br />
  437. Last updated on Apr 09, 2024 (13:47 UTC).
  438. <a href="/bugs.html">Found a bug</a>?
  439. <br />
  440. Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
  441. </div>
  442. </body>
  443. </html>
上海开阖软件有限公司 沪ICP备12045867号-1