Missing getlines func documentation from linecache module

[khalidmammadov]

BPO	39180
Nosy	@tirkarthi, @khalidmammadov
PRs	bpo-39180: Added getlines function to docs for linecache module #17784

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2020-02-22.19:44:30.977>
created_at = <Date 2020-01-01.14:29:09.540>
labels = ['3.8', 'docs']
title = 'Missing getlines func documentation from linecache module'
updated_at = <Date 2020-02-22.19:47:28.889>
user = 'https://github.com/khalidmammadov'

bugs.python.org fields:

activity = <Date 2020-02-22.19:47:28.889>
actor = 'khalidmammadov'
assignee = 'docs@python'
closed = True
closed_date = <Date 2020-02-22.19:44:30.977>
closer = 'khalidmammadov'
components = ['Documentation']
creation = <Date 2020-01-01.14:29:09.540>
creator = 'khalidmammadov'
dependencies = []
files = []
hgrepos = []
issue_num = 39180
keywords = ['patch']
message_count = 4.0
messages = ['359159', '362472', '362473', '362474']
nosy_count = 3.0
nosy_names = ['docs@python', 'xtreak', 'khalidmammadov']
pr_nums = ['17784']
priority = 'normal'
resolution = 'duplicate'
stage = 'resolved'
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue39180'
versions = ['Python 3.8']

[tirkarthi]

As a note getlines is not exposed via __all__ :

cpython/Lib/linecache.py

Line 13 in 22424c0

__all__ = ["getline", "clearcache", "checkcache"]

[khalidmammadov]

How to find if it was intentional or over-site?

[ammaraskar]

A good place to start is looking at the blame to find the commit that introduced it. Which was:

17ab123#diff-71666751dc5821f7fc30e9c8138019c9

and if we browse to the state of the file before that commit we see:

cpython/Lib/linecache.py

Lines 32 to 39 in bbd89b6

	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."""
	if cache.has_key(filename):
	return cache[filename][2]
	else:
	return updatecache(filename)

which indicates that it used to be exposed but was maybe overlooked when __all__ was added.

[khalidmammadov]

Looks like it's not meant to be made public as the module is meant to be working on a single line. So closing the issue and PR