diff options
| -rw-r--r-- | Doc/library/linecache.rst | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/Doc/library/linecache.rst b/Doc/library/linecache.rst index 12d0113..52e3339 100644 --- a/Doc/library/linecache.rst +++ b/Doc/library/linecache.rst @@ -9,11 +9,15 @@ -------------- -The :mod:`linecache` module allows one to get any line from any file, while +The :mod:`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 read from a single file. This is used by the :mod:`traceback` module to retrieve source lines for inclusion in the formatted traceback. +The :func:`tokenize.open` function is used to open Python source files. This +function uses :func:`tokenize.detect_encoding` to get the encoding of the +Python source file. + The :mod:`linecache` module defines the following functions: @@ -57,4 +61,3 @@ Example:: >>> import linecache >>> linecache.getline('/etc/passwd', 4) 'sys:x:3:3:sys:/dev:/bin/sh\n' - |