This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: linecache.py::updatecache strips directory info from files
Type: behavior Stage:
Components: Library (Lib) Versions: Python 2.5
process
Status: closed Resolution: duplicate
Dependencies: Superseder: linecache module returns wrong results
View: 1309567
Assigned To: Nosy List: ajaksu2, akuchling, georg.brandl, ndim, tleslie
Priority: normal Keywords:

Created on 2004-11-18 06:32 by tleslie, last changed 2022-04-11 14:56 by admin. This issue is now closed.

Files
File name Uploaded Description Edit
pybug.tar.gz tleslie, 2004-11-18 23:43
Messages (7)
msg23184 - (view) Author: Tim Leslie (tleslie) Date: 2004-11-18 06:32
If a filename couldn't be stat()ed, the code tries to
find it in sys.path. To do this it only takes the
filename and drops any preceding directories.

If the file happens to reside in a package, the name of
the package is lost, which can lead to badness. Eg, if
you have my_package/__init__.py, then just the file
__init__.py will be searched for, which may well be
found in the cache from a different package. This leads
to the wrong file being returned.

This bit me as a result of using pydoc on a set of my
packages. I'll try to put together a minimal example
which demonstates the behaviour.
msg23185 - (view) Author: Tim Leslie (tleslie) Date: 2004-11-18 23:43
Logged In: YES 
user_id=1081664

Running the attached code ( from ~/src, not ~/src/pybug) we
see that the contents of the cache are incorrect).

timl@newton:~/src$ tar -zxvf pybug.tar.gz 
pybug/
pybug/pkg1/
pybug/pkg1/__init__.py
pybug/pkg2/
pybug/pkg2/__init__.py
pybug/bug.py
timl@newton:~/src$ python pybug/bug.py 
{'pkg2/__init__.py': (217L, 1051027884, ['#\n', '# The
Python Imaging Library.\n', '# $Id:
//modules/pil/PIL/__init__.py#2 $\n', '#\n', '# package
placeholder\n', '#\n', '# Copyright (c) 1999 by Secret Labs
AB.\n', '#\n', '# See the README file for information on
usage and redistribution.\n', '#\n', '\n', '# ;-)\n'],
'/usr/lib/python2.3/site-packages/PIL/__init__.py'),
'pkg1/__init__.py': (217L, 1051027884, ['#\n', '# The Python
Imaging Library.\n', '# $Id: //modules/pil/PIL/__init__.py#2
$\n', '#\n', '# package placeholder\n', '#\n', '# Copyright
(c) 1999 by Secret Labs AB.\n', '#\n', '# See the README
file for information on usage and redistribution.\n', '#\n',
'\n', '# ;-)\n'],
'/usr/lib/python2.3/site-packages/PIL/__init__.py')}
timl@newton:~/src$
msg23186 - (view) Author: Tim Leslie (tleslie) Date: 2004-11-19 00:20
Logged In: YES 
user_id=1081664

I can also confirm that this bug exists in python2.4b2.
msg23187 - (view) Author: A.M. Kuchling (akuchling) * (Python committer) Date: 2006-08-03 21:18
Logged In: YES 
user_id=11375

In 2.5trunk, linecache seems to be broken in a different
way; the files are never added to the cache at all, and
getlines() returns an empty list.  

One problem is that, when updatecache searches through
sys.path, it does os.path.join(path, basename), not
filename, so it looks for ./__init__.py, not
./pkg1/__init__.py.  Changing it to filename makes the test
script work in 2.5.

It's not clear if linecache really intends to support
multiple-component filenames, though.  I think it should,
though.


msg69033 - (view) Author: Hans Ulrich Niedermann (ndim) Date: 2008-07-01 00:28
The following issues appear to be the same bug to me:

   http://bugs.python.org/issue1068477
   http://bugs.python.org/issue1309567
   http://bugs.python.org/issue1754483

and are, as of 2008-06-30, unfixed in both rel25-maint and trunk.
msg86547 - (view) Author: Daniel Diniz (ajaksu2) * (Python triager) Date: 2009-04-25 20:29
Confirmed in py3k and trunk as AMK describes it, fixed by the patch in 
issue 1309567.
msg87223 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2009-05-05 08:25
Setting #1309567 as superseder.
History
Date User Action Args
2022-04-11 14:56:08adminsetgithub: 41188
2009-05-05 08:25:21georg.brandlsetnosy: + georg.brandl
messages: + msg87223
2009-05-05 08:21:17georg.brandlsetstatus: open -> closed
resolution: duplicate
dependencies: - linecache module returns wrong results
superseder: linecache module returns wrong results
2009-04-25 20:29:05ajaksu2setnosy: + ajaksu2
messages: + msg86547

dependencies: + linecache module returns wrong results
type: behavior
2008-07-01 00:28:21ndimsetnosy: + ndim
messages: + msg69033
2004-11-18 06:32:39tlesliecreate