API Conventions
Cette page décrit les conventions utilisées dans le FASTSUITE E2 Python API.
Motifs de dénomination
- Get/Set paires : La plupart des propriétés sont exposées via des paires de méthodes
GetXxx()/SetXxx()plutôt que des propriétés Python. - Is/Has/Can : Les requêtes booléennes utilisent
IsXxx(),HasXxx()ouCanXxx(). - Créer/Ajouter/Supprimer : Les méthodes d’usine et de collection suivent les motifs
CreateXxx(),AddXxx(),RemoveXxx().
Type Conventions
- Les types de retour et les types de paramètres font référence aux classes dans le API lorsque possible.
- Les types primitifs (
str,int,float,bool) suivent les conventions standard de Python. - Les types de type enum peuvent apparaître sous forme de constantes entières ou de classes enums dédiées.
Motifs courants
- Opérateur patron : De nombreux flux de travail consistent à créer ou obtenir un objet opérateur, à le configurer, puis à l’exécuter.
- Motif d’événement : Les événements sont abonnés via des méthodes d’enregistrement du gestionnaire d’événements et déclenchent des rappels avec des objets contextuels.
- Schéma de téléchargement/téléchargement : Le transfert de données suit une configuration basée sur un profil, puis une exécution via une classe opérateur.
Structure du paquet
Le API englobe les paquets suivants :
cenpydownloadcenpylibcenpymathcenpyolpcorecenpyunitscenpyupload
Was this page helpful?