Document that print/format_exception ignore etype

[Carreau]

BPO	29660
Nosy	@Carreau, @Mariatta
PRs	bpo-29660: traceback: Document that etype is ignored in some places. #344 [3.6] bpo-29660: traceback: Document that etype is ignored in some pl… #1913 [3.5] bpo-29660: traceback: Document that etype is ignored in some pl… #1914

^{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 2017-06-02.03:27:41.923>
created_at = <Date 2017-02-27.01:21:38.865>
labels = ['3.7', 'docs']
title = 'Document that print/format_exception ignore etype'
updated_at = <Date 2017-06-02.03:27:41.922>
user = 'https://github.com/Carreau'

bugs.python.org fields:

activity = <Date 2017-06-02.03:27:41.922>
actor = 'Mariatta'
assignee = 'docs@python'
closed = True
closed_date = <Date 2017-06-02.03:27:41.923>
closer = 'Mariatta'
components = ['Documentation']
creation = <Date 2017-02-27.01:21:38.865>
creator = 'mbussonn'
dependencies = []
files = []
hgrepos = []
issue_num = 29660
keywords = []
message_count = 7.0
messages = ['288617', '294973', '294974', '294976', '294977', '294978', '294979']
nosy_count = 3.0
nosy_names = ['docs@python', 'mbussonn', 'Mariatta']
pr_nums = ['344', '1913', '1914']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue29660'
versions = ['Python 3.5', 'Python 3.6', 'Python 3.7']

[Carreau]

As far as I can tell, http://bugs.python.org/issue17911 made a couple of function in traceback ignore their first arguments (etype) and infer the type from the second one (evalue).

(In git 6bc2c1e and 2f0441f respectively).

At least print_exception and format_exception are affected.

This likely affect http://bugs.python.org/issue26389 (who wish to expand same API to remove these parameters).

And inconsistency with format_exception_only which does need etype should be checked.

If etype is a deprecated parameter it should be noted, and should likely raise a DeprecationWarning as well when set.

[Mariatta]

New changeset cdb89cd by Mariatta (Matthias Bussonnier) in branch 'master':
bpo-29660: traceback: Document that etype is ignored in some places. (GH-344)
cdb89cd

[Mariatta]

Thanks Matthias.

I can backport this later today.
Or do you want to do it? :)
You can use cherry_picker.py https://github.com/python/core-workflow/tree/master/cherry_picker

[Carreau]

Thanks @Mariatta, I'll try to cherry-pick!

[Mariatta]

New changeset e417d12 by Mariatta (Matthias Bussonnier) in branch '3.6':
bpo-29660: traceback: Document that etype is ignored in some places. (GH-344) (GH-1913)
e417d12

[Mariatta]

New changeset cca3d4a by Mariatta (Matthias Bussonnier) in branch '3.5':
bpo-29660: traceback: Document that etype is ignored in some places. (GH-344) (GH-1914)
cca3d4a

[Mariatta]

Thanks :)