pydoc includes unnecessary files for a package.

[belyi]

BPO	1217881
Nosy	@birkenfeld
Files	pydoc__all__.patch: Patch adding visiblename(modname, all) check for Package Contents

^{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 2009-04-05.17:21:58.940>
created_at = <Date 2005-06-09.23:38:39.000>
labels = ['easy', 'type-feature', 'library']
title = 'pydoc includes unnecessary files for a package.'
updated_at = <Date 2009-04-05.17:21:58.916>
user = 'https://bugs.python.org/belyi'

bugs.python.org fields:

activity = <Date 2009-04-05.17:21:58.916>
actor = 'georg.brandl'
assignee = 'none'
closed = True
closed_date = <Date 2009-04-05.17:21:58.940>
closer = 'georg.brandl'
components = ['Library (Lib)']
creation = <Date 2005-06-09.23:38:39.000>
creator = 'belyi'
dependencies = []
files = ['1717']
hgrepos = []
issue_num = 1217881
keywords = ['patch', 'easy']
message_count = 3.0
messages = ['25518', '25519', '85530']
nosy_count = 2.0
nosy_names = ['georg.brandl', 'belyi']
pr_nums = []
priority = 'normal'
resolution = 'rejected'
stage = 'test needed'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue1217881'
versions = ['Python 2.7']

[belyi]

PyDoc lists all files present in a package directory in
a "Package Contents" table instead of only the ones
listed in __all__ variable in __init__.py file.

This is very inconvenient for packages which are
wrappers for some C library since the shared library
and a Wrapper get the reference on the package page but
then they do not have any comments and their pages are
not generated. As a result package page has those
annoying dead links.

One can probably fix this by creating a special dummy
pages for those unused files but it's an agly solution.
I do believe that using __all__ variable from
__init__.py file when it is defined is more appropriate
way to know what files represent the contents of the
package.

Cheers,
Igor

[belyi]

Logged In: YES
user_id=995711

Interestingly, the patch to do this is very small since
__all__ variable is already heavy used for other items.

Hope it will help,
Igor

[birkenfeld]

I don't think that it is common practice to list submodules in __all__,
only names really exported from the package. Therefore, this does not
seem like a good change to make.