Follow

Est-ce que vous connaissez une ressource simple et concise pour Python au sujet de... je sais pas, faire un joli code, commentaires, documentation ?

@Nausicaa joli code, je te recommande de tout passer dans black (github.com/python/black) et éventuellement flake8 (mais black déjà va te faire beaucoup de choses et c'est super simple).

Après sur le joli code, c'est très subjectif, donc j'aurais pas trop de conseils à donner, à part peut-être écrire des tests si c'est envisageable, d'experience ça aide à structurer son code, et ça peut aussi servir de documentation pour les personnes qui débarquent dans le projet par exemple.

@Nausicaa pour la documentation, si ton code est relativement simple, tu peux tenter de jeter un oeil du côté de doctest, ce qui est assez pratique pour à la fois avoir des tests et de la doc DANS le code.

Je ne recommenderai pas sur de gros projets ou sur du code complexe, mais ça peut faire le taf sur des trucs plus petits :

blog.octo.com/python-doctest-q

@eliotberriot oof pourquoi je demande des trucs pour reformater après je râle que c'est pas comme j'aime :')

@Nausicaa alors sincèrement, black c'est un peu perturbant au début, mais depuis que je l'utilise, ça m'a fait gagner des dizaines d'heures, vraiment.

Et c'est un no brainer à utiliser (c'est le but).

@eliotberriot oui je vois l'intérêt mais je suis assez chiante sur comment je veux que soit le code et c'est très personnel :')

@Nausicaa Yep je comprends, après faut faire un choix quoi :p

Si tu veux beaucoup de contrôle sur le formattage, regarde peut-être du côté de pylint avec une config adaptée à tes besoin (mais forcément, c'est plus relou à faire)

Ah en outil de formattage y'a isort qui peut t'intéresser si tu as beaucoup d'imports.

@eliotberriot merci beaucoup pour tous ces liens en tout cas !

Je vais au moins les mettre de côté... Pour le moment je crois que j'ai trop envie d'avancer pour "stagner" sur de la cosmétique :P

(bon c'est plus que ça, la doc, je troll un peu...)

@Nausicaa pas de soucis, hésite pas si tu as des questions sur ces outils (je connais moins pylint, mais j'ai pas mal utilisé isort, black et doctest à une époque).

Et aussi si tu veux une relecture de ton code sur ces aspects là, ça peut se faire aussi :)

@eliotberriot j'hésitais à te demander !

J'essaierai de faire quelques efforts et j'avoue après je veux bien que tu regardes mon code et ce qui te fait tiquer ou non :3

@Nausicaa @eliotberriot passer à black ou adopter la pep8 c'est lâcher prise sur son égo et ses goûts, une des tâches les + difficiles pour un·e dev :p

@bram @eliotberriot j't'avoue pep8 qui me parle de 4 espaces plutôt que des tabulations je suis pas sûre d'avoir la force de changer x')

@Nausicaa @eliotberriot pypi.org/project/autopep8/ ou black

Mais sinon va falloir faire avec ton égo si tu veux meet les standards python hein :p

@Nausicaa (au risque de paraître reloue, suivre la PEP 8 :'3)
(et des code review maybe?)

@Nausicaa des linter par exemple (pylint), ou des plugins ide qui te montrent ça,

@Nausicaa en fait tu demandes un truc sans effort pour accomplir une tâche qui en demande et demande pas mal d'apprentissage, c'est bien ça :p ?

@bram yep :P

disons que je voudrais un truc pour commencer, sans forcément le faire à fond d'un coup

@Nausicaa commence par adopter la pep8 alors pep8.org/ (et install flake8/pep8 dans ton éditeur si black te fait peur)

Ensuite le reste c'est ... beaucoup de lectures, de pratiques, d'échanges, de points de vue différents, y a pas mal d'écoles différentes.

@Nausicaa après on peut en discuter aussi remarque, mais ça sera mon école quoi ^^'

Aka nom de variables longs explicite, simplicité other le reste et les "ceci est la super parfaite bonne pratique recommandé peut importe qu'elle soit overkill" et surtout que le code soit le + explicite et facile à lire et surtout que le flow soit facile à suvire et straightforward (je supporte pas l'over abstraction, c'est comme imposer à quelqu'un d'apprendre ton DSL)

Sign in to participate in the conversation
Pipou Academy

FR : Ceci est une instance queer, qui vise à être aussi confortable et safe que possible. Nouvelleaux élèves bienvenu'es !
EN : This is a queer instance, who aims to be as comfy and safe as possible. New students welcome !