Aller directement au contenu principal

🏛️ Architecture du Système

OpenHands System Architecture Diagram Jul 4 2024

Diagramme de l'Architecture du Système OpenHands (4 juillet 2024)

Ceci est une vue d'ensemble de haut niveau de l'architecture du système. Le système est divisé en deux composants principaux : le frontend et le backend. Le frontend est responsable de la gestion des interactions utilisateur et de l'affichage des résultats. Le backend est responsable de la gestion de la logique métier et de l'exécution des agents.

Architecture du Frontend

system_architecture.svg

Cette vue d'ensemble est simplifiée pour montrer les principaux composants et leurs interactions. Pour une vue plus détaillée de l'architecture du backend, voir la section Architecture du Backend ci-dessous.

Architecture du Backend

Avertissement : L'architecture du backend est en cours de développement et est sujette à changement. Le diagramme suivant montre l'architecture actuelle du backend basée sur le commit indiqué dans le pied de page du diagramme.

backend_architecture.svg

Mise Ă  jour de ce Diagramme

La génération du diagramme d'architecture du backend est partiellement automatisée. Le diagramme est généré à partir des indications de type dans le code en utilisant l'outil py2puml. Le diagramme est ensuite manuellement revu, ajusté et exporté en PNG et SVG.

Prérequis​

  • Environnement python fonctionnel dans lequel openhands est exĂ©cutable (selon les instructions du fichier README.md Ă  la racine du dĂ©pĂ´t)
  • py2puml installĂ©

Étapes​

  1. Générer automatiquement le diagramme en exécutant la commande suivante depuis la racine du dépôt : py2puml openhands openhands > docs/architecture/backend_architecture.puml

  2. Ouvrir le fichier généré dans un éditeur PlantUML, par ex. Visual Studio Code avec l'extension PlantUML ou PlantText

  3. Revoir le PUML généré et effectuer tous les ajustements nécessaires au diagramme (ajouter les parties manquantes, corriger les erreurs, améliorer le positionnement). py2puml crée le diagramme en se basant sur les indications de type dans le code, donc des indications manquantes ou incorrectes peuvent entraîner un diagramme incomplet ou incorrect.

  4. Revoir la différence entre le nouveau diagramme et le précédent et vérifier manuellement si les changements sont corrects. S'assurer de ne pas supprimer des parties qui ont été ajoutées manuellement au diagramme par le passé et qui sont toujours pertinentes.

  5. Ajouter le hash du commit qui a été utilisé pour générer le diagramme dans le pied de page du diagramme.

  6. Exporter le diagramme sous forme de fichiers PNG et SVG et remplacer les diagrammes existants dans le répertoire docs/architecture. Cela peut être fait avec (par ex. PlantText)