2000-02-04 15:10:34 +00:00
|
|
|
"""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 14:54:42 +00:00
|
|
|
|
1992-03-27 15:12:43 +00:00
|
|
|
import sys
|
1992-01-10 14:54:42 +00:00
|
|
|
import os
|
|
|
|
|
2003-06-29 16:59:43 +00:00
|
|
|
__all__ = ["getline", "clearcache", "checkcache"]
|
2001-01-24 06:27:27 +00:00
|
|
|
|
1992-01-10 14:54:42 +00:00
|
|
|
def getline(filename, lineno):
|
2000-02-04 15:10:34 +00:00
|
|
|
lines = getlines(filename)
|
|
|
|
if 1 <= lineno <= len(lines):
|
|
|
|
return lines[lineno-1]
|
|
|
|
else:
|
|
|
|
return ''
|
1992-01-10 14:54:42 +00:00
|
|
|
|
|
|
|
|
|
|
|
# The cache
|
|
|
|
|
|
|
|
cache = {} # The cache
|
|
|
|
|
|
|
|
|
|
|
|
def clearcache():
|
2000-02-04 15:10:34 +00:00
|
|
|
"""Clear the cache entirely."""
|
1992-01-10 14:54:42 +00:00
|
|
|
|
2000-02-04 15:10:34 +00:00
|
|
|
global cache
|
|
|
|
cache = {}
|
1992-01-10 14:54:42 +00:00
|
|
|
|
|
|
|
|
|
|
|
def getlines(filename):
|
2000-02-04 15:10:34 +00:00
|
|
|
"""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 14:54:42 +00:00
|
|
|
|
2002-06-01 14:18:47 +00:00
|
|
|
if filename in cache:
|
2000-02-04 15:10:34 +00:00
|
|
|
return cache[filename][2]
|
|
|
|
else:
|
|
|
|
return updatecache(filename)
|
1992-01-10 14:54:42 +00:00
|
|
|
|
|
|
|
|
|
|
|
def checkcache():
|
2000-02-04 15:10:34 +00:00
|
|
|
"""Discard cache entries that are out of date.
|
|
|
|
(This is not checked upon each call!)"""
|
1992-01-10 14:54:42 +00:00
|
|
|
|
2000-02-04 15:10:34 +00:00
|
|
|
for filename in cache.keys():
|
|
|
|
size, mtime, lines, fullname = cache[filename]
|
|
|
|
try:
|
|
|
|
stat = os.stat(fullname)
|
|
|
|
except os.error:
|
|
|
|
del cache[filename]
|
|
|
|
continue
|
2002-06-01 19:51:15 +00:00
|
|
|
if size != stat.st_size or mtime != stat.st_mtime:
|
2000-02-04 15:10:34 +00:00
|
|
|
del cache[filename]
|
1992-01-10 14:54:42 +00:00
|
|
|
|
|
|
|
|
|
|
|
def updatecache(filename):
|
2000-02-04 15:10:34 +00:00
|
|
|
"""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."""
|
|
|
|
|
2002-06-01 14:18:47 +00:00
|
|
|
if filename in cache:
|
2000-02-04 15:10:34 +00:00
|
|
|
del cache[filename]
|
|
|
|
if not filename or filename[0] + filename[-1] == '<>':
|
|
|
|
return []
|
|
|
|
fullname = filename
|
|
|
|
try:
|
|
|
|
stat = os.stat(fullname)
|
|
|
|
except os.error, msg:
|
2001-05-29 04:27:01 +00:00
|
|
|
# Try looking through the module search path.
|
2000-02-04 15:10:34 +00:00
|
|
|
basename = os.path.split(filename)[1]
|
|
|
|
for dirname in sys.path:
|
2001-05-29 04:27:01 +00:00
|
|
|
# When using imputil, sys.path may contain things other than
|
|
|
|
# strings; ignore them when it happens.
|
2000-02-04 15:10:34 +00:00
|
|
|
try:
|
2001-05-29 04:27:01 +00:00
|
|
|
fullname = os.path.join(dirname, basename)
|
|
|
|
except (TypeError, AttributeError):
|
|
|
|
# Not sufficiently string-like to do anything useful with.
|
2000-02-04 15:10:34 +00:00
|
|
|
pass
|
2001-05-29 04:27:01 +00:00
|
|
|
else:
|
|
|
|
try:
|
|
|
|
stat = os.stat(fullname)
|
|
|
|
break
|
|
|
|
except os.error:
|
|
|
|
pass
|
2000-02-04 15:10:34 +00:00
|
|
|
else:
|
|
|
|
# No luck
|
|
|
|
## print '*** Cannot stat', filename, ':', msg
|
|
|
|
return []
|
|
|
|
try:
|
2002-04-14 20:12:41 +00:00
|
|
|
fp = open(fullname, 'rU')
|
2000-02-04 15:10:34 +00:00
|
|
|
lines = fp.readlines()
|
|
|
|
fp.close()
|
|
|
|
except IOError, msg:
|
|
|
|
## print '*** Cannot open', fullname, ':', msg
|
|
|
|
return []
|
2002-06-01 19:51:15 +00:00
|
|
|
size, mtime = stat.st_size, stat.st_mtime
|
2000-02-04 15:10:34 +00:00
|
|
|
cache[filename] = size, mtime, lines, fullname
|
|
|
|
return lines
|