Baoding-FenShuaJiang
/
Green_GoodERP18_FSJ_Standard
Tarkkaile 1
Äänestä 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.
Puu: 0f75e31513
Branchit Tagit
${ item.name }
Create branch ${ searchTerm }
from '0f75e31513'
${ noResults }
Green_GoodERP18_FSJ_Standard/python/Doc/html/library/fileinput.html

520 lines
43KB
Raaka Blame 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="fileinput — Iterate over lines from multiple input streams" />

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

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

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

  11. <meta property="og:description" content="Source code: Lib/fileinput.py This module implements a helper class and functions to quickly write a loop over standard input or a list of files. If you just want to read or write one file see open..." />

  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/fileinput.py This module implements a helper class and functions to quickly write a loop over standard input or a list of files. If you just want to read or write one file see open..." />

  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>fileinput — Iterate over lines from multiple input streams &#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="stat — Interpreting stat() results" href="stat.html" />

  39.     <link rel="prev" title="os.path — Common pathname manipulations" href="os.path.html" />

  40.     <link rel="canonical" href="https://docs.python.org/3/library/fileinput.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.     <h4>Previous topic</h4>

  97.     <p class="topless"><a href="os.path.html"

  98.                           title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">os.path</span></code> — Common pathname manipulations</a></p>

  99.   </div>

  100.   <div>

  101.     <h4>Next topic</h4>

  102.     <p class="topless"><a href="stat.html"

  103.                           title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">stat</span></code> — Interpreting <code class="xref py py-func docutils literal notranslate"><span class="pre">stat()</span></code> results</a></p>

  104.   </div>

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

  106.     <h3>This Page</h3>

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

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

  109.       <li>

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

  111.             rel="nofollow">Show Source

  112.         </a>

  113.       </li>

  114.     </ul>

  115.   </div>

  116.         </nav>

  117.     </div>

  118. </div>

  119. 

  120.   

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

  122.       <h3>Navigation</h3>

  123.       <ul>

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

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

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

  127.         <li class="right" >

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

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

  130.         <li class="right" >

  131.           <a href="stat.html" title="stat — Interpreting stat() results"

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

  133.         <li class="right" >

  134.           <a href="os.path.html" title="os.path — Common pathname manipulations"

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

  136. 

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

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

  139.           <li class="switchers">

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

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

  142.           </li>

  143.           <li>

  144.               

  145.           </li>

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

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

  148.     </li>

  149. 

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

  151.           <li class="nav-item nav-item-2"><a href="filesys.html" accesskey="U">File and Directory Access</a> &#187;</li>

  152.         <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">fileinput</span></code> — Iterate over lines from multiple input streams</a></li>

  153.                 <li class="right">

  154.                     

  155. 

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

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

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

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

  160.         </form>

  161.     </div>

  162.                      |

  163.                 </li>

  164.             <li class="right">

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

  166.     Theme

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

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

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

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

  171.     </select>

  172. </label> |</li>

  173.             

  174.       </ul>

  175.     </div>    

  176. 

  177.     <div class="document">

  178.       <div class="documentwrapper">

  179.         <div class="bodywrapper">

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

  181.             

  182.   <section id="module-fileinput">

  183. <span id="fileinput-iterate-over-lines-from-multiple-input-streams"></span><h1><a class="reference internal" href="#module-fileinput" title="fileinput: Loop over standard input or a list of files."><code class="xref py py-mod docutils literal notranslate"><span class="pre">fileinput</span></code></a> — Iterate over lines from multiple input streams<a class="headerlink" href="#module-fileinput" title="Link to this heading">¶</a></h1>

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

  185. <hr class="docutils" />

  186. <p>This module implements a helper class and functions to quickly write a

  187. loop over standard input or a list of files. If you just want to read or

  188. write one file see <a class="reference internal" href="functions.html#open" title="open"><code class="xref py py-func docutils literal notranslate"><span class="pre">open()</span></code></a>.</p>

  189. <p>The typical use is:</p>

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

  191. <span class="k">for</span> <span class="n">line</span> <span class="ow">in</span> <span class="n">fileinput</span><span class="o">.</span><span class="n">input</span><span class="p">(</span><span class="n">encoding</span><span class="o">=</span><span class="s2">&quot;utf-8&quot;</span><span class="p">):</span>

  192.     <span class="n">process</span><span class="p">(</span><span class="n">line</span><span class="p">)</span>

  193. </pre></div>

  194. </div>

  195. <p>This iterates over the lines of all files listed in <code class="docutils literal notranslate"><span class="pre">sys.argv[1:]</span></code>, defaulting

  196. to <code class="docutils literal notranslate"><span class="pre">sys.stdin</span></code> if the list is empty.  If a filename is <code class="docutils literal notranslate"><span class="pre">'-'</span></code>, it is also

  197. replaced by <code class="docutils literal notranslate"><span class="pre">sys.stdin</span></code> and the optional arguments <em>mode</em> and <em>openhook</em>

  198. are ignored.  To specify an alternative list of filenames, pass it as the

  199. first argument to <a class="reference internal" href="#fileinput.input" title="fileinput.input"><code class="xref py py-func docutils literal notranslate"><span class="pre">input()</span></code></a>.  A single file name is also allowed.</p>

  200. <p>All files are opened in text mode by default, but you can override this by

  201. specifying the <em>mode</em> parameter in the call to <a class="reference internal" href="#fileinput.input" title="fileinput.input"><code class="xref py py-func docutils literal notranslate"><span class="pre">input()</span></code></a> or

  202. <a class="reference internal" href="#fileinput.FileInput" title="fileinput.FileInput"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileInput</span></code></a>.  If an I/O error occurs during opening or reading a file,

  203. <a class="reference internal" href="exceptions.html#OSError" title="OSError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">OSError</span></code></a> is raised.</p>

  204. <div class="versionchanged">

  205. <p><span class="versionmodified changed">Changed in version 3.3: </span><a class="reference internal" href="exceptions.html#IOError" title="IOError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">IOError</span></code></a> used to be raised; it is now an alias of <a class="reference internal" href="exceptions.html#OSError" title="OSError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">OSError</span></code></a>.</p>

  206. </div>

  207. <p>If <code class="docutils literal notranslate"><span class="pre">sys.stdin</span></code> is used more than once, the second and further use will return

  208. no lines, except perhaps for interactive use, or if it has been explicitly reset

  209. (e.g. using <code class="docutils literal notranslate"><span class="pre">sys.stdin.seek(0)</span></code>).</p>

  210. <p>Empty files are opened and immediately closed; the only time their presence in

  211. the list of filenames is noticeable at all is when the last file opened is

  212. empty.</p>

  213. <p>Lines are returned with any newlines intact, which means that the last line in

  214. a file may not have one.</p>

  215. <p>You can control how files are opened by providing an opening hook via the

  216. <em>openhook</em> parameter to <a class="reference internal" href="#fileinput.input" title="fileinput.input"><code class="xref py py-func docutils literal notranslate"><span class="pre">fileinput.input()</span></code></a> or <a class="reference internal" href="#fileinput.FileInput" title="fileinput.FileInput"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileInput()</span></code></a>. The

  217. hook must be a function that takes two arguments, <em>filename</em> and <em>mode</em>, and

  218. returns an accordingly opened file-like object. If <em>encoding</em> and/or <em>errors</em>

  219. are specified, they will be passed to the hook as additional keyword arguments.

  220. This module provides a <a class="reference internal" href="#fileinput.hook_compressed" title="fileinput.hook_compressed"><code class="xref py py-func docutils literal notranslate"><span class="pre">hook_compressed()</span></code></a> to support compressed files.</p>

  221. <p>The following function is the primary interface of this module:</p>

  222. <dl class="py function">

  223. <dt class="sig sig-object py" id="fileinput.input">

  224. <span class="sig-prename descclassname"><span class="pre">fileinput.</span></span><span class="sig-name descname"><span class="pre">input</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">files</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inplace</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">backup</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><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">mode</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'r'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">openhook</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">encoding</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">errors</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#fileinput.input" title="Link to this definition">¶</a></dt>

  225. <dd><p>Create an instance of the <a class="reference internal" href="#fileinput.FileInput" title="fileinput.FileInput"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileInput</span></code></a> class.  The instance will be used

  226. as global state for the functions of this module, and is also returned to use

  227. during iteration.  The parameters to this function will be passed along to the

  228. constructor of the <a class="reference internal" href="#fileinput.FileInput" title="fileinput.FileInput"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileInput</span></code></a> class.</p>

  229. <p>The <a class="reference internal" href="#fileinput.FileInput" title="fileinput.FileInput"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileInput</span></code></a> instance can be used as a context manager in the

  230. <a class="reference internal" href="../reference/compound_stmts.html#with"><code class="xref std std-keyword docutils literal notranslate"><span class="pre">with</span></code></a> statement.  In this example, <em>input</em> is closed after the

  231. <code class="xref std std-keyword docutils literal notranslate"><span class="pre">with</span></code> statement is exited, even if an exception occurs:</p>

  232. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="k">with</span> <span class="n">fileinput</span><span class="o">.</span><span class="n">input</span><span class="p">(</span><span class="n">files</span><span class="o">=</span><span class="p">(</span><span class="s1">&#39;spam.txt&#39;</span><span class="p">,</span> <span class="s1">&#39;eggs.txt&#39;</span><span class="p">),</span> <span class="n">encoding</span><span class="o">=</span><span class="s2">&quot;utf-8&quot;</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>

  233.     <span class="k">for</span> <span class="n">line</span> <span class="ow">in</span> <span class="n">f</span><span class="p">:</span>

  234.         <span class="n">process</span><span class="p">(</span><span class="n">line</span><span class="p">)</span>

  235. </pre></div>

  236. </div>

  237. <div class="versionchanged">

  238. <p><span class="versionmodified changed">Changed in version 3.2: </span>Can be used as a context manager.</p>

  239. </div>

  240. <div class="versionchanged">

  241. <p><span class="versionmodified changed">Changed in version 3.8: </span>The keyword parameters <em>mode</em> and <em>openhook</em> are now keyword-only.</p>

  242. </div>

  243. <div class="versionchanged">

  244. <p><span class="versionmodified changed">Changed in version 3.10: </span>The keyword-only parameter <em>encoding</em> and <em>errors</em> are added.</p>

  245. </div>

  246. </dd></dl>

  247. 

  248. <p>The following functions use the global state created by <a class="reference internal" href="#fileinput.input" title="fileinput.input"><code class="xref py py-func docutils literal notranslate"><span class="pre">fileinput.input()</span></code></a>;

  249. if there is no active state, <a class="reference internal" href="exceptions.html#RuntimeError" title="RuntimeError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">RuntimeError</span></code></a> is raised.</p>

  250. <dl class="py function">

  251. <dt class="sig sig-object py" id="fileinput.filename">

  252. <span class="sig-prename descclassname"><span class="pre">fileinput.</span></span><span class="sig-name descname"><span class="pre">filename</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#fileinput.filename" title="Link to this definition">¶</a></dt>

  253. <dd><p>Return the name of the file currently being read.  Before the first line has

  254. been read, returns <code class="docutils literal notranslate"><span class="pre">None</span></code>.</p>

  255. </dd></dl>

  256. 

  257. <dl class="py function">

  258. <dt class="sig sig-object py" id="fileinput.fileno">

  259. <span class="sig-prename descclassname"><span class="pre">fileinput.</span></span><span class="sig-name descname"><span class="pre">fileno</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#fileinput.fileno" title="Link to this definition">¶</a></dt>

  260. <dd><p>Return the integer “file descriptor” for the current file. When no file is

  261. opened (before the first line and between files), returns <code class="docutils literal notranslate"><span class="pre">-1</span></code>.</p>

  262. </dd></dl>

  263. 

  264. <dl class="py function">

  265. <dt class="sig sig-object py" id="fileinput.lineno">

  266. <span class="sig-prename descclassname"><span class="pre">fileinput.</span></span><span class="sig-name descname"><span class="pre">lineno</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#fileinput.lineno" title="Link to this definition">¶</a></dt>

  267. <dd><p>Return the cumulative line number of the line that has just been read.  Before

  268. the first line has been read, returns <code class="docutils literal notranslate"><span class="pre">0</span></code>.  After the last line of the last

  269. file has been read, returns the line number of that line.</p>

  270. </dd></dl>

  271. 

  272. <dl class="py function">

  273. <dt class="sig sig-object py" id="fileinput.filelineno">

  274. <span class="sig-prename descclassname"><span class="pre">fileinput.</span></span><span class="sig-name descname"><span class="pre">filelineno</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#fileinput.filelineno" title="Link to this definition">¶</a></dt>

  275. <dd><p>Return the line number in the current file.  Before the first line has been

  276. read, returns <code class="docutils literal notranslate"><span class="pre">0</span></code>.  After the last line of the last file has been read,

  277. returns the line number of that line within the file.</p>

  278. </dd></dl>

  279. 

  280. <dl class="py function">

  281. <dt class="sig sig-object py" id="fileinput.isfirstline">

  282. <span class="sig-prename descclassname"><span class="pre">fileinput.</span></span><span class="sig-name descname"><span class="pre">isfirstline</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#fileinput.isfirstline" title="Link to this definition">¶</a></dt>

  283. <dd><p>Return <code class="docutils literal notranslate"><span class="pre">True</span></code> if the line just read is the first line of its file, otherwise

  284. return <code class="docutils literal notranslate"><span class="pre">False</span></code>.</p>

  285. </dd></dl>

  286. 

  287. <dl class="py function">

  288. <dt class="sig sig-object py" id="fileinput.isstdin">

  289. <span class="sig-prename descclassname"><span class="pre">fileinput.</span></span><span class="sig-name descname"><span class="pre">isstdin</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#fileinput.isstdin" title="Link to this definition">¶</a></dt>

  290. <dd><p>Return <code class="docutils literal notranslate"><span class="pre">True</span></code> if the last line was read from <code class="docutils literal notranslate"><span class="pre">sys.stdin</span></code>, otherwise return

  291. <code class="docutils literal notranslate"><span class="pre">False</span></code>.</p>

  292. </dd></dl>

  293. 

  294. <dl class="py function">

  295. <dt class="sig sig-object py" id="fileinput.nextfile">

  296. <span class="sig-prename descclassname"><span class="pre">fileinput.</span></span><span class="sig-name descname"><span class="pre">nextfile</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#fileinput.nextfile" title="Link to this definition">¶</a></dt>

  297. <dd><p>Close the current file so that the next iteration will read the first line from

  298. the next file (if any); lines not read from the file will not count towards the

  299. cumulative line count.  The filename is not changed until after the first line

  300. of the next file has been read.  Before the first line has been read, this

  301. function has no effect; it cannot be used to skip the first file.  After the

  302. last line of the last file has been read, this function has no effect.</p>

  303. </dd></dl>

  304. 

  305. <dl class="py function">

  306. <dt class="sig sig-object py" id="fileinput.close">

  307. <span class="sig-prename descclassname"><span class="pre">fileinput.</span></span><span class="sig-name descname"><span class="pre">close</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#fileinput.close" title="Link to this definition">¶</a></dt>

  308. <dd><p>Close the sequence.</p>

  309. </dd></dl>

  310. 

  311. <p>The class which implements the sequence behavior provided by the module is

  312. available for subclassing as well:</p>

  313. <dl class="py class">

  314. <dt class="sig sig-object py" id="fileinput.FileInput">

  315. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">fileinput.</span></span><span class="sig-name descname"><span class="pre">FileInput</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">files</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inplace</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">backup</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><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">mode</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'r'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">openhook</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">encoding</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">errors</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#fileinput.FileInput" title="Link to this definition">¶</a></dt>

  316. <dd><p>Class <a class="reference internal" href="#fileinput.FileInput" title="fileinput.FileInput"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileInput</span></code></a> is the implementation; its methods <a class="reference internal" href="#fileinput.filename" title="fileinput.filename"><code class="xref py py-meth docutils literal notranslate"><span class="pre">filename()</span></code></a>,

  317. <a class="reference internal" href="#fileinput.fileno" title="fileinput.fileno"><code class="xref py py-meth docutils literal notranslate"><span class="pre">fileno()</span></code></a>, <a class="reference internal" href="#fileinput.lineno" title="fileinput.lineno"><code class="xref py py-meth docutils literal notranslate"><span class="pre">lineno()</span></code></a>, <a class="reference internal" href="#fileinput.filelineno" title="fileinput.filelineno"><code class="xref py py-meth docutils literal notranslate"><span class="pre">filelineno()</span></code></a>, <a class="reference internal" href="#fileinput.isfirstline" title="fileinput.isfirstline"><code class="xref py py-meth docutils literal notranslate"><span class="pre">isfirstline()</span></code></a>,

  318. <a class="reference internal" href="#fileinput.isstdin" title="fileinput.isstdin"><code class="xref py py-meth docutils literal notranslate"><span class="pre">isstdin()</span></code></a>, <a class="reference internal" href="#fileinput.nextfile" title="fileinput.nextfile"><code class="xref py py-meth docutils literal notranslate"><span class="pre">nextfile()</span></code></a> and <a class="reference internal" href="#fileinput.close" title="fileinput.close"><code class="xref py py-meth docutils literal notranslate"><span class="pre">close()</span></code></a> correspond to the

  319. functions of the same name in the module. In addition it is <a class="reference internal" href="../glossary.html#term-iterable"><span class="xref std std-term">iterable</span></a>

  320. and has a <a class="reference internal" href="io.html#io.TextIOBase.readline" title="io.TextIOBase.readline"><code class="xref py py-meth docutils literal notranslate"><span class="pre">readline()</span></code></a> method which returns the next

  321. input line. The sequence must be accessed in strictly sequential order;

  322. random access and <a class="reference internal" href="io.html#io.TextIOBase.readline" title="io.TextIOBase.readline"><code class="xref py py-meth docutils literal notranslate"><span class="pre">readline()</span></code></a> cannot be mixed.</p>

  323. <p>With <em>mode</em> you can specify which file mode will be passed to <a class="reference internal" href="functions.html#open" title="open"><code class="xref py py-func docutils literal notranslate"><span class="pre">open()</span></code></a>. It

  324. must be one of <code class="docutils literal notranslate"><span class="pre">'r'</span></code> and <code class="docutils literal notranslate"><span class="pre">'rb'</span></code>.</p>

  325. <p>The <em>openhook</em>, when given, must be a function that takes two arguments,

  326. <em>filename</em> and <em>mode</em>, and returns an accordingly opened file-like object. You

  327. cannot use <em>inplace</em> and <em>openhook</em> together.</p>

  328. <p>You can specify <em>encoding</em> and <em>errors</em> that is passed to <a class="reference internal" href="functions.html#open" title="open"><code class="xref py py-func docutils literal notranslate"><span class="pre">open()</span></code></a> or <em>openhook</em>.</p>

  329. <p>A <a class="reference internal" href="#fileinput.FileInput" title="fileinput.FileInput"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileInput</span></code></a> instance can be used as a context manager in the

  330. <a class="reference internal" href="../reference/compound_stmts.html#with"><code class="xref std std-keyword docutils literal notranslate"><span class="pre">with</span></code></a> statement.  In this example, <em>input</em> is closed after the

  331. <code class="xref std std-keyword docutils literal notranslate"><span class="pre">with</span></code> statement is exited, even if an exception occurs:</p>

  332. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="k">with</span> <span class="n">FileInput</span><span class="p">(</span><span class="n">files</span><span class="o">=</span><span class="p">(</span><span class="s1">&#39;spam.txt&#39;</span><span class="p">,</span> <span class="s1">&#39;eggs.txt&#39;</span><span class="p">))</span> <span class="k">as</span> <span class="nb">input</span><span class="p">:</span>

  333.     <span class="n">process</span><span class="p">(</span><span class="nb">input</span><span class="p">)</span>

  334. </pre></div>

  335. </div>

  336. <div class="versionchanged">

  337. <p><span class="versionmodified changed">Changed in version 3.2: </span>Can be used as a context manager.</p>

  338. </div>

  339. <div class="versionchanged">

  340. <p><span class="versionmodified changed">Changed in version 3.8: </span>The keyword parameter <em>mode</em> and <em>openhook</em> are now keyword-only.</p>

  341. </div>

  342. <div class="versionchanged">

  343. <p><span class="versionmodified changed">Changed in version 3.10: </span>The keyword-only parameter <em>encoding</em> and <em>errors</em> are added.</p>

  344. </div>

  345. <div class="versionchanged">

  346. <p><span class="versionmodified changed">Changed in version 3.11: </span>The <code class="docutils literal notranslate"><span class="pre">'rU'</span></code> and <code class="docutils literal notranslate"><span class="pre">'U'</span></code> modes and the <code class="xref py py-meth docutils literal notranslate"><span class="pre">__getitem__()</span></code> method have

  347. been removed.</p>

  348. </div>

  349. </dd></dl>

  350. 

  351. <p><strong>Optional in-place filtering:</strong> if the keyword argument <code class="docutils literal notranslate"><span class="pre">inplace=True</span></code> is

  352. passed to <a class="reference internal" href="#fileinput.input" title="fileinput.input"><code class="xref py py-func docutils literal notranslate"><span class="pre">fileinput.input()</span></code></a> or to the <a class="reference internal" href="#fileinput.FileInput" title="fileinput.FileInput"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileInput</span></code></a> constructor, the

  353. file is moved to a backup file and standard output is directed to the input file

  354. (if a file of the same name as the backup file already exists, it will be

  355. replaced silently).  This makes it possible to write a filter that rewrites its

  356. input file in place.  If the <em>backup</em> parameter is given (typically as

  357. <code class="docutils literal notranslate"><span class="pre">backup='.&lt;some</span> <span class="pre">extension&gt;'</span></code>), it specifies the extension for the backup file,

  358. and the backup file remains around; by default, the extension is <code class="docutils literal notranslate"><span class="pre">'.bak'</span></code> and

  359. it is deleted when the output file is closed.  In-place filtering is disabled

  360. when standard input is read.</p>

  361. <p>The two following opening hooks are provided by this module:</p>

  362. <dl class="py function">

  363. <dt class="sig sig-object py" id="fileinput.hook_compressed">

  364. <span class="sig-prename descclassname"><span class="pre">fileinput.</span></span><span class="sig-name descname"><span class="pre">hook_compressed</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filename</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mode</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">encoding</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">errors</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#fileinput.hook_compressed" title="Link to this definition">¶</a></dt>

  365. <dd><p>Transparently opens files compressed with gzip and bzip2 (recognized by the

  366. extensions <code class="docutils literal notranslate"><span class="pre">'.gz'</span></code> and <code class="docutils literal notranslate"><span class="pre">'.bz2'</span></code>) using the <a class="reference internal" href="gzip.html#module-gzip" title="gzip: Interfaces for gzip compression and decompression using file objects."><code class="xref py py-mod docutils literal notranslate"><span class="pre">gzip</span></code></a> and <a class="reference internal" href="bz2.html#module-bz2" title="bz2: Interfaces for bzip2 compression and decompression."><code class="xref py py-mod docutils literal notranslate"><span class="pre">bz2</span></code></a>

  367. modules.  If the filename extension is not <code class="docutils literal notranslate"><span class="pre">'.gz'</span></code> or <code class="docutils literal notranslate"><span class="pre">'.bz2'</span></code>, the file is

  368. opened normally (ie, using <a class="reference internal" href="functions.html#open" title="open"><code class="xref py py-func docutils literal notranslate"><span class="pre">open()</span></code></a> without any decompression).</p>

  369. <p>The <em>encoding</em> and <em>errors</em> values are passed to <a class="reference internal" href="io.html#io.TextIOWrapper" title="io.TextIOWrapper"><code class="xref py py-class docutils literal notranslate"><span class="pre">io.TextIOWrapper</span></code></a>

  370. for compressed files and open for normal files.</p>

  371. <p>Usage example:  <code class="docutils literal notranslate"><span class="pre">fi</span> <span class="pre">=</span> <span class="pre">fileinput.FileInput(openhook=fileinput.hook_compressed,</span> <span class="pre">encoding=&quot;utf-8&quot;)</span></code></p>

  372. <div class="versionchanged">

  373. <p><span class="versionmodified changed">Changed in version 3.10: </span>The keyword-only parameter <em>encoding</em> and <em>errors</em> are added.</p>

  374. </div>

  375. </dd></dl>

  376. 

  377. <dl class="py function">

  378. <dt class="sig sig-object py" id="fileinput.hook_encoded">

  379. <span class="sig-prename descclassname"><span class="pre">fileinput.</span></span><span class="sig-name descname"><span class="pre">hook_encoded</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">encoding</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">errors</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#fileinput.hook_encoded" title="Link to this definition">¶</a></dt>

  380. <dd><p>Returns a hook which opens each file with <a class="reference internal" href="functions.html#open" title="open"><code class="xref py py-func docutils literal notranslate"><span class="pre">open()</span></code></a>, using the given

  381. <em>encoding</em> and <em>errors</em> to read the file.</p>

  382. <p>Usage example: <code class="docutils literal notranslate"><span class="pre">fi</span> <span class="pre">=</span>

  383. <span class="pre">fileinput.FileInput(openhook=fileinput.hook_encoded(&quot;utf-8&quot;,</span>

  384. <span class="pre">&quot;surrogateescape&quot;))</span></code></p>

  385. <div class="versionchanged">

  386. <p><span class="versionmodified changed">Changed in version 3.6: </span>Added the optional <em>errors</em> parameter.</p>

  387. </div>

  388. <div class="deprecated">

  389. <p><span class="versionmodified deprecated">Deprecated since version 3.10: </span>This function is deprecated since <a class="reference internal" href="#fileinput.input" title="fileinput.input"><code class="xref py py-func docutils literal notranslate"><span class="pre">fileinput.input()</span></code></a> and <a class="reference internal" href="#fileinput.FileInput" title="fileinput.FileInput"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileInput</span></code></a>

  390. now have <em>encoding</em> and <em>errors</em> parameters.</p>

  391. </div>

  392. </dd></dl>

  393. 

  394. </section>

  395. 

  396. 

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

  398.           </div>

  399.         </div>

  400.       </div>

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

  402.         <div class="sphinxsidebarwrapper">

  403.   <div>

  404.     <h4>Previous topic</h4>

  405.     <p class="topless"><a href="os.path.html"

  406.                           title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">os.path</span></code> — Common pathname manipulations</a></p>

  407.   </div>

  408.   <div>

  409.     <h4>Next topic</h4>

  410.     <p class="topless"><a href="stat.html"

  411.                           title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">stat</span></code> — Interpreting <code class="xref py py-func docutils literal notranslate"><span class="pre">stat()</span></code> results</a></p>

  412.   </div>

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

  414.     <h3>This Page</h3>

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

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

  417.       <li>

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

  419.             rel="nofollow">Show Source

  420.         </a>

  421.       </li>

  422.     </ul>

  423.   </div>

  424.         </div>

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

  426. <span>«</span>

  427. </div>

  428. 

  429.       </div>

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

  431.     </div>  

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

  433.       <h3>Navigation</h3>

  434.       <ul>

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

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

  437.              >index</a></li>

  438.         <li class="right" >

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

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

  441.         <li class="right" >

  442.           <a href="stat.html" title="stat — Interpreting stat() results"

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

  444.         <li class="right" >

  445.           <a href="os.path.html" title="os.path — Common pathname manipulations"

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

  447. 

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

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

  450.           <li class="switchers">

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

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

  453.           </li>

  454.           <li>

  455.               

  456.           </li>

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

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

  459.     </li>

  460. 

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

  462.           <li class="nav-item nav-item-2"><a href="filesys.html" >File and Directory Access</a> &#187;</li>

  463.         <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">fileinput</span></code> — Iterate over lines from multiple input streams</a></li>

  464.                 <li class="right">

  465.                     

  466. 

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

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

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

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

  471.         </form>

  472.     </div>

  473.                      |

  474.                 </li>

  475.             <li class="right">

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

  477.     Theme

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

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

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

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

  482.     </select>

  483. </label> |</li>

  484.             

  485.       </ul>

  486.     </div>  

  487.     <div class="footer">

  488.     &copy; 

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

  490.     

  491.     Copyright

  492.     

  493.       </a>

  494.      2001-2024, Python Software Foundation.

  495.     <br />

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

  497.     <br />

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

  499.     <br />

  500.     

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

  502.     

  503.     

  504.     <br />

  505. 

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

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

  508. <br />

  509.     <br />

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

  511.     

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

  513.     

  514.     <br />

  515. 

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

  517.     </div>

  518. 

  519.   </body>

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