brain_qt.py 2.7 KB

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