Define an __all__ for html.parser

[vsajip]

BPO	14679
Nosy	@vsajip, @orsenthil, @ezio-melotti, @merwok, @mmaker
Files	issue14679.diff

^{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/ezio-melotti'
closed_at = <Date 2013-05-01.13:11:38.929>
created_at = <Date 2012-04-26.20:06:12.839>
labels = ['type-bug', 'library']
title = 'Define an __all__ for html.parser'
updated_at = <Date 2013-05-01.13:11:38.929>
user = 'https://github.com/vsajip'

bugs.python.org fields:

activity = <Date 2013-05-01.13:11:38.929>
actor = 'ezio.melotti'
assignee = 'ezio.melotti'
closed = True
closed_date = <Date 2013-05-01.13:11:38.929>
closer = 'ezio.melotti'
components = ['Library (Lib)']
creation = <Date 2012-04-26.20:06:12.839>
creator = 'vinay.sajip'
dependencies = []
files = ['29607']
hgrepos = []
issue_num = 14679
keywords = ['patch', '3.2regression']
message_count = 6.0
messages = ['159421', '171353', '171423', '185528', '185789', '188220']
nosy_count = 6.0
nosy_names = ['vinay.sajip', 'orsenthil', 'ezio.melotti', 'eric.araujo', 'maker', 'python-dev']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue14679'
versions = ['Python 3.4']

[vsajip]

The change to html.parser.tagfind in ba4baaddac8d is causing third-party code (Django) to fail. See

http://mail.python.org/pipermail/python-dev/2012-April/119074.html

for more information.

Other patterns which changed (e.g. attrfind_tolerant) might also lead to problems. As suggested in the python-dev thread, private versions of these patterns should be used and the existing public ones deprecated, where appropriate.

[ezio-melotti]

The issue with Django seems to be solved, but as Terry suggested in http://mail.python.org/pipermail/python-dev/2012-April/119087.html, adding an __all__ would be a good idea. I'm changing the scope of the issue accordingly.

[mmaker]

"# Internal" appears only in HTMLParser's methods; how could __all__ fix this?

[ezio-melotti]

The module only defines 2 public objects: HTMLParser and HTMLParseError.
The attached patch adds an __all__ with only HTMLParser. Should HTMLParseError be included too, even though it's deprecated and will be removed in 3.5?

@michele:
__all__ won't fix that, but at least it will make clear that the module-level regex (like tagfind) are not public. Renaming the methods is not a good idea IMHO, we could move the "# internal" comments in the docstrings though.

[orsenthil]

I think, HTMLParseError should also be defined __all__ (all also servers as what public classes/methods to look for sometimes and sets some expectation while reading the code.)

There is no deprecation warning added in the class here.

[python-dev]

New changeset 1f7ce8af3356 by Ezio Melotti in branch 'default':
bpo-14679: add an __all__ (that contains only HTMLParser) to html.parser.
http://hg.python.org/cpython/rev/1f7ce8af3356