Un return apparemment sans intérêt

Version imprimable

Bonjour à tous,

Quelqu'un pourrait t'il m'expliquer pourquoi dans certains exemples de fonctions du Swinnen, on retrouve l'instruction return alors qu'il n'y a rien à en attendre en retour.

Code:

1
2
3
4
5
6
7
8
9
10
11
12
13
def filtre(source,destination):
    "recopier un fichier en éliminant les lignes de remarques"
    fs = open(source, 'r')
    fd = open(destination, 'w')
    while 1:
        txt = fs.readline()
        if txt =='':
            break
        if txt[0] != '#':
            fd.write(txt)
    fs.close()
    fd.close()
    return

03/03/2024, 11h11
papajoker
Citation:

Envoyé par scalpel

dans certains exemples de fonctions

Ici, il n'y a aucun intérêt ! (A ne pas faire)
Mais, parfois, on utilise un simple return pour quitter (la fonction) avant la fin de notre fonction (équivalent d'un break pour une boucle)

------------------------

Note: code correct, mais aujourd'hui avec une version de python récente, on va plutôt écrire une chose du type:
Code:

1 2 3 4 with open(source, 'r') as fs: while txt := fs.readline(): if txt[0]... # plus besoin de fs.close() car le fichier est fermé automatiquement à la sortie du block "with"
ps: si nous voulons absolument utiliser la fonction "readline()" dans le cadre de la découvrir, en fait elle est inutile pour faire cette fonctionnalité :mouarf:
Code:

1 2 3 with open(source, 'r') as fs: for txt in fs: if ...
comprendre: pour chaque ligne dans le fichier faire ...

------------------------

re-note
if txt[0] != '#': pour un cours, vraiment pas génial :roll: préférer if not txt.startswith("#"):
03/03/2024, 11h28
fred1599

1 pièce(s) jointe(s)

Bonjour,

@scalpel,

En Python, une fonction se termine et renvoie None par défaut si aucune instruction return n'est explicitement appelée. Cela signifie que l'instruction return à la fin de la fonction filtre dans votre exemple est redondante dans le sens où elle ne change pas le comportement de la fonction. La fonction renverrait None dans tous les cas, que l'instruction return soit présente ou non.

La PEP8 n'est pas très bavarde sur ce sujet, mais on voit ceci,

Pièce jointe 651657

qui donne une indication sur ce qui est bien ou pas... mais c'est une convention pas une norme, donc on oblige pas, on conseille.
Cela met en lumière l'importance de la cohérence dans l'utilisation des instructions return pour améliorer la lisibilité et la maintenabilité du code. Pour votre fonction filtre, cela signifierait soit ne pas inclure d'instruction return si la fonction n'est pas censée retourner une valeur, soit inclure un return None explicite si vous souhaitez suivre strictement la recommandation de la PEP 8 pour la cohérence.

Bonjour

Cela permet de quitter la fonction si elle a été appelée par erreur (mauvais paramètre) pour éviter un travail inutile et voué à l'échec.

Un exemple: élever chaque élément d'une liste au carré: cela n'a de sens que si ce que reçoit la fonction est bien une liste...

Solution 1:
Code:

1 2 3 4 5 6 7 8 def carre(l): # On vérifie que "l" est bien une liste... if isinstance(l, list): # ...ce qui permet alors de la traiter for i in range(len(l)): l[i] = l[i]**2 # if # carre()
Solution 2:
Code:

1 2 3 4 5 6 7 8 def carre(l): # Cette fois, si "l" n'est pas une liste, on quitte la fonction if not isinstance(l, list): return # Puisqu'on n'a pas quitté, c'est que "l" est bien une liste donc on peut la traiter for i in range(len(l)): l[i] = l[i]**2 # carre()
Et on gagne ainsi une indentation (ce qui, je pense, améliore aussi la lisibilité)

On a aussi les outils break et continue permettant des actions similaires dans les boucles (interrompre ou continuer la boucle et éviter ainsi de faire un traitement inutile)

Le code de ton exemple un peu revisité dans le même esprit
Solution 1
Code:

1 2 3 4 5 6 7 8 9 10 11 12 13 14 def filtre(source,destination): "recopier un fichier en éliminant les lignes de remarques" fs = open(source, 'r') fd = open(destination, 'w') for txt in fs: # Si le premier caractère n'est pas "#", ce n'est pas un commentaire... if txt[0] != '#': # ...donc on peut écrire la ligne dans le fichier fd.write(txt) # if # for fs.close() fd.close() # filtre()
Solution 2
Code:

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 def filtre(source,destination): "recopier un fichier en éliminant les lignes de remarques" fs = open(source, 'r') fd = open(destination, 'w') for txt in fs: # Si le premier caractère est un "#", alors on recommence la boucle sur la ligne suivante if txt[0] == '#': continue # Puisqu'on n'a pas recommencé la boucle, c'est que le premier caractère n'est pas un "#"... # ...donc on peut écrire la ligne dans le fichier fd.write(txt) # for fs.close() fd.close() # filtre()
Toutefois, comme dit papajoker, pour ton exemple précis, ce return final sert effectivement à que dalle.

03/03/2024, 11h45
scalpel

Merci pour vos éclaircissements sur l'instruction return, mais quand je cherche à comprendre les exemples que me donne Sve@r, je me dis que le chemin va être long. 8O
03/03/2024, 12h06
Sve@r

J'ai réécrit mes exemples en y rajoutant des commentaires... 8-)
03/03/2024, 12h08
fred1599

Citation:

Envoyé par scalpel

mais quand je cherche à comprendre les exemples

Tu peux essayer de les comprendre, mais le fait de ne pas les comprendre ne sera pas très grave, n'oublie pas que l'objectif est d'observer l'utilisation de return.
03/03/2024, 12h20
scalpel

Citation:

Envoyé par papajoker

... si nous voulons absolument utiliser la fonction "readline()" dans le cadre de la découvrir, en fait elle est inutile pour faire cette fonctionnalité ...

Citation:

Envoyé par Sve@r

J'ai réécrit mes exemples en y rajoutant des commentaires... 8-)

Merci, mais je n'arrive toujours pas à comprendre comment on traite ligne par ligne sans la fonction readline() 8O
C'est vachement déroutant de se retrouver comme par magie avec apparemment une liste à traiter. :calim2:

Code:

if txt[0] == '#': continue

J'ai l'impression d'avoir reculé de 3 semaines :cry:
03/03/2024, 12h40
Sve@r

Citation:

Envoyé par scalpel

Merci, mais je n'arrive toujours pas à comprendre comment on récupère une ligne sans la fonction readline() 8O

Ca c'est autre chose (qui n'influe pas sur le sujet principal de ce topic)
Si tu préfères tu peux remplacer for txt in fs par for txt in fs.readline() sans changer le résultat.

En fait l'objet "fichier" est un objet qui contient la méthode readline() (qui permet de récupérer une ligne) et aussi la méthode __iter__() ce qui permet d'itérer (boucler) dessus.
Et quand on boucle (itère) sur un fichier, on récupère chaque ligne du fichier.

la notion "d'itérable" est assez présente en Python. Parce que très présente en informatique. La majorité des traitements se résume généralement à prendre un ensemble d’éléments et les traiter un à uns (traiter les clients d’une banque, les comptes bancaires d’un client, les lignes d’opérations dans un compte, les salles de classe d’un lycée, les cours dans une salle, les élèves dans un cours, les fichiers d’un dossier, les lignes d’un fichier, les mots d’une ligne, etc etc etc).
Et donc Python offre cette possibilité d'itération sur un maximum d'objets pouvant être considérés comme "ensemble d'éléments". Et un fichier c'est d'abord un ensemble de lignes.
03/03/2024, 12h41
papajoker
Code:

1 2 3 with open(source, 'r') as lignes: for ligne in lignes: if ...
Tu connais quand même for ? :lol:
La particularité ici est qu'un fichier texte est un itérateur, donc à chaque appel dans une bouche, il retourne automatiquement une ligne.
En fait un fichier texte fait le même chose qu'une liste ;) c'est exactement la même chose.
Code:

1 2 lignes = ["ligne a","ligne b","ligne v","ligne x"] for ligne in lignes:
Citation:

Envoyé par scalpel

comme par magie

non, c'est que tu n'as pas encore vu dans ton livre qu'un fichier est un itérateur
03/03/2024, 12h44
scalpel

Ouf ! Merci :hola:

Citation:

Envoyé par scalpel

Merci, mais je n'arrive toujours pas à comprendre comment on traite ligne par ligne sans la fonction readline()

Ton code pourrait s'écrire

Code:

1
2
3
4
5
6
def filtrer(source, destination):
    with open(source, 'r') as fichier_source, \
    open(destination, 'w') as fichier_destination:
        for ligne in fichier_source:
            if not ligne.strip().startswith('#'):
                fichier_destination.write(ligne)

EDIT: Mais celle que je préfère est deux fois plus rapide, et tout aussi simple,

Code:

1
2
3
4
5
6
def filtrer_sans_remarques_gen(source, destination):
    with open(source, 'r', encoding='utf-8') as fichier_source, \
        open(destination, 'w', encoding='utf-8') as fichier_destination:
        lignes_filtrees = (ligne for ligne in fichier_source if not ligne.strip().startswith('#'))
 
        fichier_destination.writelines(lignes_filtrees)

03/03/2024, 15h19
scalpel

:zen::rouleau:
03/03/2024, 15h21
Sve@r

Citation:

Envoyé par fred1599

et tout aussi simple,

Citation:

Envoyé par scalpel

:zen::rouleau:

Ah... je crois que ceci fait référence à cela :P

Citation:

Envoyé par Sve@r

Ah... je crois que ceci fait référence à cela :P

Et j'ai pas mis ma version binaire qui doit être plus efficace, 5 appels de moins dans le profilage

Et hop, bien fait
Code:

1 2 3 4 5 6 7 def filtrer_sans_remarques_bin(source, destination): with open(source, 'rb') as fichier_source, \ open(destination, 'wb') as fichier_destination: for ligne_bin in fichier_source: ligne = ligne_bin.decode('utf-8') if not ligne.strip().startswith('#'): fichier_destination.write(ligne_bin)

03/03/2024, 15h41
Sve@r
Citation:
Envoyé par fred1599

Code:

1 2 ligne = ligne_bin.decode('utf-8') if not ligne.strip().startswith('#')
Puisque "ligne" n'est pas réutilisé, peut-être le virer...
if not ligne_bin.decode('utf-8').strip().startswith('#')...
03/03/2024, 15h58
fred1599

Citation:

Envoyé par Sve@r

Puisque "ligne" n'est pas réutilisé, peut-être le virer...
if not ligne_bin.decode('utf-8').strip().startswith('#')...

si elle est réutilisée ligne suivante :mouarf: mais oui on peut dans cette partie de code. Le choix entre utiliser une variable intermédiaire ou enchaîner les appels de méthode directement dépend de la lisibilité et des préférences du développeur.
Je pensais déjà beaucoup utiliser de méthodes à la chaîne et nuire déjà pas mal à la lisibilité.
03/03/2024, 16h17
scalpel

Mois aussi je vais envoyer mon code, ça va vous calmer :mouarf:
03/03/2024, 16h30
Sve@r

T'inquiète pas, ça viendra assez vite.
Ceci dit, malheureusement, cette instruction de fred1599 lignes_filtrees = (ligne for ligne in fichier_source if not ligne.strip().startswith('#')) tu ne la trouveras pas dans le Swinnen. Il s'agit d'une écriture de liste en intension or (j'en avais déjà parlé quand tu nous as demandé nos avis sur ce livre), cette écriture n'y est pas expliquée.
03/03/2024, 17h02
wiztricks
Citation:
Envoyé par fred1599

Code:

1 2 Puisque "ligne" n'est pas réutilisé, peut-être le virer... if not ligne_bin.decode('utf-8').strip().startswith('#')...

si elle est réutilisée ligne suivante :mouarf: mais oui on peut dans cette partie de code. Le choix entre utiliser une variable intermédiaire ou enchaîner les appels de méthode directement dépend de la lisibilité et des préférences du développeur.
Je pensais déjà beaucoup utiliser de méthodes à la chaîne et nuire déjà pas mal à la lisibilité.
fin de ligne et # sont ASCII. Tant qu'à y aller en mode binaire le decode('utf-8') est superflu: ligne_bin.strip().startswith(b'#') suffit (tant qu'on oublie pas le b'...').

- W
03/03/2024, 19h34
fred1599

Citation:

Envoyé par wiztricks

fin de ligne et # sont ASCII. Tant qu'à y aller en mode binaire le decode('utf-8') est superflu: ligne_bin.strip().startswith(b'#') suffit (tant qu'on oublie pas le b'...').

Ah mais quel boulet j'ai codé trop vite, bien vu ! et ça me fait gagner pas mal d'appels sur le profilage, c'est top !
03/03/2024, 19h48
scalpel

Il me semblait bien moi aussi, qu'il était superflu ce decode('utf-8') :marteau:
04/03/2024, 10h39
wiztricks

C'est comme pour le "return" qui pose question dans le swinnen: ça fonctionne très bien sans... et si l'auteur avait pris le temps de se relire de façon critique, il l'aurait probablement supprimé. Mais de fait, après s'être usé les yeux à faire fonctionner un bout de code, il y a des détails qu'on ne voit plus: on sature.
Normal et pas si grave (la qualité militaire demande des moyens et un autre entrainement).

- W
04/03/2024, 11h54
scalpel

Tu auras compris que c'était de l'humour de ma part pour illustrer mon incompétence. Je suis bien incapable de comprendre et de surcroit d'analyser le code que vous avez partagé dans cette discutions. :)
04/03/2024, 13h36
wiztricks

Je voulais juste raccrocher sur le sujet initial: quand non a commencé, on se posait aussi des questions sur les codes qu'on lisait... et suivant son niveau, on ne se posera pas les mêmes questions, on ne lira pas le code de la même façon,...

- W

Citation:

Envoyé par papajoker

non, c'est que tu n'as pas encore vu dans ton livre qu'un fichier est un itérateur

En fait, ma réponse est incomplète !
Oui, un fichier est un itérateur

Code:

1
2
3
fs = open("truc.txt")
for ligne in fs:
    print("->", ligne)

Mais, pour information, l'instruction with ne retourne pas obligatoirement l'objet passé à "with", et cet objet "interne" lui, peut-être un itérateur.
Exemple:

Code:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
class ParseurCle:
    def __init__(self, paragraphe: str):
        self.items = (
            l.split("=")[0] 
                for l in paragraphe.splitlines()
                if l and "=" in l
            )
    def __enter__(self):
        return self.items   # on retourne/consume ce Générateur
 
    def __exit__(self, *exc):
        return True
 
 
texte = """
a = 1
b = 2
x
c = 3
"""
 
 
with ParseurCle(texte) as magique:
    for line in magique:    # ici, en fait "magique" est "ParseurCle.items" et pas ParseurCle !
        print("clé: ", line)

06/03/2024, 14h04
Sve@r

Citation:

Envoyé par papajoker

Oui, un fichier est un itérateur... Mais, pour information, l'instruction with ne retourne pas...

En réalité, parler de ce qu'est un fichier et comment le traiter n'oblige pas nécessairement à parler de with.

Citation:

Envoyé par papajoker

Exemple

Je pense que là c'est du trop haut niveau pour scalpel. Imagine, il n'a pas encore commencé l'objet...:oops:
06/03/2024, 16h28
scalpel

Citation:

Envoyé par Sve@r

... Je pense que là c'est du trop haut niveau pour scalpel ...

Je confirme :?

J'ai tout de même chargé le script (pour le voir en plus gros) 8O
Je l'ai exécuté pour voir le résultat :calim2:

Impossible de comprendre :weird:

Citation:

Envoyé par scalpel

Impossible de comprendre :weird:

Il s'agit du bloc "with".
Ce bloc doit être associé à une ressource et garantit la libération de la ressource quand on le quitte.
Code:

1 2 3 4 5 with open(fichier, ...) as fp: # Ici le fichier est ouvert et est accessible via "fp" # Ici le fichier est ouvert et est accessible via "fp" # Ici le fichier est ouvert et est accessible via "fp" # Ici le fichier est automatiquement fermé (même pas besoin d'écrire fp.close())
Et cela peut s'appliquer à la majorité des ressources informatiques qui doivent être "ouvertes" pour y accéder puis être "refermées" en fin de travail (fichiers, base de données, socket, ...)

Ensuite papajoker montre comment créer son propre "with" qu'il appelle "ParseurCle".
Cet objet se crée de façon classique (il te faudra apprendre l'objet pour connaître cette "façon classique") auquel on rajoute deux méthodes particulières :
__enter__() qui est automatiquement appelée quand on appelle le with (là tu progammes l'ouverture de la ressource que tu veux offrir)
__exit__() qui est automatiquement appelée quand on quitte le bloc (là tu programmes le nettoyage)

De là tout utilisateur pourra appeler with ParseurCle(data_a_traiter) as variable_pour_les_traiter et aura l'assurance qu'en quittant le bloc, les ressources qu'il aura pu "réserver" seront libérées.

07/03/2024, 10h40
scalpel

C'est un poil plus clair.