aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/python/traitlets/py3/tests/utils/test_decorators.py
blob: 39b882c0ea84c3955e3e9253876175849c58f1aa (plain) (blame)
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
from __future__ import annotations

from inspect import Parameter, signature
from unittest import TestCase

from traitlets import HasTraits, Int, Unicode
from traitlets.utils.decorators import signature_has_traits


class TestExpandSignature(TestCase):
    def test_no_init(self):
        @signature_has_traits
        class Foo(HasTraits):
            number1 = Int()
            number2 = Int()
            value = Unicode("Hello")

        parameters = signature(Foo).parameters
        parameter_names = list(parameters)

        self.assertIs(parameters["args"].kind, Parameter.VAR_POSITIONAL)
        self.assertEqual("args", parameter_names[0])

        self.assertIs(parameters["number1"].kind, Parameter.KEYWORD_ONLY)
        self.assertIs(parameters["number2"].kind, Parameter.KEYWORD_ONLY)
        self.assertIs(parameters["value"].kind, Parameter.KEYWORD_ONLY)

        self.assertIs(parameters["kwargs"].kind, Parameter.VAR_KEYWORD)
        self.assertEqual("kwargs", parameter_names[-1])

        f = Foo(number1=32, value="World")
        self.assertEqual(f.number1, 32)
        self.assertEqual(f.number2, 0)
        self.assertEqual(f.value, "World")

    def test_partial_init(self):
        @signature_has_traits
        class Foo(HasTraits):
            number1 = Int()
            number2 = Int()
            value = Unicode("Hello")

            def __init__(self, arg1, **kwargs):
                self.arg1 = arg1

                super().__init__(**kwargs)

        parameters = signature(Foo).parameters
        parameter_names = list(parameters)

        self.assertIs(parameters["arg1"].kind, Parameter.POSITIONAL_OR_KEYWORD)
        self.assertEqual("arg1", parameter_names[0])

        self.assertIs(parameters["number1"].kind, Parameter.KEYWORD_ONLY)
        self.assertIs(parameters["number2"].kind, Parameter.KEYWORD_ONLY)
        self.assertIs(parameters["value"].kind, Parameter.KEYWORD_ONLY)

        self.assertIs(parameters["kwargs"].kind, Parameter.VAR_KEYWORD)
        self.assertEqual("kwargs", parameter_names[-1])

        f = Foo(1, number1=32, value="World")
        self.assertEqual(f.arg1, 1)
        self.assertEqual(f.number1, 32)
        self.assertEqual(f.number2, 0)
        self.assertEqual(f.value, "World")

    def test_duplicate_init(self):
        @signature_has_traits
        class Foo(HasTraits):
            number1 = Int()
            number2 = Int()

            def __init__(self, number1, **kwargs):
                self.test = number1

                super().__init__(number1=number1, **kwargs)

        parameters = signature(Foo).parameters
        parameter_names = list(parameters)

        self.assertListEqual(parameter_names, ["number1", "number2", "kwargs"])

        f = Foo(number1=32, number2=36)
        self.assertEqual(f.test, 32)
        self.assertEqual(f.number1, 32)
        self.assertEqual(f.number2, 36)

    def test_full_init(self):
        @signature_has_traits
        class Foo(HasTraits):
            number1 = Int()
            number2 = Int()
            value = Unicode("Hello")

            def __init__(self, arg1, arg2=None, *pos_args, **kw_args):
                self.arg1 = arg1
                self.arg2 = arg2
                self.pos_args = pos_args
                self.kw_args = kw_args

                super().__init__(*pos_args, **kw_args)

        parameters = signature(Foo).parameters
        parameter_names = list(parameters)

        self.assertIs(parameters["arg1"].kind, Parameter.POSITIONAL_OR_KEYWORD)
        self.assertEqual("arg1", parameter_names[0])

        self.assertIs(parameters["arg2"].kind, Parameter.POSITIONAL_OR_KEYWORD)
        self.assertEqual("arg2", parameter_names[1])

        self.assertIs(parameters["pos_args"].kind, Parameter.VAR_POSITIONAL)
        self.assertEqual("pos_args", parameter_names[2])

        self.assertIs(parameters["number1"].kind, Parameter.KEYWORD_ONLY)
        self.assertIs(parameters["number2"].kind, Parameter.KEYWORD_ONLY)
        self.assertIs(parameters["value"].kind, Parameter.KEYWORD_ONLY)

        self.assertIs(parameters["kw_args"].kind, Parameter.VAR_KEYWORD)
        self.assertEqual("kw_args", parameter_names[-1])

        f = Foo(1, 3, 45, "hey", number1=32, value="World")
        self.assertEqual(f.arg1, 1)
        self.assertEqual(f.arg2, 3)
        self.assertTupleEqual(f.pos_args, (45, "hey"))
        self.assertEqual(f.number1, 32)
        self.assertEqual(f.number2, 0)
        self.assertEqual(f.value, "World")

    def test_no_kwargs(self):
        with self.assertRaises(RuntimeError):

            @signature_has_traits
            class Foo(HasTraits):
                number1 = Int()
                number2 = Int()

                def __init__(self, arg1, arg2=None):
                    pass