1# Licensed under the LGPL: https://www.gnu.org/licenses/old-licenses/lgpl-2.1.en.html
2# For details: https://github.com/pylint-dev/astroid/blob/main/LICENSE
3# Copyright (c) https://github.com/pylint-dev/astroid/blob/main/CONTRIBUTORS.txt
4
5"""Astroid hooks for the PyQT library."""
6
7from astroid import nodes
8from astroid.brain.helpers import register_module_extender
9from astroid.builder import AstroidBuilder, parse
10from astroid.manager import AstroidManager
11
12
13def _looks_like_signal(
14 node: nodes.FunctionDef, signal_name: str = "pyqtSignal"
15) -> bool:
16 """Detect a Signal node."""
17 klasses = node.instance_attrs.get("__class__", [])
18 # On PySide2 or PySide6 (since Qt 5.15.2) the Signal class changed locations
19 if node.qname().partition(".")[0] in {"PySide2", "PySide6"}:
20 return any(cls.qname() == "Signal" for cls in klasses) # pragma: no cover
21 if klasses:
22 try:
23 return klasses[0].name == signal_name
24 except AttributeError: # pragma: no cover
25 # return False if the cls does not have a name attribute
26 pass
27 return False
28
29
30def transform_pyqt_signal(node: nodes.FunctionDef) -> None:
31 module = parse("""
32 _UNSET = object()
33
34 class pyqtSignal(object):
35 def connect(self, slot, type=None, no_receiver_check=False):
36 pass
37 def disconnect(self, slot=_UNSET):
38 pass
39 def emit(self, *args):
40 pass
41 """)
42 signal_cls: nodes.ClassDef = module["pyqtSignal"]
43 node.instance_attrs["emit"] = [signal_cls["emit"]]
44 node.instance_attrs["disconnect"] = [signal_cls["disconnect"]]
45 node.instance_attrs["connect"] = [signal_cls["connect"]]
46
47
48def transform_pyside_signal(node: nodes.FunctionDef) -> None:
49 module = parse("""
50 class NotPySideSignal(object):
51 def connect(self, receiver, type=None):
52 pass
53 def disconnect(self, receiver):
54 pass
55 def emit(self, *args):
56 pass
57 """)
58 signal_cls: nodes.ClassDef = module["NotPySideSignal"]
59 node.instance_attrs["connect"] = [signal_cls["connect"]]
60 node.instance_attrs["disconnect"] = [signal_cls["disconnect"]]
61 node.instance_attrs["emit"] = [signal_cls["emit"]]
62
63
64def pyqt4_qtcore_transform():
65 return AstroidBuilder(AstroidManager()).string_build("""
66
67def SIGNAL(signal_name): pass
68
69class QObject(object):
70 def emit(self, signal): pass
71""")
72
73
74def register(manager: AstroidManager) -> None:
75 register_module_extender(manager, "PyQt4.QtCore", pyqt4_qtcore_transform)
76 manager.register_transform(
77 nodes.FunctionDef, transform_pyqt_signal, _looks_like_signal
78 )
79 manager.register_transform(
80 nodes.ClassDef,
81 transform_pyside_signal,
82 lambda node: node.qname() in {"PySide.QtCore.Signal", "PySide2.QtCore.Signal"},
83 )