More documentation for the imp module

[jhorneman]

BPO	616247
Nosy	@brettcannon, @rhettinger, @facundobatista

^{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 = 'https://github.com/brettcannon'
closed_at = <Date 2009-04-02.05:43:21.038>
created_at = <Date 2002-09-29.19:58:55.000>
labels = ['type-feature', 'docs']
title = 'More documentation for the imp module'
updated_at = <Date 2009-04-02.05:43:21.036>
user = 'https://bugs.python.org/jhorneman'

bugs.python.org fields:

activity = <Date 2009-04-02.05:43:21.036>
actor = 'brett.cannon'
assignee = 'brett.cannon'
closed = True
closed_date = <Date 2009-04-02.05:43:21.038>
closer = 'brett.cannon'
components = ['Documentation']
creation = <Date 2002-09-29.19:58:55.000>
creator = 'jhorneman'
dependencies = []
files = []
hgrepos = []
issue_num = 616247
keywords = []
message_count = 4.0
messages = ['53633', '53634', '60141', '85170']
nosy_count = 5.0
nosy_names = ['brett.cannon', 'rhettinger', 'jvr', 'facundobatista', 'jhorneman']
pr_nums = []
priority = 'low'
resolution = 'wont fix'
stage = 'needs patch'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue616247'
versions = ['Python 3.1', 'Python 2.7']

[jhorneman]

Not all of the public functions of the imp module appear to be
documented (in section 3.21, Python version
2.2).

get_frozen_object
load_package
PY_CODERESOURCE

are
not documented.

Also, the documentation for
load_module() can be a bit confusing, partially due to inconsistent
use of the word pairs 'tuple' / 'triple' and 'pathname' /
'filename'.

(I did not need the abovementioned public
functions, but while struggling with this module I noticed them and
wondered if the documentation was outdated, or whether they held
the key to my success.)

[rhettinger]

Logged In: YES
user_id=80475

I believe both functions are obsolete and are subsumed by
load_module() and find_module(). I don't know about
Py_CODERESOURCE (it is MacIntosh specific).

Referring to jvr for disposition on the first two and then to
Jack for the third.

[facundobatista]

If those two are obsolete, we may add a DeprecationWarning in 2.6 and
hide/remove them in 2.7.

What do you think?

[brettcannon]

As Raymond pointed out, people should not use the undocumented
functions. Deprecation should be a separate issue.