Discussion :

[manticore]

Bonjour,

dans mon code j'ai plusieurs méthodes qui renvoie des tuples ou des listes, j'aimerai savoir quelle est la bonne pratique afin d'éviter des "magics numbers", je pensais à l'utilisation d'un dictionnaire. Est-ce la bonne solution ?

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
9
10
11
12
13
14
 
def exemple(self, debut, fin):
    """
    Exemple de méthode qui retourne un tuple
    @param...
    @return Un tuple avec les indices de début, fin et size
    """
    return (debut, fin, start + fin)
 
dic_exemple = {
               "debut" : 0,
               "fin"   : 1,
               "size"  : 2
               }

Si vous utilisez des dictionnaires ou les placez-vous ? Dans la classe ? Dans un fichier externe de "constante".

Merci d'avances pour vos conseils

[mont29]

Si j’ai bien compris le problème, il me semble que les namedtuples, du module standard collections, est la solution idéale, non*?

[EDIT] Tant qu’à faire, petit exemple vite fait*:

Code python :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
9
10
11
12
13
14
from collections import namedtuple
 
def example(start, end):
    """
    Example of a method returning a tuple.
    @param...
    @return A tuple, with start and end indices, and size.
    """
    return (start, end, start + end)
 
Result = namedtuple("Result", "start, end, size")
 
res = Result._make(example(-13, 666))
print(res.start, res.size)

[manticore]

Une pure merveille exactement ce qu'il me fallait... encore tellement à apprendre

[wiztricks]

Salut,

Ce que retourne une fonction fait partie de la définition de son interface.
En Python, une fonction retourne toujours un objet ou None.

dans mon code j'ai plusieurs méthodes qui renvoie des tuples ou des listes, j'aimerai savoir quelle est la bonne pratique afin d'éviter des "magics numbers", je pensais à l'utilisation d'un dictionnaire.

Si l'interface dit: la fonction retourne un itérable il n'y a rien à changer mais vous écrivez:

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
    return (debut, fin, start + fin)
 
dic_exemple = {
               "debut" : 0,
               "fin"   : 1,
               "size"  : 2
               }

De mon point de vue, la fonction ne retourne pas une liste de nombre mais une structure qui pourrait être mieux décrite par clés/valeurs et effectivement pourquoi pas un "dict" pour emballer cela?

Mais vous pourriez aussi "emballer" la chose dans l'instance d'une "class" particulière ou un namedtuple (voir module collections).

Comme cela fait partie de "l'interface", la mise en forme pourra aider à documenter, vérifier, debugger, .... et cela fait sens sur les interfaces "publiques" maintenant pour les interfaces internes, c'est vous qui voyez.

Bon courage,
- W

[manticore]

Oui deux nouvelles bonnes idées (class, retour d'un dico), merci pour les précisions.

C'est vrai que j'avais jamais pensé à retourner un dictionnaire depuis une fonction...

Il faut vraiment que je lises quelques pages de docs/tuto

Merci

[mont29]

C'est vrai que j'avais jamais pensé à retourner un dictionnaire depuis une fonction...

Aïe… Oui, en effet, si tu peux modifier tes fonctions, c’est nettement plus simple de retourner un dict ou un objet… J’avais suggéré namedtuple, partant du principe que tu avais affaire à une interface non modifiable*!