test_keywordonlyarg.py 6.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178
  1. """Unit tests for the keyword only argument specified in PEP 3102."""
  2. __author__ = "Jiwon Seo"
  3. __email__ = "seojiwon at gmail dot com"
  4. import unittest
  5. def posonly_sum(pos_arg1, *arg, **kwarg):
  6. return pos_arg1 + sum(arg) + sum(kwarg.values())
  7. def keywordonly_sum(*, k1=0, k2):
  8. return k1 + k2
  9. def keywordonly_nodefaults_sum(*, k1, k2):
  10. return k1 + k2
  11. def keywordonly_and_kwarg_sum(*, k1, k2, **kwarg):
  12. return k1 + k2 + sum(kwarg.values())
  13. def mixedargs_sum(a, b=0, *arg, k1, k2=0):
  14. return a + b + k1 + k2 + sum(arg)
  15. def mixedargs_sum2(a, b=0, *arg, k1, k2=0, **kwargs):
  16. return a + b + k1 + k2 + sum(arg) + sum(kwargs.values())
  17. def sortnum(*nums, reverse=False):
  18. return sorted(list(nums), reverse=reverse)
  19. def sortwords(*words, reverse=False, **kwargs):
  20. return sorted(list(words), reverse=reverse)
  21. class Foo:
  22. def __init__(self, *, k1, k2=0):
  23. self.k1 = k1
  24. self.k2 = k2
  25. def set(self, p1, *, k1, k2):
  26. self.k1 = k1
  27. self.k2 = k2
  28. def sum(self):
  29. return self.k1 + self.k2
  30. class KeywordOnlyArgTestCase(unittest.TestCase):
  31. def assertRaisesSyntaxError(self, codestr):
  32. def shouldRaiseSyntaxError(s):
  33. compile(s, "<test>", "single")
  34. self.assertRaises(SyntaxError, shouldRaiseSyntaxError, codestr)
  35. def testSyntaxErrorForFunctionDefinition(self):
  36. self.assertRaisesSyntaxError("def f(p, *):\n pass\n")
  37. self.assertRaisesSyntaxError("def f(p1, *, p1=100):\n pass\n")
  38. self.assertRaisesSyntaxError("def f(p1, *k1, k1=100):\n pass\n")
  39. self.assertRaisesSyntaxError("def f(p1, *, k1, k1=100):\n pass\n")
  40. self.assertRaisesSyntaxError("def f(p1, *, **k1):\n pass\n")
  41. self.assertRaisesSyntaxError("def f(p1, *, k1, **k1):\n pass\n")
  42. self.assertRaisesSyntaxError("def f(p1, *, None, **k1):\n pass\n")
  43. self.assertRaisesSyntaxError("def f(p, *, (k1, k2), **kw):\n pass\n")
  44. def testSyntaxForManyArguments(self):
  45. # more than 255 positional arguments, should compile ok
  46. fundef = "def f(%s):\n pass\n" % ', '.join('i%d' % i for i in range(300))
  47. compile(fundef, "<test>", "single")
  48. # more than 255 keyword-only arguments, should compile ok
  49. fundef = "def f(*, %s):\n pass\n" % ', '.join('i%d' % i for i in range(300))
  50. compile(fundef, "<test>", "single")
  51. def testTooManyPositionalErrorMessage(self):
  52. def f(a, b=None, *, c=None):
  53. pass
  54. with self.assertRaises(TypeError) as exc:
  55. f(1, 2, 3)
  56. expected = (f"{f.__qualname__}() takes from 1 to 2 "
  57. "positional arguments but 3 were given")
  58. self.assertEqual(str(exc.exception), expected)
  59. def testSyntaxErrorForFunctionCall(self):
  60. self.assertRaisesSyntaxError("f(p, k=1, p2)")
  61. self.assertRaisesSyntaxError("f(p, k1=50, *(1,2), k1=100)")
  62. def testRaiseErrorFuncallWithUnexpectedKeywordArgument(self):
  63. self.assertRaises(TypeError, keywordonly_sum, ())
  64. self.assertRaises(TypeError, keywordonly_nodefaults_sum, ())
  65. self.assertRaises(TypeError, Foo, ())
  66. try:
  67. keywordonly_sum(k2=100, non_existing_arg=200)
  68. self.fail("should raise TypeError")
  69. except TypeError:
  70. pass
  71. try:
  72. keywordonly_nodefaults_sum(k2=2)
  73. self.fail("should raise TypeError")
  74. except TypeError:
  75. pass
  76. def testFunctionCall(self):
  77. self.assertEqual(1, posonly_sum(1))
  78. self.assertEqual(1+2, posonly_sum(1,**{"2":2}))
  79. self.assertEqual(1+2+3, posonly_sum(1,*(2,3)))
  80. self.assertEqual(1+2+3+4, posonly_sum(1,*(2,3),**{"4":4}))
  81. self.assertEqual(1, keywordonly_sum(k2=1))
  82. self.assertEqual(1+2, keywordonly_sum(k1=1, k2=2))
  83. self.assertEqual(1+2, keywordonly_and_kwarg_sum(k1=1, k2=2))
  84. self.assertEqual(1+2+3, keywordonly_and_kwarg_sum(k1=1, k2=2, k3=3))
  85. self.assertEqual(1+2+3+4,
  86. keywordonly_and_kwarg_sum(k1=1, k2=2,
  87. **{"a":3,"b":4}))
  88. self.assertEqual(1+2, mixedargs_sum(1, k1=2))
  89. self.assertEqual(1+2+3, mixedargs_sum(1, 2, k1=3))
  90. self.assertEqual(1+2+3+4, mixedargs_sum(1, 2, k1=3, k2=4))
  91. self.assertEqual(1+2+3+4+5, mixedargs_sum(1, 2, 3, k1=4, k2=5))
  92. self.assertEqual(1+2, mixedargs_sum2(1, k1=2))
  93. self.assertEqual(1+2+3, mixedargs_sum2(1, 2, k1=3))
  94. self.assertEqual(1+2+3+4, mixedargs_sum2(1, 2, k1=3, k2=4))
  95. self.assertEqual(1+2+3+4+5, mixedargs_sum2(1, 2, 3, k1=4, k2=5))
  96. self.assertEqual(1+2+3+4+5+6,
  97. mixedargs_sum2(1, 2, 3, k1=4, k2=5, k3=6))
  98. self.assertEqual(1+2+3+4+5+6,
  99. mixedargs_sum2(1, 2, 3, k1=4, **{'k2':5, 'k3':6}))
  100. self.assertEqual(1, Foo(k1=1).sum())
  101. self.assertEqual(1+2, Foo(k1=1,k2=2).sum())
  102. self.assertEqual([1,2,3], sortnum(3,2,1))
  103. self.assertEqual([3,2,1], sortnum(1,2,3, reverse=True))
  104. self.assertEqual(['a','b','c'], sortwords('a','c','b'))
  105. self.assertEqual(['c','b','a'], sortwords('a','c','b', reverse=True))
  106. self.assertEqual(['c','b','a'],
  107. sortwords('a','c','b', reverse=True, ignore='ignore'))
  108. def testKwDefaults(self):
  109. def foo(p1,p2=0, *, k1, k2=0):
  110. return p1 + p2 + k1 + k2
  111. self.assertEqual(2, foo.__code__.co_kwonlyargcount)
  112. self.assertEqual({"k2":0}, foo.__kwdefaults__)
  113. foo.__kwdefaults__ = {"k1":0}
  114. try:
  115. foo(1,k1=10)
  116. self.fail("__kwdefaults__ is not properly changed")
  117. except TypeError:
  118. pass
  119. def test_kwonly_methods(self):
  120. class Example:
  121. def f(self, *, k1=1, k2=2):
  122. return k1, k2
  123. self.assertEqual(Example().f(k1=1, k2=2), (1, 2))
  124. self.assertEqual(Example.f(Example(), k1=1, k2=2), (1, 2))
  125. self.assertRaises(TypeError, Example.f, k1=1, k2=2)
  126. def test_issue13343(self):
  127. # The Python compiler must scan all symbols of a function to
  128. # determine their scope: global, local, cell...
  129. # This was not done for the default values of keyword
  130. # arguments in a lambda definition, and the following line
  131. # used to fail with a SystemError.
  132. lambda *, k1=unittest: None
  133. def test_mangling(self):
  134. class X:
  135. def f(self, *, __a=42):
  136. return __a
  137. self.assertEqual(X().f(), 42)
  138. def test_default_evaluation_order(self):
  139. # See issue 16967
  140. a = 42
  141. with self.assertRaises(NameError) as err:
  142. def f(v=a, x=b, *, y=c, z=d):
  143. pass
  144. self.assertEqual(str(err.exception), "name 'b' is not defined")
  145. with self.assertRaises(NameError) as err:
  146. f = lambda v=a, x=b, *, y=c, z=d: None
  147. self.assertEqual(str(err.exception), "name 'b' is not defined")
  148. if __name__ == "__main__":
  149. unittest.main()