summaryrefslogtreecommitdiffstats
path: root/sources/pyside2/tests/registry/signature_test.py
blob: 949244dc37966efb388672c8b9f4364d851e4051 (plain)
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
#############################################################################
##
## Copyright (C) 2017 The Qt Company Ltd.
## Contact: https://www.qt.io/licensing/
##
## This file is part of PySide2.
##
## $QT_BEGIN_LICENSE:LGPL$
## Commercial License Usage
## Licensees holding valid commercial Qt licenses may use this file in
## accordance with the commercial license agreement provided with the
## Software or, alternatively, in accordance with the terms contained in
## a written agreement between you and The Qt Company. For licensing terms
## and conditions see https://www.qt.io/terms-conditions. For further
## information use the contact form at https://www.qt.io/contact-us.
##
## GNU Lesser General Public License Usage
## Alternatively, this file may be used under the terms of the GNU Lesser
## General Public License version 3 as published by the Free Software
## Foundation and appearing in the file LICENSE.LGPL3 included in the
## packaging of this file. Please review the following information to
## ensure the GNU Lesser General Public License version 3 requirements
## will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
##
## GNU General Public License Usage
## Alternatively, this file may be used under the terms of the GNU
## General Public License version 2.0 or (at your option) the GNU General
## Public license version 3 or any later version approved by the KDE Free
## Qt Foundation. The licenses are as published by the Free Software
## Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
## included in the packaging of this file. Please review the following
## information to ensure the GNU General Public License requirements will
## be met: https://www.gnu.org/licenses/gpl-2.0.html and
## https://www.gnu.org/licenses/gpl-3.0.html.
##
## $QT_END_LICENSE$
##
#############################################################################

from __future__ import print_function, absolute_import

import sys
import os
import unittest
from collections import OrderedDict
from pprint import pprint
from util import isolate_warnings, check_warnings
import PySide2

"""
This test shows that we have over 14500 signatures,
and that they all can be created.
"""

all_modules = list("PySide2." + x for x in PySide2.__all__)

from PySide2.support.signature import parser, inspect

_do_print = (True if os.isatty(sys.stdout.fileno()) or "-v" in sys.argv
             else False)

def dprint(*args, **kw):
    if _do_print:
        print(*args, **kw)

def enum_module(mod_name):
    __import__(mod_name)
    count = 0
    module = sys.modules[mod_name]
    dprint()
    dprint("Module", mod_name)
    members = inspect.getmembers(module, inspect.isclass)
    for class_name, klass in members:
        signature = getattr(klass, '__signature__', None)
        dprint()
        # class_members = inspect.getmembers(klass)
        # gives us also the inherited things.
        dprint("  class {}:".format(class_name))
        if signature is None:
            pass # initialization not called?
        elif isinstance(signature, list):
            dprint("    with overloading():")
            for overload in signature:
                dprint("      def __init__" + str(overload))
        else:
            dprint("    def __init__" + str(signature))
        count += 1
        class_members = list(klass.__dict__.items())
        have_sig = signature is not None
        have_members = 0
        for func_name, func in class_members:
            signature = getattr(func, '__signature__', None)
            if signature is not None:
                if isinstance(signature, list):
                    dprint("    with overloading():")
                    for overload in signature:
                        dprint("      def", func_name + str(overload))
                else:
                    dprint("    def", func_name + str(signature))
                count += 1
                have_members = count
        if not have_sig and not have_members:
            # print at least "pass"
            dprint("    pass")
    return count

def enum_all():
    result = OrderedDict()
    total = 0
    for mod_name in all_modules:
        result[mod_name] = enum_module(mod_name)
        total += result[mod_name]
    pprint(result if sys.version_info >= (3,) else list(result.items()))
    print("Total", total)
    return result


class PySideSignatureTest(unittest.TestCase):
    def testAllSignaturesCanBuild(self):
        with isolate_warnings():
            # This test touches all attributes
            result = enum_all()
            # We omit the number of functions test.
            # That is replaced by existence_test.py .
            for mod_name, count in result.items():
                pass
            # If an attribute could not be computed, then we will have a warning
            # in the warningregistry.
            if check_warnings():
                raise RuntimeError("There are errors, see above.")

    def testSignatureExist(self):
        t1 = type(PySide2.QtCore.QObject.children.__signature__)
        self.assertEqual(t1, inspect.Signature)
        t2 = type(PySide2.QtCore.QObject.__dict__["children"].__signature__)
        self.assertEqual(t2, t1)
        obj = PySide2.QtWidgets.QApplication.palette
        t3 = type(obj.__signature__)
        self.assertEqual(t3, list)
        self.assertEqual(len(obj.__signature__), 3)
        for thing in obj.__signature__:
            self.assertEqual(type(thing), inspect.Signature)
        sm = PySide2.QtWidgets.QApplication.__dict__["palette"]
        self.assertFalse(callable(sm))
        self.assertEqual(sm.__func__, obj)
        self.assertTrue(hasattr(sm, "__signature__") and
                        sm.__signature__ is not None)

    def testSignatureIsCached(self):
        # see if we get the same object
        ob1 = PySide2.QtCore.QObject.children.__signature__
        ob2 = PySide2.QtCore.QObject.children.__signature__
        self.assertTrue(ob1 is ob2)
        # same with multi signature
        ob1 = PySide2.QtWidgets.QApplication.palette.__signature__
        ob2 = PySide2.QtWidgets.QApplication.palette.__signature__
        self.assertTrue(ob1 is ob2)

    def testModuleIsInitialized(self):
        assert PySide2.QtWidgets.QApplication.__signature__ is not None

    def test_NotCalled_is_callable_and_correct(self):
        # A signature that has a default value with some "Default(...)"
        # wrapper is callable and creates an object of the right type.
        sig = PySide2.QtCore.QByteArray().toPercentEncoding.__signature__
        called_default = sig.parameters["exclude"].default()
        self.assertEqual(type(called_default), PySide2.QtCore.QByteArray)

if __name__ == "__main__":
    unittest.main()