{"id":12265,"date":"2020-05-20T17:49:13","date_gmt":"2020-05-21T00:49:13","guid":{"rendered":"https:\/\/careerkarma.com\/blog\/?p=12265"},"modified":"2023-12-01T02:47:51","modified_gmt":"2023-12-01T10:47:51","slug":"python-csv-module","status":"publish","type":"post","link":"https:\/\/careerkarma.com\/blog\/python-csv-module\/","title":{"rendered":"The Python CSV Module: Step-By-Step Guide"},"content":{"rendered":"\n

The Python CSV module is used to handle CSV files. CSV files can hold a lot of information, and the CSV module lets Python read and write to CSV files with the <\/em>reader()<\/em><\/code> and <\/em>writer()<\/em><\/code> functions. <\/em><\/p>\n\n\n\n

\n\n\n\n

Reading, writing, and manipulating data is an essential part of programming. Therefore, it can be useful to know how to handle files in Python, so that you can read and write data from external sources. <\/p>\n\n\n\n

For example, let\u2019s say that you are the owner of a local ice cream shop who wants to learn more about customer trends. You could use Python to analyze the data you have gathered on user orders to find out about which flavors of ice cream are popular, how much people spend on those flavors, and more.<\/p>\n\n\n\n

This is where the Python CSV module comes in. CSV files are used to store a large amount of data, and the CSV module allows you to parse those files in Python. In this tutorial, we are going to explore how to read and write to CSV files using the CSV Python module.<\/p>\n\n\n\n

CSV Refresher<\/h2>\n\n\n\n

When you\u2019re working with data, you may have a list of that data separated by commas. For example, you may have a list of ice cream orders whose values are separated with commas. This data structure is referred to as CSV data or Comma-Separated Values.<\/p>\n\n\n\n

Traditional text files can be useful for when you need to store data, but they cannot be used to store structured data. CSV files, on the other hand, allow you to store structured data in a table format that you can reference in your code, similar to how spreadsheets and databases allow you to store structured data. For example, you may have a CSV file that stores ice cream flavors or supplier information.<\/p>\n\n\n\n

Here\u2019s an example of a CSV file: <\/p>\n\n\n\n

suppliers.csv\nHendersons Creamery, 123 Main Street, Cream\nPeterson Chocolate, 129 Second Street, Chocolate Sprinkles<\/pre><\/div>\n\n\n\n
This file stores three items: the name of a supplier, their address, and the product with which they supply our business. Our file also stores two lines of data, one for Hendersons Creamery and the other for Peterson Chocolate.<\/p>\n\n\n\n
Because our data is structured in a CSV file, we can parse it through a Python program and get data from individual columns or rows.<\/p>\n\n\n\n
Python CSV Module<\/h2>\n\n\n\n
The Python CSV module can be used to parse CSV data in Python. So, if you have a CSV file of supplier information, for example, you can use the CSV module to retrieve and work with that data.<\/p>\n\n\n\n
CSV is a built-in Python module, but before we start using it, we have to import CSV<\/code> into our program. We can do so using this code:<\/p>\n\n\n\n
import csv<\/pre><\/div>\n\n\n\n
Reading CSV Files<\/h3>\n\n\n\n
Before you can work with data in a CSV file, you need to read the file. The CSV module comes with a method called reader()<\/code> which can be used to read a CSV file into our program. The reader function takes each line of a specified file and turns it into a list of columns.<\/p>\n\n\n\n
Let\u2019s say that we have a list of ice cream suppliers in a file called suppliers.csv<\/code> that we want to read into our program. The contents of the file is as follows:<\/p>\n\n\n\n
Hendersons Creamery, 123 Main Street, Cream\nPeterson Chocolate, 129 Second Street, Chocolate Sprinkles\nHW Smith and Co, 17 Boston Avenue, Ice Cream Cones<\/pre><\/div>\n\n\n\n
We can retrieve this data using the following code:<\/p>\n\n\n\n
import csv\nwith open(\"suppliers.csv\", \"r\") as f:\n\tcontents = csv.reader(f)\n\tfor c in contents:\n\t\tprint(c)<\/pre><\/div>\n\n\n\n
There\u2019s a lot going on here, so let\u2019s break it down. On the first line, we import the csv<\/code> module, which allows us to use CSV methods in our code. On the next line, we use a with<\/code> statement to open up our file, and state that our file should be assigned the value f<\/code>. <\/p>\n\n\n\n
Next, we use contents = csv.reader(f)<\/code> to read the contents of our file, making use of the csv.reader()<\/code> function. Finally, our program creates a for loop that loops through each line in the CSV file and prints it out to the Python shell.<\/p>\n\n\n\n
Our program returns the following: <\/p>\n\n\n\n
['Hendersons Creamery', ' 123 Main Street', ' Cream']\n['Peterson Chocolate', ' 129 Second Street', ' Chocolate Sprinkles']\n['HW Smith and Co', ' 17 Boston Avenue', ' Ice Cream Cones']<\/pre><\/div>\n\n\n\n
As you can see, our program has read the contents of our file and turned each line into an array. Now that we have this data, we can manipulate it in our program.<\/p>\n\n\n\n
Let\u2019s say that we are sending a notice to cancel our orders for next week because the shop will be closed. We could use this code to get the addresses of each supplier so we can send them the notice:<\/p>\n\n\n\n
\u2026\n\tfor c in contents:\n\t\tprint(c[1])<\/pre><\/div>\n\n\n\n
Our program returns: <\/p>\n\n\n\n
123 Main Street\n129 Second Street\n17 Boston Avenue<\/pre><\/div>\n\n\n\n
In our code, we create a for<\/code> loop that goes through each line in our contents<\/code> variable. Then, we print out the value of each item with the index number 1<\/code>, which in this case contains the address of each supplier.<\/p>\n\n\n\n
Now, let\u2019s say that we want to read data from our file into an array. This is a common function because it allows us to store our data in another variable for later use. Here\u2019s the code we could use to perform this action:<\/p>\n\n\n\n
import csv\nsuppliers = []\nwith open(\"suppliers.csv\", \"r\") as f:\n\tcontents = csv.reader(f)\n\tfor c in contents:\n\t\tsuppliers.append(c)\nprint(suppliers)<\/pre><\/div>\n\n\n\n
Our code returns the following:<\/p>\n\n\n\n
[['Hendersons Creamery', ' 123 Main Street', ' Cream'], ['Peterson Chocolate', ' 129 Second Street', ' Chocolate Sprinkles'], ['HW Smith and Co', ' 17 Boston Avenue', ' Ice Cream Cones']]<\/pre><\/div>\n\n\n\n
Let\u2019s explain what is going on in our code. Our program opens the file suppliers.csv<\/code>, reads the file, then appends each record into the array suppliers<\/code> that we declared at the start of our program. Then, our program prints out the variable suppliers<\/code>. <\/p>\n\n\n\n
Writing to CSV Files<\/h3>\n\n\n\n
The CSV module contains a method that can be used to write data to a CSV file: writer()<\/code>. The writer()<\/code> function allows us to write data to the file we specify so that we can save our data for later use.<\/p>\n\n\n\n
The writer()<\/code> function creates an object that we can use to write to a file. Then, in order to write data to our file, we use the writerow()<\/code> method.<\/p>\n\n\n\n
Let\u2019s say that we have written a program that adds a new value to each supplier record. This value holds whether or not the supplier is the primary supplier for a certain product. Here\u2019s the code we could use to write the data we have to a file:<\/p>\n\n\n\n
import csv\nsuppliers = []\nwith open(\"suppliers.csv\", \"r\") as f:\n\tcontents = csv.reader(f)\n\tfor c in contents:\n\t\tc.append(\"Yes\")\n\t\tsuppliers.append(c)\nwith open(\"new_suppliers.csv\", \"w\") as f:\nwrite_to_file = csv.writer(f)\nfor s in suppliers:\n\twrite_to_file.writerow(s)<\/pre><\/div>\n\n\n\n
The start of our code is very similar to our previous examples; it reads the file suppliers.csv<\/code> and moves its contents to the suppliers<\/code> array. The only difference is that the read function adds a new value called Yes<\/code> to each item in our suppliers array. This value denotes whether or not the supplier is the primary supplier of a certain product.<\/p>\n\n\n\n
Next, we open up a new file called new_suppliers.csv<\/code> and write the contents of our suppliers<\/code> to that file. We use the writer()<\/code> function to prepare our file for writing.<\/p>\n\n\n\n
Then, we create a for<\/code> loop that goes through our suppliers<\/code> array and uses the writerow()<\/code> method to add each supplier to the new_suppliers.csv<\/code> file.<\/p>\n\n\n\n
Our code returns the following: <\/p>\n\n\n\n
new_suppliers.csv\nHendersons Creamery, 123 Main Street, Cream,Yes\nPeterson Chocolate, 129 Second Street, Chocolate Sprinkles,Yes\nHW Smith and Co, 17 Boston Avenue, Ice Cream Cones,Yes<\/pre><\/div>\n\n\n\n
However, it\u2019s not necessary to loop through each item if we want to write our entire suppliers<\/code> variable to a file. Instead, we can use the writerows()<\/code> method to write every item in the suppliers<\/code> variable to our new_suppliers.csv<\/code> file.<\/p>\n\n\n\n
Here\u2019s the code we would use:<\/p>\n\n\n\n
\u2026\n\twrite_to_file = csv.writer(f)\n\twrite_to_file.writerows(suppliers)\n\u2026<\/pre><\/div>\n\n\n\n
Our code returns:<\/p>\n\n\n\n
new_suppliers.csv\nHendersons Creamery, 123 Main Street, Cream,Yes\nPeterson Chocolate, 129 Second Street, Chocolate Sprinkles,Yes\nHW Smith and Co, 17 Boston Avenue, Ice Cream Cones,Yes<\/pre><\/div>\n\n\n\n
CSV File Quoting<\/h3>\n\n\n\n
In the above example, our code wrote the suppliers<\/code> array to a new file as it appeared. <\/p>\n\n\n\n
However, there may be occasions when you want each value to be written to a file in quotation marks. For example, you may have a list of suppliers where a few supplier names contain commas, which would result in our CSV file becoming malformed.<\/p>\n\n\n\n
The CSV module contains four quoting functions that can be used to surround the values to be written to your file in quotation marks so this does not happen. These functions are passed as an argument to the csv.writer()<\/code> method, and are as follows:<\/p>\n\n\n\n