File: testcustomparam.py

package info (click to toggle)
python-param 2.1.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,048 kB
  • sloc: python: 17,980; makefile: 3
file content (137 lines) | stat: -rw-r--r-- 3,368 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
"""
Unit tests for checking the API defended to create custom Parameters.
"""

import param
import pytest

from .utils import check_defaults


@pytest.fixture
def custom_parameter():
    class CustomParameter(param.Parameter):
        def __init__(self, default='custom', **params):
            super().__init__(default=default, **params)

    return CustomParameter


@pytest.fixture
def custom_parameter_with_slot():
    class CustomParameter(param.Parameter):

        __slots__ = ['foo', 'bar']

        def __init__(self, default='custom', foo=True, bar=None, **params):
            super().__init__(default=default,  **params)
            self.foo = foo
            self.bar = bar

    return CustomParameter



def _check_simple_defaults(param):
    assert param.default == 'custom'
    assert param.allow_None is False


def _check_slot_defaults(param):
    assert param.default == 'custom'
    assert param.allow_None is False
    assert param.foo is True
    assert param.bar is None


def test_customparam_defaults_unbound(custom_parameter):
    c = custom_parameter()

    check_defaults(c, label=None)
    _check_simple_defaults(c)


def test_customparam_defaults_class(custom_parameter):
    class P(param.Parameterized):
        c = custom_parameter()

    check_defaults(P.param.c, label='C')
    _check_simple_defaults(P.param.c)


def test_customparam_defaults_inst(custom_parameter):
    class P(param.Parameterized):
        c = custom_parameter()

    p = P()

    check_defaults(p.param.c, label='C')
    _check_simple_defaults(p.param.c)


def test_customparam_slot_defaults_unbound(custom_parameter_with_slot):
    c = custom_parameter_with_slot()

    check_defaults(c, label=None)
    _check_slot_defaults(c)


def test_customparam_slot_defaults_class(custom_parameter_with_slot):
    class P(param.Parameterized):
        c = custom_parameter_with_slot()

    check_defaults(P.param.c, label='C')
    _check_slot_defaults(P.param.c)


def test_customparam_slot_defaults_inst(custom_parameter_with_slot):
    class P(param.Parameterized):
        c = custom_parameter_with_slot()

    p = P()

    check_defaults(p.param.c, label='C')
    _check_slot_defaults(p.param.c)


def test_customparam_inheritance(custom_parameter_with_slot):
    class A(param.Parameterized):
        c = param.Parameter(doc='foo')

    class B(A):
        c = custom_parameter_with_slot()

    assert B.param.c.doc == 'foo'
    assert B().param.c.doc == 'foo'


def test_customparam_inheritance_override(custom_parameter_with_slot):
    class A(param.Parameterized):
        c = param.Parameter(doc='foo')

    class B(A):
        c = custom_parameter_with_slot(doc='bar')

    assert B.param.c.doc == 'bar'
    assert B().param.c.doc == 'bar'

def test_inheritance_parameter_attribute_without_default():

    class CustomParameter(param.Parameter):

        __slots__ = ['foo']

        # foo has no default value defined in _slot_defaults

        def __init__(self, foo=param.Undefined, **params):
            super().__init__(**params)
            # To trigger Parameter.__getattribute__
            self.foo = foo
            if self.foo == 'bar':
                pass

    with pytest.raises(
        KeyError,
        match="Slot 'foo' on unbound parameter 'CustomParameter' has no default value defined in `_slot_defaults`"
    ):
        CustomParameter()