[issue23883] __all__ lists are incomplete

STINNER Victor added the comment: Can this issue be closed now? -- keywords: -easy nosy: +vstinner ___ Python tracker ___ ___

[issue23883] __all__ lists are incomplete

Roundup Robot added the comment: New changeset a36c7f87eba9 by Martin Panter in branch 'default': Issue #23883: News updates for __all__ attributes https://hg.python.org/cpython/rev/a36c7f87eba9 -- ___ Python tracker

[issue23883] __all__ lists are incomplete

Jacek Kołodziej added the comment: In this case I'm proposing a small patch just for testing pydoc module's __all__ list and left the decision to you, whether to apply it or not. :) Test doesn't use test.support.check__all__ (see msg266312) - blacklist would be huge and expected list, as you

[issue23883] __all__ lists are incomplete

Martin Panter added the comment: I think pydoc could be left alone. The RST documentation doesn’t say anything about importing any functions from the module that I can see. I was surprised that it even defines __all__ = ["help"]. Perhaps pydoc.doc() was another false indication in Serhiy’s

[issue23883] __all__ lists are incomplete

Jacek Kołodziej added the comment: Per Martin's request, I've created a few new issues for next batch of module's __all__ list updates: * cgi: #27105 * configparser: #27106 * mailbox: #27107 * mimetypes: #27108 * plistlib: #27109 * smtpd: #27110 * tokenize: #27112 I've also looked at pydoc

[issue23883] __all__ lists are incomplete

Changes by Martin Panter : -- dependencies: +subprocess.__all__ incomplete on Windows ___ Python tracker ___

[issue23883] __all__ lists are incomplete

Changes by Martin Panter : -- dependencies: +Add missing XMLPullParser to ElementTree.__all__ ___ Python tracker ___

[issue23883] __all__ lists are incomplete

Serhiy Storchaka added the comment: Thanks for caring for this Martin. > Should we add anything into What's New, maybe warning of new symbols from > "import *"? I think yes. -- ___ Python tracker

[issue23883] __all__ lists are incomplete

Roundup Robot added the comment: New changeset 62e925be0aff by Serhiy Storchaka in branch 'default': Issue #23883: Removed redundant names from blacklists. https://hg.python.org/cpython/rev/62e925be0aff -- ___ Python tracker

[issue23883] __all__ lists are incomplete

Roundup Robot added the comment: New changeset 571632315c36 by Martin Panter in branch 'default': Issue #23883: Missing fileinput.__all__ APIs; patch by Mauro SM Rodrigues https://hg.python.org/cpython/rev/571632315c36 New changeset a2ffa9eedb1b by Martin Panter in branch 'default': Issue

[issue23883] __all__ lists are incomplete

Martin Panter added the comment: I committed the last three patches to 3.6: 571632315c36: fileinput a2ffa9eedb1b: calendar 48090e08e367: tarfile a5d3ebb6ad2a: Update news Please let me know if there are some outstanding patches here that I missed. Otherwise, I think we are up to step 6 in

[issue23883] __all__ lists are incomplete

Martin Panter added the comment: issue23883_fileinput.v2.patch looks good to me. -- ___ Python tracker ___

[issue23883] __all__ lists are incomplete

Mauro S. M. Rodrigues added the comment: New version. -- Added file: http://bugs.python.org/file41052/issue23883_fileinput.v2.patch ___ Python tracker

[issue23883] __all__ lists are incomplete

Martin Panter added the comment: Thankyou for sticking with this Jacek. I have committed your three patches. I reworded the documentation a little bit, mainly so it says that it looks for “public” names, rather than documented names, because it does not look at documentation at all. I also

[issue23883] __all__ lists are incomplete

Roundup Robot added the comment: New changeset f8fa7bc837a3 by Martin Panter in branch 'default': Issue #23883: Add test.support.check__all__() and test gettext.__all__ https://hg.python.org/cpython/rev/f8fa7bc837a3 New changeset 78d67bdc1142 by Martin Panter in branch 'default': Issue #23883:

[issue23883] __all__ lists are incomplete

Jacek Kołodziej added the comment: Martin, yay! :) And thank you for the documentation correction. Milap, Joel, Mauro, are you still interested in working on patches for calendar/tarfile/fileinput patches? I intend to finish them up if that's not the case. --

[issue23883] __all__ lists are incomplete

Berker Peksag added the comment: > The reason why I prefer the current API over my support.expected_module_api() > idea is it requires the extra assertCountEqual() boilerplate at each call > site. I personally find explicit assert* calls in a test case more readable(e.g. I don't need to

[issue23883] __all__ lists are incomplete

Martin Panter added the comment: The reason why I prefer the current API over my support.expected_module_api() idea is it requires the extra assertCountEqual() boilerplate at each call site. Jacek’s three patches look ready to me. I propose: 1. Commit Issue23883_support_check__all__.v6.patch

[issue23883] __all__ lists are incomplete

Berker Peksag added the comment: I like Martin's support.expected_module_api() suggestion in msg247167. I still find passing self to a function just to use assertCountEqual a bit weird, but I can live with that. -- ___ Python tracker

[issue23883] __all__ lists are incomplete

Changes by Jacek Kołodziej : Added file: http://bugs.python.org/file41012/Issue23883_all.v6.patch ___ Python tracker ___

[issue23883] __all__ lists are incomplete

Jacek Kołodziej added the comment: Serhiy, thank you for the review. I've made proposed changes (along with rebasing Issue23883_all patch; Issue23883_test_gettext.v3.patch still applies cleanly). -- Added file: http://bugs.python.org/file41013/Issue23883_support_check__all__.v6.patch

[issue23883] __all__ lists are incomplete

Serhiy Storchaka added the comment: I have added comments on Rietveld. Besides few stylistic nitpicks Issue23883_support_check__all__.v5.patch LGTM. > But passing "self" to it feels a bit weird. This is not new. There are other testing helpers in test.support that needs passing "self". If

[issue23883] __all__ lists are incomplete

Michael Selik added the comment: many things are not present in os.__all__ that should be, including os.getcwd -- nosy: +selik ___ Python tracker ___

[issue23883] __all__ lists are incomplete

Jacek Kołodziej added the comment: Does anyone have strong preference towards one of the propositions above? TestCase subclass looks reasonable IMHO, but I'd not add that to the scope of this issue (I'd be happy to implement it later, though). Any suggestions? --

[issue23883] __all__ lists are incomplete

Berker Peksag added the comment: Thank you all for your work and apologies for my lack of response. I'm +1 on adding a check__all__ helper to test.support. But passing self to it feels a bit weird. Perhaps the assertCountEqual part could be moved outside of the helper. If Serhiy(and/or other

[issue23883] __all__ lists are incomplete

Changes by Jacek Kołodziej kolodzi...@gmail.com: Added file: http://bugs.python.org/file39976/Issue23883_support_check__all__.v5.patch ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue23883 ___

[issue23883] __all__ lists are incomplete

Jacek Kołodziej added the comment: raiseExecptions typo: Might be best to get the typo fixed first (maybe open a separate issue, since it should probably be fixed starting from the 3.4 branch). Done in #24678 and commited in 83b45ea19d00 . Regarding OpcodeInfo, it is probably up to your

[issue23883] __all__ lists are incomplete

Martin Panter added the comment: Here is a brainstorm of alternatives that don’t require passing “self” into a helper function. But IMO the current proposal that does pass “self” is better. * Passive expected_module_api() function, and manually check the return value. Precedent:

[issue23883] __all__ lists are incomplete

Martin Panter added the comment: raiseExecptions typo: Might be best to get the typo fixed first (maybe open a separate issue, since it should probably be fixed starting from the 3.4 branch). Regarding OpcodeInfo, it is probably up to your judgement. --

[issue23883] __all__ lists are incomplete

Jacek Kołodziej added the comment: I'm getting patches ready with amendments you've proposed. Two things, though (and two on Rietveld): That raiseExecptions thing looks like a typo to me. The code should probably be monkey patching the module variable, and restoring it after the test. Then

[issue23883] __all__ lists are incomplete

Martin Panter added the comment: That raiseExecptions thing looks like a typo to me. The code should probably be monkey patching the module variable, and restoring it after the test. Then you wouldn’t need to add your extra typoed version to the blacklist. In the logging module, I reckon

[issue23883] __all__ lists are incomplete

Jacek Kołodziej added the comment: In any case it is too late for 3.5. Ok, next round of patches is based on default branch. Jacek: If we used the ModuleType check, and somebody adds a module-level constant (like logging.CRITICAL = 50), the test will automatically detect if they forget

[issue23883] __all__ lists are incomplete

Changes by Jacek Kołodziej kolodzi...@gmail.com: Added file: http://bugs.python.org/file39867/Issue23883_support_check__all__.v4.patch ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue23883 ___

[issue23883] __all__ lists are incomplete

Changes by Jacek Kołodziej kolodzi...@gmail.com: Added file: http://bugs.python.org/file39868/Issue23883_test_gettext.v3.patch ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue23883 ___

[issue23883] __all__ lists are incomplete

Martin Panter added the comment: The technical bit of Issue23883_support_check__all__.v3.patch looks pretty good. Mainly some grammar suggestions for the documentation. Issue23883_test_gettext.v2.patch looks fine; just depends on check__all__() being added. Couple of comments about the APIs

[issue23883] __all__ lists are incomplete

Martin Panter added the comment: Jacek: If we used the ModuleType check, and somebody adds a module-level constant (like logging.CRITICAL = 50), the test will automatically detect if they forget to update __all__. That is what I meant by the test being stricter. But it looks like you went for

[issue23883] __all__ lists are incomplete

Jacek Kołodziej added the comment: Nice work with the check__all__() function. Thank you! :) I left some comments on Reitveld. Also, it currently ignores items satisfying either of these checks: * isinstance(module_object, types.ModuleType) * getattr(module_object, '__module__', None)

[issue23883] __all__ lists are incomplete

Changes by Jacek Kołodziej kolodzi...@gmail.com: Added file: http://bugs.python.org/file39807/Issue23883_support_check__all__.v3.patch ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue23883 ___

[issue23883] __all__ lists are incomplete

Changes by Jacek Kołodziej kolodzi...@gmail.com: Added file: http://bugs.python.org/file39808/Issue23883_test_gettext.v2.patch ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue23883 ___

[issue23883] __all__ lists are incomplete

Martin Panter added the comment: I think names should be in __all__ even if they shadow builtins, at least in a new feature release. There is plenty of precedent, e.g. asyncio.TimeoutError; reprlib.repr(); threading.enumerate(). Modules with open() in __all__ include aifc, bz2, codecs, dbm,

[issue23883] __all__ lists are incomplete

Serhiy Storchaka added the comment: Serhiy: ftplib.Error does not actually appear to be documented. Perhaps it should not be added to __all__ after all? (excuse the pun) Agree. The list is only cursorily filtered result of some one-liners and can contain false names. --

[issue23883] __all__ lists are incomplete

Serhiy Storchaka added the comment: Adding new names to __all__ can have undesired effect and break user code (by hiding builtins as for tarfile.open). Perhaps not all documented names should be imported with import *. In any case it is too late for 3.5. -- versions: +Python 3.6

[issue23883] __all__ lists are incomplete

Jacek Kołodziej added the comment: I've added previously missing test and docs for test.support.check__all__ in Issue23883_support_check__all__.v2.patch . Awaiting review. :) -- Added file: http://bugs.python.org/file39760/Issue23883_support_check__all__.v2.patch

[issue23883] __all__ lists are incomplete

Jacek Kołodziej added the comment: ftplib and threading have more functions I've meant function and exceptions, of course. Sorry for the noise. -- ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue23883

[issue23883] __all__ lists are incomplete

Changes by Jacek Kołodziej kolodzi...@gmail.com: Added file: http://bugs.python.org/file39734/Issue23883_test_gettext.patch ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue23883 ___

[issue23883] __all__ lists are incomplete

Jacek Kołodziej added the comment: Thank you for feedback, Martin. I've amended the the patch. Next, I've prepared some initial test.support.check__all__ helper, based on generalization of all previous patches. Its name/params' descriptions may be a bit rough - amendments/suggestions for such

[issue23883] __all__ lists are incomplete

Changes by Mauro S. M. Rodrigues maurosmrodrig...@gmail.com: Removed file: http://bugs.python.org/file39140/issue23883_fileinput.patch ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue23883 ___

[issue23883] __all__ lists are incomplete

Changes by Mauro S. M. Rodrigues maurosmrodrig...@gmail.com: Added file: http://bugs.python.org/file39718/issue23883_fileinput.patch ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue23883 ___

[issue23883] __all__ lists are incomplete

Jacek Kołodziej added the comment: Hi! This is my first attempt at contributing so as always, feedback will be well appreciated. :) I meant to start small so I took a shot with csv module. In test, initial expected set contains QUOTE_* because they don't provide __module__ attribute, and

[issue23883] __all__ lists are incomplete

Changes by Jacek Kołodziej kolodzi...@gmail.com: Removed file: http://bugs.python.org/file39716/Issue23883_csv_all.patch ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue23883 ___

[issue23883] __all__ lists are incomplete

Changes by Jacek Kołodziej kolodzi...@gmail.com: Added file: http://bugs.python.org/file39717/Issue23883_csv_all.patch ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue23883 ___

[issue23883] __all__ lists are incomplete

Martin Panter added the comment: Reviews of the patches waiting here: tarfile, calendar (Joel): Look mainly good; I added minor suggestions about the test cases to Reitveld. fileinput (Mauro): Looks pretty good; one minor comment on Rietveld. csv (Jacek): Pretty good; couple minor

[issue23883] __all__ lists are incomplete

Mauro Rodrigues added the comment: Hi guys! Here is a patch for the fileinput module, with some names beyond fileinput.fileno: fileinput.hook_compressed, fileinput.hook_encoded as mentioned in the docs https://docs.python.org/3/library/fileinput.html This is my first patch as well, so

[issue23883] __all__ lists are incomplete

Joel Taddei added the comment: I took a stab at the calendar module. Found a few items in the documentation which weren't listed in the above list: LocaleTextCalendar, LocaleHTMLCalendar, and weekheader. I was curious though about week and prweek as month and prmonth are documented and

[issue23883] __all__ lists are incomplete

Joel Taddei added the comment: Woops just noticed above in the issue someone else picked up the Calendar __all__. I am genuinely sorry I didn't intend to duplicate the effort. -- ___ Python tracker rep...@bugs.python.org

[issue23883] __all__ lists are incomplete

Joel Taddei added the comment: I took care of the tarfile module. Added the following according to the first message: tarfile.CompressionError tarfile.HeaderError tarfile.ReadError tarfile.open The following were included in __all__ that were not explicitly mentioned in the first message

[issue23883] __all__ lists are incomplete

Martin Panter added the comment: Regarding tarfile: Two of the extra errors are documented, so I agree they should be added: * tarfile.StreamError * tarfile.ExtractError However I’m not so sure about main(), TarIter, and the HeaderError subclasses. They aren’t mentioned in the documentation.

[issue23883] __all__ lists are incomplete

Joel Taddei added the comment: Thanks for the feedback. I was unsure how to proceed with the undocumented items that seemed to be categorized as exported. Thanks for catching ENCODING *_FORMAT. -- Added file: http://bugs.python.org/file39064/Issue23883_tarfile_all.patch

[issue23883] __all__ lists are incomplete

Joel Taddei added the comment: Put HeaderError back in and removed the extra XHDTYPE. We can get more input on the type constants as well as the undocumented but exported items. Could just be cleared up with some edits to documentation. -- Added file:

[issue23883] __all__ lists are incomplete

Changes by Joel Taddei jtad...@gmail.com: Removed file: http://bugs.python.org/file39064/Issue23883_tarfile_all.patch ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue23883 ___

[issue23883] __all__ lists are incomplete

Martin Panter added the comment: Oh I see, TarIter is listed underneath a comment saying “Exported Classes”, and main() is listed underneath “exported functions”. If they are indeed meant to be exported, they should probably also be documented. Otherwise, maybe we can just add another comment

[issue23883] __all__ lists are incomplete

Changes by Joel Taddei jtad...@gmail.com: Removed file: http://bugs.python.org/file39051/Issue23883_tarfile_all.patch ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue23883 ___

[issue23883] __all__ lists are incomplete

Roundup Robot added the comment: New changeset 717d87c13f0d by Andrew Kuchling in branch '3.4': #23883: add names missing from __all__ (l*gettext, bind_textdomain_codeset) https://hg.python.org/cpython/rev/717d87c13f0d -- ___ Python tracker

[issue23883] __all__ lists are incomplete

Roundup Robot added the comment: New changeset 86fbe140e395 by Andrew Kuchling in branch '2.7': #23883: add names missing from __all__ (l*gettext, bind_textdomain_codeset) https://hg.python.org/cpython/rev/86fbe140e395 -- ___ Python tracker

[issue23883] __all__ lists are incomplete

Changes by Berker Peksag berker.pek...@gmail.com: -- nosy: +berker.peksag ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue23883 ___ ___

[issue23883] __all__ lists are incomplete

Roundup Robot added the comment: New changeset ebf3e6332a44 by Berker Peksag in branch 'default': Issue #23883: Add missing entries to traceback.__all__. https://hg.python.org/cpython/rev/ebf3e6332a44 -- nosy: +python-dev ___ Python tracker

[issue23883] __all__ lists are incomplete

Milap Bhojak added the comment: I working on these three. calendar.Calendar calendar.HTMLCalendar calendar.TextCalendar Changes would be the same as https://hg.python.org/cpython/rev/ebf3e6332a44/ for every module? -- nosy: +milap.py ___ Python

[issue23883] __all__ lists are incomplete

Martin Panter added the comment: Serhiy: Yes I was also thinking it might be time for a common helper function. Milap: I think changes like you mentioned (originally by me) would be fine. Another variation was done for Issue 10838: revision 10b0a8076be8, which expects each object that is not

[issue23883] __all__ lists are incomplete

Changes by Berker Peksag berker.pek...@gmail.com: -- keywords: +easy stage: - needs patch ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue23883 ___

[issue23883] __all__ lists are incomplete

Serhiy Storchaka added the comment: May be makes sense to add a helper in test.support that implements a test similar to the one in issue23411, and add tests for __all__ in multiple modules. -- ___ Python tracker rep...@bugs.python.org

[issue23883] __all__ lists are incomplete

New submission from Serhiy Storchaka: Here is a (perhaps incomplete) list of documented names absent in __all__ lists of respective modules. Perhaps some of them (but not all) are worth to be added to __all__ lists. calendar.Calendar calendar.HTMLCalendar calendar.TextCalendar cgi.test

[issue23883] __all__ lists are incomplete

Changes by Serhiy Storchaka storch...@gmail.com: -- dependencies: +subprocess __all__ is incomplete ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue23883 ___

[issue23883] __all__ lists are incomplete

Martin Panter added the comment: http.client.HTTPMessage: See Issue 23439. There was resistance to adding this (and the status code constants), though IMO they should be added, since they are documented public APIs. http.server.test(): In Issue 23418, I consciously left this function out. It