Tutoriel : Reverse-Proxy avec Docker

1 – Introduction

Dans ce tutoriel, on va voir comment mettre en place, étape par étape, un reverse-proxy dans un container docker. On va créer un container reverse-proxy et trois containers serveurs web qui, chacun, se trouve dans son propre réseau.

Le reverse-proxy va nous permettre de déployer plusieurs applications web (sites web) sur la même machine qui seront accessibles avec la même adresse IP. L’aiguillage des requêtes se fait selon le nom de domaine de chaque site par le reverse-proxy.

2 – Architecture générale

Le système qu’on veut mettre en place se compose d’un container reverse-proxy qui va recevoir toutes les requêtes HTTP, puis, en fonction du nom de domaine (dans l’url) le reverse-proxy aiguille ces requêtes vers les différents containers serveurs web.

Les containers serveur web peuvent être tous dans le même réseau comme ils peuvent aussi être dans des sous réseaux différents. Pour rester générique, on va considérer trois containers serveurs web se trouvant dans trois réseaux différents.

Pour que le containers reverse proxy puisse communiquer avec les containers serveurs web, il doit avoir une interface dans le même réseau que chacun d’eux en plus de son propore réseau.

Le tableau suivant résume les informations sur les différents containers :

Nom ContainerAdresse IPRéseauImage DockerURL
Serveur_web_1192.168.0.3192.168.0.0/24web-server (httpd)http://site1.com
Serveur_web_2192.168.1.3192.168.1.0/24web-server (httpd)http://site2.com
Serveur_web_3192.168.2.3192.168.2.0/24web-server (httpd)http://site3.com
Reverse-Proxy192.168.0.2
192.168.1.2
192.168.2.2
172.17.0.2
192.168.0.0/24
192.168.1.0/24
192.168.2.0/24
172.17.0.0/16
reverse-proxy (nginx)

La figure suivante illustre l’architecture générale de notre système :

3 – Préparation des images docker

Pour mettre en place notre architecture décrite précédemment, on a besoin de préparer les images docker afin de créer les containers. Plus précisément, on a besoin de deux images docker :

  • Une image docker pour le reverse-proxy basée sur « nginx » , et
  • Une autre image pour les serveurs web basée sur « httpd » .

3.1 – Solution 1 : avec des dockerfiles

Poour créer les images du reverse-proxy nginx et les serveurs web httpd en utilisant des dockerfiles, il faut copier ces deux textes suivants et les mettre dans deux fichiers, puis utiliser la commande « docker build » pour créer les deux images.

Le ficher « Dockerfile1 » pour le reverse-proxy nginx :

FROM nginx

RUN apt-get update
RUN apt-get install -y nano
RUN mkdir -p /etc/nginx/sites-enabled
RUN mkdir -p /etc/nginx/sites-available
ENTRYPOINT service nginx restart && /bin/bash

Le fichier « Dockerfile2 » pour le serveur web httpd :

FROM httpd
RUN apt-get update
RUN apt-get install -y nano

Maintenant que les deux fichiers dockerfile sont créés, il est possible de créer les deux images en faisant :

$ docker build -t touatily/reverse-proxy -f Dockerfile1 .
$ docker build -t touatily/web-server -f Dockerfile2 .

Les deux images s’appellent « touatily/reverse-proxy » et « touatily/web-server » respectivement. On peut vérifier ce en faisant :

$ docker images

3.2 – Solution 2 : téléchargement depuis dockerhub

La deuxième solution consiste à récupérer les images docker directement depuis docker hub. Pour cela, il faut taper les commandes suivantes :

$ docker pull touatily/reverse-proxy
$ docker pull touatily/web-server

Pour vérifier que les images ont bien été téléchargées depuis docker hub, il faut afficher la liste des images avec la commande « docker images » :

$ docker images

4 – Création des containers

À ce niveau, les images docker sont prêtes. Mais avant de créer les containers concrètement, il faut passer par plusieurs étapes :

4.1 – Préparation des réseaux

Comme indiqué précédemment, il nous faut un réseau par serveur web. Donc, en tout, on a besoin de trois réseaux en plus des réseaux créés par défaut par docker. Les informations sur les réseaux sont données plus haut dans le tableau récapitulatif.

Les commandes à exécuter sont les suivantes :

$ docker network create --subnet=192.168.0.0/24 --gateway=192.168.0.1 --driver=bridge réseau1
$ docker network create --subnet=192.168.1.0/24 --gateway=192.168.1.1 --driver=bridge réseau2
$ docker network create --subnet=192.168.2.0/24 --gateway=192.168.2.1 --driver=bridge réseau3

Pour vérifier que tout est en ordre, on peut afficher la liste des réseaux existants, et si tout s’est bien déroulé, on verra les trois réseaux (réseau1, réseau2, et réseau3) s’afficher en plus des trois réseaux créés par défaut :

docker network ls

4.2 – Lancement des containers

4.2.1 – Préparation des sites web

Avant de lancer les trois containers serveurs web, on crée trois répertoires (contenant chacun un fichier « index.html ») qui correspondent au trois sites web :

$ mkdir -p /root/websites/site1
$ echo "<h1>Site web 1</h1>" > /root/websites/site1/index.html
$ mkdir -p /root/websites/site2
$ echo "<h1>Site web 2</h1>" > /root/websites/site2/index.html
$ mkdir -p /root/websites/site3
$ echo "<h1>Site web 3</h1>" > /root/websites/site3/index.html

Evidemment, on peut mettre d’autres fichier HTML dans les trois répertoires, mais par soucis de simplicité, on se limite à des sites web constitués d’une seule page HTML.

4.2.2 – Création des containers serveurs web

Pour lancer les trois containers serveurs web il faut taper les commandes suivantes :

$ docker container run -itd --name serveur_web_1 --net réseau1 --ip 192.168.0.3 -v /root/websites/site1/:/usr/local/apache2/htdocs/  touatily/web-server 
$ docker container run -itd --name serveur_web_2 --net réseau2 --ip 192.168.1.3 -v /root/websites/site2/:/usr/local/apache2/htdocs/ touatily/web-server
$ docker container run -itd --name serveur_web_3 --net réseau3 --ip 192.168.2.3 -v /root/websites/site3/:/usr/local/apache2/htdocs/ touatily/web-server

Maintenant, il nous reste à créer le container pour le reverse-proxy nginx.

$ sudo docker container run -itd --name reverse-proxy -p80:80 -v /srv/virtual-hosts/:/etc/nginx/sites-available/ touatily/reverse-proxy

Quelques remarques s’imposent :

  • Il faut lancer le container reverse-proxy en utilisant sudo, car pour pouvoir mapper le port 80 de la machine, il faut les droits root.
  • Pour chacun des trois containers serveur web, on a mappé son repertoire « /usr/local/apache2/htdocs/ » sur le répertoire de la machine « /root/websites/site[123]/ ». Donc, pour mettre à jour le contenu des sites web, il suffit de modifier le contenu des répertoires de la machine « /root/websites/site[123]/ » et les changement seront pris en considération immédiatement.

4.3 – Configurations

4.3.1 – Côté reverse-proxy :

Il faudra créer les hôtes virtuels (un hôte virtuel par site web). Pour cela, dans le répertoire « /srv/virtual-hosts/ » qu’on a mappé sur le répertoire « /etc/nginx/sites-available/ » du container, on va créer un fichier de configuration par hôte virtuel (virtual host). Voici à quoi ressemble le fichier « site1.com » de configuration de l’hôte virtuel « site1.com » :

server {
listen 80;
server_name site1.com;

location / {
proxy_pass http://192.168.0.3;
}
}

Il faudra créer deux autres fichiers qui correspondent aux deux autres hôtes virtuels « site2.com » et « site3.com » en changeant le texte surligné en jaune par les valeurs « site2.com » et « http://192.168.1.3 » pour l’hôte virtuel « site2.com » et par les valeurs « site3.com » et « http://192.168.2.3 » pour l’hôte virtuel « site3.com ».

Maintenant, il faut s’assurer que le reverse-proxy nginx prenne en considération ces hôtes virtuels en vérifiant son fichier de configuration « /etc/nginx/nginx.conf ». Plus exactement, il faut vérifier que la ligne « include /etc/nginx/sites-enabled/*; » est présente dans la partie « http { … } » :

...
http {
...
include /etc/nginx/sites-enabled/*;
...
}

Pour ce, vous pouvez vous attachez au container puis modifier le fichier en faisant :

$ docker container attach reverse-proxy
root@f4be511eeda8:~# nano /etc/nginx/nginx.conf

Il nous reste encore à activer les différent hôtes virtuels et recharger la configuration pour que nginx prenne en considération des changement éffectués :

$ docker exec reverse-proxy ln -s /etc/nginx/sites-available/site1.com /etc/nginx/sites-enabled/site1.com
$ docker exec reverse-proxy ln -s /etc/nginx/sites-available/site2.com /etc/nginx/sites-enabled/site2.com
$ docker exec reverse-proxy ln -s /etc/nginx/sites-available/site3.com /etc/nginx/sites-enabled/site3.com

$ docker exec reverse service nginx reload

Reamrques :

  • Il ne faut pas redémarrer le service nginx sur le reverse proxy car cela va tuer le processus principal du container.
  • Comme on a mappé le répertoire des hôtes virtuels de nginx « /etc/nginx/sites-available/ » dans le répertoire « /srv/virtual-hosts/ », si jamais on a besoin d’ajouter de nouveaux hôtes virtuels, il suffit de
    • Ajouter le fichier de configuration dans « /srv/virtual-hosts/ »,
    • Activier l’hôte virtuel en créant un lien symbolique dans « /etc/nginx/sites-enabled/ », puis
    • Recharger les configurations nginx.

Il faudra maintenant ajouter notre container reverse proxy aux différents réseaux déjà créés, pour qu’il puisse communiquer avec les trois containers serveurs web :

$ docker network connect --ip 192.168.0.2 réseau1 reverse-proxy
$ docker network connect --ip 192.168.1.2 réseau2 reverse-proxy
$ docker network connect --ip 192.168.2.2 réseau3 reverse-proxy

4.3.2 – Côté serveurs web :

Il n’y a pas de configuration à faire du côté des serveurs web.

4.3.3 – Côté client :

Comme les trois noms de domaine « site1.com », « site2.com », et « site3.com » ne sont pas enregistrés dans un DNS, il faut les définir localement sur la machine locale. Pour cela, on n’a qu’à modifier le fichier « /etc/hosts » en ajoutant une ligne pour chaque nom de domaine.

172.17.0.2      site1.com
172.17.0.2 site2.com
172.17.0.2 site3.com

Il faut noter que l’adresse IP est la même pour les trois noms de domaine, et, est celle du reverse-proxy. En effet, toute requête demandant une url d’un des trois noms de domaine dois être routée vers le reverse-proxy. Et c’est ce dernier qui fait l’aiguillage.

5 – Tests & Vérifications

Pour vérifier que tout est bien mis en place, il suffit d’ouvrir une navigateur web et de saisir les url des trois sites web : « site1.com », « site2.com », et « site3.com ».

Les figures suivante montrent bien le résultat :

Il est possible également de faire la vérification en utilisant la commande « curl » :

$ curl site1.com
$ curl site2.com
$ curl site3.com

6 – Conclusion

Dans cette article, nous avons vu comment mettre en place un reverse-proxy et trois serveurs web en utilisant des containers docker. Le rôle du reverse-proxy et de recevoir toutes les requêtes web arrivant sur la machines, ensuite, il s’en charge de les aiguiller, selon le nom de domaine demandé, vers les différents serveurs web. Ces derniers peuvent se trouver dans différents réseaux.

Le reverse-proxy se charge également de relayer les réponses générer par les serveurs web aux clients qui ont émis les requêtes.

Les gestion des erreurs en Python : Les exceptions

1 – Introduction

Pour qu’un programme soit complet, il doit tenir compte de tous les cas possibles, en particulier, quand il manipule des données saisies par l’utilisateur. En effet, un programme qui demande à un utilisateur de saisir un entier par exemple, doit vérifier que la saisie est bien un entier et non autre chose (chaîne de caractère ou flottant par exemple).

Un autre exemple, c’est quand un programme utilise des fonctions systèmes de manipulation de fichiers, de communication réseau, … etc. Il doit toujours vérifier que l’appel système a bien réussi et n’a pas généré d’erreur.

Le mécanisme utilisé pour la gestion des erreurs en Python est : Les « exceptions ».

2 – Gestion des erreurs

Dans un programme, quand on a une partie du code qui est suceptible de générer une erreur et donc de lever une exception, on place cette partie du code dans un bloc « try … except … ».

Voici la syntaxe dans le cas général :

try:
<code susceptible de générer une exception>
except:
<traitement de l'exception>
[
finally:
<code exécuté dans tous les cas>
]

Dans le code précédent, le bloc « try » commence à s’exécuter. Si tout se passe bien, le bloc « expect » sera ignoré et on passe directement au bloc « finally ».
Si jamais une erreur se produit, l’exécution du bloc « try » est stoppée. Une exception, dont le type dépend de la nature de l’erreur, est levée. Cette dernière va être traitée par le bloc « except » prévu à cet effet. Celui-ci. Enfin, le bloc « finally » s’exécute. Remarquez que le bloc « finally » s’exécute dans tous les cas.

Il arrive également où une même partie du code soit susceptible de générer plusieurs types d’exception dans ce cas, on a la possibilité de mettre un seul bloc « except », et donc on définie un traitement commun à toutes les exceptions comme montré dans le code précédent.

La deuxième solution serait de mettre plusieurs blocs « except », et donc de définir plusieurs traitements selon le type de l’exception :

try:
<code susceptible de générer des exceptions>
except <exception 1>:
<traitement exception 1>
except <exception 2>:
<traitement exception 2>
...
except <exception n>:
<traitement exception n>
[
finally:
<traitement final>
]

Python définie une multitude de classes qui pourraient être utilisées pour déclencher des exceptions. La liste exhaustive de la hiérarchie des exceptions se trouve ici.

3 – Créer de nouveaux types d’exceptions

Python offre la possibilité de créer de nouveaux types d’exception. Pour ce, il faut créer une classe qui hérite, de manière directe ou indirecte, de la classe « BaseException » (La classe « BaseEception » doit être une une classe ancêtre de la classe à définir).

L’exemple suivant montre la définition d’une classe « ErreurPersonnalisee » qui hérite de la classe « BaseException ». Elle définie deux attributs : « code » et « msg » :

class ErreurPersonnalisee (BaseException):
def __init__(self, msg, code):
super().__init__(msg)
self.msg = msg
self.code = code
def __str__(self):
return str(self.code) + " - " + str(self.msg) + "\n"

raise ErreurPersonnalisee("Informations sur l'erreur", 1)

L’affichage produit est :

Traceback (most recent call last):
    File "test.py", line 10, in <module>
       raise erreur("Informations sur l'erreur", 1)
__main__.erreur: 1 - Informations sur l'erreur

4 – Exemples

4.1 – Lecture d’un fichier json

Les erreurs qui peuvent se produisent quand on lit un fichier JSON sont :

  • Le fichier est inexistant (L’exception levée dans ce cas est : « FileNotFoundError »),
  • Le fichier existe mais le programme n’a pas de droit de lecture sur lui (l’exception est « PermissionError »),
  • Le contenu du fichier n’est pas au format JSON (« ValueError »).

Le code suivant détaille bien les différents cas :

import json

try:
fichier = open("fichier.json", "r")
contenu = json.load(fichier)
print(contenu)
fichier.close()
except FileNotFoundError:
print("Le fichier demandé n'existe pas")
except PermissionError:
print("Le fichier existe mais pas de droit de lecture")
except ValueError:
print("Le fichier n'est pas au format json"

4.2 – Saisie d’un nombre entier

Lorsqu’on demande à l’utilisateur de saisir un entier, les erreurs possibles qui peuvent se produire sont :

  • L’utilisateur saisie « <CTRL>+<D> » pour la fin de fichier (L’exception levée dans ce cas est « EOFError »).
  • L’utilisateur saisie une chaîne de caractères qui ne peut être convertie en entier (l’exception dans ce cas est « ValueError »).
while True:
try:
n = int(input("Donner un nombre"))
break
except EOFError:
print("L'utilisateur n'a rien saisi")
except ValueError:
print("La saisie n'a pas pu être convertie en entier")

5 – Déclencher une exception

On utilise le mot clé « raise » pour lever une exception dans un code donné :

raise <objet exception>

Il arrive aussi que, dans un bloc « except », on veuille remonter la même exception pour qu’elle soit traitée à un niveau supérieur (une des fonctions appelantes). Pour cela il suffit juste de d’utiliser le mot clé « raise » sans préciser l’exception.

try:
<code susceptible de générer des exceptions>
except:
<traitement partiel de l’exception>
raise
# l'exception est remontée au niveau supérieur pour qu'elle soit
# traitée.

6 – Conclusion

Dans cet article, on a vu le concept d’exception en python qui permet la gestion des erreurs. Python définie une multitude d’exception, chacune prévue pour une type d’erreur particulier.

Il est possible de capturer une exception avec le les bloc « try … except … finally … », dans le but de la traiter et éviter l’arrêt brusque de l’exécution du programme.

On a vu qu’il est possible de créer nos propres types d’exceptions adaptées à l’application à développer.

Les structures de contrôle en Python

1 – Introduction

Les instructions ne s’exécutent pas toujours séquentiellement. En effet, il arrive qu’on veuille choisir entre deux ou plusieurs traitements à exécuter selon la situation au moment de l’exécution, les autres traitements seront alors ignorés. 

Il arrive également qu’un traitement doive se faire plusieurs fois mais on ne veut pas dupliquer cette partie du code car cela rendrait le programme très volumineux.

Dans cet article on va détailler les différentes structures de contrôle du flux d’exécution d’un programme.

2 – Les structures de contrôle

Il existe principalement deux types de structures de contrôle dans un programme : la structure alternative et les boucles (traitement répétitif).

2.1 – Structure alternative : « if » … « elif » … « else »

La structure alternative permet de faire en sorte qu’un traitement ne s’exécute que si une condition est vérifiée. Autrement dit, après évaluation de la condition, si cette dernière a pour valeur « True », le traitement sera exécuté, dans le cas contraire, le traitement est ignoré et on passe à la suite.

La syntaxe d’une structure alternative est :

if <condition 1> :
<traitement 1>
[
elif <condition 2> :
<traitement 2>
elif <condition 3> :
<traitement 3>
...
elif <condition n> :
<traitement n>
]
[
else :
<traitement else>
]

Voici quelques remarques concernant le code précédent :

  • La ligne qui précède un bloc de traitement se termine par deux points « : ».
  • Toutes les instructions d’un bloc de traitement sont décalées par rapport à la ligne qui introduit le bloc : l’indentation en python est très importante car c’est elle qui détermine le début et la fin d’un bloc.
  • Ce qui est entre crochets « [] » est facultatif. En effet, un « if » ne possède pas forcément des « elif » et un « else ».
  • Pour ce qui est des blocs « elif », on peut en mettre autant qu’on veut :  Il n’y a pas de limite.
  • Il n’y a qu’un seul bloc « else » au plus, et s’il est présent, il est mis à la fin.
  • Il n’y a qu’un seul traitement <traitement i> au plus qui sera exécuté, et cela dépend des conditions <condition i>. En effet, la première condition <condition i> à être évaluée (en commençant su haut vers le bas) à « True », le bloc correspondant <traitement i> sera exécuté.
  • S’il n’y a aucune condition qui est vraie, le bloc du « else » (s’il existe) sera exécuté.

Voici un exemple plus concret :

n = input("Entrer un nombre : ")
if n % 2 == 0:
print("pair")
else:
print("impair")

Le code précédent demande à l’utilisateur de saisir un nombre puis vérifie sa parité. S’il y est pair, il affiche « pair », sinon il affiche « impair ».

2.2 – Boucle « for »

Une boucle permet de définir un traitement itératif, c-à-d que c’est un bloc qui s’exécute 0 (zéro) ou plusieurs fois. On utilise le mot clé « for » pour définir une boucle dont le nombre d’itérations est connu à l’avance.

En python, pour écrire une boucle « for », on a besoin d’une variable itérable (C’est-à-dire une variable contenant plusieurs éléments et qu’on peut itérer). L’indice de la boucle va prendre les différentes valeurs des éléments contenus dans l’itérable au fil des itérations.

La syntaxe d’une boucle « for » est la suivante :

for x in <iterable>:
<traitement for>

Le bloc <traitement for> sera exécuté autant de fois que d’éléments dans <itérable>. À chaque itération, la variable « x » prend la valeur d’un élément de <itérable>.

Voici un exemple plus concret d’une boucle « for » :

for i in range(10):
print(i)

C’est une boucle « for » qui fait 10 itérations. la variable « i » prend les valeurs de 0 à 9.

2.3 – Boucle « while »

Le deuxième type de boucles c’est la boucle « while ». Comme la boucle « for », la boucle « while » permet de définir un traitement répétitif qui s’exécute 0 à plusieurs fois. Par contre, le nombre d’itération n’est pas connu à l’avance mais plutôt dépend d’une condition. En effet, la boucle  « while » définie une condition qui sera évaluer avant chaque début d’itération : Si la condition est vraie, le bloc s’exécute une fois de plus, sinon, la boucle se termine et l’exécution du programme continue à partir de l’instruction qui suit la boucle.

Quand il s’agit de la boucle « while », on parle souvent de condition d’arrêt. Cette dernière représente la condition pour que le programme sort de la boucle et continue en séquence. La condition d’arrêt est tout simplement la négation de la condition de boucle.

Voici la syntaxe d’une boucle « while » :

while <condition>:
<traitement while>

Voici un code python qui affiche les nombre de 0 à 9 avec une boucle « while » :

a = 0
while
a < 10:
    print(a)

3 – Conclusion

Dans cet article, nous avons vu les trois manières possibles de rompre la séquence en Python. on utilise la structure alternative « if … elif … else » pour effectuer un traitement particulier selon la valeur d’une ou plusieurs conditions.

On utilise les boucles « for » et « while » pour les traitements répétitifs (des traitements qui s’exécutent 0 ou plusieurs fois). Si on connait à l’avance le nombre d’itérations c’est la boucle « for » qui faut utiliser, dans le cas contraire, la boucle « while » est à utiliser.

Python : affectation vs. copy vs. deepcopy

1 – Introduction

Quand on écrit un programme, on a souvent besoin de sauvegarder le contenu d’une variable dans une autre variable avant de la modifier. Ou alors, on construit une variable à partir du contenu d’une autre variable et changer uniquement les parties qui diffèrent. Là encore, on a besoin de copier une variable dans une autre.

En python, les choses ne sont pas aussi simples. En effet, il y a trois niveaux de copies qu’on va détailler dans cet article.

2 – Différents niveaux de copie

Avant d’expliquer en détail, il serait intéressant de présenter certaines fonctions Python qui nous seront utiles.

  • La fonction prédéfinie « id » :

En regardant l’aide donné par le shell python, et ce, en faisant « help(id) », après traduction on aura ça :

id(obj, /)
Renvoie l’identité d’un objet.


Ceci est garanti d’être unique parmi tous les objets existants simultanéments.
(CPython utilise l’adresse mémoire de l’objet.)

C’est important de comprendre ce que renvoie la fonction « id » car on va l’utiliser juste après pour mieux expliquer les différentes manières de copier des variables.

2.1 – Affectation

Pour comprendre de quoi il s’agit, voici un exemple de code python : 

>>> l1 = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
>>> l2 = l1

La deuxième ligne de ce code crée un nouvelle référence au même objet liste contenant les éléments de 1 jusqu’à 10. Il est important de souligner qu’il n’y a qu’un seul objet liste référencé par deux références : « l1 » et « l2 ».

On peut le vérifier en affichant l’identité des objets référencés « l1 » et « l2 » en faisant :

>> print(id(l1), id(l2), sep="\n")
45511432
45511432

Le résultat varie d’une exécution à une autre mais ce qui est sûr, c’est que la valeur est la même pour les deux références.

Une autre manière de vérifier qu’il n’y a qu’un seul objet référencé par les deux références, c’est en modifiant le contenu de « l1 », par exemple, puis voir le contenu de « l2 » :

>>> l1[0] = 100
>>> print(l1, l2, sep="\n")
[100, 2, 3, 4, 5, 6, 7, 8, 9, 10]
[100, 2, 3, 4, 5, 6, 7, 8, 9, 10]

On voit bien que c’est le même résultat pour les deux références, car, tout simplement, c’est le même objet qui a été modifié.

La figure suivante illustre bien ce qui se passe qu’on fait une affectation d’un objet à une variable (référence).

Figure 1 : Illustration d’un affectation

2.2 – copie simple (copy.copy)

Comme indiquer dans le titre, la fonction « copy » est définie dans le module python « copy ». Donc, pour pouvoir l’utiliser il faudra préalablement importer ce module en faisant :

import copy

Reprenons maintenant l’exemple précédent, et voyons ce qui se passe si on utilise la fonction « copy » au lieu d’une affectation :

>>> l1 = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
>>> l2 = copy.copy(l1)
>>> print(id(l1), id(l2), sep="\n")
45511432
45833384

Remarquez ici, que les identités (donc les adresses) des objets référencés par « l1 » et « l2 » sont différentes, donc ça montre bien que ce sont deux objets distincts.

Prenant un autre exemple :

>>> l1 = [[1, 2, 3], [4, 5, 6]]
>>> l2 = copy.copy(l1)
>>> print(id(l1[0]), id(l2[0]), sep="\n")
45833640
45833640
>>> print(id(l1[1]), id(l2[1]), sep="\n")
45833544
45833544

Ceci montre que le premier élément (respectivement le deuxième élément) de chacune des deux listes « l1 » et « l2 » fait référence au même objet liste « [1, 2, 3] » (respectivement « [4, 5, 6] »). Si jamais on met à jour la valeur de « l1[0][0] », « l2[0][0] » sera modifié également.

La figure suivante illustre bien ce qui passe qu’on crée une copie en utilisant la fonction « copy.copy ».

Figure 2 : Illustration d’un copie simple avec « copy.copy »

La situation qu’on a vu précédemment peut être parfois gênante quand on a plusieurs niveaux de listes (c-à-d liste de listes de listes de …. ) ou d’objets de manière générale. En effet, il n’y a que le premier niveau (première liste) qui est dupliquer, mais les autres niveaux ne le sont pas.

Pour pallier à ce petit problème, il existe une manière pour faire une copie profonde qu’on va détailler juste après.

2.3 – copie profonde (dopy.deepcopy)

On a vu précédemment, « copy.deepcopy » permet de pallier à la limite de la copie simple en dupliquant tous les niveaux de listes (ou d’objets de manière générale). Ceci est fait de manière récursive dans le but de créer un nouvel objet identique au premier (Les deux ont les mêmes valeurs) mais qui sont totalement distincts.

Reprenons l’exemple précédent :

>>> l1 = [[1, 2, 3], [4, 5, 6]]
>>> l2 = copy.copy(l1)
>>> print(id(l1[0]), id(l2[0]), sep="\n")
45833448
33401128
>>> print(id(l1[1]), id(l2[1]), sep="\n")
45833384
45631656

Remarquez bien que les éléments des deux listes référencent des objets « liste » distincts. Car les valeurs de leurs identités sont différentes.

La figure suivante illustre bien ce qui se passe quand on fait une copie profonde avec « copy.deepcopy ».

Figure 3 : Illustration d’une copie profonde (deepcopy)

3 – Conclusion

Le but de cet est de bien montrer et expliquer la différence entre les trois niveaux de copies (affectation, copie simple, copie profonde). C’est très important de maîtriser ces notions pour éviter d’avoir des surprises à l’exécution d’un programme.