OrchestraPython

From ArmadeusWiki
Revision as of 09:03, 12 February 2008 by FabriceM (Talk | contribs) (Convention de codage)

Jump to: navigation, search

Plan de développement

Cette page a pour objectif de clarifier le développement d'Orchestra en Python. Pourquoi Python ? Parce que c'est le langage que j'ai choisi pour le développement tout simplement. Et aussi parce qu'il:

  • intègre déjà beaucoup de fonctions;
  • est multi-platerforme (Unix/Linux, MacOS, Windows, BSD, etc.);
  • est facilement extensible
  • etc...

Après une petite analyse des possibilités du langage Python et divers projets existants, j'ai décidé de découper le développement de cette façon:

  • orchestra.py: ce module est le module principal qui va lancer/initialiser le progamme
  • orchestralib: cette librairie est le coeur de l'application, c'est ici que se situe toute l'intelligence.

La librairie orchestralib est composée des sous-librairies suivantes:

  • core : cette librairie contient toutes les classes de base utilisées par Orchestra
  • components : cette librairie contient toutes les classes nécessaires au traitement des "Armadeus Ready Components"
  • thirdparty : cette librairie contient toutes les librairies tierces utilisées pour le développement et ne faisant pas partie des librairies standards de Python
  • vhdl : cette librairie contient les classes nécessaires pour le traitement des fichiers VHDL

Convention de codage

Pour le développement des classes, la convention de codage suivante a été utilisée:

  • Tous les noms sont en anglais, courts et le plus expressifs possibles;
  • Le nom des variables est en minuscule avec '_' pour la séparation des mots;
  • Le nom des constantes est en majuscule avec '_' pour la séparation des mots;
  • Le nom des fonctions est en camelCase, avec la première lettre en minuscule;
  • Le nom des classes est en CamelCase, avec la première lettre en majuscule.