- Writing List to a File in Python
- Table of contents
- Steps to Write List to a File in Python
- Example to Write List to a File in Python
- Example to Read List from a File in Python
- Write a list to file without using a loop
- Pickle module to write (serialize) list into a file
- Json module to write list into a JSON file
- writelines() method to write a list of lines to a file
- About Vishal
- Related Tutorial Topics:
- Python Exercises and Quizzes
- Saving programs in Python
- Writing, Saving and Running Python Programs with IDLE
Writing List to a File in Python
In this article, you’ll learn how to write a list to a file in Python.
Often, we require storing a list, dictionary, or any in-memory data structure to persistent storage such as file or database so that we can reuse it whenever needed. For example, after analyzing data, you can store it in a file, and for the next time, that data can be read to use in an application.
There are multiple ways to write a Python list to a file. After reading this article, You’ll learn:
- Write a list to a text file and read it in a Python program when required using a write() and read() method.
- How to use Python’s pickle module to serialize and deserialize a list into a file. Serialize means saving a list object to a file. Deserialize means reading that list back into memory.
- Use of built-in json module to write a list to a json file.
Table of contents
Steps to Write List to a File in Python
Python offers the write() method to write text into a file and the read() method to read a file. The below steps show how to save Python list line by line into a text file.
- Open file in write mode Pass file path and access mode w to the open() function. The access mode opens a file in write mode.
For example, fp= open(r’File_Path’, ‘w’) . - Iterate list using a for loop Use for loop to iterate each item from a list. We iterate the list so that we can write each item of a list into a file.
- Write current item into the file In each loop iteration, we get the current item from the list. Use the write(‘text’) method to write the current item to a file and move to the next iteration. we will repeat this step till the last item of a list.
- Close file after completing the write operation When we complete writing a list to a file, we need to ensure that the file will be closed properly. Use file close() method to close a file.
Example to Write List to a File in Python
# list of names names = ['Jessa', 'Eric', 'Bob'] # open file in write mode with open(r'E:/demos/files_demos/account/sales.txt', 'w') as fp: for item in names: # write each item on a new line fp.write("%s\n" % item) print('Done')
Note: We used the \n in write() method to break the lines to write each item on a new line.
Below content got written in a file.
Example to Read List from a File in Python
Now, Let’s see how to read the same list from a file back into memory.
# empty list to read list from a file names = [] # open file and read the content in a list with open(r'E:\demos\files_demos\account\sales.txt', 'r') as fp: for line in fp: # remove linebreak from a current name # linebreak is the last character of each line x = line[:-1] # add current item to the list names.append(x) # display list print(names)
Write a list to file without using a loop
In this example, we are using a join method of a str class to add a newline after each item of a list and write it to a file.
The join() method will join all items in a list into a string, using a \n character as separator (which will add a new line after each list item).
# list of names names = ['Jessa', 'Eric', 'Bob'] with open(r'E:/demos/files_demos/account/sales.txt', 'w') as fp: fp.write('\n'.join(names))
If you want to convert all items of a list to a string when writing then use the generator expression.
# list of names names = ['Jessa', 'Eric', 'Bob'] with open(r'E:/demos/files_demos/account/sales.txt', 'w') as fp: fp.write("\n".join(str(item) for item in names))
Pickle module to write (serialize) list into a file
Python pickle module is used for serializing and de-serializing a Python object. For example, we can convert any Python objects such as list, dict into a character stream using pickling. This character stream contains all the information necessary to reconstruct the object in the future.
Any object in Python can be pickled and saved in persistent storage such as database and file for later use.
Example: Pickle and write Python list into a file
- First import the pickle module
- To write a list to a binary file, use the access mode ‘b’ to open a file. For writing, it will be wb , and for reading, it will be rb . The file open() function will check if the file already exists and, if not, will create one. If a file already exists, it gets truncated, and new content will be added at the start of a file.
- Next, The pickle’s dump(list, file_object) method converts an in-memory Python object into a bytes string and writes it to a binary file.
# Python program to store list to file using pickle module import pickle # write list to binary file def write_list(a_list): # store list in binary file so 'wb' mode with open('listfile', 'wb') as fp: pickle.dump(names, fp) print('Done writing list into a binary file') # Read list to memory def read_list(): # for reading also binary mode is important with open('sampleList', 'rb') as fp: n_list = pickle.load(fp) return n_list # list of names names = ['Jessa', 'Eric', 'Bob'] write_list(names) r_names = read_list() print('List is', r_names)
Done writing list into a binary file List is ['Jessa', 'Eric', 'Bob']
Json module to write list into a JSON file
We can use it in the following cases.
- Most of the time, when you execute a GET request, you receive a response in JSON format, and you can store JSON response in a file for future use or for an underlying system to use.
- For example, you have data in a list, and you want to encode and store it in a file in the form of JSON.
In this example, we are going to use the Python json module to convert the list into JSON format and write it into a file using a json dump() method.
# Python program to store list to JSON file import json def write_list(a_list): print("Started writing list data into a json file") with open("names.json", "w") as fp: json.dump(a_list, fp) print("Done writing JSON data into .json file") # Read list to memory def read_list(): # for reading also binary mode is important with open('names.json', 'rb') as fp: n_list = json.load(fp) return n_list # assume you have the following list names = ['Jessa', 'Eric', 'Bob'] write_list(names) r_names = read_list() print('List is', r_names)
Started writing list data into a json file Done writing JSON data into .json file List is ['Jessa', 'Eric', 'Bob']
writelines() method to write a list of lines to a file
We can write multiple lines at once using the writelines() method. For example, we can pass a list of strings to add to the file. Use this method when you want to write a list into a file.
# list of names names = ['Jessa', 'Eric', 'Bob'] with open(r'E:/demos/files_demos/account/sales.txt', 'w') as fp: fp.writelines(names)
Here is the output we are getting
cat sales.txt JessaEricBob
As you can see in the output, the file writelines() method doesn’t add any line separators after each list item.
To overcome this limitation, we can use list comprehension to add the new line character after each element in the list and then pass the list to the writelines method.
# list of names names = ['Jessa', 'Eric', 'Bob'] # add '\n' after each item of a list n_names = ["<>\n".format(i) for i in names] with open(r'E:/demos/files_demos/account/sales.txt', 'w') as fp: fp.writelines(n_names)
cat sales.txt Jessa Eric Bob
Did you find this page helpful? Let others know about it. Sharing helps me continue to create free Python resources.
About Vishal
I’m Vishal Hule, Founder of PYnative.com. I am a Python developer, and I love to write articles to help students, developers, and learners. Follow me on Twitter
Related Tutorial Topics:
Python Exercises and Quizzes
Free coding exercises and quizzes cover Python basics, data structure, data analytics, and more.
- 15+ Topic-specific Exercises and Quizzes
- Each Exercise contains 10 questions
- Each Quiz contains 12-15 MCQ
Saving programs in Python
Swadhin Ray
Here I am using Python IDLE(GUI) to write a simple program and save it, so that we can just execute it in future. Because when we write any program and exit from Python then program that we have written will be lost. So for not losing our program we save it.
So when we use Python IDLE(GUI) we can navigate to «File» and then click on «New Window» or we can use shortcut i.e.«Ctrl+N» which will open a new text editor where we can write our program and save it into any location on the operating system. From the new window we can execute our program too.
Below are the screen shots taken after opening IDEL and then opening a New window.
Now let us write a simple program and save it on any location, but when we save the file the extension of the file name will always be «.py» :
x = raw_input("Enter your name : ") print "Hello " + x
Once it is saved on your system then navigate to «Run» and click on «Run Module» or «F5» which will run on the Python Shell as like below:
Python 2.7.3 (default, Apr 10 2012, 23:31:26) [MSC v.1500 32 bit (Intel)] on win32 Type "copyright", "credits" or "license()" for more information. >>> ================================ RESTART ================================ >>> Enter your name : Sloba Hello Sloba >>>
I have named this program as «test.py». Below is the image of the file that I have saved it on my desktop.
Now we can also run this program by simply double click on it. But we will be unable to see the result after we enter the name as I have shown earlier, because it is processed so fast that we cannot see if the printed the input successfully or not.
So for avoiding this let us modify the program a bit and execute it from my desktop.
x = raw_input("Enter your name : ") print "Hello " + x raw_input(" Hit to Exit ")
Now when we run the script from desktop then it will show the result after we pass the our name as input:
Enter your name : Sloba Hello Sloba Hit to Exit
So once we hit enter the command prompt will be closed. Now we come to know like how to save our Python program and if we want to hold before exit then we can make use of a function called «RAW_INPUT».
Writing, Saving and Running Python Programs with IDLE
Entering commands at the prompt is just the beginning. Let’s use IDLE to save and run files. With this skill you’ll be able to write and build complex and powerful Python programs. IDLE has two modes: interactive and script. We wrote our first program, “Hello, World!” in interactive mode. Interactive mode immediately returns the results of commands you enter into the shell. In script mode, you will write a script and then run it.
Let’s create a module. We’ll cover modules in depth later. For now, all you need to know is that a module is a file containing Python code ending in the suffix:
If it’s not already running, start IDLE. Using IDLE is very similar to using a text editor. Under File, select New Window or press Ctrl + N. That will bring up a new window titled, “Untitled”.
Enter this command in the Untitled window:
print(“What's brown and sounds like a bell?”)
We need to save our file before we can run it. So under File, select Save. At the prompt, name it something clever like:
And save it somewhere you can find it later.
Now the fun part. Under Run, select Run Module.
Now go back to the Shell. What’s this RESTART business? The Shell is restarted every time you run a module in IDLE. That’s to clear out any old settings that might interfere with your program. Below the RESTART line you should see:
It’s not much of a joke without a punchline. Let’s modify our module. Change the following:
input(“What's brown and sound like a bell?”) print(“Dung!”)
Let’s run that again, this time with the keyboard shortcut: F5. Try that.
In the Shell you’ll see our joke printed, but where’s the punchline? Notice that there isn’t a prompt? That’s because the Shell is waiting for your input. Press any key.
I love that joke. It’s so good and so bad. Know what I mean? Know what I mean? Nudge nudge, say no more.