Help on importlib.resources outputs the builtin open description

[serhiy-storchaka]

BPO	33537
Nosy	@warsaw, @brettcannon, @ncoghlan, @ericsnowcurrently, @serhiy-storchaka
PRs	bpo-33537: Add __all__ in importlib.resources. #6902 bpo-33537: Add an __all__ to importlib.resources #6920 [3.7] bpo-33537: Add an __all__ to importlib.resources (GH-6920) #6941

^{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/warsaw'
closed_at = <Date 2018-05-23.05:19:03.855>
created_at = <Date 2018-05-16.12:29:28.589>
labels = ['3.7', '3.8', 'type-bug', 'library']
title = 'Help on importlib.resources outputs the builtin open description'
updated_at = <Date 2018-05-23.05:19:03.854>
user = 'https://github.com/serhiy-storchaka'

bugs.python.org fields:

activity = <Date 2018-05-23.05:19:03.854>
actor = 'serhiy.storchaka'
assignee = 'barry'
closed = True
closed_date = <Date 2018-05-23.05:19:03.855>
closer = 'serhiy.storchaka'
components = ['Library (Lib)']
creation = <Date 2018-05-16.12:29:28.589>
creator = 'serhiy.storchaka'
dependencies = []
files = []
hgrepos = []
issue_num = 33537
keywords = ['patch']
message_count = 4.0
messages = ['316802', '316856', '316951', '316960']
nosy_count = 5.0
nosy_names = ['barry', 'brett.cannon', 'ncoghlan', 'eric.snow', 'serhiy.storchaka']
pr_nums = ['6902', '6920', '6941']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue33537'
versions = ['Python 3.7', 'Python 3.8']

[serhiy-storchaka]

help(importlib.resources) outputs many noise. In particular it contains the description of builtin open() which is longer than descriptions of all functions defined in importlib.resources. It also contains references to typing classes in the DATA section.

There are two ways of solving this problem. First way: make all imported names underscored (for example _open instead of builtin_open). Second way: add __all__.

Actually I don't understand why buildin_open is used instead of just open. And _zipimport_get_resource_reader looks unused.

[warsaw]

Thanks, I will add an __all__

_zipimport_get_resource_reader gets called from C and it's the way we trampoline from the inscrutable zipimport.c into something we can more reasonably implement the ResourceReader API. There's a comment above _ZipImportResourceReader but do you think that's easy to miss or misunderstand?

The use of builtins_open is historical; the importlib.resources name used to be open. I think we can get rid of this cruft, as it's just an implementation detail.

I'll work on a PR

[warsaw]

New changeset 0ed66df by Barry Warsaw in branch 'master':
bpo-33537: Add an __all__ to importlib.resources (bpo-6920)
0ed66df

[warsaw]

New changeset 6417d33 by Barry Warsaw (Miss Islington (bot)) in branch '3.7':
bpo-33537: Add an __all__ to importlib.resources (GH-6920) (bpo-6941)
6417d33