Misleading error from getspnam function of spwd module

[vajrasky]

BPO	18787
Nosy	@loewis, @pitrou, @rbtcollins, @berkerpeksag, @serhiy-storchaka, @vajrasky
Files	fix_error_message_getspnam.patch fix_error_message_getspnam_v2.patch issue18787.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 = None
closed_at = <Date 2016-03-19.09:44:42.280>
created_at = <Date 2013-08-20.04:13:01.870>
labels = ['extension-modules', 'type-bug']
title = 'Misleading error from getspnam function of spwd module'
updated_at = <Date 2016-03-23.20:16:18.707>
user = 'https://github.com/vajrasky'

bugs.python.org fields:

activity = <Date 2016-03-23.20:16:18.707>
actor = 'python-dev'
assignee = 'none'
closed = True
closed_date = <Date 2016-03-19.09:44:42.280>
closer = 'berker.peksag'
components = ['Extension Modules']
creation = <Date 2013-08-20.04:13:01.870>
creator = 'vajrasky'
dependencies = []
files = ['31380', '31382', '40567']
hgrepos = []
issue_num = 18787
keywords = ['patch']
message_count = 12.0
messages = ['195678', '195683', '195685', '195688', '195693', '233288', '247375', '251542', '251544', '262034', '262292', '262303']
nosy_count = 7.0
nosy_names = ['loewis', 'pitrou', 'rbcollins', 'python-dev', 'berker.peksag', 'serhiy.storchaka', 'vajrasky']
pr_nums = []
priority = 'low'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue18787'
versions = ['Python 3.6']

[vajrasky]

As root:

$ sudo python3
[sudo] password for ethan: 
Python 3.2.3 (default, Apr 10 2013, 05:07:54) 
[GCC 4.7.2] on linux2
Type "help", "copyright", "credits" or "license" for more information.
>>> import spwd
>>> spwd.getspnam("I_don't_exist")
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
KeyError: 'getspnam(): name not found'
>>> spwd.getspnam("bin")
spwd.struct_spwd(sp_nam='bin', sp_pwd='*', sp_lstchg=15259, sp_min=0, sp_max=99999, sp_warn=7, sp_inact=-1, sp_expire=-1, sp_flag=-1)

As normal user:

$ python3
Python 3.2.3 (default, Apr 10 2013, 05:07:54) 
[GCC 4.7.2] on linux2
Type "help", "copyright", "credits" or "license" for more information.
>>> import spwd
>>> spwd.getspnam("I_don't_exist")
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
KeyError: 'getspnam(): name not found'
>>> spwd.getspnam("bin")
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
KeyError: 'getspnam(): name not found'

People can be confused. How could the name not found if the name actually exists?

Attached the patch to differentiate the error whether the error is really 'name not found' or 'permission denied'.

I use the error message from the getspnam manual:
http://man7.org/linux/man-pages/man3/getspnam.3.html

There is another error message from getspnam beside EACCES (permission denied), which is ERANGE, but I don't think we need to handle this.

[serhiy-storchaka]

PyErr_SetFromErrno(PyExc_OSError) looks more appropriate for permission denied error. However this change is backward incompatible so perhaps we have to left a KeyError.

[vajrasky]

Attached the patch to accomodate Serhiy Storchaka's suggestion by using KeyError exception for backward compatibility.

[serhiy-storchaka]

It was not a suggestion, it was a doubt.

See also bpo-10388.

[vajrasky]

Sorry about that.

Okay, so for now, we wait for other people's suggestion, which way we should use to handle this situation?

[pitrou]

I think we should always raise OSError if errno is non-zero (and not KeyError).

[rbtcollins]

Sounds like we want something analogous to http://bugs.python.org/file33404/fix_error_message_getspall_v2.patch for this bug. Moving to patch needed.

It looks like it would be easily tested too, so I'd like to see a test too please.

[berkerpeksag]

Here is a patch with a test.

[serhiy-storchaka]

As far as this change breaks compatibility. please add a note in the "Porting to Python 3.6" section in What's New.

[python-dev]

New changeset a1d738158390 by Berker Peksag in branch 'default':
Issue bpo-18787: spwd.getspnam() now raises a PermissionError if the user
https://hg.python.org/cpython/rev/a1d738158390

[python-dev]

New changeset 430af393d8f1 by Victor Stinner in branch 'default':
Try to fix test_spwd on OpenIndiana
https://hg.python.org/cpython/rev/430af393d8f1

[python-dev]

New changeset c1677c8f92e1 by Victor Stinner in branch 'default':
Fix test_spwd on OpenIndiana
https://hg.python.org/cpython/rev/c1677c8f92e1