Introduction
La bibliothèque PySide est un wrapper Python pour la boîte à outils d'interface utilisateur graphique (GUI) multiplateforme Qt. FreeCAD utilise Qt comme principale boîte à outils GUI. Qt est plus qu'une simple boîte à outils GUI, c'est une collection de bibliothèques C++ à des fins diverses. On peut par exemple faire du réseautage avec les composants de la bibliothèque Qt, tous accessibles en Python via PySide. Toute interface graphique pouvant être créée en C++ peut également être créée et modifiée en Python. L'avantage d'utiliser Python est que les interfaces Qt peuvent être développées et testées en direct, car il n'est pas nécessaire de compiler les fichiers source.
La méthode recommandée pour importer PySide (quelle que soit la version) dans FreeCAD est la suivante :
from PySide import QtCore, QtGui, QtWidgets
Versions Qt & PySide
- La version 1.0 de Qt a été lancée au milieu des années 1990.
- La version 4.0 de Qt a été lancée en 2005 et la série 4.x a été officiellement retirée en 2015.
- Le wrapper Python pour Qt4.x s'appelle PySide.
- La version 5.0 de Qt a été publiée en 2012 et la série 5.x a été officiellement retirée en 2020.
- Le wrapper Python pour Qt5.x s'appelle PySide2.
- La version 6.0 de Qt a été publiée en 2020, il s'agit de la série de versions actuelle.
- Le wrapper Python pour Qt6.x s'appelle PySide6.
Exemples créés avec PySide. À gauche: un simple dialogue. À droite: un dialogue plus complexe avec des graphiques.
FreeCAD et PySide
L'idée initiale derrière FreeCAD était de réunir Cas.CADE (noyau géométrique), Qt (boîte à outils graphique) et Python afin de créer un programme de CAO paramétrique 3D libre avec un moteur de script intégré. C'était au début des années 2000, c'est-à-dire avant l'existence de PySide, et c'est pourquoi un autre wrapper, PyQt, a été utilisé pendant les dix premières années d'existence de FreeCAD. PySide a été créé pour résoudre les problèmes de licence avec PyQt, et le passage de FreeCAD à PySide a été effectué en 2013 (commit 1dc122dc9a).
Si vous souhaitez connaître la version de Qt utilisée par votre installation, la boîte de dialogue À propos contient une liste des versions dans laquelle Qt est inclus.
Pour plus d'informations, consultez :
Lorsque vous installez FreeCAD, vous obtenez à la fois Qt et PySide correspondant dans le cadre du paquet. Si vous effectuez vous-même la compilation, vous devez vérifier que les versions correspondantes de ces deux bibliothèques sont installées afin que FreeCAD fonctionne correctement. Bien sûr, PySide ne fonctionnera que si Qt est présent.
Compatibilité multi-versions
La principale différence entre les bibliothèques PySide, PySide2 et PySide6 réside dans l'espace de noms. PySide (Qt4) dispose des espaces de noms principaux QtGui et QtCore, tandis que PySide2 (Qt5) et PySide6 (Qt6) ont introduit l'espace de noms supplémentaire QtWidgets, où se trouvent désormais tous les widgets, qui se trouvaient auparavant dans l'espace de noms QtGui.
L'approche de FreeCAD pour gérer les différentes versions de Qt/PySide consiste à les appeler toutes les PySide, ce qui devrait en réalité être considéré comme PySideX. Peu importe la version de Qt/PySide installée, elles sont toutes importées avec PySide.
Un shim gère les différences entre les versions. Ce shim PySide se trouve dans le répertoire Ext/ d'une installation de FreeCAD compilée pour Qt5/Qt6.
/usr/share/freecad/Ext/PySide
Ce module importe simplement les classes nécessaires depuis PySide2/6 et les place dans l'espace de noms PySide. Cette approche a été choisie pour sa capacité à assurer la rétrocompatibilité du point de vue de Qt4.
PySide2.QtCore -> PySide.QtCore
PySide2.QtGui -> PySide.QtGui
PySide2.QtWidgets -> PySide.QtWidgets
PySide2.QtSvg -> PySide.QtSvg
PySide2.QtUiTools -> PySide.QtUiTools
C'est pourquoi les classes PySide2.QtWidgets sont également placées dans l'espace de noms PySide.QtGui.
PySide2.QtWidgets.QCheckBox -> PySide.QtGui.QCheckBox
Mais la méthode actuellement recommandée consiste à utiliser l'espacement moderne.
from PySide import QtCore, QtGui, QtWidgets
my_check_box = QtWidgets.QCheckBox()
Exemples d'utilisation de PySide
- Exemples PySide Débutant, bonjour le monde, annonces, entrez du texte, entrez un numéro.
- Exemples intermédiaires PySide, dimensionnement de la fenêtre, masquage des widgets, menus contextuels, position de la souris, événements de la souris.
- Exemples avancés de PySide, de nombreux widgets.
Les exemples de PySide sont divisés en 3 parties, différenciées par niveau d'exposition à PySide, Python et les composants internes de FreeCAD. La première page a un aperçu sur PySide; les deuxième et troisième pages sont pour la plupart des exemples de code à différents niveaux.
On s'attend à ce que ces exemples soient utiles pour commencer et par la suite l'utilisateur peut consulter d'autres ressources en ligne ou la documentation officielle.
Documentation
Il existe certaines différences dans la gestion des widgets entre les différentes versions. Les programmeurs doivent être conscients de ces incompatibilités et consulter la documentation officielle si quelque chose ne fonctionne pas comme prévu sur une plateforme donnée. Bien que cela soit rare, il peut parfois être nécessaire d'effectuer des appels versionnés via des clauses if.
La documentation PySide fait référence aux classes de style Python; cependant, puisque Qt est à l'origine une bibliothèque C++, les mêmes informations devraient être disponibles dans la référence C++ correspondante.
- Modules Qt disponibles sur PySide6 (Qt5/Qt6).
- Toutes les classes Qt par module dans Qt5 pour C++.
- Modules Qt disponibles auprès de PySide (Qt4).
Cette page est extraite de https://wiki.freecad.org/PySide