improve sys.settrace and sys.setprofile documentation

[zhangyangyu]

BPO	32532
Nosy	@zhangyangyu, @pablogsal
PRs	bpo-32532: Improve documentation of settrace and setprofile #5359

^{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 2018-01-27.15:05:37.407>
created_at = <Date 2018-01-11.06:25:56.640>
labels = ['easy', 'type-feature', '3.7', 'docs']
title = 'improve sys.settrace and sys.setprofile documentation'
updated_at = <Date 2018-01-27.15:05:37.406>
user = 'https://github.com/zhangyangyu'

bugs.python.org fields:

activity = <Date 2018-01-27.15:05:37.406>
actor = 'xiang.zhang'
assignee = 'docs@python'
closed = True
closed_date = <Date 2018-01-27.15:05:37.407>
closer = 'xiang.zhang'
components = ['Documentation']
creation = <Date 2018-01-11.06:25:56.640>
creator = 'xiang.zhang'
dependencies = []
files = []
hgrepos = []
issue_num = 32532
keywords = ['patch', 'easy']
message_count = 4.0
messages = ['309793', '310261', '310377', '310863']
nosy_count = 3.0
nosy_names = ['docs@python', 'xiang.zhang', 'pablogsal']
pr_nums = ['5359']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue32532'
versions = ['Python 3.7']

[zhangyangyu]

I propose to mention the behaviour that "if exception raised in tracefunc or profilefunc, the handler will be unset" in the documentation of sys.settrace and sys.setprofile. I encounter this behaviour and surprised by it since I can't get the info from the doc. Only by digging into the source code, I can find out why the profile messages suddenly disappear.

[pablogsal]

There are some issues in the documentation for this function (slightly related) to this described here: https://bugs.python.org/issue17799.

I can update the PR linked to that issue with this information as well.

[zhangyangyu]

Hi Pablo, it would be nice. But for bpo-17799, I don't know actually which part should be fixed, doc or code? I think it's better to consult gurus on python-dev mail list.

[zhangyangyu]

New changeset 60da99b by Xiang Zhang in branch 'master':
bpo-32532: Improve documentation of settrace and setprofile (bpo-5359)
60da99b