From 376658fa13f5c56a89a47ced0c5a88c43ce508b7 Mon Sep 17 00:00:00 2001 From: Victor Stinner Date: Wed, 18 Mar 2015 14:16:50 +0100 Subject: Issue #11726: Fix linecache example in the doc Use a Python source file (linecache.__file__) instead of /etc/passwd. Modify also linecache docstrings to clarify the linecache is written to cache Python source files, not any text files. --- Doc/library/linecache.rst | 4 ++-- Lib/linecache.py | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/Doc/library/linecache.rst b/Doc/library/linecache.rst index 0c096ad..e9ec801 100644 --- a/Doc/library/linecache.rst +++ b/Doc/library/linecache.rst @@ -51,5 +51,5 @@ The :mod:`linecache` module defines the following functions: Example:: >>> import linecache - >>> linecache.getline('/etc/passwd', 4) - 'sys:x:3:3:sys:/dev:/bin/sh\n' + >>> linecache.getline(linecache.__file__, 8) + 'import sys\n' diff --git a/Lib/linecache.py b/Lib/linecache.py index 02a9eb5..e505b03 100644 --- a/Lib/linecache.py +++ b/Lib/linecache.py @@ -1,4 +1,4 @@ -"""Cache lines from files. +"""Cache lines from Python source files. This is intended to read lines from modules imported -- hence if a filename is not found, it will look down the module search path for a file by @@ -32,7 +32,7 @@ def clearcache(): def getlines(filename, module_globals=None): - """Get the lines for a file from the cache. + """Get the lines for a Python source file from the cache. Update the cache if it doesn't contain an entry for this file already.""" if filename in cache: -- cgit v0.12