Skip to content

Commit 63e89a0

Browse files
author
Josh Hoyt
committed
[project @ Added magic no_default argument to Message.getArg to make it raise a KeyError when the value is not found.]
Also a bit of refactoring in test_message to make it less error-prone and more thorough.
1 parent 06fcef9 commit 63e89a0

2 files changed

Lines changed: 60 additions & 48 deletions

File tree

‎openid/message.py‎

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
"""Extension argument processing code
22
"""
3-
__all__ = ['Message', 'NamespaceMap',
3+
__all__ = ['Message', 'NamespaceMap', 'no_default',
44
'OPENID_NS', 'BARE_NS', 'OPENID1_NS', 'OPENID2_NS', 'SREG_URI',
55
'IDENTIFIER_SELECT']
66

@@ -54,6 +54,10 @@ class UndefinedOpenIDNamespace(ValueError):
5454
"""Raised if the generic OpenID namespace is accessed when there
5555
is no OpenID namespace set for this message."""
5656

57+
# Sentinel used for Message implementation to indicate that getArg
58+
# should raise an exception instead of returning a default.
59+
no_default = object()
60+
5761
class Message(object):
5862
"""
5963
In the implementation of this object, None represents the global
@@ -351,9 +355,32 @@ def getKey(self, namespace, ns_key):
351355

352356
def getArg(self, namespace, key, default=None):
353357
"""Get a value for a namespaced key.
358+
359+
@param namespace: The namespace in the message for this key
360+
@type namespace: str
361+
362+
@param key: The key to get within this namespace
363+
@type key: str
364+
365+
@param default: The value to use if this key is absent from
366+
this message. Using the special value
367+
openid.message.no_default will result in this method
368+
raising a KeyError instead of returning the default.
369+
370+
@rtype: str or the type of default
371+
@raises: KeyError (if default is no_default)
372+
@raises: UndefinedOpenIDNamespace (if the message has not yet
373+
had an OpenID namespace set)
354374
"""
355375
namespace = self._fixNS(namespace)
356-
return self.args.get((namespace, key), default)
376+
args_key = (namespace, key)
377+
try:
378+
return self.args[args_key]
379+
except KeyError:
380+
if default is no_default:
381+
raise
382+
else:
383+
return default
357384

358385
def getArgs(self, namespace):
359386
"""Get the arguments that are defined for this namespace URI

‎openid/test/test_message.py‎

Lines changed: 31 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,23 @@
66
import unittest
77
import datadriven
88

9+
def mkGetArgTest(ns, key, expected=None):
10+
def test(self):
11+
a_default = object()
12+
self.failUnlessEqual(self.msg.getArg(ns, key), expected)
13+
if expected is None:
14+
self.failUnlessEqual(
15+
self.msg.getArg(ns, key, a_default), a_default)
16+
self.failUnlessRaises(
17+
KeyError, self.msg.getArg, ns, key, message.no_default)
18+
else:
19+
self.failUnlessEqual(
20+
self.msg.getArg(ns, key, a_default), expected)
21+
self.failUnlessEqual(
22+
self.msg.getArg(ns, key, message.no_default), expected)
23+
24+
return test
25+
926
class EmptyMessageTest(unittest.TestCase):
1027
def setUp(self):
1128
self.msg = message.Message()
@@ -79,18 +96,10 @@ def test_getArg(self):
7996
self.failUnlessRaises(message.UndefinedOpenIDNamespace,
8097
self.msg.getArg, message.OPENID_NS, 'foo')
8198

82-
def test_getArgBARE(self):
83-
self.failUnlessEqual(self.msg.getArg(message.BARE_NS, 'foo'), None)
84-
85-
def test_getArgNS1(self):
86-
self.failUnlessEqual(self.msg.getArg(message.OPENID1_NS, 'foo'), None)
87-
88-
def test_getArgNS2(self):
89-
self.failUnlessEqual(self.msg.getArg(message.OPENID2_NS, 'foo'), None)
90-
91-
def test_getArgNS3(self):
92-
self.failUnlessEqual(self.msg.getArg('urn:nothing-significant', 'foo'),
93-
None)
99+
test_getArgBARE = mkGetArgTest(message.BARE_NS, 'foo')
100+
test_getArgNS1 = mkGetArgTest(message.OPENID1_NS, 'foo')
101+
test_getArgNS2 = mkGetArgTest(message.OPENID2_NS, 'foo')
102+
test_getArgNS3 = mkGetArgTest('urn:nothing-significant', 'foo')
94103

95104
def test_getArgs(self):
96105
# Could reasonably return {} instead of raising an
@@ -266,23 +275,11 @@ def test_hasKeyNS3(self):
266275
self.failUnlessEqual(
267276
self.msg.hasKey('urn:nothing-significant', 'mode'), False)
268277

269-
def test_getArg(self):
270-
self.failUnlessEqual(self.msg.getArg(message.OPENID_NS, 'mode'),
271-
'error')
272-
273-
def test_getArgBARE(self):
274-
self.failUnlessEqual(self.msg.getArg(message.BARE_NS, 'mode'), None)
275-
276-
def test_getArgNS1(self):
277-
self.failUnlessEqual(self.msg.getArg(message.OPENID1_NS, 'mode'),
278-
'error')
279-
280-
def test_getArgNS2(self):
281-
self.failUnlessEqual(self.msg.getArg(message.OPENID2_NS, 'mode'), None)
282-
283-
def test_getArgNS3(self):
284-
self.failUnlessEqual(
285-
self.msg.getArg('urn:nothing-significant', 'mode'), None)
278+
test_getArgBARE = mkGetArgTest(message.BARE_NS, 'mode')
279+
test_getArgNS = mkGetArgTest(message.OPENID_NS, 'mode', 'error')
280+
test_getArgNS1 = mkGetArgTest(message.OPENID1_NS, 'mode', 'error')
281+
test_getArgNS2 = mkGetArgTest(message.OPENID2_NS, 'mode')
282+
test_getArgNS3 = mkGetArgTest('urn:nothing-significant', 'mode')
286283

287284
def test_getArgs(self):
288285
self.failUnlessEqual(self.msg.getArgs(message.OPENID_NS),
@@ -488,23 +485,11 @@ def test_hasKeyNS3(self):
488485
self.failUnlessEqual(
489486
self.msg.hasKey('urn:nothing-significant', 'mode'), False)
490487

491-
def test_getArgOpenID(self):
492-
self.failUnlessEqual(self.msg.getArg(message.OPENID_NS, 'mode'),
493-
'error')
494-
495-
def test_getArgBARE(self):
496-
self.failUnlessEqual(self.msg.getArg(message.BARE_NS, 'mode'), None)
497-
498-
def test_getArgNS1(self):
499-
self.failUnlessEqual(self.msg.getArg(message.OPENID1_NS, 'mode'), None)
500-
501-
def test_getArgNS2(self):
502-
self.failUnlessEqual(self.msg.getArg(message.OPENID2_NS, 'mode'),
503-
'error')
504-
505-
def test_getArgNS3(self):
506-
self.failUnlessEqual(
507-
self.msg.getArg('urn:nothing-significant', 'mode'), None)
488+
test_getArgBARE = mkGetArgTest(message.BARE_NS, 'mode')
489+
test_getArgNS = mkGetArgTest(message.OPENID_NS, 'mode', 'error')
490+
test_getArgNS1 = mkGetArgTest(message.OPENID1_NS, 'mode')
491+
test_getArgNS2 = mkGetArgTest(message.OPENID2_NS, 'mode', 'error')
492+
test_getArgNS3 = mkGetArgTest('urn:nothing-significant', 'mode')
508493

509494
def test_getArgsOpenID(self):
510495
self.failUnlessEqual(self.msg.getArgs(message.OPENID_NS),

0 commit comments

Comments
 (0)