pyficache 0.2.5

Cache lines and file information which are generally Python programs

SYNOPSIS

The pyficache module allows one to get any line from any file, caching lines of the file on first access to the file. Although the file may be any file, the common use is when the file is a Python script since parsing of the file is done to figure out where the statement boundaries are when the file is syntax-highlighted. The syntax-highlighted lines are cached along with the plain text.

The routines here may be is useful when a small random sets of lines are read from a single file, in particular in a debugger to show source lines.

A file path can be remapped to another path. This is useful for example when debugging remotely and the remote file path may be different from the path on a local filesystem. In the trepan debugger, eval and exec strings are saved in a temporary file and then the pseudo-filename <string> is remapped to that temporary file name.

Similarly lines within a file can be remapped to other lines. This may be useful in preprocessors or template systems where ones wants to make a correspondence between the template file and the expanded Python file as seen in a tool using that underlying Python file such as a debugger or profiler.

Summary

import pyficache
lines = pyficache.getlines('/tmp/myprogram.py')
line = pyficache.getline('/tmp/myprogram.py', 6)
if len(lines) >= 6:
  assert lines[6] == line

pyficache.remap_file('/tmp/myprogram.py', 'another-name')
line_from_alias = pyficache.getline('another-name', 6)
if len(lines) >= 6:
  assert lines[6] == line_from_alias

assert '/tmp/myprogram.py', pyficache.remove_remap_file('another-name')
# another-name is no longer an alias for /tmp/myprogram
assert None, pyficache.remove_remap_file('another-name')

pyficache.clear_file_cache()
pyficache.clear_file_cache('/tmp/myprogram.py')
pyficache.update_cache()   # Check for modifications of all cached files.

Credits

This is a port of the my Ruby linecache module which in turn is based on the Python linecache module.

coverage provides the cool stuff to figure out lines where there statements.

Other stuff

Author: Rocky Bernstein <[e-mail]> License: Copyright (c) 2009, 2015 Rocky Bernstein. Released under the GNU GPL 3 license