Complétion de code (IntelliSense)

Suivez les instructions ci-dessous pour ajouter la complétion de code Zato, également connue sous le nom d'IntelliSense, à votre IDE.

D'une part, cela vous permettra de compléter les noms des classes ou des méthodes que vos services utilisent. D'autre part, cela vous permettra d'appliquer des indications de typage statique à votre code et de les faire valider par votre IDE pendant que vous éditez le code source.

Les instructions couvrent Visual Studio Code et PyCharm. Si vous utilisez un autre IDE, suivez le processus général basé sur la documentation de votre IDE - essentiellement, vous devez ajouter le code source de Zato à la liste des chemins Python supplémentaires de votre IDE afin que celui-ci sache comment résoudre les importations.

Code Visual Studio

  • Clonez le dépôt Zato de https://github.com/zatosource/zato vers un répertoire local. Appelons /home/user/install/zato le répertoire résultant avec le clone git.

  • Passez à la branche appelée support/3.2 - c'est là que se trouve le code source de Zato 3.2.

  • Ouvrez le fichier settings.json de l'utilisateur dans votre instance de VS Code. Si vous n'êtes pas sûr de l'endroit où il se trouve, vous pouvez y accéder par File -> Preferences -> Settings -> [search for pythonpath] -> Cliquez "Edit in settings.json".

  • Dans le fichier settings.json, ajoutez ces deux nouvelles clés, ou ajoutez de nouvelles entrées aux clés, si elles existent déjà :

    • python.autoComplete.extraPaths
    • python.analysis.extraPaths
  • Les clés doivent se lire comme suit. Remplacez /home/user/install/zato/code en conséquence et utilisez le chemin vers lequel vous avez cloné le dépôt git.

    "python.autoComplete.extraPaths": [
        "/home/user/install/zato/code/zato-agent/src",
        "/home/user/install/zato/code/zato-broker/src",
        "/home/user/install/zato/code/zato-cli/src",
        "/home/user/install/zato/code/zato-client/src",
        "/home/user/install/zato/code/zato-common/src",
        "/home/user/install/zato/code/zato-distlock/src",
        "/home/user/install/zato/code/zato-hl7/src",
        "/home/user/install/zato/code/zato-scheduler/src",
        "/home/user/install/zato/code/zato-server/src",
        "/home/user/install/zato/code/zato-sso/src",
        "/home/user/install/zato/code/zato-testing/src",
    ],
    "python.analysis.extraPaths": [
        "/home/user/install/zato/code/zato-agent/src",
        "/home/user/install/zato/code/zato-broker/src",
        "/home/user/install/zato/code/zato-cli/src",
        "/home/user/install/zato/code/zato-client/src",
        "/home/user/install/zato/code/zato-common/src",
        "/home/user/install/zato/code/zato-distlock/src",
        "/home/user/install/zato/code/zato-hl7/src",
        "/home/user/install/zato/code/zato-scheduler/src",
        "/home/user/install/zato/code/zato-server/src",
        "/home/user/install/zato/code/zato-sso/src",
        "/home/user/install/zato/code/zato-testing/src",
    ]
    

  • Maintenant, après avoir redémarré votre IDE, vous serez en mesure d'utiliser la complétion de code :

  • N'oubliez pas de tirer régulièrement de git les dernières mises à jour de support/{ config.extra.docs.version_default }} pour garder votre IDE à jour.

PyCharm

  • Clonez le dépôt Zato de https://github.com/zatosource/zato vers un répertoire local. Appelons /home/user/install/zato le répertoire résultant avec le clone git.

  • Passez à la branche appelée support/3.2 - c'est là que se trouve le code source de Zato 3.2.

  • Ensuite, ajoutez les répertoires contenant le code source de Zato à la liste des répertoires dans lesquels l'interpréteur Python de votre projet PyCharm recherche des chemins supplémentaires. Suivez les étapes ci-dessous.

  • Allez dans File -> Settings -> Project <project name> -> Python interpreter.

  • Cliquez sur l'icône en forme de roue dentée à côté du nom de l'interpréteur que votre projet utilise et choisissez Show All....

  • Ceci montrera une liste d'interprètes que votre projet est capable d'utiliser. La liste peut potentiellement contenir plus d'un interprète. Sélectionnez l'interpréteur que votre projet utilise. Ensuite, cliquez sur l'icône qui ressemble à une arborescence de répertoires - c'est l'icône la plus à droite dans les rangées d'icônes ci-dessous, indiquée par la flèche verte.

  • Une fenêtre de dialogue s'ouvre et affiche une liste de tous les chemins que l'interpréteur utilise. Pour chaque répertoire listé ci-dessous, cliquez sur l'icône + (symbole plus) pour ajouter le répertoire aux chemins de votre interpréteur. Remplacez le chemin d'accès à votre clone git si nécessaire.
/home/user/install/zato/code/zato-agent/src
/home/user/install/zato/code/zato-broker/src
/home/user/install/zato/code/zato-cli/src
/home/user/install/zato/code/zato-client/src
/home/user/install/zato/code/zato-common/src
/home/user/install/zato/code/zato-distlock/src
/home/user/install/zato/code/zato-hl7/src
/home/user/install/zato/code/zato-scheduler/src
/home/user/install/zato/code/zato-server/src
/home/user/install/zato/code/zato-sso/src
/home/user/install/zato/code/zato-testing/src

  • Maintenant, après avoir redémarré votre IDE, vous serez en mesure d'utiliser la complétion de code :

  • N'oubliez pas de tirer régulièrement de git les dernières mises à jour de support/{ config.extra.docs.version_default }} pour garder votre EDI à jour.