Donate

Introduction

La console Python est une console qui fait partie de l'interface utilisateur de FreeCAD. Elle exécute une instance de l'interpréteur Python qui peut être utilisé pour contrôler les processus FreeCAD, créer et modifier des objets et leurs propriétés.

Elle peut être rendue visible/cachée par le menu déroulant Visualisation → Panneaux → Console Python.

La console Python de FreeCAD a une coloration syntaxique de base, capable de différencier avec différents styles et couleurs, commentaires, chaînes, valeurs numériques, fonctions intégrées, sortie texte imprimée et délimiteurs tels que des parenthèses et des virgules. Ces propriétés de la console peuvent être configurées dans l’éditeur de préférences.

La console Python affichant des messages lorsque FreeCAD vient de démarrer.

Création de scripts

Pour les débutants complets, voir : Introduction à Python et Tutoriel sur les scripts Python.

Voir aussi : Débuter avec les scripts et Objets créés par script.

La console Python peut effectuer l'achèvement du code de base lorsqu'un point est écrit après un objet. il montrera les méthodes publiques et les attributs (variables) de l'objet actuel (classe), par exemple obj.

La console peut également afficher la chaîne de documentation d’une fonction particulière lors de l’écriture de la parenthèse ouvrante, par exemple function(

Exemple de code Python produisant des objets dans la vue 3D.

Les scripts d'initialisation FreeCAD chargent automatiquement certains modules et définissent certains alias. De fait, ceux-ci sont disponibles dans la console Python.

App = FreeCAD
Gui = FreeCADGui

Par conséquent, ils sont égaux à

App.newDocument()
FreeCAD.newDocument()

Remarque : ces modules et alias pré-chargés ne sont disponibles qu'à partir de la console Python intégrée au programme FreeCAD. Si vous utilisez FreeCAD en tant que bibliothèque dans un programme externe, n'oubliez pas de charger les modules FreeCAD et FreeCADGui et de définir les alias nécessaires, si vous le souhaitez.

Menu contextuel

Un clic droit sur la console Python ouvre un menu contextuel contenant les commandes suivantes :

• Copier : stocke le texte sélectionné dans le presse-papiers pour le coller ultérieurement ; cette commande est désactivée si rien n'est sélectionné.
• Copier la commande : stocke la commande sélectionnée dans le presse-papiers pour la coller ultérieurement ; cette commande est désactivée si rien n'est sélectionné.
• Copier l'historique : copie l'historique complet des commandes Python saisies au cours de cette session.
• Enregistrer l'historique sous… : enregistre l'historique complet des commandes Python saisies au cours de cette session dans un fichier texte.
• Enregistrer l'historique : à déterminer.
• Coller : colle le texte précédemment copié dans le presse-papiers dans la console Python.
• Sélectionner tout : sélectionne tout le texte dans la console Python.
• Effacer la console : efface toutes les commandes saisies dans la console Python. Cette fonction est utile si la console Python est remplie de messages et de commandes précédemment saisies qui peuvent distraire l'attention lors du test d'une nouvelle fonction. Il s'agit simplement d'une question d'esthétique, car cette commande ne supprime pas les variables existantes ni les modules importés dans la session.
• Insérer le nom du fichier… : ouvre une boîte de dialogue permettant de rechercher un fichier dans le système, puis insère le chemin d'accès complet du fichier. Cette fonction est utile pour tester les fonctions qui traitent un fichier d'entrée, sans avoir à écrire le nom complet dans la console, ce qui est source d'erreurs. Cette commande n'exécute pas le fichier et ne l'importe pas en tant que module Python, elle renvoie simplement le chemin d'accès complet de ce fichier.
• Retour à la ligne automatique : renvoie à la ligne les lignes très longues qui dépassent la dimension horizontale de la console Python.

Remarques

• On a la possibilité de faire défiler l'API dans la console Python. Exemple :
  1. Dans la console, tapez : FreeCAD.
  2. Une fenêtre de dialogue s'affiche avec des classes/fonctions optionnelles à choisir.
  3. Faites défiler la liste pour lire la description de chaque classe/fonction.
  4. En choisissant une fonction et en la faisant suivre d'un ., on peut répéter les étapes 2 et 3 pour aller plus loin dans l'API.
• La complétion par tabulation/mot est prise en charge par le raccourci Ctrl+Espace.