[Python] : how to overload a Pypot method

[Thot]

I have a question about overloading methods in Python. I do not see how to do. Example :
I want to modify the error file in pypot.dynamixel. Til now, I modified directly the pypot code but it is very dirty.
I did the same for the rest.py to add a new rest API method.

Thanks for your help.

[Manon]

Plusieurs réponses possibles à cette question:

• Si tu cherches à enlever un bug/apporter une nouvelle feature vraiment interressante à Pypot: autant en faire profiter tout le monde. Tu forkes le repository pypot dans ton git hub, tu modifies, tu pushes dans ton github, puis tu fais un pull request vers pypot.

• Si tu fais des modifs qui peuvent intéresser certaines personnes mais pas tout le monde: tu forkes le repository pypot et tu modifies ton pypot (eventuellement en faisant des branches).

• Si tu veux garder ton pypot dans l’état d’origine (pour compatibilité, par exemple) tu peux essayer de faire de l’héritage: tu crées un classe Python qui hérite de la classe de Pypot que tu veux modofier et tu peux surcharger (overload) certaines fonctions. Il faut ensuite bien gérer les imports pour appeler ta classe, qui utilisera ses fonctions par défaut ou les fonctions de la classe parente si tu ne les a pas surchargées.

Answer seemed easier to write in french, I can translate if needed.

[Thot]

Merci pour ces réponses. Pour la troisième option, ce dont j’ai peur c’est que, par exemple, le module rest.py est importé dans un autre module de pypot auquel je n’ai pas accès (si je m’interdit de toucher au code de pypot). Ce module en question, il faudrait donc que je le surcharge aussi ? et ainsi de suite. Au final, je risque de tout surcharger et de faire péter le disjonteur.

[Manon]

Je suis d’accord avec toi, je n’ai pas de solution miracle…

Y a-t-il une raison particulière pour refuser de modifier Pypot ? En ajoutant un remote repository, tu peux récupérer les mises à jour de la version officielle même dans ton pypot modifié (au risque de quelques conflits, bien sur).

[Pierre]

@Thot

Pour la troisième option, ce dont j’ai peur c’est que, par exemple, le module rest.py est importé dans un autre module de pypot auquel je n’ai pas accès (si je m’interdit de toucher au code de pypot).

Dans l’exemple que tu donnes où tu souhaites que ta modification à rest.py soit propagée à tous les modules qui l’utilises tu dois très clairement choisir une des deux premières options.

Tu peux également faire des patchs de code à la volée (au runtime), tu peux regarder la manière dont marche pypot_time et vrep_time par exemple. Par contre, je ne le recommanderais vraiment que dans des cas très particuliers car cela rend la lecture du code extrêmement complexe pour qui ne connait pas bien les rouages de python.

Comme indiqué plus haut, je pense que pour toi la manière la plus simple et efficace de travailler et d’avoir ton fork perso de pypot que tu maintiens à jour avec la branche “officielle”. Tout ce que tu développes et que tu penses peut avoir de l’intérêt pour les autres fait une pull request, même si c’est dans un état instable, pas propre, etc… la pull request doit être vu plutôt comme une manière de nous dire: “regardez je travaille là dessus, ça vous intéresse, comment on pourrait faire pour l’intégrer”.

Nous ne sommes pas toujours réactif pour intégrer les autres codes car nous essayons de conserver une uniformité relative du code et que les journées ne font que 24H mais il ne faut surtout pas hésiter à proposer des modifications !

BTW, la fonction que tu as rajouté à l’API REST aurait tout à fait sa place dans le dépôt officiel !

[Thot]

Merci pour vos reponses. Je ne suis pas habitué encore a toutes les fonctions de git et surtout comment les utiliser. Mais je comprends le truc.
Matlab permet justement de surcharger facilement une fonction du noyau, mais j’avoue, c’est un mauvais reflexe

[Thot]

J’ai fait mon fork de pypot, j’ai fait mes modifs comme il faut. J’ai juste une question :
Quand vous faites des mises à jours sur la version officielle de Pypot, comment je peux rapatrier les commits de retard ? Je n’ai pas trouvé le bouton dans github (j’ai trouvé le pull request mais pas l’inverse).

Merci.

[Manon]

Excellente question

Je me suis aussi posé la question et j’ai fouillé un peu pour trouver la réponse donc j’ai eu le réflexe de faire un bout de doc pour la prochaine fois que j’en aurai besoin…

To keep up-to-date with the original code, we are going to add a remote directory. Choose a meaningful name (I often use ‘official’). Find the HTTPS clone URL from the original project and type (inside the git folder):

> git remote add <name> <URL>
> git remote -v

The second line shows you your remote directories. Now you can fetch (pull) or push from and on two distinct remote repositories (origin being the one you initially cloned from). To update your robot and your github, first get the latest code from the new remote, then push it on your github repo:

> git pull <name> master
> git push origin master

If you try to push to the original code remote, you will get a ‘forbidden’ error.

Et aussi un bon conseil pour la suite:

If you have only a few minor modifications to do, you can keep it that way: change the code, commit and push in this directory, then go to GitHub to do a ‘pull request’.

But if you have multiple modifications to do on different subparts, you may want to separate them. This will also easy the work of the owner of the original project: he will be able to integrate small, consistent modification one at a time instead of having to test all your modifications and accept all of them or none of them.

So let’s go branching. A branch is a different copy of the same git directory that allows you to modify things and easily go back to previous, stable state.

Create a branch (branch named test-branch for the example, call it something meaningful) and add it to your GitHub repo:

> git checkout -b test-branch

Now if you commit, it commits in the branch. Push in the branch:

> git push origin test-branch

You can now make a pull request to the original code with your branch and start another branch to keep working while your pull request waits for acceptance.

Tout ça devrais être intégré un jour (prochain) dans une doc pour développeurs.

[Theo]

Ou plus simple, tu peux directement récupérer la branche master distante de la sorte (l’url dépend évidement du dépôt git)

git pull https://github.com/poppy-project/pypot.git

Tu peux aussi récupérer directement une branche en particulier, par exemple pour récupérer la branche distante gh-pages dans ton dépôt actuel :

git pull https://github.com/poppy-project/pypot.git gh-pages

Si tu aimes bien l’interface graphique de Github, tu peux aussi choisir de faire une pull request sur ton dépôt. Pour cela il faut faire une pull request en prenant comme “base fork” ton dépôt, choisir ensuite “compare accross fork”, puis choisir comme “head fork” le dépôt officiel (cf capture écran).

Si la pull request peut être mergée automatiquement ça fait la même chose que précédemment ; si ce n’est pas le cas il faut le faire à la main pour résoudre les conflits ce qui perd son intérêt.

[Thot]

Super, merci à vous deux pour ces astuces. Du coup, j’ai fait ma version de Pypot pour la scène avec désactivation des checksum error (un bonheur), update de l’API REST pour des trames compressées et la désactivation de l’overload error (plus dangeureux, je sais, mais l’arret du robot sur scène est interdit)