Python In Datei schreiben - Funktionen zum Öffnen, Lesen, Anhängen und andere Funktionen zur Dateiverwaltung werden erläutert

Herzlich willkommen

Hallo! Wenn Sie lernen möchten, wie Sie mit Dateien in Python arbeiten, ist dieser Artikel genau das Richtige für Sie. Das Arbeiten mit Dateien ist eine wichtige Fähigkeit, die jeder Python-Entwickler erlernen sollte. Beginnen wir also.

In diesem Artikel erfahren Sie:

  • So öffnen Sie eine Datei.
  • So lesen Sie eine Datei.
  • So erstellen Sie eine Datei.
  • So ändern Sie eine Datei.
  • So schließen Sie eine Datei.
  • So öffnen Sie Dateien für mehrere Vorgänge.
  • So arbeiten Sie mit Dateiobjektmethoden.
  • So löschen Sie Dateien.
  • Wie man mit Kontextmanagern arbeitet und warum sie nützlich sind.
  • Umgang mit Ausnahmen, die beim Arbeiten mit Dateien ausgelöst werden können.
  • und mehr!

Lass uns anfangen! ✨

🔹 Arbeiten mit Dateien: Grundlegende Syntax

Eine der wichtigsten Funktionen , die Sie , wie Sie mit Dateien in Python arbeiten müssen verwenden ist open(), eine eingebaute Funktion , die eine Datei öffnet und Ihr Programm es und mit ihm arbeiten zu können.

Dies ist die grundlegende Syntax :

💡 Tipp: Dies sind die beiden am häufigsten verwendeten Argumente zum Aufrufen dieser Funktion. Es gibt sechs zusätzliche optionale Argumente. Um mehr darüber zu erfahren, lesen Sie bitte diesen Artikel in der Dokumentation.

Erster Parameter: Datei

Der erste Parameter der open()Funktion ist fileder absolute oder relative Pfad zu der Datei, mit der Sie arbeiten möchten.

Normalerweise verwenden wir einen relativen Pfad, der angibt, wo sich die Datei relativ zum Speicherort des Skripts (Python-Datei) befindet, das die open()Funktion aufruft .

Der Pfad in diesem Funktionsaufruf lautet beispielsweise:

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

Enthält nur den Namen der Datei. Dies kann verwendet werden, wenn sich die Datei, die Sie öffnen möchten, im selben Verzeichnis oder Ordner wie das Python-Skript befindet:

Befindet sich die Datei jedoch in einem verschachtelten Ordner, so:

Dann müssen wir einen bestimmten Pfad verwenden, um der Funktion mitzuteilen, dass sich die Datei in einem anderen Ordner befindet.

In diesem Beispiel wäre dies der Pfad:

open("data/names.txt")

Beachten Sie, dass wir data/zuerst schreiben (den Namen des Ordners, gefolgt von a /) und dann names.txt(den Namen der Datei mit der Erweiterung).

💡 Tipp: Die drei Buchstaben .txt, die auf den Punkt folgen, names.txtsind die "Erweiterung" der Datei oder ihr Typ. In diesem Fall wird .txtangezeigt, dass es sich um eine Textdatei handelt.

Zweiter Parameter: Modus

Der zweite Parameter der open()Funktion ist die modeZeichenfolge mit einem Zeichen. Dieses einzelne Zeichen teilt Python im Grunde mit, was Sie mit der Datei in Ihrem Programm vorhaben.

Verfügbare Modi sind:

  • Lesen Sie ( "r").
  • Anhängen ( "a")
  • Schreiben ( "w")
  • Erstellen ( "x")

Sie können die Datei auch öffnen in:

  • Textmodus ( "t")
  • Binärmodus ( "b")

Um den Text- oder Binärmodus zu verwenden, müssen Sie diese Zeichen zum Hauptmodus hinzufügen. Zum Beispiel: "wb"bedeutet, im Binärmodus zu schreiben.

💡 Tipp: Die Standardmodi sind read ( "r") und text ( "t"), was "zum Lesen von Text öffnen" ( "rt") bedeutet. Sie müssen sie also nicht angeben, open()wenn Sie sie verwenden möchten, da sie standardmäßig zugewiesen sind. Sie können einfach schreiben open().

Warum Modi?

Es ist wirklich sinnvoll, dass Python nur bestimmte Berechtigungen erteilt, basierend auf dem, was Sie mit der Datei vorhaben, oder? Warum sollte Python Ihrem Programm erlauben, mehr als nötig zu tun? Dies ist im Grunde der Grund, warum Modi existieren.

Denken Sie darüber nach - es kann problematisch sein, einem Programm zu erlauben, mehr als nötig zu tun. Wenn Sie beispielsweise nur den Inhalt einer Datei lesen müssen, kann es gefährlich sein, Ihrem Programm zu erlauben, ihn unerwartet zu ändern, was möglicherweise zu Fehlern führen kann.

🔸 So lesen Sie eine Datei

Nachdem Sie nun mehr über die Argumente der open()Funktion wissen , sehen wir uns an, wie Sie eine Datei öffnen und in einer Variablen speichern können, um sie in Ihrem Programm zu verwenden.

Dies ist die grundlegende Syntax:

Wir weisen den zurückgegebenen Wert einfach einer Variablen zu. Zum Beispiel:

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

Ich weiß, dass Sie sich vielleicht fragen: Von welcher Art von Wert wird zurückgegeben open()?

Nun, ein Dateiobjekt .

Lassen Sie uns ein wenig über sie sprechen.

Dateiobjekte

Gemäß der Python-Dokumentation lautet ein Dateiobjekt :

Ein Objekt, das eine dateiorientierte API (mit Methoden wie read () oder write ()) für eine zugrunde liegende Ressource verfügbar macht.

Dies sagt uns im Grunde, dass ein Dateiobjekt ein Objekt ist, mit dem wir mit vorhandenen Dateien in unserem Python-Programm arbeiten und interagieren können.

Dateiobjekte haben Attribute wie:

  • 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.

🔹 So erstellen Sie eine Datei

Wenn Sie eine Datei "dynamisch" mit Python erstellen müssen, können Sie dies im "x"Modus tun .

Mal sehen wie. Dies ist die grundlegende Syntax:

Hier ist ein Beispiel. Dies ist mein aktuelles Arbeitsverzeichnis:

Wenn ich diese Codezeile ausführe:

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

Eine neue Datei mit diesem Namen wird erstellt:

In diesem Modus können Sie eine Datei erstellen und dann dynamisch mit Methoden schreiben, die Sie in wenigen Augenblicken lernen werden.

💡 Tipp: Die Datei bleibt zunächst leer, bis Sie sie ändern.

Eine merkwürdige Sache ist, dass, wenn Sie versuchen, diese Zeile erneut auszuführen und eine Datei mit diesem Namen bereits vorhanden ist, dieser Fehler angezeigt wird:

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

Gemäß der Python-Dokumentation ist diese Ausnahme (Laufzeitfehler):

Wird ausgelöst, wenn versucht wird, eine bereits vorhandene Datei oder ein bereits vorhandenes Verzeichnis zu erstellen.

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

Mal sehen was passiert:

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

Dieser Fehler wird ausgelöst, weil wir versuchen, eine geschlossene Datei zu lesen. Genial, oder? Der Kontextmanager erledigt die ganze schwere Arbeit für uns, er ist lesbar und prägnant.

🔹 Umgang mit Ausnahmen beim Arbeiten mit Dateien

Wenn Sie mit Dateien arbeiten, können Fehler auftreten. Manchmal verfügen Sie möglicherweise nicht über die erforderlichen Berechtigungen zum Ändern oder Zugreifen auf eine Datei, oder eine Datei ist möglicherweise gar nicht vorhanden.

Als Programmierer müssen Sie diese Umstände vorhersehen und in Ihrem Programm behandeln, um plötzliche Abstürze zu vermeiden, die die Benutzererfahrung definitiv beeinträchtigen könnten.

Sehen wir uns einige der häufigsten Ausnahmen (Laufzeitfehler) an, die bei der Arbeit mit Dateien auftreten können:

FileNotFoundError

Laut der Python-Dokumentation ist diese Ausnahme:

Wird ausgelöst, wenn eine Datei oder ein Verzeichnis angefordert wird, aber nicht vorhanden ist.

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:

Wird ausgelöst, wenn versucht wird, einen Vorgang ohne die entsprechenden Zugriffsrechte auszuführen - z. B. Dateisystemberechtigungen.

Diese Ausnahme wird ausgelöst, wenn Sie versuchen, eine Datei zu lesen oder zu ändern, die keine Zugriffsberechtigung hat. Wenn Sie dies versuchen, wird der folgende Fehler angezeigt:

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

IsADirectoryError

Laut der Python-Dokumentation ist diese Ausnahme:

Wird ausgelöst, wenn eine Dateivorgang für ein Verzeichnis angefordert wird.

Diese besondere Ausnahme wird ausgelöst, wenn Sie versuchen, ein Verzeichnis anstelle einer Datei zu öffnen oder zu bearbeiten. Seien Sie also sehr vorsichtig mit dem Pfad, den Sie als Argument übergeben.

Umgang mit Ausnahmen

Um diese Ausnahmen zu behandeln, können Sie eine try / exception- Anweisung verwenden. Mit dieser Anweisung können Sie Ihrem Programm "sagen", was zu tun ist, falls etwas Unerwartetes passiert.

Dies ist die grundlegende Syntax:

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. ⭐️