openlog()s 'logopt' keyword broken in syslog module

[tbielawa]

BPO	11648
Nosy	@birkenfeld, @pitrou, @ericvsmith, @bitdancer, @sandrotosi
Files	syslog-fixlogopt-keyword.patch syslogtest-pid.py

^{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 2012-01-04.22:14:00.669>
created_at = <Date 2011-03-23.02:42:36.307>
labels = ['docs']
title = "openlog()s 'logopt' keyword broken in syslog module"
updated_at = <Date 2012-01-04.22:14:00.663>
user = 'https://bugs.python.org/tbielawa'

bugs.python.org fields:

activity = <Date 2012-01-04.22:14:00.663>
actor = 'sandro.tosi'
assignee = 'docs@python'
closed = True
closed_date = <Date 2012-01-04.22:14:00.669>
closer = 'sandro.tosi'
components = ['Documentation']
creation = <Date 2011-03-23.02:42:36.307>
creator = 'tbielawa'
dependencies = []
files = ['21352', '21353']
hgrepos = []
issue_num = 11648
keywords = ['patch']
message_count = 6.0
messages = ['131844', '131845', '131846', '131860', '131862', '150630']
nosy_count = 8.0
nosy_names = ['georg.brandl', 'jafo', 'pitrou', 'eric.smith', 'r.david.murray', 'sandro.tosi', 'docs@python', 'tbielawa']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue11648'
versions = ['Python 2.7', 'Python 3.2', 'Python 3.3']

[tbielawa]

bpo-8451 unintentionally introduced a bug into the openlog() function in the syslog module.

syslog.openlog() as documented [1] is defined as: syslog.openlog([ident[, logopt[, facility]]]). I believe this is caused by the patch for bpo-8451 redefining the kwargs to expect a 'logoption' keyword instead.

This patch:

• Fixes syslog.openlog() so that it properly accepts the 'logopt' keyword argument again.

[1] http://docs.python.org/library/syslog.html#syslog.openlog

[tbielawa]

Trivial though it may be, the attached script demonstrates how to reproduce the bug described.

[tbielawa]

Classification update.

[birkenfeld]

Now that keyword support was introduced, I'd rather fix the documentation to use the new name.

[ericvsmith]

I agree with Georg, unfortunately.

And I say "unfortunately" because neither "logopt" nor "logoption" is a good name. The "log" part adds nothing. The man page for syslog calls this "option", which would be my preferred name. But changing it now would be a hassle.

Also, we clearly need a test for this, since apparently none failed when it was changed to the longer name.

[sandrotosi]

This has already been fixed with 71f7175e2b34 & friends.