File: test_advanced.py

package info (click to toggle)
python-makefun 1.15.4-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 440 kB
  • sloc: python: 2,384; makefile: 2
file content (262 lines) | stat: -rw-r--r-- 7,953 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
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
154
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
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
import logging
import sys

import pytest

from makefun.main import get_signature_from_string, with_signature

from makefun import create_wrapper, wraps

try:  # python 3.3+
    from inspect import signature, Signature, Parameter
except ImportError:
    from funcsigs import signature, Signature, Parameter


def test_non_representable_defaults():
    """ Tests that non-representable default values are handled correctly """

    def foo(logger=logging.getLogger('default')):
        pass

    @wraps(foo)
    def bar(*args, **kwargs):
        pass

    bar()


def test_preserve_attributes():
    """ Tests that attributes are preserved """

    def foo():
        pass

    setattr(foo, 'a', True)

    @wraps(foo)
    def bar(*args, **kwargs):
        pass

    assert bar.a


def test_empty_name_in_string():
    """ Tests that string signatures can now be provided without function name"""
    if sys.version_info < (3, 0):
        str_sig = '(a)'
    else:
        str_sig = '(a:int)'
    func_name, func_sig, func_sig_str = get_signature_from_string(str_sig, locals())
    assert func_name is None
    # to handle type hints in signatures in python 3.5 we have to always remove the spaces
    assert str(func_sig).replace(' ', '') == str_sig
    assert func_sig_str == str_sig + ':'


def test_same_than_wraps_basic():
    """Tests that the metadata set by @wraps is correct"""

    from tests.test_doc import test_from_sig_wrapper
    from functools import wraps as functools_wraps

    def foo_wrapper(*args, **kwargs):
        """ hoho """
        pass

    functool_wrapped = functools_wraps(test_from_sig_wrapper)(foo_wrapper)

    # WARNING: functools.wraps irremediably contaminates foo_wrapper, we have to redefine it
    def foo_wrapper(*args, **kwargs):
        """ hoho """
        pass

    makefun_wrapped = wraps(test_from_sig_wrapper)(foo_wrapper)
    # compare with the default behaviour of with_signature, that is to copy metadata from the decorated
    makefun_with_signature_inverted = with_signature(signature(test_from_sig_wrapper))(test_from_sig_wrapper)
    makefun_with_signature_normal = with_signature(signature(test_from_sig_wrapper))(foo_wrapper)

    for field in ('__module__', '__name__', '__qualname__', '__doc__', '__annotations__'):
        if sys.version_info < (3, 0) and field in {'__qualname__', '__annotations__'}:
            pass
        else:
            assert getattr(functool_wrapped, field) == getattr(makefun_wrapped, field), "field %s is different" % field
            assert getattr(functool_wrapped, field) == getattr(makefun_with_signature_inverted, field), "field %s is different" % field
            if field != '__annotations__':
                assert getattr(functool_wrapped, field) != getattr(makefun_with_signature_normal, field), "field %s is identical" % field


def tests_wraps_sigchange():
    """ Tests that wraps can be used to change the signature """

    def foo(a):
        """ hoho """
        return a

    @wraps(foo, new_sig="(a, b=0)")
    def goo(*args, **kwargs):
        kwargs.pop('b')
        return foo(*args, **kwargs)

    for field in ('__module__', '__name__', '__qualname__', '__doc__', '__annotations__'):
        if sys.version_info < (3, 0) and field in {'__qualname__', '__annotations__'}:
            pass
        else:
            assert getattr(goo, field) == getattr(foo, field), "field %s is different" % field

    assert str(signature(goo)) == "(a, b=0)"
    assert goo('hello') == 'hello'


def tests_wraps_lambda():
    """ Tests that `@wraps` can duplicate the signature of a lambda """
    foo = lambda a: a

    @wraps(foo)
    def goo(*args, **kwargs):
        return foo(*args, **kwargs)

    assert goo.__name__ == (lambda: None).__name__
    assert str(signature(goo)) == '(a)'
    assert goo('hello') == 'hello'


def tests_wraps_renamed_lambda():
     """ Tests that `@wraps` can duplicate the signature of a lambda that has been renamed """
     foo = lambda a: a
     foo.__name__ = 'bar'

     @wraps(foo)
     def goo(*args, **kwargs):
         return foo(*args, **kwargs)

     assert goo.__name__ == 'bar'
     assert str(signature(goo)) == '(a)'
     assert goo('hello') == 'hello'


def test_lambda_signature_str():
    """ Tests that `@with_signature` can create a lambda from a signature string """
    new_sig = '(a, b=5)'

    @with_signature(new_sig, func_name='<lambda>')
    def foo(a, b):
        return a + b

    assert foo.__name__ == '<lambda>'
    assert foo.__code__.co_name == '<lambda>'
    assert str(signature(foo)) == new_sig
    assert foo(a=4) == 9


def test_co_name():
    """ Tests that `@with_signature` can be used to change the __code__.co_name """
    @with_signature('()', co_name='bar')
    def foo():
        return 'hello'

    assert foo.__name__ == 'foo'
    assert foo.__code__.co_name == 'bar'
    assert foo() == 'hello'


def test_with_signature_lambda():
    """ Tests that `@with_signature` can be used to change the __code__.co_name to `'<lambda>'` """
    @with_signature('()', co_name='<lambda>')
    def foo():
        return 'hello'

    assert foo.__code__.co_name == '<lambda>'
    assert foo() == 'hello'


def test_create_wrapper_lambda():
    """ Tests that `create_wrapper` returns a lambda function when given a lambda function to wrap"""
    def foo():
        return 'hello'
    bar = create_wrapper(lambda: None, foo)

    assert bar.__name__ == '<lambda>'
    assert bar() == 'hello'


def test_invalid_co_name():
    """ Tests that `@with_signature` raises a `ValueError` when given an `co_name` that cannot be duplicated. """
    with pytest.raises(ValueError):
        @with_signature('()', co_name='<invalid>')
        def foo():
            return 'hello'


def test_invalid_func_name():
    """ Tests that `@with_signature` can duplicate a func_name that is invalid in a function definition. """
    @with_signature('()', func_name='<invalid>')
    def foo():
        return 'hello'

    assert foo.__name__ == '<invalid>'
    assert foo() == 'hello'


@pytest.mark.skipif(sys.version_info < (3, 0), reason="requires python3 or higher")
def test_qualname_when_nested():
    """ Tests that qualname is correctly set when `@with_signature` is applied on nested functions """

    class C:
        def f(self):
            pass
        class D:
            @with_signature("(self, a)")
            def g(self):
                pass

    assert C.__qualname__ == 'test_qualname_when_nested.<locals>.C'
    assert C.f.__qualname__ == 'test_qualname_when_nested.<locals>.C.f'
    assert C.D.__qualname__ == 'test_qualname_when_nested.<locals>.C.D'

    # our mod
    assert C.D.g.__qualname__ == 'test_qualname_when_nested.<locals>.C.D.g'
    assert str(signature(C.D.g)) == "(self, a)"


@pytest.mark.skipif(sys.version_info < (3, 5), reason="requires python 3.5 or higher (non-comment type hints)")
def test_type_hint_error():
    """ Test for https://github.com/smarie/python-makefun/issues/32 """

    from tests._test_py35 import make_ref_function
    ref_f = make_ref_function()

    @wraps(ref_f)
    def foo(a):
        return a

    assert foo(10) == 10


@pytest.mark.skipif(sys.version_info < (3, 5), reason="requires python 3.5 or higher (non-comment type hints)")
def test_type_hint_error2():
    """ Test for https://github.com/smarie/python-makefun/issues/32 """

    from tests._test_py35 import make_ref_function2
    ref_f = make_ref_function2()

    @wraps(ref_f)
    def foo(a):
        return a

    assert foo(10) == 10


@pytest.mark.skipif(sys.version_info < (3, 5), reason="requires python 3.5 or higher (non-comment type hints)")
def test_type_hint_error_sigchange():
    """ Test for https://github.com/smarie/python-makefun/issues/32 """

    from tests._test_py35 import make_ref_function
    from typing import Any
    ref_f = make_ref_function()

    @wraps(ref_f, new_sig="(a: Any)")
    def foo(a):
        return a

    assert foo(10) == 10