cpython/Lib/linecache.py

102 lines
2.7 KiB
Python
Raw Normal View History

"""Cache lines from 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
that name.
"""
1992-01-10 10:54:42 -04:00
import sys
1992-01-10 10:54:42 -04:00
import os
from stat import *
2001-01-24 02:27:27 -04:00
__all__ = ["getline","clearcache","checkcache"]
1992-01-10 10:54:42 -04:00
def getline(filename, lineno):
lines = getlines(filename)
if 1 <= lineno <= len(lines):
return lines[lineno-1]
else:
return ''
1992-01-10 10:54:42 -04:00
# The cache
cache = {} # The cache
def clearcache():
"""Clear the cache entirely."""
1992-01-10 10:54:42 -04:00
global cache
cache = {}
1992-01-10 10:54:42 -04:00
def getlines(filename):
"""Get the lines for a file from the cache.
Update the cache if it doesn't contain an entry for this file already."""
1992-01-10 10:54:42 -04:00
if cache.has_key(filename):
return cache[filename][2]
else:
return updatecache(filename)
1992-01-10 10:54:42 -04:00
def checkcache():
"""Discard cache entries that are out of date.
(This is not checked upon each call!)"""
1992-01-10 10:54:42 -04:00
for filename in cache.keys():
size, mtime, lines, fullname = cache[filename]
try:
stat = os.stat(fullname)
except os.error:
del cache[filename]
continue
if size != stat[ST_SIZE] or mtime != stat[ST_MTIME]:
del cache[filename]
1992-01-10 10:54:42 -04:00
def updatecache(filename):
"""Update a cache entry and return its list of lines.
If something's wrong, print a message, discard the cache entry,
and return an empty list."""
if cache.has_key(filename):
del cache[filename]
if not filename or filename[0] + filename[-1] == '<>':
return []
fullname = filename
try:
stat = os.stat(fullname)
except os.error, msg:
# Try looking through the module search path.
basename = os.path.split(filename)[1]
for dirname in sys.path:
# When using imputil, sys.path may contain things other than
# strings; ignore them when it happens.
try:
fullname = os.path.join(dirname, basename)
except (TypeError, AttributeError):
# Not sufficiently string-like to do anything useful with.
pass
else:
try:
stat = os.stat(fullname)
break
except os.error:
pass
else:
# No luck
## print '*** Cannot stat', filename, ':', msg
return []
try:
fp = open(fullname, 'rU')
lines = fp.readlines()
fp.close()
except IOError, msg:
## print '*** Cannot open', fullname, ':', msg
return []
size, mtime = stat[ST_SIZE], stat[ST_MTIME]
cache[filename] = size, mtime, lines, fullname
return lines