Ecrire dans un fichier Python - Explication des fonctions d'ouverture, de lecture, d'ajout et d'autres fonctions de gestion de fichiers

Bienvenue

Salut! Si vous souhaitez apprendre à travailler avec des fichiers en Python, cet article est pour vous. Travailler avec des fichiers est une compétence importante que tout développeur Python devrait apprendre, alors commençons.

Dans cet article, vous apprendrez:

  • Comment ouvrir un fichier.
  • Comment lire un fichier.
  • Comment créer un fichier.
  • Comment modifier un fichier.
  • Comment fermer un fichier.
  • Comment ouvrir des fichiers pour plusieurs opérations.
  • Comment travailler avec les méthodes d'objet fichier.
  • Comment supprimer des fichiers.
  • Comment travailler avec les gestionnaires de contexte et pourquoi ils sont utiles.
  • Comment gérer les exceptions qui pourraient être déclenchées lorsque vous travaillez avec des fichiers.
  • et plus!

Commençons! ✨

🔹 Travailler avec des fichiers: syntaxe de base

L' une des fonctions les plus importantes que vous aurez besoin d'utiliser pendant que vous travaillez avec des fichiers en Python est open(), une fonction intégrée qui ouvre un fichier et permet à votre programme pour l' utiliser et de travailler avec elle.

Voici la syntaxe de base :

💡 Astuce: ce sont les deux arguments les plus couramment utilisés pour appeler cette fonction. Il existe six arguments facultatifs supplémentaires. Pour en savoir plus à leur sujet, veuillez lire cet article dans la documentation.

Premier paramètre: fichier

Le premier paramètre de la open()fonction est filele chemin absolu ou relatif du fichier avec lequel vous essayez de travailler.

Nous utilisons généralement un chemin relatif, qui indique où se trouve le fichier par rapport à l'emplacement du script (fichier Python) qui appelle la open()fonction.

Par exemple, le chemin dans cet appel de fonction:

open("names.txt") # The relative path is "names.txt"

Contient uniquement le nom du fichier. Cela peut être utilisé lorsque le fichier que vous essayez d'ouvrir se trouve dans le même répertoire ou dossier que le script Python, comme ceci:

Mais si le fichier se trouve dans un dossier imbriqué, comme ceci:

Ensuite, nous devons utiliser un chemin spécifique pour indiquer à la fonction que le fichier se trouve dans un autre dossier.

Dans cet exemple, ce serait le chemin:

open("data/names.txt")

Notez que nous écrivons d' data/abord (le nom du dossier suivi de a /) puis names.txt(le nom du fichier avec l'extension).

💡 Astuce: les trois lettres .txtqui suivent le point names.txtsont l '«extension» du fichier ou son type. Dans ce cas, .txtindique qu'il s'agit d'un fichier texte.

Deuxième paramètre: Mode

Le deuxième paramètre de la open()fonction est le mode, une chaîne avec un caractère. Ce caractère unique indique essentiellement à Python ce que vous prévoyez de faire avec le fichier de votre programme.

Les modes disponibles sont:

  • Lisez ( "r").
  • Ajouter ( "a")
  • Ecrire ( "w")
  • Créer ( "x")

Vous pouvez également choisir d'ouvrir le fichier dans:

  • Mode texte ( "t")
  • Mode binaire ( "b")

Pour utiliser le mode texte ou binaire, vous devez ajouter ces caractères au mode principal. Par exemple: "wb"signifie écrire en mode binaire.

💡 Astuce: les modes par défaut sont read ( "r") et text ( "t"), ce qui signifie «ouvrir pour lire du texte» ( "rt"), vous n'avez donc pas besoin de les spécifier open()si vous souhaitez les utiliser car ils sont attribués par défaut. Vous pouvez simplement écrire open().

Pourquoi les modes?

Il est vraiment logique que Python n'accorde que certaines autorisations en fonction de ce que vous prévoyez de faire avec le fichier, non? Pourquoi Python devrait-il permettre à votre programme de faire plus que nécessaire? C'est essentiellement pourquoi les modes existent.

Pensez-y - permettre à un programme de faire plus que nécessaire peut poser problème. Par exemple, si vous avez seulement besoin de lire le contenu d'un fichier, il peut être dangereux de permettre à votre programme de le modifier de manière inattendue, ce qui pourrait potentiellement introduire des bogues.

🔸 Comment lire un fichier

Maintenant que vous en savez plus sur les arguments que open()prend la fonction, voyons comment vous pouvez ouvrir un fichier et le stocker dans une variable pour l'utiliser dans votre programme.

Voici la syntaxe de base:

Nous attribuons simplement la valeur renvoyée à une variable. Par exemple:

names_file = open("data/names.txt", "r")

Je sais que vous vous demandez peut-être: quel type de valeur est renvoyé open()?

Eh bien, un objet fichier .

Parlons un peu d'eux.

Objets de fichier

Selon la documentation Python, un objet fichier est:

Un objet exposant une API orientée fichier (avec des méthodes telles que read () ou write ()) à une ressource sous-jacente.

Cela nous indique essentiellement qu'un objet fichier est un objet qui nous permet de travailler et d'interagir avec des fichiers existants dans notre programme Python.

Les objets fichier ont des attributs, tels que:

  • name: the name of the file.
  • closed: True if the file is closed. False otherwise.
  • mode: the mode used to open the file.

For example:

f = open("data/names.txt", "a") print(f.mode) # Output: "a"

Now let's see how you can access the content of a file through a file object.

Methods to Read a File

For us to be able to work file objects, we need to have a way to "interact" with them in our program and that is exactly what methods do. Let's see some of them.

Read()

The first method that you need to learn about is read(),which returns the entire content of the file as a string.

Here we have an example:

f = open("data/names.txt") print(f.read())

The output is:

Nora Gino Timmy William

You can use the type() function to confirm that the value returned by f.read() is a string:

print(type(f.read())) # Output 

Yes, it's a string!

In this case, the entire file was printed because we did not specify a maximum number of bytes, but we can do this as well.

Here we have an example:

f = open("data/names.txt") print(f.read(3))

The value returned is limited to this number of bytes:

Nor

❗️Important: You need to close a file after the task has been completed to free the resources associated to the file. To do this, you need to call the close() method, like this:

Readline() vs. Readlines()

You can read a file line by line with these two methods. They are slightly different, so let's see them in detail.

readline() reads one line of the file until it reaches the end of that line. A trailing newline character (\n) is kept in the string.

💡 Tip: Optionally, you can pass the size, the maximum number of characters that you want to include in the resulting string.

For example:

f = open("data/names.txt") print(f.readline()) f.close()

The output is:

Nora 

This is the first line of the file.

In contrast, readlines() returns a list with all the lines of the file as individual elements (strings). This is the syntax:

For example:

f = open("data/names.txt") print(f.readlines()) f.close()

The output is:

['Nora\n', 'Gino\n', 'Timmy\n', 'William']

Notice that there is a \n (newline character) at the end of each string, except the last one.

💡 Tip: You can get the same list with list(f).

You can work with this list in your program by assigning it to a variable or using it in a loop:

f = open("data/names.txt") for line in f.readlines(): # Do something with each line f.close()

We can also iterate over f directly (the file object) in a loop:

f = open("data/names.txt", "r") for line in f: # Do something with each line f.close()

Those are the main methods used to read file objects. Now let's see how you can create files.

🔹 Comment créer un fichier

Si vous avez besoin de créer un fichier "dynamiquement" en utilisant Python, vous pouvez le faire avec le "x"mode.

Voyons comment. Voici la syntaxe de base:

Voici un exemple. Ceci est mon répertoire de travail actuel:

Si j'exécute cette ligne de code:

f = open("new_file.txt", "x")

Un nouveau fichier portant ce nom est créé:

Avec ce mode, vous pouvez créer un fichier, puis y écrire dynamiquement en utilisant des méthodes que vous apprendrez dans quelques instants.

💡 Astuce: le fichier sera initialement vide jusqu'à ce que vous le modifiiez.

Une chose curieuse est que si vous essayez d'exécuter à nouveau cette ligne et qu'un fichier avec ce nom existe déjà, vous verrez cette erreur:

Traceback (most recent call last): File "", line 8, in  f = open("new_file.txt", "x") FileExistsError: [Errno 17] File exists: 'new_file.txt'

Selon la documentation Python, cette exception (erreur d'exécution) est:

Déclenché lors de la tentative de création d'un fichier ou d'un répertoire qui existe déjà.

Now that you know how to create a file, let's see how you can modify it.

🔸 How to Modify a File

To modify (write to) a file, you need to use the write() method. You have two ways to do it (append or write) based on the mode that you choose to open it with. Let's see them in detail.

Append

"Appending" means adding something to the end of another thing. The "a" mode allows you to open a file to append some content to it.

For example, if we have this file:

And we want to add a new line to it, we can open it using the "a" mode (append) and then, call the write() method, passing the content that we want to append as argument.

This is the basic syntax to call the write()method:

Here's an example:

f = open("data/names.txt", "a") f.write("\nNew Line") f.close()

💡 Tip: Notice that I'm adding \n before the line to indicate that I want the new line to appear as a separate line, not as a continuation of the existing line.

This is the file now, after running the script:

💡 Tip: The new line might not be displayed in the file untilf.close() runs.

Write

Sometimes, you may want to delete the content of a file and replace it entirely with new content. You can do this with the write() method if you open the file with the "w" mode.

Here we have this text file:

If I run this script:

f = open("data/names.txt", "w") f.write("New Content") f.close() 

This is the result:

As you can see, opening a file with the "w" mode and then writing to it replaces the existing content.

💡 Tip: The write() method returns the number of characters written.

If you want to write several lines at once, you can use the writelines() method, which takes a list of strings. Each string represents a line to be added to the file.

Here's an example. This is the initial file:

If we run this script:

f = open("data/names.txt", "a") f.writelines(["\nline1", "\nline2", "\nline3"]) f.close()

The lines are added to the end of the file:

Open File For Multiple Operations

Now you know how to create, read, and write to a file, but what if you want to do more than one thing in the same program? Let's see what happens if we try to do this with the modes that you have learned so far:

If you open a file in "r" mode (read), and then try to write to it:

f = open("data/names.txt") f.write("New Content") # Trying to write f.close()

You will get this error:

Traceback (most recent call last): File "", line 9, in  f.write("New Content") io.UnsupportedOperation: not writable

Similarly, if you open a file in "w" mode (write), and then try to read it:

f = open("data/names.txt", "w") print(f.readlines()) # Trying to read f.write("New Content") f.close()

You will see this error:

Traceback (most recent call last): File "", line 14, in  print(f.readlines()) io.UnsupportedOperation: not readable

The same will occur with the "a" (append) mode.

How can we solve this? To be able to read a file and perform another operation in the same program, you need to add the "+" symbol to the mode, like this:

f = open("data/names.txt", "w+") # Read + Write
f = open("data/names.txt", "a+") # Read + Append
f = open("data/names.txt", "r+") # Read + Write

Very useful, right? This is probably what you will use in your programs, but be sure to include only the modes that you need to avoid potential bugs.

Sometimes files are no longer needed. Let's see how you can delete files using Python.

🔹 How to Delete Files

To remove a file using Python, you need to import a module called os which contains functions that interact with your operating system.

💡 Tip: A module is a Python file with related variables, functions, and classes.

Particularly, you need the remove()function. This function takes the path to the file as argument and deletes the file automatically.

Let's see an example. We want to remove the file called sample_file.txt.

To do it, we write this code:

import os os.remove("sample_file.txt")
  • The first line: import os is called an "import statement". This statement is written at the top of your file and it gives you access to the functions defined in the os module.
  • The second line: os.remove("sample_file.txt") removes the file specified.

💡 Tip: you can use an absolute or a relative path.

Now that you know how to delete files, let's see an interesting tool... Context Managers!

🔸 Meet Context Managers

Context Managers are Python constructs that will make your life much easier. By using them, you don't need to remember to close a file at the end of your program and you have access to the file in the particular part of the program that you choose.

Syntax

This is an example of a context manager used to work with files:

💡 Tip: The body of the context manager has to be indented, just like we indent loops, functions, and classes. If the code is not indented, it will not be considered part of the context manager.

When the body of the context manager has been completed, the file closes automatically.

with open("", "") as : # Working with the file... # The file is closed here!

Example

Here's an example:

with open("data/names.txt", "r+") as f: print(f.readlines()) 

This context manager opens the names.txt file for read/write operations and assigns that file object to the variable f. This variable is used in the body of the context manager to refer to the file object.

Trying to Read it Again

After the body has been completed, the file is automatically closed, so it can't be read without opening it again. But wait! We have a line that tries to read it again, right here below:

with open("data/names.txt", "r+") as f: print(f.readlines()) print(f.readlines()) # Trying to read the file again, outside of the context manager

Voyons ce qui se passe:

Traceback (most recent call last): File "", line 21, in  print(f.readlines()) ValueError: I/O operation on closed file.

Cette erreur est générée car nous essayons de lire un fichier fermé. Génial, non? Le gestionnaire de contexte fait tout le travail difficile pour nous, il est lisible et concis.

🔹 Comment gérer les exceptions lors de l'utilisation de fichiers

Lorsque vous travaillez avec des fichiers, des erreurs peuvent survenir. Parfois, vous ne disposez pas des autorisations nécessaires pour modifier ou accéder à un fichier, ou un fichier peut même ne pas exister.

En tant que programmeur, vous devez prévoir ces circonstances et les gérer dans votre programme pour éviter des plantages soudains qui pourraient définitivement affecter l'expérience utilisateur.

Voyons quelques-unes des exceptions les plus courantes (erreurs d'exécution) que vous pourriez trouver lorsque vous travaillez avec des fichiers:

FileNotFoundError

Selon la documentation Python, cette exception est:

Déclenché lorsqu'un fichier ou un répertoire est demandé mais n'existe pas.

For example, if the file that you're trying to open doesn't exist in your current working directory:

f = open("names.txt")

You will see this error:

Traceback (most recent call last): File "", line 8, in  f = open("names.txt") FileNotFoundError: [Errno 2] No such file or directory: 'names.txt'

Let's break this error down this line by line:

  • File "", line 8, in . This line tells you that the error was raised when the code on the file located in was running. Specifically, when line 8 was executed in .
  • f = open("names.txt"). This is the line that caused the error.
  • FileNotFoundError: [Errno 2] No such file or directory: 'names.txt' . This line says that a FileNotFoundError exception was raised because the file or directory names.txt doesn't exist.

💡 Tip: Python is very descriptive with the error messages, right? This is a huge advantage during the process of debugging.

PermissionError

This is another common exception when working with files. According to the Python Documentation, this exception is:

Déclenché lors d'une tentative d'exécution d'une opération sans les droits d'accès adéquats - par exemple, les autorisations du système de fichiers.

Cette exception est déclenchée lorsque vous essayez de lire ou de modifier un fichier auquel vous n'avez pas accès. Si vous essayez de le faire, vous verrez cette erreur:

Traceback (most recent call last): File "", line 8, in  f = open("") PermissionError: [Errno 13] Permission denied: 'data'

IsADirectoryError

Selon la documentation Python, cette exception est:

Déclenché lorsqu'une opération de fichier est demandée sur un répertoire.

Cette exception particulière est déclenchée lorsque vous essayez d'ouvrir ou de travailler sur un répertoire au lieu d'un fichier, soyez donc très prudent avec le chemin que vous passez en argument.

Comment gérer les exceptions

Pour gérer ces exceptions, vous pouvez utiliser une instruction try / except . Avec cette instruction, vous pouvez "dire" à votre programme ce qu'il doit faire en cas d'inattendu.

Voici la syntaxe de base:

try: # Try to run this code except : # If an exception of this type is raised, stop the process and jump to this block 

Here you can see an example with FileNotFoundError:

try: f = open("names.txt") except FileNotFoundError: print("The file doesn't exist")

This basically says:

  • Try to open the file names.txt.
  • If a FileNotFoundError is thrown, don't crash! Simply print a descriptive statement for the user.

💡 Tip: You can choose how to handle the situation by writing the appropriate code in the except block. Perhaps you could create a new file if it doesn't exist already.

To close the file automatically after the task (regardless of whether an exception was raised or not in the try block) you can add the finally block.

try: # Try to run this code except : # If this exception is raised, stop the process immediately and jump to this block finally: # Do this after running the code, even if an exception was raised

This is an example:

try: f = open("names.txt") except FileNotFoundError: print("The file doesn't exist") finally: f.close()

There are many ways to customize the try/except/finally statement and you can even add an else block to run a block of code only if no exceptions were raised in the try block.

💡 Tip: To learn more about exception handling in Python, you may like to read my article: "How to Handle Exceptions in Python: A Detailed Visual Introduction".

🔸 In Summary

  • You can create, read, write, and delete files using Python.
  • File objects have their own set of methods that you can use to work with them in your program.
  • Context Managers help you work with files and manage them by closing them automatically when a task has been completed.
  • Exception handling is key in Python. Common exceptions when you are working with files include FileNotFoundError, PermissionError and IsADirectoryError. They can be handled using try/except/else/finally.

I really hope you liked my article and found it helpful. Now you can work with files in your Python projects. Check out my online courses. Follow me on Twitter. ⭐️