Python Write to File - Отваряне, четене, добавяне и други обяснени функции за обработка на файлове

Добре дошли

Здравей! Ако искате да научите как да работите с файлове в Python, тогава тази статия е за вас. Работата с файлове е важно умение, което всеки разработчик на Python трябва да научи, така че нека да започнем.

В тази статия ще научите:

  • Как да отворите файл.
  • Как се чете файл.
  • Как да създадете файл.
  • Как да модифицирам файл.
  • Как да затворите файл.
  • Как да отворите файлове за множество операции.
  • Как се работи с методите на файловите обекти.
  • Как да изтриете файлове.
  • Как да работите с контекстни мениджъри и защо те са полезни.
  • Как да се справя с изключенията, които биха могли да възникнат, когато работите с файлове.
  • и още!

Нека да започнем! ✨

🔹 Работа с файлове: Основен синтаксис

Една от най-важните функции, които ще трябва да използвате, докато работите с файлове в Python open(), е вградена функция, която отваря файл и позволява на вашата програма да го използва и да работи с него.

Това е основният синтаксис :

💡 Съвет: Това са двата най-често използвани аргумента за извикване на тази функция. Има шест допълнителни аргумента по избор. За да научите повече за тях, моля, прочетете тази статия в документацията.

Първи параметър: Файл

Първият параметър на open()функцията е fileабсолютният или относителният път към файла, с който се опитвате да работите.

Обикновено използваме относителен път, който показва къде се намира файлът спрямо местоположението на скрипта (Python файл), който извиква open()функцията.

Например пътят в тази функция извиква:

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

Съдържа само името на файла. Това може да се използва, когато файлът, който се опитвате да отворите, е в същата директория или папка като скрипта на Python, като този:

Но ако файлът е в вложена папка, ето така:

След това трябва да използваме определен път, за да кажем на функцията, че файлът е в друга папка.

В този пример това би бил пътят:

open("data/names.txt")

Забележете, че data/първо пишем (името на папката, последвано от a /) и след това names.txt(името на файла с разширението).

💡 Съвет: Трите букви, .txtкоито следват точката, names.txtса „разширението“ на файла или неговия тип. В този случай .txtуказва, че това е текстов файл.

Втори параметър: Режим

Вторият параметър на open()функцията е modeнизът с един символ. Този единствен знак основно казва на Python какво планирате да направите с файла във вашата програма.

Наличните режими са:

  • Прочетете ( "r").
  • Добавяне ( "a")
  • Пишете ( "w")
  • Създаване ( "x")

Можете също да изберете да отворите файла в:

  • Текстов режим ( "t")
  • Двоичен режим ( "b")

За да използвате текстов или двоичен режим, ще трябва да добавите тези знаци към основния режим. Например: "wb"означава писане в двоичен режим.

💡 Съвет: Режимите по подразбиране са read ( "r") и text ( "t"), което означава „отворен за четене на текст“ ( "rt"), така че не е необходимо да ги посочвате, open()ако искате да ги използвате, тъй като те са назначени по подразбиране. Можете просто да пишете open().

Защо режими?

Наистина има смисъл Python да предоставя само определени разрешения въз основа на това, което планирате да направите с файла, нали? Защо Python трябва да позволява на вашата програма да прави повече от необходимото? Това е основната причина за съществуването на режими.

Помислете - позволяването на програма да прави повече от необходимото може да създаде проблеми. Например, ако трябва само да прочетете съдържанието на даден файл, може да бъде опасно да позволите на вашата програма да го модифицира неочаквано, което потенциално може да доведе до грешки.

🔸 Как да прочетете файл

След като знаете повече за аргументите, които open()функцията приема, нека видим как можете да отворите файл и да го съхраните в променлива, за да го използвате във вашата програма.

Това е основният синтаксис:

Ние просто присвояваме стойността, върната на променлива. Например:

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

Знам, че може би питате: от какъв тип стойност се връща open()?

Е, един обект файл .

Нека поговорим малко за тях.

Файлови обекти

Според документацията на Python файловият обект е:

Обект, излагащ API, ориентиран към файлове (с методи като read () или write ()) на основен ресурс.

Това основно ни казва, че файловият обект е обект, който ни позволява да работим и да взаимодействаме със съществуващи файлове в нашата програма Python.

Файловите обекти имат атрибути, като:

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

🔹 Как да създадете файл

Ако трябва да създадете файл „динамично“ с помощта на Python, можете да го направите с "x"режима.

Да видим как. Това е основният синтаксис:

Ето един пример. Това е текущата ми работна директория:

Ако изпълня този ред код:

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

Създава се нов файл с това име:

С този режим можете да създадете файл и след това да пишете в него динамично, използвайки методи, които ще научите само след няколко минути.

💡 Съвет: Първоначално файлът ще бъде празен, докато не го промените.

Любопитното е, че ако опитате да стартирате този ред отново и файл с това име вече съществува, ще видите тази грешка:

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

Според документацията на Python това изключение (грешка по време на изпълнение) е:

Повишава се при опит за създаване на файл или директория, който вече съществува.

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

Нека да видим какво ще стане:

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

Тази грешка се появява, защото се опитваме да прочетем затворен файл. Страхотно, нали? Контекстният мениджър върши цялата тежка работа за нас, четим е и кратък.

🔹 Как да се справя с изключенията при работа с файлове

Когато работите с файлове, могат да възникнат грешки. Понякога може да нямате необходимите разрешения за промяна или достъп до файл, или файл дори може да не съществува.

Като програмист трябва да предвидите тези обстоятелства и да се справите с тях във вашата програма, за да избегнете внезапни сривове, които определено могат да повлияят на потребителското изживяване.

Нека да видим някои от най-често срещаните изключения (грешки по време на изпълнение), които може да намерите, когато работите с файлове:

FileNotFoundError

Според документацията на Python това изключение е:

Повишава се, когато се изисква файл или директория, но не съществува.

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:

Повишава се при опит за стартиране на операция без адекватни права за достъп - например разрешения за файлова система.

Това изключение се повдига, когато се опитвате да прочетете или промените файл, който няма разрешение за достъп. Ако се опитате да го направите, ще видите тази грешка:

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

IsADirectoryError

Според документацията на Python това изключение е:

Повишава се, когато се изисква файлова операция в директория.

Това специално изключение се повдига, когато се опитвате да отворите или работите върху директория вместо файл, така че бъдете много внимателни с пътя, който предавате като аргумент.

Как да се справя с изключенията

За да се справите с тези изключения, можете да използвате инструкция за опит / изключение . С това изявление можете да „кажете“ на програмата си какво да прави, в случай че се случи нещо неочаквано.

Това е основният синтаксис:

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