Extra python modules/fr

Présentation
Cette page contient plusieurs modules python supplémentaires ou d'autres bouts de code qui peuvent être téléchargés gratuitement sur Internet, et ajouter des fonctionnalités à votre installation de FreeCAD.

PySide (précédemment PyQt4)

 * page officielle (PySide): http://qt-project.org/wiki/PySide
 * licence: LGPL
 * option, plusieurs modules sont nécessaires et d'autres modules peuvent être ajoutés : Draft, Arch, Ship, Plot, OpenSCAD, Spreadsheet

PySide (auparavant PyQt) est requise par tous les modules de FreeCAD et pour accéder à l'interface Qt de FreeCAD. Il est déjà livré dans dans les versions FreeCAD, et est généralement installé automatiquement par FreeCAD sur Linux, l'installation peut se faire à partir des dépôts officiels. Si ces modules (Draft, Arch, etc) sont activés après l'installation de FreeCAD, cela signifie que PySide (auparavant PyQt) est déjà installé, et vous n'avez pas besoin de faire quoi que ce soit de plus.

Remarque : PyQt4 va devenir progressivement obsolète dans FreeCAD, après la version 0.13, la préférence ira sur PySide, qui fait exactement le même travail, mais dispose d'une licence (LGPL) plus compatible avec FreeCAD.

Linux
La façon la plus simple d'installer PySide est de l'installer par le biais du gestionnaire de paquets de votre distribution. Sur les systèmes Debian / Ubuntu, le nom du package est généralement python-PySide, tandis que sur les systèmes basés sur RPM il est nommé Pyside. Les dépendances nécessaires (Qt et SIP) seront pris en charge automatiquement.

Windows
Le programme peut être téléchargé à partir PySide Downloads. Vous aurez besoin d'installer les bibliothèques Qt et SIP avant d'installer PySide (à documenter).

MacOSX
PyQt pour Mac doit être installé via homebrew ou port. Pour plus d'informations voir Installation des dépendances.

Utilisation
Une fois installé, vous pouvez vérifier le bon fonctionne de l'installation, en tapant dans la console Python de FreeCAD :

Pour accéder à l'interface de FreeCAD, tapez :

Maintenant, vous pouvez commencer l'exploration de l'interface avec la commande dir. Vous pouvez ajouter de nouveaux éléments, comme un widget personnalisé, avec des commandes comme :

Travailler avec Unicode :

Travailler avec QFileDialog et OpenFileName :

Travailler avec QFileDialog et SaveFileName :

Exemple de transition de PyQt4 vers PySide
PS: ces exemples d'erreurs ont été trouvées dans la transition de PyQt4 à PySide et ces corrections ont été faites, d'autres solutions sont certainement disponibles avec les exemples ci-dessus

Pour accéder à l'interface FreeCAD, tapez: Vous pouvez ajouter de nouveaux éléments, comme un widget personnalisé, avec des commandes comme :

Travailler avec Unicode :

Travailler avec QFileDialog et OpenFileName :

Travailler avec QFileDialog et SaveFileName :

Travailler avec MessageBox:

Travailler avec setProperty (PyQt4) et setValue (PySide)

remplacer par :

Travailler avec setToolTip

remplacer par :

ou

Documentation
Plus de tutoriels sur PyQt4 (y compris sur la façon de construire des interfaces avec Qt Designer pour utiliser avec python) :


 * API PyQt4 - La référence officielle sur l'API de PyQt4


 * Introduction PyQt4- une simple introduction.


 * un tutoriel - vraiment complet.

Pivy

 * homepage: https://bitbucket.org/Coin3D/coin/wiki/Home
 * license: BSD
 * option, utilisé par tous les modules de FreeCAD: Draft, Arch

Pivy a besoin de plusieurs modules pour accéder à la vue 3D de FreeCAD. Pour les fenêtres, pivy est déjà fourni dans l'installateur de FreeCAD pour Linux, il est généralement installé automatiquement lorsque vous installez FreeCAD partir d'un référentiel officiel. Sur MacOSX, malheureusement, vous aurez besoin de compiler Pivy vous même.

Prérequis
Je crois, qu'avant de compiler Pivy vous devez avoir Coin et SoQt d'installés.

J'ai trouvé que pour la compilation sur Mac, il suffisait d'installer le Coin3 binary package.

La tentative d'installation de Coin sur MacPorts était problématique : j'ai essayé d'ajouter un grand nombre de paquets X Windows, et, finalement, tout c'est terminé avec une erreur de script !

Pour Fedora, j'ai trouvé un RPM avec Coin3.

SoQt, compilé à partir des sources fonctionne très bien sur Mac et Linux.

Debian & Ubuntu
Depuis Debian Squeeze et Ubuntu Lucid, Pivy est disponible directement à partir des dépôts officiels, et, nous permet d'économiser beaucoup de tracas.

En attendant, vous pouvez soit télécharger l'un des packages que nous avons fait (pour Debian et Ubuntu karmic), disponibles sur les pages de téléchargements, ou, vous pouvez le compiler vous-même.

La meilleure façon de compiler facilement Pivy, est de prendre le debian source package pour Pivy, et, faire un package avec debuild.

C'est le même code source que sur le site officiel de Pivy, mais, les gens de Debian ont ajoutés plusieurs bug-fixing. Il compile également très bien sur : Ubuntu Karmic ... télécharger .orig.gz et .diff.gz, décompressez le tout, puis appliquez .diff à la source :

allez dans le dossier source de Pivy décompressé, et appliquez le patch .diff :

alors

pour avoir Pivy, correctement compilé, avec un package officiellement installable. Ensuite, il suffit d'installer le package avec gdebi.

Autres distributions Linux
D'abord, téléchargez les dernières sources du project's repository :

En Mars 2012, la dernière version était la pivy-0.5.

Ensuite, vous avez besoin d'un outil appelé SWIG pour générer le code C++ pour les Python bindings. Pivy-0.5 rapports qui a été testé seulement avec SWIG 1.3.31, 1.3.33, 1.3.35 et 1.3.40. Ainsi, vous pouvez télécharger une archive source pour l'une de ces anciennes versions de SWIG.

Puis, décompressez-le, et, faites en ligne de commande (en tant que root) :

Il faut quelques secondes pour la compilation.

Alternativement, vous pouvez essayer avec une compilation plus récent SWIG. En Mars 2012, la version référentielle typique était 2.0.4.

Pivy a un problème de compilation avec les versions inférieures 2.0.4 de SWIG sur Mac OS (voir ci-dessous), mais semble compiler correctement sur Fedora Core 15.

Après cela, allez dans le source Pivy et tapez :

pour créer les fichiers sources. Notez que cette génération de fichiers peut produire des milliers de mises en garde, mais j'espère qu'il n'y aura pas d'erreurs.

Ceci est probablement obsolète, mais vous risquez de rencontrer une erreur de compilation, ou, un "const char*" ne peut pas être converti en un "char*".

Pour corriger cela, il vous suffit d'écrire une "const", dans les lignes appropriées, avant la génération. Il y a six lignes à corriger.

Après cela, installez (en tant que root) :

Ça y est, pivy est installé.

Mac OS
Ces instructions peuvent ne pas être complètes. Quelque chose plus ou moins comme cela a fonctionné pour OS 10.7 de Mars 2012. J'utilise MacPorts pour les dépôts, mais d'autres options devraient également fonctionner.

En ce qui concerne linux, téléchargez les dernières sources :

Si vous n'avez pas hg, vous pouvez l'obtenir à partir MacPorts :

Puis, comme ci-dessus vous avez besoin SWIG.

Faites :

J'ai trouvé que j'avais besoin aussi de faire :

En Mars 2012, MacPorts SWIG est la version 2.0.4. Comme il est indiqué ci-dessus pour Linux, il vaudrait mieux télécharger une version plus ancienne. SWIG 2.0.4 semble avoir un bug qui empêche la compilation de Pivy.

Regardez le premier message dans ce : digest

Cela peut être corrigé, en modifiant les 2 emplacements source et déréférencer : *arg4, *arg5 à la place de arg4, arg5.

Maintenant nous pouvons compiler Pivy:

Windows
En supposant que vous utilisiez Visual Studio 2005 ou une version ultérieure, vous devrez ouvrir une invite de commande avec Visual Studio 2005 Command prompt dans le menu Outils.

Si l'interpréteur Python n'est pas encore dans le chemin système (PATH), faites :

Pour que Pivy soit fonctionnel, vous devriez télécharger les dernières sources à partir du référentiel du projet :

Ensuite, vous avez besoin d'un outil appelé SWIG pour générer le code C++ pour les Python bindings. Il est recommandé d'utiliser la version 1.3.25 de SWIG, pas la dernière version, parceque, Pivy ne fonctionne pas correctement avec la version 1.3.25. Télécharger le binaire pour la version 1.3.25 de Swig.

Puis décompressez-le et à partir de la ligne de commande, ajoutez le chemin (path) du système

et définir le chemin approprié à COINDIR :

Sous Windows, le fichier de configuration Pivy attend SoWin au lieu de SoQt par défaut. Je n'ai pas trouvé de façon évidente pour compiler avec SoQt, alors, j'ai modifié le fichier setup.py directement.

A la ligne 200 il suffit de retirer la partie sowin : ('gui._sowin', 'sowin-config', 'pivy.gui.') (ne pas enlever la parenthèse fermante ! ).

Après cela, allez dans le source de pivy et tapez :

qui crée les fichiers source. Vous pouvez rencontrer une erreur de compilation, cause, plusieurs fichiers d'en-tête n'ont pas été trouvés.

Dans ce cas, réglez la variable INCLUDE comme ceci :

et si les en-têtes soqt, ne sont pas au même endroit que les en-têtes Coin, faites aussi ceci :

et finalement, pour les en-têtes Qt faites :

Si vous utilisez Express Edition of Visual Studio, vous pouvez obtenir une exception Python keyerror.

Dans ce cas, vous devez modifier de petites choses dans msvccompiler.py, qui se trouve, dans votre installation Python.

Aller à la ligne 122 et remplacez la ligne :

par

Puis réessayez.

Si vous obtenez une deuxième erreur comme :

vous devez également remplacer la ligne 128 comme ceci :

par

Réessayez encore une fois.

Si vous obtenez de nouveau une erreur comme :

alors vous devriez vérifier les variables d'environnement DISTUTILS_USE_SDK et MSSDK avec :

Si ce n'est pas toujours pas arrangé, il suffit de définir à 1 :

Maintenant, vous pouvez rencontrer une erreur de compilation, ou un const char* ne peut pas être converti en un char*.

Pour corriger cela il vous suffit d'écrire un const avant, dans les lignes appropriées, il y a six lignes à corriger.

Après copiez le répertoire généré par Pivy dans un endroit où l'interpréteur Python de FreeCAD peut le trouver.

Utilisation
Pour vérifier si pivy est correctement installé :

Pour avoir accès à Pivy à partir de la scénographique de FreeCAD, procédez comme ceci:

Vous pouvez maintenant explorer la FCSceneGraph avec la commande dir.

Documentation
Malheureusement, la documentation sur Pivy est "pour le moment" presque inexistante sur le net. Mais vous pouvez trouver de la documentation très utile sur Coin, car Pivy a simplement traduit les fonctions, Coin, des nœuds et des méthodes en Python, les noms sont conservés (mêmes noms) ainsi que les propriétés ne sont différentes que par la syntaxe entre le C et Python :


 * https://bitbucket.org/Coin3D/coin/wiki/Documentation - Coin3D API Reference
 * http://www-evasion.imag.fr/~Francois.Faure/doc/inventorMentor/sgi_html/index.html - The Inventor Mentor - La "bible" de Inventor langage de description de scène.

Vous pouvez également consulter le fichier Draft.py dans le dossier FreeCAD Mod/Draft, car Pivy est fortement utilisé.

pyCollada

 * homepage: http://pycollada.github.com
 * license: BSD
 * option, est nécessaire pour permettre l'importation et l'exportation de fichiers Collada (.DAE)

pyCollada est une bibliothèque Python qui permet aux programmes de lire et d'écrire des fichiers Collada (*.DAE). Lorsque pyCollada est installé sur votre système, FreeCAD le détecte et ajoute les options d'importation et d'exportation, qui permettent l'ouverture et l'enregistrement de fichiers au format Collada.

Installation
Pycollada n'est généralement pas encore disponible dans les dépôts des distributions Linux, mais puisqu'il est fait uniquement en Python, il ne nécessite pas de compilation, et est facile à installer.

Vous avez 2 façons de l'installer, soit directement à partir du pycollada git repository officiel, ou avec l'outil easy_install.

Linux
Dans les deux cas, vous aurez besoin des paquetages suivants, installés d'avance sur votre système :

Avec easy_install (easy_install)
En supposant que vous avez déjà installé complètement Python, l'utilitaire easy_install doit être déjà présent :

Vous devez vous assurer que pycollada, est correctement installé, en utilisant la commande suivante dans la console Python :

Si la commande ne retourne aucun message d'erreur, alors tout est OK.

Windows
Pycollada est inclus sur Windows depuis la version 0.15 et dans les versions de développement de FreeCAD, donc aucune étape supplémentaire n'est nécessaire.

Mac OS
Si vous utilisez l'accumulation des Homebrew FreeCAD vous pouvez installer pycollada dans votre système Python en utilisant pip.

Si vous devez installer pip:

Installer pycollada:

Si vous utilisez une version binaire de FreeCAD, vous pouvez dire pip installez pycollada dans le site-packages à l'intérieur FreeCAD.app:

ou après avoir téléchargé le code pycollada

IfcOpenShell

 * homepage: http://www.ifcopenshell.org
 * license: LGPL
 * option, requis pour étendre les capacités d'importation de fichiers IFC

IFCOpenShell, est une bibliothèque actuellement en développement, ce qui permet d'importer (et bientôt d'exporter) Industry foundation Classes (*.Fichiers IFC).

Ceci est une extension pour le format STEP, et, devient la norme dans les workflows BIM. Lorsque ifcopenshell est correctement installé sur votre système, le de FreeCAD le détectera, et, l'utilisera pour importer des fichiers IFC. Étant donné qu'ifcopenshell est basé sur OpenCasCade, comme FreeCAD, la qualité de l'importation est très élevée, en produisant une géométrie de solides de haute qualité.

Installation
Étant donné que 'ifcopenshell est assez nouveau, vous devrez probablement le compiler vous-même.

Linux
Vous aurez besoin de deux ou trois paquets de développement, installés sur votre système afin de rassembler les ifcopenshell :

mais, étant donné que FreeCAD exige tout, vous pouvez compiler FreeCAD, vous n'aurez aucune dépendance supplémentaire pour compiler IfcOpenShell.

Prenez le dernier code source ici :

Le processus de création est très simple :

ou, si vous utilisez oce au lieu d'opencascade :

Étant donné que ifcopenshell est fait principalement pour Blender, il utilise python3 par défaut. Pour l'utiliser à l'intérieur de FreeCAD, vous devez le compiler avec la même version de Python qui est utilisé dans FreeCAD. Vous devrez peut-être forcer les paramètres avec la version de Python et cmake (réglez la version de Python avec la vôtre) :

Alors :

Vous pouvez vérifier que ifcopenshell, a été correctement installé en tapant dans la console Python :

Si la commande ne retourne aucun message d'erreur, alors tout est OK.

Windows
Note: les installateurs officiels FreeCAD obtenus à partir de la page du site Web/github de FreeCAD contiennent déjà ifcopenshell.

 Documentation copiée à partir du fichier README IfcOpenShell

Les utilisateurs sont priés d'utiliser le fichier .sln de Visual Studio qui se trouve dans win/folder.

Pour les utilisateurs de Windows une version pré-construite Open CASCADE est disponible sur le site d'OpenCascade. Téléchargez, et, installez cette version dans le chemin d'accès d'Open CASCADE, et, des fichiers de la bibliothèque de MS Visual Studio C++.

Pour créer le IfcPython wrapper, SWIG doit être installé. Téléchargez la dernière version de swigwin. Après avoir extrait le fichier .zip, veuillez ajouter le dossier à la variable d'environnement PATH. Python doit être installé, veuillez fournir les chemins d'accès des fichiers include, et, bibliothèque pour Visual Studio.

Liens
Tutoriel Import/Export IFC - compiling IfcOpenShell

ODA Converter (précédemment Teigha Converter)

 * page d'accueil: https://www.opendesign.com/guestfiles/oda_file_converter
 * licence: freeware
 * optionnel, utilisé pour permettre l'importation et l'exportation de fichiers DWG

Le convertisseur ODA Converter est un petit utilitaire disponible gratuitement qui permet de convertir plusieurs versions de fichiers DWG et DXF. FreeCAD peut l'utiliser pour permettre l'importation et l'exportation de fichiers DWG, en convertissant les fichiers DWG au format DXF de manière transparente, puis utiliser son importateur DXF standard pour importer le contenu du fichier. Les restrictions de l'importateur DXF s'appliquent.

Installation
S'installe sur toutes les plateformes, par l'installation du paquet approprié disponible à https://www.opendesign.com/guestfiles/oda_file_converter. Après l'installation, si l'utilitaire n'est pas trouvé automatiquement par FreeCAD, vous devrez configurer manuellement le chemin de l'exécutable du convertisseur via le menu Édition → Préférences → Importer-Exporter → DWG et renseignez le champs "Chemin d’accès du convertisseur de fichier Teiga".

LazyLoader
LazyLoader is a python module that allows deferred loading, while still importing at the top of the script. This is useful if you are importing another module that is slow, and it is used several times throughout the script. Using LazyLoader can improve workbench startup times, but the module will still need to be loaded on first use.

Installation
LazyLoader is included with FreeCAD v0.19

Usage
You will need to import LazyLoader, then change the import of whatever module you want to be deferred.

The variable Part is how the module is named in your script. You can replicate "import Part as P" by changing the variable.

You can also import a module from a package.

You can't import individual functions, just entire modules.

Links

 * Original source: https://github.com/tensorflow/tensorflow/blob/master/tensorflow/python/util/lazy_loader.py
 * Further explanation: https://wil.yegelwel.com/lazily-importing-python-modules/
 * Code within the FreeCAD source code: https://github.com/FreeCAD/FreeCAD/tree/master/src/3rdParty/lazy_loader
 * Forum discussion: https://forum.freecadweb.org/viewtopic.php?f=10&t=45298