parthtamu/rag-code-assistant
0
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="linecache — Random access to text lines" />8<meta property="og:type" content="website" />9<meta property="og:url" content="https://docs.python.org/3/library/linecache.html" />10<meta property="og:site_name" content="Python documentation" />11<meta property="og:description" content="Source code: Lib/linecache.py The linecache module allows one to get any line from a Python source file, while attempting to optimize internally, using a cache, the common case where many lines are..." />12<meta property="og:image:width" content="1146" />13<meta property="og:image:height" content="600" />14<meta property="og:image" content="https://docs.python.org/3.15/_images/social_previews/summary_library_linecache_0b7a1e3b.png" />15<meta property="og:image:alt" content="Source code: Lib/linecache.py The linecache module allows one to get any line from a Python source file, while attempting to optimize internally, using a cache, the common case where many lines are..." />16<meta name="description" content="Source code: Lib/linecache.py The linecache module allows one to get any line from a Python source file, while attempting to optimize internally, using a cache, the common case where many lines are..." />17<meta name="twitter:card" content="summary_large_image" />18<meta name="theme-color" content="#3776ab">19 20 <title>linecache — Random access to text lines — Python 3.15.0a6 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">21 22 <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b86133f3" />23 <link rel="stylesheet" type="text/css" href="../_static/classic.css?v=234b1a7c" />24 <link rel="stylesheet" type="text/css" href="../_static/pydoctheme.css?v=89a2f22a" />25 <link rel="stylesheet" type="text/css" href="../_static/profiling-sampling-visualization.css?v=0c2600ae" />26 <link id="pygments_dark_css" media="(prefers-color-scheme: dark)" rel="stylesheet" type="text/css" href="../_static/pygments_dark.css?v=5349f25f" />27 28 <script src="../_static/documentation_options.js?v=6b7c9ff5"></script>29 <script src="../_static/doctools.js?v=9bcbadda"></script>30 <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>31 <script src="../_static/profiling-sampling-visualization.js?v=9811ed04"></script>32 33 <script src="../_static/sidebar.js"></script>34 35 <link rel="search" type="application/opensearchdescription+xml"36 title="Search within Python 3.15.0a6 documentation"37 href="../_static/opensearch.xml"/>38 <link rel="author" title="About these documents" href="../about.html" />39 <link rel="index" title="Index" href="../genindex.html" />40 <link rel="search" title="Search" href="../search.html" />41 <link rel="copyright" title="Copyright" href="../copyright.html" />42 <link rel="next" title="shutil — High-level file operations" href="shutil.html" />43 <link rel="prev" title="fnmatch — Unix filename pattern matching" href="fnmatch.html" />44 45 46 <script defer file-types="bz2,epub,zip" data-domain="docs.python.org" src="https://analytics.python.org/js/script.file-downloads.outbound-links.js"></script>47 48 <link rel="canonical" href="https://docs.python.org/3/library/linecache.html">49 50 51 52 53 <style>54 @media only screen {55 table.full-width-table {56 width: 100%;57 }58 }59 </style>60<link rel="stylesheet" href="../_static/pydoctheme_dark.css" media="(prefers-color-scheme: dark)" id="pydoctheme_dark_css">61 <link rel="shortcut icon" type="image/png" href="../_static/py.svg">62 <script type="text/javascript" src="../_static/copybutton.js"></script>63 <script type="text/javascript" src="../_static/menu.js"></script>64 <script type="text/javascript" src="../_static/search-focus.js"></script>65 <script type="text/javascript" src="../_static/themetoggle.js"></script> 66 <script type="text/javascript" src="../_static/rtd_switcher.js"></script>67 <meta name="readthedocs-addons-api-version" content="1">68 69 </head>70<body>71<div class="mobile-nav">72 <input type="checkbox" id="menuToggler" class="toggler__input" aria-controls="navigation"73 aria-pressed="false" aria-expanded="false" role="button" aria-label="Menu">74 <nav class="nav-content" role="navigation">75 <label for="menuToggler" class="toggler__label">76 <span></span>77 </label>78 <span class="nav-items-wrapper">79 <a href="https://www.python.org/" class="nav-logo">80 <img src="../_static/py.svg" alt="Python logo">81 </a>82 <span class="version_switcher_placeholder"></span>83 <form role="search" class="search" action="../search.html" method="get">84 <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" class="search-icon">85 <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>86 </svg>87 <input placeholder="Quick search" aria-label="Quick search" type="search" name="q">88 <input type="submit" value="Go">89 </form>90 </span>91 </nav>92 <div class="menu-wrapper">93 <nav class="menu" role="navigation" aria-label="main navigation">94 <div class="language_switcher_placeholder"></div>95 96<label class="theme-selector-label">97 Theme98 <select class="theme-selector" oninput="activateTheme(this.value)">99 <option value="auto" selected>Auto</option>100 <option value="light">Light</option>101 <option value="dark">Dark</option>102 </select>103</label>104 <div>105 <h4>Previous topic</h4>106 <p class="topless"><a href="fnmatch.html"107 title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">fnmatch</span></code> — Unix filename pattern matching</a></p>108 </div>109 <div>110 <h4>Next topic</h4>111 <p class="topless"><a href="shutil.html"112 title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">shutil</span></code> — High-level file operations</a></p>113 </div>114 <script>115 document.addEventListener('DOMContentLoaded', () => {116 const title = document.querySelector('meta[property="og:title"]').content;117 const elements = document.querySelectorAll('.improvepage');118 const pageurl = window.location.href.split('?')[0];119 elements.forEach(element => {120 const url = new URL(element.href.split('?')[0].replace("-nojs", ""));121 url.searchParams.set('pagetitle', title);122 url.searchParams.set('pageurl', pageurl);123 url.searchParams.set('pagesource', "library/linecache.rst");124 element.href = url.toString();125 });126 });127 </script>128 <div role="note" aria-label="source link">129 <h3>This page</h3>130 <ul class="this-page-menu">131 <li><a href="../bugs.html">Report a bug</a></li>132 <li><a class="improvepage" href="../improve-page-nojs.html">Improve this page</a></li>133 <li>134 <a href="https://github.com/python/cpython/blob/main/Doc/library/linecache.rst?plain=1"135 rel="nofollow">Show source136 </a>137 </li>138 139 </ul>140 </div>141 </nav>142 </div>143</div>144 145 146 <div class="related" role="navigation" aria-label="Related">147 <h3>Navigation</h3>148 <ul>149 <li class="right" style="margin-right: 10px">150 <a href="../genindex.html" title="General Index"151 accesskey="I">index</a></li>152 <li class="right" >153 <a href="../py-modindex.html" title="Python Module Index"154 >modules</a> |</li>155 <li class="right" >156 <a href="shutil.html" title="shutil — High-level file operations"157 accesskey="N">next</a> |</li>158 <li class="right" >159 <a href="fnmatch.html" title="fnmatch — Unix filename pattern matching"160 accesskey="P">previous</a> |</li>161 162 <li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"></li>163 <li><a href="https://www.python.org/">Python</a> »</li>164 <li class="switchers">165 <div class="language_switcher_placeholder"></div>166 <div class="version_switcher_placeholder"></div>167 </li>168 <li>169 170 </li>171 <li id="cpython-language-and-version">172 <a href="../index.html">3.15.0a6 Documentation</a> »173 </li>174 175 <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> »</li>176 <li class="nav-item nav-item-2"><a href="filesys.html" accesskey="U">File and Directory Access</a> »</li>177 <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">linecache</span></code> — Random access to text lines</a></li>178 <li class="right">179 180 181 <div class="inline-search" role="search">182 <form class="inline-search" action="../search.html" method="get">183 <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box">184 <input type="submit" value="Go">185 </form>186 </div>187 |188 </li>189 <li class="right">190<label class="theme-selector-label">191 Theme192 <select class="theme-selector" oninput="activateTheme(this.value)">193 <option value="auto" selected>Auto</option>194 <option value="light">Light</option>195 <option value="dark">Dark</option>196 </select>197</label> |</li>198 199 </ul>200 </div> 201 202 <div class="document">203 <div class="documentwrapper">204 <div class="bodywrapper">205 <div class="body" role="main">206 207 <section id="module-linecache">208<span id="linecache-random-access-to-text-lines"></span><h1><code class="xref py py-mod docutils literal notranslate"><span class="pre">linecache</span></code> — Random access to text lines<a class="headerlink" href="#module-linecache" title="Link to this heading">¶</a></h1>209<p><strong>Source code:</strong> <a class="extlink-source reference external" href="https://github.com/python/cpython/tree/main/Lib/linecache.py">Lib/linecache.py</a></p>210<hr class="docutils" />211<p>The <code class="xref py py-mod docutils literal notranslate"><span class="pre">linecache</span></code> module allows one to get any line from a Python source file, while212attempting to optimize internally, using a cache, the common case where many213lines are read from a single file. This is used by the <a class="reference internal" href="traceback.html#module-traceback" title="traceback: Print or retrieve a stack traceback."><code class="xref py py-mod docutils literal notranslate"><span class="pre">traceback</span></code></a> module214to retrieve source lines for inclusion in the formatted traceback.</p>215<p>The <a class="reference internal" href="tokenize.html#tokenize.open" title="tokenize.open"><code class="xref py py-func docutils literal notranslate"><span class="pre">tokenize.open()</span></code></a> function is used to open files. This216function uses <a class="reference internal" href="tokenize.html#tokenize.detect_encoding" title="tokenize.detect_encoding"><code class="xref py py-func docutils literal notranslate"><span class="pre">tokenize.detect_encoding()</span></code></a> to get the encoding of the217file; in the absence of an encoding token, the file encoding defaults to UTF-8.</p>218<p>The <code class="xref py py-mod docutils literal notranslate"><span class="pre">linecache</span></code> module defines the following functions:</p>219<dl class="py function">220<dt class="sig sig-object py" id="linecache.getline">221<span class="sig-prename descclassname"><span class="pre">linecache.</span></span><span class="sig-name descname"><span class="pre">getline</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">lineno</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">module_globals</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="#linecache.getline" title="Link to this definition">¶</a></dt>222<dd><p>Get line <em>lineno</em> from file named <em>filename</em>. This function will never raise an223exception — it will return <code class="docutils literal notranslate"><span class="pre">''</span></code> on errors (the terminating newline character224will be included for lines that are found).</p>225<p id="index-0">If <em>filename</em> indicates a frozen module (starting with <code class="docutils literal notranslate"><span class="pre">'<frozen</span> <span class="pre">'</span></code>), the function226will attempt to get the real file name from <code class="docutils literal notranslate"><span class="pre">module_globals['__file__']</span></code> if227<em>module_globals</em> is not <code class="docutils literal notranslate"><span class="pre">None</span></code>.</p>228<p>If a file named <em>filename</em> is not found, the function first checks229for a <span class="target" id="index-1"></span><a class="pep reference external" href="https://peps.python.org/pep-0302/"><strong>PEP 302</strong></a> <code class="docutils literal notranslate"><span class="pre">__loader__</span></code> in <em>module_globals</em>.230If there is such a loader and it defines a <code class="docutils literal notranslate"><span class="pre">get_source</span></code> method,231then that determines the source lines232(if <code class="docutils literal notranslate"><span class="pre">get_source()</span></code> returns <code class="docutils literal notranslate"><span class="pre">None</span></code>, then <code class="docutils literal notranslate"><span class="pre">''</span></code> is returned).233Finally, if <em>filename</em> is a relative filename,234it is looked up relative to the entries in the module search path, <code class="docutils literal notranslate"><span class="pre">sys.path</span></code>.</p>235<div class="versionchanged">236<p><span class="versionmodified changed">Changed in version 3.14: </span>Support <em>filename</em> of frozen modules.</p>237</div>238</dd></dl>239 240<dl class="py function">241<dt class="sig sig-object py" id="linecache.clearcache">242<span class="sig-prename descclassname"><span class="pre">linecache.</span></span><span class="sig-name descname"><span class="pre">clearcache</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#linecache.clearcache" title="Link to this definition">¶</a></dt>243<dd><p>Clear the cache. Use this function if you no longer need lines from files244previously read using <a class="reference internal" href="#linecache.getline" title="linecache.getline"><code class="xref py py-func docutils literal notranslate"><span class="pre">getline()</span></code></a>.</p>245</dd></dl>246 247<dl class="py function">248<dt class="sig sig-object py" id="linecache.checkcache">249<span class="sig-prename descclassname"><span class="pre">linecache.</span></span><span class="sig-name descname"><span class="pre">checkcache</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filename</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="#linecache.checkcache" title="Link to this definition">¶</a></dt>250<dd><p>Check the cache for validity. Use this function if files in the cache may have251changed on disk, and you require the updated version. If <em>filename</em> is omitted,252it will check all the entries in the cache.</p>253</dd></dl>254 255<dl class="py function">256<dt class="sig sig-object py" id="linecache.lazycache">257<span class="sig-prename descclassname"><span class="pre">linecache.</span></span><span class="sig-name descname"><span class="pre">lazycache</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">module_globals</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#linecache.lazycache" title="Link to this definition">¶</a></dt>258<dd><p>Capture enough detail about a non-file-based module to permit getting its259lines later via <a class="reference internal" href="#linecache.getline" title="linecache.getline"><code class="xref py py-func docutils literal notranslate"><span class="pre">getline()</span></code></a> even if <em>module_globals</em> is <code class="docutils literal notranslate"><span class="pre">None</span></code> in the later260call. This avoids doing I/O until a line is actually needed, without having261to carry the module globals around indefinitely.</p>262<div class="versionadded">263<p><span class="versionmodified added">Added in version 3.5.</span></p>264</div>265</dd></dl>266 267<p>Example:</p>268<div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">import</span><span class="w"> </span><span class="nn">linecache</span>269<span class="gp">>>> </span><span class="n">linecache</span><span class="o">.</span><span class="n">getline</span><span class="p">(</span><span class="n">linecache</span><span class="o">.</span><span class="vm">__file__</span><span class="p">,</span> <span class="mi">8</span><span class="p">)</span>270<span class="go">'import sys\n'</span>271</pre></div>272</div>273</section>274 275 276 <div class="clearer"></div>277 </div>278 </div>279 </div>280 <div class="sphinxsidebar" role="navigation" aria-label="Main">281 <div class="sphinxsidebarwrapper">282 <div>283 <h4>Previous topic</h4>284 <p class="topless"><a href="fnmatch.html"285 title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">fnmatch</span></code> — Unix filename pattern matching</a></p>286 </div>287 <div>288 <h4>Next topic</h4>289 <p class="topless"><a href="shutil.html"290 title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">shutil</span></code> — High-level file operations</a></p>291 </div>292 <script>293 document.addEventListener('DOMContentLoaded', () => {294 const title = document.querySelector('meta[property="og:title"]').content;295 const elements = document.querySelectorAll('.improvepage');296 const pageurl = window.location.href.split('?')[0];297 elements.forEach(element => {298 const url = new URL(element.href.split('?')[0].replace("-nojs", ""));299 url.searchParams.set('pagetitle', title);300 url.searchParams.set('pageurl', pageurl);301 url.searchParams.set('pagesource', "library/linecache.rst");302 element.href = url.toString();303 });304 });305 </script>306 <div role="note" aria-label="source link">307 <h3>This page</h3>308 <ul class="this-page-menu">309 <li><a href="../bugs.html">Report a bug</a></li>310 <li><a class="improvepage" href="../improve-page-nojs.html">Improve this page</a></li>311 <li>312 <a href="https://github.com/python/cpython/blob/main/Doc/library/linecache.rst?plain=1"313 rel="nofollow">Show source314 </a>315 </li>316 317 </ul>318 </div>319 </div>320<div id="sidebarbutton" title="Collapse sidebar">321<span>«</span>322</div>323 324 </div>325 <div class="clearer"></div>326 </div> 327 <div class="related" role="navigation" aria-label="Related">328 <h3>Navigation</h3>329 <ul>330 <li class="right" style="margin-right: 10px">331 <a href="../genindex.html" title="General Index"332 >index</a></li>333 <li class="right" >334 <a href="../py-modindex.html" title="Python Module Index"335 >modules</a> |</li>336 <li class="right" >337 <a href="shutil.html" title="shutil — High-level file operations"338 >next</a> |</li>339 <li class="right" >340 <a href="fnmatch.html" title="fnmatch — Unix filename pattern matching"341 >previous</a> |</li>342 343 <li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"></li>344 <li><a href="https://www.python.org/">Python</a> »</li>345 <li class="switchers">346 <div class="language_switcher_placeholder"></div>347 <div class="version_switcher_placeholder"></div>348 </li>349 <li>350 351 </li>352 <li id="cpython-language-and-version">353 <a href="../index.html">3.15.0a6 Documentation</a> »354 </li>355 356 <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> »</li>357 <li class="nav-item nav-item-2"><a href="filesys.html" >File and Directory Access</a> »</li>358 <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">linecache</span></code> — Random access to text lines</a></li>359 <li class="right">360 361 362 <div class="inline-search" role="search">363 <form class="inline-search" action="../search.html" method="get">364 <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box">365 <input type="submit" value="Go">366 </form>367 </div>368 |369 </li>370 <li class="right">371<label class="theme-selector-label">372 Theme373 <select class="theme-selector" oninput="activateTheme(this.value)">374 <option value="auto" selected>Auto</option>375 <option value="light">Light</option>376 <option value="dark">Dark</option>377 </select>378</label> |</li>379 380 </ul>381 </div> 382 <div class="footer">383 © <a href="../copyright.html">Copyright</a> 2001 Python Software Foundation.384 <br>385 This page is licensed under the Python Software Foundation License Version 2.386 <br>387 Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.388 <br>389 390 See <a href="/license.html">History and License</a> for more information.<br>391 392 393 <br>394 395 The Python Software Foundation is a non-profit corporation.396<a href="https://www.python.org/psf/donations/">Please donate.</a>397<br>398 <br>399 Last updated on Mar 10, 2026 (08:58 UTC).400 401 <a href="/bugs.html">Found a bug</a>?402 403 <br>404 405 Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.406 </div>407 408 </body>409</html>