Baoding-FenShuaJiang
/
Green_GoodERP18_FSJ_Standard
Obserwuj 1
Polub 0
Wiki 捐赠
gooderp18绿色标准版
Nie możesz wybrać więcej, niż 25 tematów Tematy muszą się zaczynać od litery lub cyfry, mogą zawierać myślniki ('-') i mogą mieć do 35 znaków.
Gałąź: master
Gałęzie Tagi
${ item.name }
Utwórz gałąź ${ searchTerm }
z 'master'
${ noResults }
Green_GoodERP18_FSJ_Standard/python/Doc/html/library/tokenize.html

613 lines
43KB
Czysty Bezpośredni odnośnik Wina Historia 

  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="tokenize — Tokenizer for Python source" />

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

  9. <meta property="og:url" content="https://docs.python.org/3/library/tokenize.html" />

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

  11. <meta property="og:description" content="Source code: Lib/tokenize.py The tokenize module provides a lexical scanner for Python source code, implemented in Python. The scanner in this module returns comments as tokens as well, making it u..." />

  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="Source code: Lib/tokenize.py The tokenize module provides a lexical scanner for Python source code, implemented in Python. The scanner in this module returns comments as tokens as well, making it u..." />

  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>tokenize — Tokenizer for Python source &#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="tabnanny — Detection of ambiguous indentation" href="tabnanny.html" />

  39.     <link rel="prev" title="keyword — Testing for Python keywords" href="keyword.html" />

  40.     <link rel="canonical" href="https://docs.python.org/3/library/tokenize.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="#"><code class="xref py py-mod docutils literal notranslate"><span class="pre">tokenize</span></code> — Tokenizer for Python source</a><ul>

  99. <li><a class="reference internal" href="#tokenizing-input">Tokenizing Input</a></li>

  100. <li><a class="reference internal" href="#command-line-usage">Command-Line Usage</a></li>

  101. <li><a class="reference internal" href="#examples">Examples</a></li>

  102. </ul>

  103. </li>

  104. </ul>

  105. 

  106.   </div>

  107.   <div>

  108.     <h4>Previous topic</h4>

  109.     <p class="topless"><a href="keyword.html"

  110.                           title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">keyword</span></code> — Testing for Python keywords</a></p>

  111.   </div>

  112.   <div>

  113.     <h4>Next topic</h4>

  114.     <p class="topless"><a href="tabnanny.html"

  115.                           title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">tabnanny</span></code> — Detection of ambiguous indentation</a></p>

  116.   </div>

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

  118.     <h3>This Page</h3>

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

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

  121.       <li>

  122.         <a href="https://github.com/python/cpython/blob/main/Doc/library/tokenize.rst"

  123.             rel="nofollow">Show Source

  124.         </a>

  125.       </li>

  126.     </ul>

  127.   </div>

  128.         </nav>

  129.     </div>

  130. </div>

  131. 

  132.   

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

  134.       <h3>Navigation</h3>

  135.       <ul>

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

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

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

  139.         <li class="right" >

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

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

  142.         <li class="right" >

  143.           <a href="tabnanny.html" title="tabnanny — Detection of ambiguous indentation"

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

  145.         <li class="right" >

  146.           <a href="keyword.html" title="keyword — Testing for Python keywords"

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

  148. 

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

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

  151.           <li class="switchers">

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

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

  154.           </li>

  155.           <li>

  156.               

  157.           </li>

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

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

  160.     </li>

  161. 

  162.           <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>

  163.           <li class="nav-item nav-item-2"><a href="language.html" accesskey="U">Python Language Services</a> &#187;</li>

  164.         <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">tokenize</span></code> — Tokenizer for Python source</a></li>

  165.                 <li class="right">

  166.                     

  167. 

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

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

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

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

  172.         </form>

  173.     </div>

  174.                      |

  175.                 </li>

  176.             <li class="right">

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

  178.     Theme

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

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

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

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

  183.     </select>

  184. </label> |</li>

  185.             

  186.       </ul>

  187.     </div>    

  188. 

  189.     <div class="document">

  190.       <div class="documentwrapper">

  191.         <div class="bodywrapper">

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

  193.             

  194.   <section id="module-tokenize">

  195. <span id="tokenize-tokenizer-for-python-source"></span><h1><a class="reference internal" href="#module-tokenize" title="tokenize: Lexical scanner for Python source code."><code class="xref py py-mod docutils literal notranslate"><span class="pre">tokenize</span></code></a> — Tokenizer for Python source<a class="headerlink" href="#module-tokenize" title="Link to this heading">¶</a></h1>

  196. <p><strong>Source code:</strong> <a class="reference external" href="https://github.com/python/cpython/tree/3.12/Lib/tokenize.py">Lib/tokenize.py</a></p>

  197. <hr class="docutils" />

  198. <p>The <a class="reference internal" href="#module-tokenize" title="tokenize: Lexical scanner for Python source code."><code class="xref py py-mod docutils literal notranslate"><span class="pre">tokenize</span></code></a> module provides a lexical scanner for Python source code,

  199. implemented in Python.  The scanner in this module returns comments as tokens

  200. as well, making it useful for implementing “pretty-printers”, including

  201. colorizers for on-screen displays.</p>

  202. <p>To simplify token stream handling, all <a class="reference internal" href="../reference/lexical_analysis.html#operators"><span class="std std-ref">operator</span></a> and

  203. <a class="reference internal" href="../reference/lexical_analysis.html#delimiters"><span class="std std-ref">delimiter</span></a> tokens and <a class="reference internal" href="constants.html#Ellipsis" title="Ellipsis"><code class="xref py py-data docutils literal notranslate"><span class="pre">Ellipsis</span></code></a> are returned using

  204. the generic <a class="reference internal" href="token.html#token.OP" title="token.OP"><code class="xref py py-data docutils literal notranslate"><span class="pre">OP</span></code></a> token type.  The exact

  205. type can be determined by checking the <code class="docutils literal notranslate"><span class="pre">exact_type</span></code> property on the

  206. <a class="reference internal" href="../glossary.html#term-named-tuple"><span class="xref std std-term">named tuple</span></a> returned from <a class="reference internal" href="#tokenize.tokenize" title="tokenize.tokenize"><code class="xref py py-func docutils literal notranslate"><span class="pre">tokenize.tokenize()</span></code></a>.</p>

  207. <div class="admonition warning">

  208. <p class="admonition-title">Warning</p>

  209. <p>Note that the functions in this module are only designed to parse

  210. syntactically valid Python code (code that does not raise when parsed

  211. using <a class="reference internal" href="ast.html#ast.parse" title="ast.parse"><code class="xref py py-func docutils literal notranslate"><span class="pre">ast.parse()</span></code></a>).  The behavior of the functions in this module is

  212. <strong>undefined</strong> when providing invalid Python code and it can change at any

  213. point.</p>

  214. </div>

  215. <section id="tokenizing-input">

  216. <h2>Tokenizing Input<a class="headerlink" href="#tokenizing-input" title="Link to this heading">¶</a></h2>

  217. <p>The primary entry point is a <a class="reference internal" href="../glossary.html#term-generator"><span class="xref std std-term">generator</span></a>:</p>

  218. <dl class="py function">

  219. <dt class="sig sig-object py" id="tokenize.tokenize">

  220. <span class="sig-prename descclassname"><span class="pre">tokenize.</span></span><span class="sig-name descname"><span class="pre">tokenize</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">readline</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#tokenize.tokenize" title="Link to this definition">¶</a></dt>

  221. <dd><p>The <a class="reference internal" href="#tokenize.tokenize" title="tokenize.tokenize"><code class="xref py py-func docutils literal notranslate"><span class="pre">tokenize()</span></code></a> generator requires one argument, <em>readline</em>, which

  222. must be a callable object which provides the same interface as the

  223. <a class="reference internal" href="io.html#io.IOBase.readline" title="io.IOBase.readline"><code class="xref py py-meth docutils literal notranslate"><span class="pre">io.IOBase.readline()</span></code></a> method of file objects.  Each call to the

  224. function should return one line of input as bytes.</p>

  225. <p>The generator produces 5-tuples with these members: the token type; the

  226. token string; a 2-tuple <code class="docutils literal notranslate"><span class="pre">(srow,</span> <span class="pre">scol)</span></code> of ints specifying the row and

  227. column where the token begins in the source; a 2-tuple <code class="docutils literal notranslate"><span class="pre">(erow,</span> <span class="pre">ecol)</span></code> of

  228. ints specifying the row and column where the token ends in the source; and

  229. the line on which the token was found. The line passed (the last tuple item)

  230. is the <em>physical</em> line.  The 5 tuple is returned as a <a class="reference internal" href="../glossary.html#term-named-tuple"><span class="xref std std-term">named tuple</span></a>

  231. with the field names:

  232. <code class="docutils literal notranslate"><span class="pre">type</span> <span class="pre">string</span> <span class="pre">start</span> <span class="pre">end</span> <span class="pre">line</span></code>.</p>

  233. <p>The returned <a class="reference internal" href="../glossary.html#term-named-tuple"><span class="xref std std-term">named tuple</span></a> has an additional property named

  234. <code class="docutils literal notranslate"><span class="pre">exact_type</span></code> that contains the exact operator type for

  235. <a class="reference internal" href="token.html#token.OP" title="token.OP"><code class="xref py py-data docutils literal notranslate"><span class="pre">OP</span></code></a> tokens.  For all other token types <code class="docutils literal notranslate"><span class="pre">exact_type</span></code>

  236. equals the named tuple <code class="docutils literal notranslate"><span class="pre">type</span></code> field.</p>

  237. <div class="versionchanged">

  238. <p><span class="versionmodified changed">Changed in version 3.1: </span>Added support for named tuples.</p>

  239. </div>

  240. <div class="versionchanged">

  241. <p><span class="versionmodified changed">Changed in version 3.3: </span>Added support for <code class="docutils literal notranslate"><span class="pre">exact_type</span></code>.</p>

  242. </div>

  243. <p><a class="reference internal" href="#tokenize.tokenize" title="tokenize.tokenize"><code class="xref py py-func docutils literal notranslate"><span class="pre">tokenize()</span></code></a> determines the source encoding of the file by looking for a

  244. UTF-8 BOM or encoding cookie, according to <span class="target" id="index-0"></span><a class="pep reference external" href="https://peps.python.org/pep-0263/"><strong>PEP 263</strong></a>.</p>

  245. </dd></dl>

  246. 

  247. <dl class="py function">

  248. <dt class="sig sig-object py" id="tokenize.generate_tokens">

  249. <span class="sig-prename descclassname"><span class="pre">tokenize.</span></span><span class="sig-name descname"><span class="pre">generate_tokens</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">readline</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#tokenize.generate_tokens" title="Link to this definition">¶</a></dt>

  250. <dd><p>Tokenize a source reading unicode strings instead of bytes.</p>

  251. <p>Like <a class="reference internal" href="#tokenize.tokenize" title="tokenize.tokenize"><code class="xref py py-func docutils literal notranslate"><span class="pre">tokenize()</span></code></a>, the <em>readline</em> argument is a callable returning

  252. a single line of input. However, <a class="reference internal" href="#tokenize.generate_tokens" title="tokenize.generate_tokens"><code class="xref py py-func docutils literal notranslate"><span class="pre">generate_tokens()</span></code></a> expects <em>readline</em>

  253. to return a str object rather than bytes.</p>

  254. <p>The result is an iterator yielding named tuples, exactly like

  255. <a class="reference internal" href="#tokenize.tokenize" title="tokenize.tokenize"><code class="xref py py-func docutils literal notranslate"><span class="pre">tokenize()</span></code></a>. It does not yield an <a class="reference internal" href="token.html#token.ENCODING" title="token.ENCODING"><code class="xref py py-data docutils literal notranslate"><span class="pre">ENCODING</span></code></a> token.</p>

  256. </dd></dl>

  257. 

  258. <p>All constants from the <a class="reference internal" href="token.html#module-token" title="token: Constants representing terminal nodes of the parse tree."><code class="xref py py-mod docutils literal notranslate"><span class="pre">token</span></code></a> module are also exported from

  259. <a class="reference internal" href="#module-tokenize" title="tokenize: Lexical scanner for Python source code."><code class="xref py py-mod docutils literal notranslate"><span class="pre">tokenize</span></code></a>.</p>

  260. <p>Another function is provided to reverse the tokenization process. This is

  261. useful for creating tools that tokenize a script, modify the token stream, and

  262. write back the modified script.</p>

  263. <dl class="py function">

  264. <dt class="sig sig-object py" id="tokenize.untokenize">

  265. <span class="sig-prename descclassname"><span class="pre">tokenize.</span></span><span class="sig-name descname"><span class="pre">untokenize</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">iterable</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#tokenize.untokenize" title="Link to this definition">¶</a></dt>

  266. <dd><p>Converts tokens back into Python source code.  The <em>iterable</em> must return

  267. sequences with at least two elements, the token type and the token string.

  268. Any additional sequence elements are ignored.</p>

  269. <p>The reconstructed script is returned as a single string.  The result is

  270. guaranteed to tokenize back to match the input so that the conversion is

  271. lossless and round-trips are assured.  The guarantee applies only to the

  272. token type and token string as the spacing between tokens (column

  273. positions) may change.</p>

  274. <p>It returns bytes, encoded using the <a class="reference internal" href="token.html#token.ENCODING" title="token.ENCODING"><code class="xref py py-data docutils literal notranslate"><span class="pre">ENCODING</span></code></a> token, which

  275. is the first token sequence output by <a class="reference internal" href="#tokenize.tokenize" title="tokenize.tokenize"><code class="xref py py-func docutils literal notranslate"><span class="pre">tokenize()</span></code></a>. If there is no

  276. encoding token in the input, it returns a str instead.</p>

  277. </dd></dl>

  278. 

  279. <p><a class="reference internal" href="#tokenize.tokenize" title="tokenize.tokenize"><code class="xref py py-func docutils literal notranslate"><span class="pre">tokenize()</span></code></a> needs to detect the encoding of source files it tokenizes. The

  280. function it uses to do this is available:</p>

  281. <dl class="py function">

  282. <dt class="sig sig-object py" id="tokenize.detect_encoding">

  283. <span class="sig-prename descclassname"><span class="pre">tokenize.</span></span><span class="sig-name descname"><span class="pre">detect_encoding</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">readline</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#tokenize.detect_encoding" title="Link to this definition">¶</a></dt>

  284. <dd><p>The <a class="reference internal" href="#tokenize.detect_encoding" title="tokenize.detect_encoding"><code class="xref py py-func docutils literal notranslate"><span class="pre">detect_encoding()</span></code></a> function is used to detect the encoding that

  285. should be used to decode a Python source file. It requires one argument,

  286. readline, in the same way as the <a class="reference internal" href="#tokenize.tokenize" title="tokenize.tokenize"><code class="xref py py-func docutils literal notranslate"><span class="pre">tokenize()</span></code></a> generator.</p>

  287. <p>It will call readline a maximum of twice, and return the encoding used

  288. (as a string) and a list of any lines (not decoded from bytes) it has read

  289. in.</p>

  290. <p>It detects the encoding from the presence of a UTF-8 BOM or an encoding

  291. cookie as specified in <span class="target" id="index-1"></span><a class="pep reference external" href="https://peps.python.org/pep-0263/"><strong>PEP 263</strong></a>. If both a BOM and a cookie are present,

  292. but disagree, a <a class="reference internal" href="exceptions.html#SyntaxError" title="SyntaxError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">SyntaxError</span></code></a> will be raised. Note that if the BOM is found,

  293. <code class="docutils literal notranslate"><span class="pre">'utf-8-sig'</span></code> will be returned as an encoding.</p>

  294. <p>If no encoding is specified, then the default of <code class="docutils literal notranslate"><span class="pre">'utf-8'</span></code> will be

  295. returned.</p>

  296. <p>Use <a class="reference internal" href="#tokenize.open" title="tokenize.open"><code class="xref py py-func docutils literal notranslate"><span class="pre">open()</span></code></a> to open Python source files: it uses

  297. <a class="reference internal" href="#tokenize.detect_encoding" title="tokenize.detect_encoding"><code class="xref py py-func docutils literal notranslate"><span class="pre">detect_encoding()</span></code></a> to detect the file encoding.</p>

  298. </dd></dl>

  299. 

  300. <dl class="py function">

  301. <dt class="sig sig-object py" id="tokenize.open">

  302. <span class="sig-prename descclassname"><span class="pre">tokenize.</span></span><span class="sig-name descname"><span class="pre">open</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filename</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#tokenize.open" title="Link to this definition">¶</a></dt>

  303. <dd><p>Open a file in read only mode using the encoding detected by

  304. <a class="reference internal" href="#tokenize.detect_encoding" title="tokenize.detect_encoding"><code class="xref py py-func docutils literal notranslate"><span class="pre">detect_encoding()</span></code></a>.</p>

  305. <div class="versionadded">

  306. <p><span class="versionmodified added">New in version 3.2.</span></p>

  307. </div>

  308. </dd></dl>

  309. 

  310. <dl class="py exception">

  311. <dt class="sig sig-object py" id="tokenize.TokenError">

  312. <em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">tokenize.</span></span><span class="sig-name descname"><span class="pre">TokenError</span></span><a class="headerlink" href="#tokenize.TokenError" title="Link to this definition">¶</a></dt>

  313. <dd><p>Raised when either a docstring or expression that may be split over several

  314. lines is not completed anywhere in the file, for example:</p>

  315. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="s2">&quot;&quot;&quot;Beginning of</span>

  316. <span class="s2">docstring</span>

  317. </pre></div>

  318. </div>

  319. <p>or:</p>

  320. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="p">[</span><span class="mi">1</span><span class="p">,</span>

  321.  <span class="mi">2</span><span class="p">,</span>

  322.  <span class="mi">3</span>

  323. </pre></div>

  324. </div>

  325. </dd></dl>

  326. 

  327. </section>

  328. <section id="command-line-usage">

  329. <span id="tokenize-cli"></span><h2>Command-Line Usage<a class="headerlink" href="#command-line-usage" title="Link to this heading">¶</a></h2>

  330. <div class="versionadded">

  331. <p><span class="versionmodified added">New in version 3.3.</span></p>

  332. </div>

  333. <p>The <a class="reference internal" href="#module-tokenize" title="tokenize: Lexical scanner for Python source code."><code class="xref py py-mod docutils literal notranslate"><span class="pre">tokenize</span></code></a> module can be executed as a script from the command line.

  334. It is as simple as:</p>

  335. <div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>python<span class="w"> </span>-m<span class="w"> </span>tokenize<span class="w"> </span><span class="o">[</span>-e<span class="o">]</span><span class="w"> </span><span class="o">[</span>filename.py<span class="o">]</span>

  336. </pre></div>

  337. </div>

  338. <p>The following options are accepted:</p>

  339. <dl class="std option">

  340. <dt class="sig sig-object std" id="cmdoption-tokenize-h">

  341. <span id="cmdoption-tokenize-help"></span><span class="sig-name descname"><span class="pre">-h</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--help</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-tokenize-h" title="Link to this definition">¶</a></dt>

  342. <dd><p>show this help message and exit</p>

  343. </dd></dl>

  344. 

  345. <dl class="std option">

  346. <dt class="sig sig-object std" id="cmdoption-tokenize-e">

  347. <span id="cmdoption-tokenize-exact"></span><span class="sig-name descname"><span class="pre">-e</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--exact</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-tokenize-e" title="Link to this definition">¶</a></dt>

  348. <dd><p>display token names using the exact type</p>

  349. </dd></dl>

  350. 

  351. <p>If <code class="file docutils literal notranslate"><span class="pre">filename.py</span></code> is specified its contents are tokenized to stdout.

  352. Otherwise, tokenization is performed on stdin.</p>

  353. </section>

  354. <section id="examples">

  355. <h2>Examples<a class="headerlink" href="#examples" title="Link to this heading">¶</a></h2>

  356. <p>Example of a script rewriter that transforms float literals into Decimal

  357. objects:</p>

  358. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">tokenize</span> <span class="kn">import</span> <span class="n">tokenize</span><span class="p">,</span> <span class="n">untokenize</span><span class="p">,</span> <span class="n">NUMBER</span><span class="p">,</span> <span class="n">STRING</span><span class="p">,</span> <span class="n">NAME</span><span class="p">,</span> <span class="n">OP</span>

  359. <span class="kn">from</span> <span class="nn">io</span> <span class="kn">import</span> <span class="n">BytesIO</span>

  360. 

  361. <span class="k">def</span> <span class="nf">decistmt</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>

  362. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Substitute Decimals for floats in a string of statements.</span>

  363. 

  364. <span class="sd">    &gt;&gt;&gt; from decimal import Decimal</span>

  365. <span class="sd">    &gt;&gt;&gt; s = &#39;print(+21.3e-5*-.1234/81.7)&#39;</span>

  366. <span class="sd">    &gt;&gt;&gt; decistmt(s)</span>

  367. <span class="sd">    &quot;print (+Decimal (&#39;21.3e-5&#39;)*-Decimal (&#39;.1234&#39;)/Decimal (&#39;81.7&#39;))&quot;</span>

  368. 

  369. <span class="sd">    The format of the exponent is inherited from the platform C library.</span>

  370. <span class="sd">    Known cases are &quot;e-007&quot; (Windows) and &quot;e-07&quot; (not Windows).  Since</span>

  371. <span class="sd">    we&#39;re only showing 12 digits, and the 13th isn&#39;t close to 5, the</span>

  372. <span class="sd">    rest of the output should be platform-independent.</span>

  373. 

  374. <span class="sd">    &gt;&gt;&gt; exec(s)  #doctest: +ELLIPSIS</span>

  375. <span class="sd">    -3.21716034272e-0...7</span>

  376. 

  377. <span class="sd">    Output from calculations with Decimal should be identical across all</span>

  378. <span class="sd">    platforms.</span>

  379. 

  380. <span class="sd">    &gt;&gt;&gt; exec(decistmt(s))</span>

  381. <span class="sd">    -3.217160342717258261933904529E-7</span>

  382. <span class="sd">    &quot;&quot;&quot;</span>

  383.     <span class="n">result</span> <span class="o">=</span> <span class="p">[]</span>

  384.     <span class="n">g</span> <span class="o">=</span> <span class="n">tokenize</span><span class="p">(</span><span class="n">BytesIO</span><span class="p">(</span><span class="n">s</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s1">&#39;utf-8&#39;</span><span class="p">))</span><span class="o">.</span><span class="n">readline</span><span class="p">)</span>  <span class="c1"># tokenize the string</span>

  385.     <span class="k">for</span> <span class="n">toknum</span><span class="p">,</span> <span class="n">tokval</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">_</span> <span class="ow">in</span> <span class="n">g</span><span class="p">:</span>

  386.         <span class="k">if</span> <span class="n">toknum</span> <span class="o">==</span> <span class="n">NUMBER</span> <span class="ow">and</span> <span class="s1">&#39;.&#39;</span> <span class="ow">in</span> <span class="n">tokval</span><span class="p">:</span>  <span class="c1"># replace NUMBER tokens</span>

  387.             <span class="n">result</span><span class="o">.</span><span class="n">extend</span><span class="p">([</span>

  388.                 <span class="p">(</span><span class="n">NAME</span><span class="p">,</span> <span class="s1">&#39;Decimal&#39;</span><span class="p">),</span>

  389.                 <span class="p">(</span><span class="n">OP</span><span class="p">,</span> <span class="s1">&#39;(&#39;</span><span class="p">),</span>

  390.                 <span class="p">(</span><span class="n">STRING</span><span class="p">,</span> <span class="nb">repr</span><span class="p">(</span><span class="n">tokval</span><span class="p">)),</span>

  391.                 <span class="p">(</span><span class="n">OP</span><span class="p">,</span> <span class="s1">&#39;)&#39;</span><span class="p">)</span>

  392.             <span class="p">])</span>

  393.         <span class="k">else</span><span class="p">:</span>

  394.             <span class="n">result</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="n">toknum</span><span class="p">,</span> <span class="n">tokval</span><span class="p">))</span>

  395.     <span class="k">return</span> <span class="n">untokenize</span><span class="p">(</span><span class="n">result</span><span class="p">)</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s1">&#39;utf-8&#39;</span><span class="p">)</span>

  396. </pre></div>

  397. </div>

  398. <p>Example of tokenizing from the command line.  The script:</p>

  399. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="k">def</span> <span class="nf">say_hello</span><span class="p">():</span>

  400.     <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;Hello, World!&quot;</span><span class="p">)</span>

  401. 

  402. <span class="n">say_hello</span><span class="p">()</span>

  403. </pre></div>

  404. </div>

  405. <p>will be tokenized to the following output where the first column is the range

  406. of the line/column coordinates where the token is found, the second column is

  407. the name of the token, and the final column is the value of the token (if any)</p>

  408. <div class="highlight-shell-session notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>python<span class="w"> </span>-m<span class="w"> </span>tokenize<span class="w"> </span>hello.py

  409. <span class="go">0,0-0,0:            ENCODING       &#39;utf-8&#39;</span>

  410. <span class="go">1,0-1,3:            NAME           &#39;def&#39;</span>

  411. <span class="go">1,4-1,13:           NAME           &#39;say_hello&#39;</span>

  412. <span class="go">1,13-1,14:          OP             &#39;(&#39;</span>

  413. <span class="go">1,14-1,15:          OP             &#39;)&#39;</span>

  414. <span class="go">1,15-1,16:          OP             &#39;:&#39;</span>

  415. <span class="go">1,16-1,17:          NEWLINE        &#39;\n&#39;</span>

  416. <span class="go">2,0-2,4:            INDENT         &#39;    &#39;</span>

  417. <span class="go">2,4-2,9:            NAME           &#39;print&#39;</span>

  418. <span class="go">2,9-2,10:           OP             &#39;(&#39;</span>

  419. <span class="go">2,10-2,25:          STRING         &#39;&quot;Hello, World!&quot;&#39;</span>

  420. <span class="go">2,25-2,26:          OP             &#39;)&#39;</span>

  421. <span class="go">2,26-2,27:          NEWLINE        &#39;\n&#39;</span>

  422. <span class="go">3,0-3,1:            NL             &#39;\n&#39;</span>

  423. <span class="go">4,0-4,0:            DEDENT         &#39;&#39;</span>

  424. <span class="go">4,0-4,9:            NAME           &#39;say_hello&#39;</span>

  425. <span class="go">4,9-4,10:           OP             &#39;(&#39;</span>

  426. <span class="go">4,10-4,11:          OP             &#39;)&#39;</span>

  427. <span class="go">4,11-4,12:          NEWLINE        &#39;\n&#39;</span>

  428. <span class="go">5,0-5,0:            ENDMARKER      &#39;&#39;</span>

  429. </pre></div>

  430. </div>

  431. <p>The exact token type names can be displayed using the <a class="reference internal" href="#cmdoption-tokenize-e"><code class="xref std std-option docutils literal notranslate"><span class="pre">-e</span></code></a> option:</p>

  432. <div class="highlight-shell-session notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>python<span class="w"> </span>-m<span class="w"> </span>tokenize<span class="w"> </span>-e<span class="w"> </span>hello.py

  433. <span class="go">0,0-0,0:            ENCODING       &#39;utf-8&#39;</span>

  434. <span class="go">1,0-1,3:            NAME           &#39;def&#39;</span>

  435. <span class="go">1,4-1,13:           NAME           &#39;say_hello&#39;</span>

  436. <span class="go">1,13-1,14:          LPAR           &#39;(&#39;</span>

  437. <span class="go">1,14-1,15:          RPAR           &#39;)&#39;</span>

  438. <span class="go">1,15-1,16:          COLON          &#39;:&#39;</span>

  439. <span class="go">1,16-1,17:          NEWLINE        &#39;\n&#39;</span>

  440. <span class="go">2,0-2,4:            INDENT         &#39;    &#39;</span>

  441. <span class="go">2,4-2,9:            NAME           &#39;print&#39;</span>

  442. <span class="go">2,9-2,10:           LPAR           &#39;(&#39;</span>

  443. <span class="go">2,10-2,25:          STRING         &#39;&quot;Hello, World!&quot;&#39;</span>

  444. <span class="go">2,25-2,26:          RPAR           &#39;)&#39;</span>

  445. <span class="go">2,26-2,27:          NEWLINE        &#39;\n&#39;</span>

  446. <span class="go">3,0-3,1:            NL             &#39;\n&#39;</span>

  447. <span class="go">4,0-4,0:            DEDENT         &#39;&#39;</span>

  448. <span class="go">4,0-4,9:            NAME           &#39;say_hello&#39;</span>

  449. <span class="go">4,9-4,10:           LPAR           &#39;(&#39;</span>

  450. <span class="go">4,10-4,11:          RPAR           &#39;)&#39;</span>

  451. <span class="go">4,11-4,12:          NEWLINE        &#39;\n&#39;</span>

  452. <span class="go">5,0-5,0:            ENDMARKER      &#39;&#39;</span>

  453. </pre></div>

  454. </div>

  455. <p>Example of tokenizing a file programmatically, reading unicode

  456. strings instead of bytes with <a class="reference internal" href="#tokenize.generate_tokens" title="tokenize.generate_tokens"><code class="xref py py-func docutils literal notranslate"><span class="pre">generate_tokens()</span></code></a>:</p>

  457. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">tokenize</span>

  458. 

  459. <span class="k">with</span> <span class="n">tokenize</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="s1">&#39;hello.py&#39;</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>

  460.     <span class="n">tokens</span> <span class="o">=</span> <span class="n">tokenize</span><span class="o">.</span><span class="n">generate_tokens</span><span class="p">(</span><span class="n">f</span><span class="o">.</span><span class="n">readline</span><span class="p">)</span>

  461.     <span class="k">for</span> <span class="n">token</span> <span class="ow">in</span> <span class="n">tokens</span><span class="p">:</span>

  462.         <span class="nb">print</span><span class="p">(</span><span class="n">token</span><span class="p">)</span>

  463. </pre></div>

  464. </div>

  465. <p>Or reading bytes directly with <a class="reference internal" href="#tokenize.tokenize" title="tokenize.tokenize"><code class="xref py py-func docutils literal notranslate"><span class="pre">tokenize()</span></code></a>:</p>

  466. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">tokenize</span>

  467. 

  468. <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="s1">&#39;hello.py&#39;</span><span class="p">,</span> <span class="s1">&#39;rb&#39;</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>

  469.     <span class="n">tokens</span> <span class="o">=</span> <span class="n">tokenize</span><span class="o">.</span><span class="n">tokenize</span><span class="p">(</span><span class="n">f</span><span class="o">.</span><span class="n">readline</span><span class="p">)</span>

  470.     <span class="k">for</span> <span class="n">token</span> <span class="ow">in</span> <span class="n">tokens</span><span class="p">:</span>

  471.         <span class="nb">print</span><span class="p">(</span><span class="n">token</span><span class="p">)</span>

  472. </pre></div>

  473. </div>

  474. </section>

  475. </section>

  476. 

  477. 

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

  479.           </div>

  480.         </div>

  481.       </div>

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

  483.         <div class="sphinxsidebarwrapper">

  484.   <div>

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

  486.     <ul>

  487. <li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate"><span class="pre">tokenize</span></code> — Tokenizer for Python source</a><ul>

  488. <li><a class="reference internal" href="#tokenizing-input">Tokenizing Input</a></li>

  489. <li><a class="reference internal" href="#command-line-usage">Command-Line Usage</a></li>

  490. <li><a class="reference internal" href="#examples">Examples</a></li>

  491. </ul>

  492. </li>

  493. </ul>

  494. 

  495.   </div>

  496.   <div>

  497.     <h4>Previous topic</h4>

  498.     <p class="topless"><a href="keyword.html"

  499.                           title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">keyword</span></code> — Testing for Python keywords</a></p>

  500.   </div>

  501.   <div>

  502.     <h4>Next topic</h4>

  503.     <p class="topless"><a href="tabnanny.html"

  504.                           title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">tabnanny</span></code> — Detection of ambiguous indentation</a></p>

  505.   </div>

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

  507.     <h3>This Page</h3>

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

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

  510.       <li>

  511.         <a href="https://github.com/python/cpython/blob/main/Doc/library/tokenize.rst"

  512.             rel="nofollow">Show Source

  513.         </a>

  514.       </li>

  515.     </ul>

  516.   </div>

  517.         </div>

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

  519. <span>«</span>

  520. </div>

  521. 

  522.       </div>

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

  524.     </div>  

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

  526.       <h3>Navigation</h3>

  527.       <ul>

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

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

  530.              >index</a></li>

  531.         <li class="right" >

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

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

  534.         <li class="right" >

  535.           <a href="tabnanny.html" title="tabnanny — Detection of ambiguous indentation"

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

  537.         <li class="right" >

  538.           <a href="keyword.html" title="keyword — Testing for Python keywords"

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

  540. 

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

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

  543.           <li class="switchers">

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

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

  546.           </li>

  547.           <li>

  548.               

  549.           </li>

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

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

  552.     </li>

  553. 

  554.           <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>

  555.           <li class="nav-item nav-item-2"><a href="language.html" >Python Language Services</a> &#187;</li>

  556.         <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">tokenize</span></code> — Tokenizer for Python source</a></li>

  557.                 <li class="right">

  558.                     

  559. 

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

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

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

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

  564.         </form>

  565.     </div>

  566.                      |

  567.                 </li>

  568.             <li class="right">

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

  570.     Theme

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

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

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

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

  575.     </select>

  576. </label> |</li>

  577.             

  578.       </ul>

  579.     </div>  

  580.     <div class="footer">

  581.     &copy; 

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

  583.     

  584.     Copyright

  585.     

  586.       </a>

  587.      2001-2024, Python Software Foundation.

  588.     <br />

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

  590.     <br />

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

  592.     <br />

  593.     

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

  595.     

  596.     

  597.     <br />

  598. 

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

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

  601. <br />

  602.     <br />

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

  604.     

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

  606.     

  607.     <br />

  608. 

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

  610.     </div>

  611. 

  612.   </body>

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