Python/fr

Description
Python est un langage de programmation de haut niveau à usage général très utilisé dans les grandes applications pour automatiser certaines tâches en créant des scripts ou des macros.

Dans FreeCAD, le code Python peut être utilisé pour créer divers éléments par programmation, sans qu'il soit nécessaire de cliquer sur l'interface graphique. De plus, de nombreux outils et ateliers de FreeCAD sont programmés en Python.

Voir Introduction à Python pour en savoir plus sur le langage de programmation Python, puis sur Tutoriel sur les scripts Python et sur principes de base des scripts FreeCAD pour lancer la création de scripts dans FreeCAD.

Lisibilité
La lisibilité du code Python est l'un des aspects les plus importants de ce langage. L'utilisation d'un style clair et cohérent au sein de la communauté Python facilite les contributions de différents développeurs, car la plupart des programmeurs Python expérimentés s'attendent à ce que le code soit formaté d'une certaine manière et suive certaines règles. Lors de l'écriture de code Python, il est conseillé de suivre PEP8: Guide de style pour Python Code et PEP257: Conventions Docstring.

Ces documents présentent des explications d'une manière plus conviviale :
 * Comment écrire un beau code Python avec PEP 8
 * Documenter du code Python : un guide complet.

Conventions
Dans cette documentation, certaines conventions relatives aux exemples Python doivent être suivies.

Ceci est une signature de fonction typique


 * Les arguments avec des paires clé-valeur sont facultatifs, la valeur par défaut étant indiquée dans la signature. Cela signifie que les appels suivants sont équivalents:


 * Dans cet exemple, le premier argument n'a pas de valeur par défaut, il devrait donc toujours être inclus.


 * Lorsque les arguments sont donnés avec la clé explicite, les arguments facultatifs peuvent être donnés dans n'importe quel ordre. Cela signifie que les appels suivants sont équivalents:


 * Les directives de Python insistent sur la lisibilité du code; en particulier, les parenthèses doivent suivre immédiatement le nom de la fonction et un espace doit suivre une virgule.


 * Si le code doit être divisé sur plusieurs lignes, utilisez une virgule entre parenthèses ou entre crochets. la deuxième ligne doit être alignée sur la précédente.


 * Les fonctions peuvent renvoyer un objet qui peut être utilisé comme base d'une autre fonction de dessin.

Importations
Les fonctions Python sont stockées dans des fichiers appelés modules. Avant d'utiliser une fonction de ce module, celui-ci doit être inclus dans le document avec l'instruction.

Cela crée des fonctions préfixées, c'est-à-dire. Ce système empêche les conflits de noms avec des fonctions portant le même nom mais provenant de modules différents. Par exemple, les deux fonctions et  peuvent coexister sans problème.

Des exemples complets doivent inclure les importations nécessaires et les fonctions préfixées.