API Conventions

Cette page décrit les conventions utilisées dans le FASTSUITE E2 API Python.

Motifs de nommage

• Paires Get/Set : La plupart des propriétés sont exposées via GetXxx() / SetXxx() paires de méthodes plutôt que des propriétés Python.
• Préfixes Is/Has/Can : Les requêtes booléennes utilisent IsXxx(), HasXxx() ou CanXxx() nommage.
• Créer/Ajouter/Supprimer : Les méthodes d’usine et de collection suivent des motifs CreateXxx(), AddXxx() RemoveXxx().

Conventions de type

• Les types de retour et les types de paramètres référencent les classes au sein de la API lorsque possible.
• Les types primitifs (str, int, float, bool) suivent les conventions standard de Python.
• Les types de type enum peuvent apparaître comme des constantes entières ou des classes enum dédiées.

Schémas courants

• Pattern opérateur : De nombreux flux de travail impliquent la création ou l’obtention d’un objet opérateur, sa configuration, puis son exécution.
• 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.
• Motif de téléchargement/télécharge : 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 couvre les packages suivants :

• cenpydownload
• cenpylib
• cenpymath
• cenpyolpcore
• cenpyunits
• cenpyupload