test_extcall.py 8.64 KB
Newer Older
1

Christian Heimes's avatar
Christian Heimes committed
2 3 4 5
"""Doctest for method/function calls.

We're going the use these types for extra testing

6 7
    >>> from collections import UserList
    >>> from collections import UserDict
Christian Heimes's avatar
Christian Heimes committed
8 9 10 11

We're defining four helper functions

    >>> def e(a,b):
12
    ...     print(a, b)
Christian Heimes's avatar
Christian Heimes committed
13 14

    >>> def f(*a, **k):
15
    ...     print(a, support.sortdict(k))
Christian Heimes's avatar
Christian Heimes committed
16 17

    >>> def g(x, *y, **z):
18
    ...     print(x, y, support.sortdict(z))
Christian Heimes's avatar
Christian Heimes committed
19 20

    >>> def h(j=1, a=2, h=3):
21
    ...     print(j, a, h)
Christian Heimes's avatar
Christian Heimes committed
22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68

Argument list examples

    >>> f()
    () {}
    >>> f(1)
    (1,) {}
    >>> f(1, 2)
    (1, 2) {}
    >>> f(1, 2, 3)
    (1, 2, 3) {}
    >>> f(1, 2, 3, *(4, 5))
    (1, 2, 3, 4, 5) {}
    >>> f(1, 2, 3, *[4, 5])
    (1, 2, 3, 4, 5) {}
    >>> f(1, 2, 3, *UserList([4, 5]))
    (1, 2, 3, 4, 5) {}

Here we add keyword arguments

    >>> f(1, 2, 3, **{'a':4, 'b':5})
    (1, 2, 3) {'a': 4, 'b': 5}
    >>> f(1, 2, 3, *[4, 5], **{'a':6, 'b':7})
    (1, 2, 3, 4, 5) {'a': 6, 'b': 7}
    >>> f(1, 2, 3, x=4, y=5, *(6, 7), **{'a':8, 'b': 9})
    (1, 2, 3, 6, 7) {'a': 8, 'b': 9, 'x': 4, 'y': 5}

    >>> f(1, 2, 3, **UserDict(a=4, b=5))
    (1, 2, 3) {'a': 4, 'b': 5}
    >>> f(1, 2, 3, *(4, 5), **UserDict(a=6, b=7))
    (1, 2, 3, 4, 5) {'a': 6, 'b': 7}
    >>> f(1, 2, 3, x=4, y=5, *(6, 7), **UserDict(a=8, b=9))
    (1, 2, 3, 6, 7) {'a': 8, 'b': 9, 'x': 4, 'y': 5}

Examples with invalid arguments (TypeErrors). We're also testing the function
names in the exception messages.

Verify clearing of SF bug #733667

    >>> e(c=4)
    Traceback (most recent call last):
      ...
    TypeError: e() got an unexpected keyword argument 'c'

    >>> g()
    Traceback (most recent call last):
      ...
69
    TypeError: g() missing 1 required positional argument: 'x'
Christian Heimes's avatar
Christian Heimes committed
70 71 72 73

    >>> g(*())
    Traceback (most recent call last):
      ...
74
    TypeError: g() missing 1 required positional argument: 'x'
Christian Heimes's avatar
Christian Heimes committed
75 76 77 78

    >>> g(*(), **{})
    Traceback (most recent call last):
      ...
79
    TypeError: g() missing 1 required positional argument: 'x'
Christian Heimes's avatar
Christian Heimes committed
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94

    >>> g(1)
    1 () {}
    >>> g(1, 2)
    1 (2,) {}
    >>> g(1, 2, 3)
    1 (2, 3) {}
    >>> g(1, 2, 3, *(4, 5))
    1 (2, 3, 4, 5) {}

    >>> class Nothing: pass
    ...
    >>> g(*Nothing())
    Traceback (most recent call last):
      ...
95
    TypeError: g() argument after * must be a sequence, not Nothing
Christian Heimes's avatar
Christian Heimes committed
96 97 98 99 100 101 102 103

    >>> class Nothing:
    ...     def __len__(self): return 5
    ...

    >>> g(*Nothing())
    Traceback (most recent call last):
      ...
104
    TypeError: g() argument after * must be a sequence, not Nothing
Christian Heimes's avatar
Christian Heimes committed
105 106 107 108 109 110 111 112 113 114 115 116 117 118

    >>> class Nothing():
    ...     def __len__(self): return 5
    ...     def __getitem__(self, i):
    ...         if i<3: return i
    ...         else: raise IndexError(i)
    ...

    >>> g(*Nothing())
    0 (1, 2) {}

    >>> class Nothing:
    ...     def __init__(self): self.c = 0
    ...     def __iter__(self): return self
119
    ...     def __next__(self):
Christian Heimes's avatar
Christian Heimes committed
120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153
    ...         if self.c == 4:
    ...             raise StopIteration
    ...         c = self.c
    ...         self.c += 1
    ...         return c
    ...

    >>> g(*Nothing())
    0 (1, 2, 3) {}

Make sure that the function doesn't stomp the dictionary

    >>> d = {'a': 1, 'b': 2, 'c': 3}
    >>> d2 = d.copy()
    >>> g(1, d=4, **d)
    1 () {'a': 1, 'b': 2, 'c': 3, 'd': 4}
    >>> d == d2
    True

What about willful misconduct?

    >>> def saboteur(**kw):
    ...     kw['x'] = 'm'
    ...     return kw

    >>> d = {}
    >>> kw = saboteur(a=1, **d)
    >>> d
    {}


    >>> g(1, 2, 3, **{'x': 4, 'y': 5})
    Traceback (most recent call last):
      ...
154
    TypeError: g() got multiple values for argument 'x'
Christian Heimes's avatar
Christian Heimes committed
155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209

    >>> f(**{1:2})
    Traceback (most recent call last):
      ...
    TypeError: f() keywords must be strings

    >>> h(**{'e': 2})
    Traceback (most recent call last):
      ...
    TypeError: h() got an unexpected keyword argument 'e'

    >>> h(*h)
    Traceback (most recent call last):
      ...
    TypeError: h() argument after * must be a sequence, not function

    >>> dir(*h)
    Traceback (most recent call last):
      ...
    TypeError: dir() argument after * must be a sequence, not function

    >>> None(*h)
    Traceback (most recent call last):
      ...
    TypeError: NoneType object argument after * must be a sequence, \
not function

    >>> h(**h)
    Traceback (most recent call last):
      ...
    TypeError: h() argument after ** must be a mapping, not function

    >>> dir(**h)
    Traceback (most recent call last):
      ...
    TypeError: dir() argument after ** must be a mapping, not function

    >>> None(**h)
    Traceback (most recent call last):
      ...
    TypeError: NoneType object argument after ** must be a mapping, \
not function

    >>> dir(b=1, **{'b': 1})
    Traceback (most recent call last):
      ...
    TypeError: dir() got multiple values for keyword argument 'b'

Another helper function

    >>> def f2(*a, **b):
    ...     return a, b


    >>> d = {}
210
    >>> for i in range(512):
Christian Heimes's avatar
Christian Heimes committed
211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226
    ...     key = 'k%d' % i
    ...     d[key] = i
    >>> a, b = f2(1, *(2,3), **d)
    >>> len(a), len(b), b == d
    (3, 512, True)

    >>> class Foo:
    ...     def method(self, arg1, arg2):
    ...         return arg1+arg2

    >>> x = Foo()
    >>> Foo.method(*(x, 1, 2))
    3
    >>> Foo.method(x, *(1, 2))
    3
    >>> Foo.method(*(1, 2, 3))
227
    5
Christian Heimes's avatar
Christian Heimes committed
228
    >>> Foo.method(1, *[2, 3])
229
    5
Christian Heimes's avatar
Christian Heimes committed
230

231
A PyCFunction that takes only positional parameters should allow an
Christian Heimes's avatar
Christian Heimes committed
232 233 234 235 236 237 238 239 240 241 242 243 244 245 246
empty keyword dictionary to pass without a complaint, but raise a
TypeError if te dictionary is not empty

    >>> try:
    ...     silence = id(1, *{})
    ...     True
    ... except:
    ...     False
    True

    >>> id(1, **{'foo': 1})
    Traceback (most recent call last):
      ...
    TypeError: id() takes no keyword arguments

Benjamin Peterson's avatar
Benjamin Peterson committed
247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264
A corner case of keyword dictionary items being deleted during
the function call setup. See <http://bugs.python.org/issue2016>.

    >>> class Name(str):
    ...     def __eq__(self, other):
    ...         try:
    ...              del x[self]
    ...         except KeyError:
    ...              pass
    ...         return str.__eq__(self, other)
    ...     def __hash__(self):
    ...         return str.__hash__(self)

    >>> x = {Name("a"):1, Name("b"):2}
    >>> def f(a, b):
    ...     print(a,b)
    >>> f(**x)
    1 2
265

266
Too many arguments:
267

268 269
    >>> def f(): pass
    >>> f(1)
270 271
    Traceback (most recent call last):
      ...
272 273 274
    TypeError: f() takes 0 positional arguments but 1 was given
    >>> def f(a): pass
    >>> f(1, 2)
275 276
    Traceback (most recent call last):
      ...
277 278 279
    TypeError: f() takes 1 positional argument but 2 were given
    >>> def f(a, b=1): pass
    >>> f(1, 2, 3)
280 281
    Traceback (most recent call last):
      ...
282 283 284
    TypeError: f() takes from 1 to 2 positional arguments but 3 were given
    >>> def f(*, kw): pass
    >>> f(1, kw=3)
285 286
    Traceback (most recent call last):
      ...
287 288 289 290 291 292 293 294
    TypeError: f() takes 0 positional arguments but 1 positional argument (and 1 keyword-only argument) were given
    >>> def f(*, kw, b): pass
    >>> f(1, 2, 3, b=3, kw=3)
    Traceback (most recent call last):
      ...
    TypeError: f() takes 0 positional arguments but 3 positional arguments (and 2 keyword-only arguments) were given
    >>> def f(a, b=2, *, kw): pass
    >>> f(2, 3, 4, kw=4)
295 296
    Traceback (most recent call last):
      ...
297
    TypeError: f() takes from 1 to 2 positional arguments but 3 positional arguments (and 1 keyword-only argument) were given
298

299 300 301
Too few and missing arguments:

    >>> def f(a): pass
302 303 304
    >>> f()
    Traceback (most recent call last):
      ...
305 306 307
    TypeError: f() missing 1 required positional argument: 'a'
    >>> def f(a, b): pass
    >>> f()
308 309
    Traceback (most recent call last):
      ...
310 311
    TypeError: f() missing 2 required positional arguments: 'a' and 'b'
    >>> def f(a, b, c): pass
312 313 314
    >>> f()
    Traceback (most recent call last):
      ...
315 316
    TypeError: f() missing 3 required positional arguments: 'a', 'b', and 'c'
    >>> def f(a, b, c, d, e): pass
317 318 319
    >>> f()
    Traceback (most recent call last):
      ...
320 321 322
    TypeError: f() missing 5 required positional arguments: 'a', 'b', 'c', 'd', and 'e'
    >>> def f(a, b=4, c=5, d=5): pass
    >>> f(c=12, b=9)
323 324
    Traceback (most recent call last):
      ...
325
    TypeError: f() missing 1 required positional argument: 'a'
326

327 328 329
Same with keyword only args:

    >>> def f(*, w): pass
330 331
    >>> f()
    Traceback (most recent call last):
332 333 334 335
      ...
    TypeError: f() missing 1 required keyword-only argument: 'w'
    >>> def f(*, a, b, c, d, e): pass
    >>> f()
336
    Traceback (most recent call last):
337 338 339
      ...
    TypeError: f() missing 5 required keyword-only arguments: 'a', 'b', 'c', 'd', and 'e'

Christian Heimes's avatar
Christian Heimes committed
340 341
"""

342
import sys
343
from test import support
Christian Heimes's avatar
Christian Heimes committed
344 345

def test_main():
346
    support.run_doctest(sys.modules[__name__], True)
Christian Heimes's avatar
Christian Heimes committed
347 348 349

if __name__ == '__main__':
    test_main()