diff options
author | cinap_lenrek <cinap_lenrek@localhost> | 2011-05-03 11:25:13 +0000 |
---|---|---|
committer | cinap_lenrek <cinap_lenrek@localhost> | 2011-05-03 11:25:13 +0000 |
commit | 458120dd40db6b4df55a4e96b650e16798ef06a0 (patch) | |
tree | 8f82685be24fef97e715c6f5ca4c68d34d5074ee /sys/src/cmd/python/Doc/lib/liblinecache.tex | |
parent | 3a742c699f6806c1145aea5149bf15de15a0afd7 (diff) |
add hg and python
Diffstat (limited to 'sys/src/cmd/python/Doc/lib/liblinecache.tex')
-rw-r--r-- | sys/src/cmd/python/Doc/lib/liblinecache.tex | 50 |
1 files changed, 50 insertions, 0 deletions
diff --git a/sys/src/cmd/python/Doc/lib/liblinecache.tex b/sys/src/cmd/python/Doc/lib/liblinecache.tex new file mode 100644 index 000000000..72c774341 --- /dev/null +++ b/sys/src/cmd/python/Doc/lib/liblinecache.tex @@ -0,0 +1,50 @@ +\section{\module{linecache} --- + Random access to text lines} + +\declaremodule{standard}{linecache} +\sectionauthor{Moshe Zadka}{moshez@zadka.site.co.il} +\modulesynopsis{This module provides random access to individual lines + from text files.} + + +The \module{linecache} module allows one to get any line from any 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 +\refmodule{traceback} module to retrieve source lines for inclusion in +the formatted traceback. + +The \module{linecache} module defines the following functions: + +\begin{funcdesc}{getline}{filename, lineno\optional{, module_globals}} +Get line \var{lineno} from file named \var{filename}. This function +will never throw an exception --- it will return \code{''} on errors +(the terminating newline character will be included for lines that are +found). + +If a file named \var{filename} is not found, the function will look +for it in the module\indexiii{module}{search}{path} search path, +\code{sys.path}, after first checking for a \pep{302} \code{__loader__} +in \var{module_globals}, in case the module was imported from a zipfile +or other non-filesystem import source. + +\versionadded[The \var{module_globals} parameter was added]{2.5} +\end{funcdesc} + +\begin{funcdesc}{clearcache}{} +Clear the cache. Use this function if you no longer need lines from +files previously read using \function{getline()}. +\end{funcdesc} + +\begin{funcdesc}{checkcache}{\optional{filename}} +Check the cache for validity. Use this function if files in the cache +may have changed on disk, and you require the updated version. If +\var{filename} is omitted, it will check all the entries in the cache. +\end{funcdesc} + +Example: + +\begin{verbatim} +>>> import linecache +>>> linecache.getline('/etc/passwd', 4) +'sys:x:3:3:sys:/dev:/bin/sh\n' +\end{verbatim} |