14.2: Writing to Files

Learning Objectives

By the end of this section you should be able to

• Understand how to open a file for writing.
• Explain different modes for opening a file in Python.
• Demonstrate the use of the write() function to write to a file.
• Understand the importance of closing a file.

Opening a file for writing

A file may be opened for reading, allowing no changes, or for writing, allowing changes to occur in the file. The mode defines whether a file is opened for reading only or for writing. The default mode of the open() function is reading only. A second mode parameter defines the mode.

Ex: open("output.txt", 'w') opens the output.txt file in writing mode. The following table lists common modes.

Table 14.1 Modes for the open() function.

Parameter	Mode name and description	Example
'r'	Read mode: Open the specified file for reading. If the file does not exist, an error occurs. When no mode parameter is used, the default is to open a file in read mode.	fileobj = open("input.txt") same as: fileobj = open("input.txt", 'r')
'w'	Write mode: Open the specified file for writing. If the file does not exist, then the file is created. If the file already exists, the contents of the file are overwritten.	fileobj = open("output.txt", 'w')
'a'	Append mode: Open the specified file for appending, which means adding information to the end of the existing file. If the file does not exist, then the file is created.	fileobj = open("log.txt", 'a')

Concepts in Practice: File modes

Assume that a file named logfile.txt exists.

Concepts in Practice \(\PageIndex{1}\): File modes

To read logfile.txt, which of the following lines of code works best?

1. logfile = open("logfile.txt")
2. logfile = open("logfile.txt", 'w')
3. logfile = open("logfile.txt", 'a')

Answer

a. The default mode for the open() function is read.

Concepts in Practice \(\PageIndex{2}\): File modes

Additions are to be made to logfile.txt. Which of the following lines of code works best?

1. infile = open("logfile.txt")
2. infile = open("logfile.txt", 'w')
3. infile = open("logfile.txt", 'a')

Answer

c. 'a' indicates append mode allowing additions to the file.

Concepts in Practice \(\PageIndex{3}\): File modes

A new file called newlog.txt must be created. Which of the following lines of code works best?

1. logfile = open("newlog.txt")
2. logfile = open("newlog.txt", 'w')
3. logfile = open("newlog.txt", 'a')

Answer

b. 'w' indicates write mode, and newlog.txt will be created or overwritten (if newlog.txt already exists) and will allow writing.

Using write() and close()

The write() function is used to write to an already opened file. The write() function will only accept a string parameter. Other variable types must be cast to string before writing using write().

The write() function does not automatically add a newline character as the print() function does. A newline must be added explicitly by adding a newline ('\n') character.

The write() function writes automatically to a temporary store called the file buffer. To ensure that the information is written to a file, the close() function must be used. The close() function finalizes changes and closes the file.

Example 14.2: Writing and appending to a file

    """Operations for writing and appending to files."""

    # Create a new file
    opfile = open("output.txt", 'w')

    # Writing to the file
    opfile.write("Writing to a new file.")

    # To add another line the newline character must be used
    opfile.write("\nSecond line.")

    # Ensure changes are saved by closing the file
    opfile.close()

    # Read and display the contents of the file
    infile = open("output.txt")
    print("\nRead the original file:\n")
    print(infile.read())
    infile.close()

    # Reopen the file in append mode to add to the file
    opfile = open("output.txt", 'a')

    # Note the use of newline characters
    opfile.write("\nAdding to the file.")
    opfile.write("\nAdding another line.")

    # Ensure changes are saved by closing the file
    opfile.close()

    # Read and display the contents of the modified file
    infile = open("output.txt")
    print("\nRead the modified file:\n")
    print(infile.read())
    infile.close()

The code's output is:

    Read the original file:

    Writing to a new file.
    Second line.

    Read the modified file:

    Writing to a new file.
    Second line.
    Adding to the file.
    Adding another line.

Checkpoint: write() and close()

Concepts in Practice: Writing to files

resources.txt already exists. What would happen for each of the following snippets of code?

Concepts in Practice \(\PageIndex{4}\): Writing to files

outfile = open("resources.txt", 'w')
outfile.write("new content")

1. nothing
2. The contents of the resources.txt file is overwritten with the line "new content".
3. The resources.txt file is overwritten, but the contents of resources.txt are uncertain.

Answer

c. resources.txt is likely empty, but the state of resources.txt is uncertain. To ensure the contents are saved correctly, the close() function must be used.

Concepts in Practice \(\PageIndex{5}\): Writing to files

outfile = open("resources.txt", 'w')
outfile.write("new content")
outfile.close()

1. The content of the resources.txt file is overwritten with the line "new content".
2. The line "new content" is added to the end of resources.txt.

Answer

a. Write mode will overwrite the existing file. The close() statement finalizes changes to the file.

Concepts in Practice \(\PageIndex{6}\): Writing to files

outfile = open("resources.txt", 'a')
outfile.write("new content")
outfile.close()

1. The content of the resources.txt file is overwritten with the line "new content".
2. The line "new content" is added to the end of resources.txt.

Answer

b. Append mode adds to the existing file. resources.txt is opened such that additions can be made to the file.

Try It: Writing to a new file

Write a line of text to a file called out.txt. Don't forget to use close(). out.txt should only have the line of text that you have written.

Interactive Code

out.log

Hello this file should be overwritten.

Answer

# Open the file in write mode
outfile = open("out.txt", 'w')

# Write to the new file.
outfile.write("Creating new content in a new file.")

# Close the file to record changes to the file
outfile.close()

Try It: Writing to an existing file

Add two lines of text to the file called out.log, such that out.log has three lines after the code executes.

Hint: Don't forget that you need a newline character.

Interactive Code

out.log

This file should be added to...
# Open the file in append mode
outfile = open("out.log", 'a')

# Write 2 lines to the file
outfile.write("\nThis is the first line.")
outfile.write("\nThis is the second line.")

# Always remember to close the file to ensure changes are recorded.
outfile.close()