linecache2

1.0.0 · maintenance · verified Sat Apr 11

linecache2 is a Python library providing backports of the standard library's `linecache` module to older supported Python versions (specifically Python 2.6, 3.2, 3.3, and 3.4). It enables random access to individual lines from text files, optimizing internally through a cache, similar to the built-in module. The current version is 1.0.0, released in March 2015, and its development status is 'Mature', indicating stability rather than active feature development.

Warnings

gotcha linecache2 is a backport designed for older Python versions (2.6, 3.2, 3.3, 3.4). Using it in modern Python environments (3.5+) is generally unnecessary as the functionality is built-in, and the native `linecache` module might offer newer features or optimizations not present in the backport (e.g., support for frozen modules in Python 3.14).
Fix: For Python versions 3.5 and above, prefer the built-in `linecache` module. Only use `linecache2` if you explicitly target one of its supported older Python versions or if a dependency (like `traceback2`) requires it.
deprecated The library's last release was in March 2015, and it primarily targets Python 2.6 and 3.2-3.4. Given the end-of-life for Python 2 and older Python 3 versions, `linecache2` is effectively deprecated for new development.
Fix: For new projects, target Python 3.5+ and use the standard `linecache` module. If maintaining legacy code on older Python versions, ensure `linecache2` is correctly installed and its specific behaviors are understood, especially its unicode handling in Python 2.x when used by `traceback2`.
gotcha `traceback2`, which also supports older Python versions, depends on `linecache2`. In Python 2.x, `traceback2` creates unicode output, unlike the standard `traceback` module, due to its reliance on `linecache2`. This can lead to different output encoding behaviors in legacy Python 2 applications.
Fix: Be aware of the unicode output when using `linecache2` (or libraries dependent on it like `traceback2`) in Python 2.x. Handle string types carefully, explicitly encoding or decoding as needed, or migrate to Python 3 where unicode handling is more consistent.

Install

pip install linecache2 Install linecache2

Imports

getline
```
from linecache2 import getline
```
While 'linecache' is the standard module, 'linecache2' is a distinct backport. Directly importing from 'linecache2' ensures you use the backported version, especially in environments where its specific behavior (e.g., unicode handling in Python 2.x) might be desired or required by dependent libraries like traceback2.
clearcache
```
from linecache2 import clearcache
```
As with getline, direct import from linecache2 is necessary to interact with the backported module's cache.

Quickstart

This quickstart demonstrates how to use `linecache2` to retrieve specific lines from a file, similar to the standard `linecache` module. It includes examples of `getline` to fetch a line by its number, `checkcache` to update cache entries, and `clearcache` to remove cached data. The core functionality mirrors the standard library, but with compatibility for older Python versions.

import os
from linecache2 import getline, clearcache, checkcache

# Create a dummy file for demonstration
filename = 'example_file.py'
with open(filename, 'w') as f:
    f.write('print("Hello, world!")\n')
    f.write('x = 10\n')
    f.write('y = x + 5\n')
    f.write('print(f"The value of y is {y}")\n')

# Get a specific line from the file
line_2 = getline(filename, 2)
print(f"Line 2: {line_2.strip()}")

# Check if the cache needs updating (e.g., if the file changed on disk)
checkcache(filename)

# Clear the cache for a specific file or entirely
clearcache(filename)

# Verify line is empty after clearing cache (unless re-read)
# line_2_after_clear = getline(filename, 2) # This would re-read and cache it again

# Clean up the dummy file
os.remove(filename)

view raw JSON →