Python: return, return None, and no return at all -- is there any difference?

Question

Considérez ces trois fonctions :

def my_func1():
  print "Hello World"
  return None

def my_func2():
  print "Hello World"
  return

def my_func3():
  print "Hello World"

Ils semblent tous retourner None. Y a-t-il des différences entre le comportement de la valeur retournée par ces fonctions ? Y a-t-il des raisons de préférer l'une à l'autre ?

---

_{Voir aussi : <a href="https://stackoverflow.com/questions/10067013">est-il possible de ne rien retourner d'une fonction en python ?</a>}

Answer 1

Sur le comportement actuel, il n'y a pas de différence. Ils renvoient tous None et c'est tout. Cependant, il y a un moment et un endroit pour chacun de ces cas. Les instructions suivantes expliquent essentiellement comment les différentes méthodes doivent être utilisées (ou du moins comment j'ai appris qu'elles devraient l'être), mais ce ne sont pas des règles absolues, donc vous pouvez les mélanger si vous le jugez nécessaire.

Utilisation de return None

Cela indique que la fonction est effectivement censée renvoyer une valeur pour une utilisation ultérieure, et dans ce cas elle renvoie None. Cette valeur None peut ensuite être utilisée ailleurs. return None n'est jamais utilisé s'il n'y a pas d'autres valeurs de retour possibles de la fonction.

Dans l'exemple suivant, nous renvoyons la mère de la personne si la personne donnée est humaine. Si ce n'est pas une humaine, nous renvoyons None car la personne n'a pas de mère (supposons qu'elle n'est pas un animal ou quelque chose du genre).

def get_mother(person):
    if is_human(person):
        return person.mother
    else:
        return None

Utilisation de return

Ceci est utilisé pour la même raison que break dans les boucles. La valeur de retour n'a pas d'importance et vous voulez simplement sortir de toute la fonction. C'est extrêmement utile à certains endroits, même si vous n'en avez pas souvent besoin.

Nous avons 15 prisonniers et nous savons que l'un d'eux a un couteau. Nous parcourons chaque prisonnier un par un pour vérifier s'ils ont un couteau. Si nous tombons sur la personne avec le couteau, nous pouvons simplement quitter la fonction car nous savons qu'il n'y a qu'un couteau et aucune raison de vérifier le reste des prisonniers. Si nous ne trouvons pas le prisonnier avec le couteau, nous lançons une alerte. Cela pourrait être fait de nombreuses manières différentes et utiliser return n'est probablement même pas la meilleure façon, mais c'est juste un exemple pour montrer comment utiliser return pour sortir d'une fonction.

def find_prisoner_with_knife(prisoners):
    for prisoner in prisoners:
        if "knife" in prisoner.items:
            prisoner.move_to_inquisition()
            return # pas besoin de vérifier le reste des prisonniers ni de lancer une alerte
    raise_alert()

Remarque : Vous ne devriez jamais faire var = find_prisoner_with_knife(), car la valeur de retour n'est pas censée être récupérée.

Ne pas utiliser return du tout

Cela renverra également None, mais cette valeur n'est pas censée être utilisée ou récupérée. Cela signifie simplement que la fonction s'est terminée avec succès. C'est essentiellement la même chose que return dans les fonctions void dans des langages tels que C++ ou Java.

Dans l'exemple suivant, nous définissons le nom de la mère de la personne, puis la fonction se termine après avoir réussi.

def set_mother(person, mother):
    if is_human(person):
        person.mother = mother

Remarque : Vous ne devriez jamais faire var = set_mother(my_person, my_mother), car la valeur de retour n'est pas censée être récupérée.

Answer 2

Oui, ils sont tous les mêmes.

Nous pouvons examiner le code machine interprété pour confirmer qu'ils font exactement la même chose.

import dis

def f1():
  print "Hello World"
  return None

def f2():
  print "Hello World"
  return

def f3():
  print "Hello World"

dis.dis(f1)
    4   0 LOAD_CONST    1 ('Hello World')
        3 PRINT_ITEM
        4 PRINT_NEWLINE

    5   5 LOAD_CONST    0 (None)
        8 RETURN_VALUE

dis.dis(f2)
    9   0 LOAD_CONST    1 ('Hello World')
        3 PRINT_ITEM
        4 PRINT_NEWLINE

    10  5 LOAD_CONST    0 (None)
        8 RETURN_VALUE

dis.dis(f3)
    14  0 LOAD_CONST    1 ('Hello World')
        3 PRINT_ITEM
        4 PRINT_NEWLINE            
        5 LOAD_CONST    0 (None)
        8 RETURN_VALUE

Answer 3

Comme d'autres l'ont déjà répondu, le résultat est exactement le même, None est retourné dans tous les cas.

La différence est stylistique, mais veuillez noter que PEP8 exige que l'utilisation soit cohérente :

Soyez cohérent dans les instructions de retour. Toutes les instructions de retour dans une fonction devraient soit retourner une expression, soit aucune d'entre elles ne devraient. Si une quelconque instruction de retour renvoie une expression, toutes les instructions de retour où aucune valeur n'est renvoyée devraient explicitement indiquer ceci comme return None, et une instruction de retour explicite devrait être présente à la fin de la fonction (si atteignable).

Oui :

def foo(x):
    if x >= 0:
        return math.sqrt(x)
    return None

def bar(x):
    if x < 0:
        return None
    return math.sqrt(x)

Non :

def foo(x):
    if x >= 0:
        return math.sqrt(x)

def bar(x):
    if x < 0:
        return
    return math.sqrt(x)

https://www.python.org/dev/peps/pep-0008/#programming-recommendations

---

Fondamentalement, si vous renvoyez jamais une valeur non-None dans une fonction, cela signifie que la valeur de retour a une signification et est destinée à être capturée par les appelants. Donc, lorsque vous retournez None, cela doit aussi être explicite, pour indiquer que None dans ce cas a une signification, c'est l'une des valeurs de retour possibles.

Si vous n'avez pas besoin de retourner du tout, votre fonction fonctionne essentiellement comme une procédure au lieu d'une fonction, alors il vous suffit de ne pas inclure l'instruction return.

Si vous rédigez une fonction de type procédure et qu'il y a une opportunité de retourner plus tôt (c'est-à-dire que vous avez déjà terminé à ce moment-là et n'avez pas besoin d'exécuter le reste de la fonction), vous pouvez utiliser des retours vides pour signaler au lecteur qu'il s'agit simplement d'une fin d'exécution anticipée et que la valeur None retournée implicitement n'a aucune signification et n'est pas destinée à être capturée (la fonction de type procédure renvoie toujours None de toute façon).

Answer 4

Chacun renvoie le même singleton None -- Il n'y a pas de différence fonctionnelle.

Je pense qu'il est raisonnablement idiomatique de laisser de côté l'instruction return sauf si vous en avez besoin pour sortir de la fonction plus tôt (dans ce cas, un simple return est plus courant), ou retourner quelque chose d'autre que None. Il est également logique et semble idiomatique d'écrire return None lorsqu'il s'agit d'une fonction qui a une autre voie qui renvoie quelque chose d'autre que None. Écrire return None explicitement est un indice visuel pour le lecteur qu'il y a une autre branche qui renvoie quelque chose de plus intéressant (et que le code appelant devra probablement gérer les deux types de valeurs de retour).

Souvent en Python, les fonctions qui renvoient None sont utilisées comme des fonctions void en C -- Leur but est généralement d'opérer sur les arguments d'entrée sur place (à moins que vous n'utilisiez des données globales (frissons)). Renvoyer None rend généralement plus explicite que les arguments ont été modifiés. Cela rend un peu plus clair pourquoi il est logique de laisser de côté l'instruction return d'un point de vue des "conventions du langage".

Cela dit, si vous travaillez dans une base de code qui a déjà des conventions prédéfinies à ce sujet, je suivrais certainement la même voie pour aider à maintenir l'uniformité de la base de code...

Answer 5

En termes de fonctionnalité, ils sont tous les mêmes, la différence entre eux réside dans la lisibilité du code et le style (ce qui est également important à considérer)