tips   8   21120
How to upload and process the CSV file in Django

In this article we will discuss how to upload a csv file and then process the content without storing file on server. 

One approach could be uploading the file, storing it in upload directory and then reading the file.

Another approach could be uploading file and reading it directly from post data without storing it in memory and displaying the data.

We will work with the later approach here.


Uploading CSV file:

First create HTML form to upload the csv file. Use below code for the same.

<form action="{% url "myapp:upload_csv" %}" method="POST" enctype="multipart/form-data" class="form-horizontal"> 
{% csrf_token %}
<div class="form-group">
    <label for="name" class="col-md-3 col-sm-3 col-xs-12 control-label">File: </label>
    <div class="col-md-8">
        <input type="file" name="csv_file" id="csv_file" required="True" class="form-control">
    </div>                    
</div>
<div class="form-group">                    
    <div class="col-md-3 col-sm-3 col-xs-12 col-md-offset-3" style="margin-bottom:10px;">
         <button class="btn btn-primary"> <span class="glyphicon glyphicon-upload" style="margin-right:5px;"></span>Upload </button>
    </div> 
</div>
</form>


Important: Do not forget to include enctype="multipart/form-data"  in form.

upload csv in django.png


Add a URL in URLpatterns.

url(r'^upload/csv/$', views.upload_csv, name='upload_csv'),
Create a function in views with the name upload_csv .


Process the CSV file:

In view function, get the file from post data and process it. I used below code in my project.

def upload_csv(request):
	data = {}
	if "GET" == request.method:
		return render(request, "myapp/upload_csv.html", data)
    # if not GET, then proceed
	try:
		csv_file = request.FILES["csv_file"]
		if not csv_file.name.endswith('.csv'):
			messages.error(request,'File is not CSV type')
			return HttpResponseRedirect(reverse("myapp:upload_csv"))
        #if file is too large, return
		if csv_file.multiple_chunks():
			messages.error(request,"Uploaded file is too big (%.2f MB)." % (csv_file.size/(1000*1000),))
			return HttpResponseRedirect(reverse("myapp:upload_csv"))

		file_data = csv_file.read().decode("utf-8")		

		lines = file_data.split("\n")
		#loop over the lines and save them in db. If error , store as string and then display
		for line in lines:						
			fields = line.split(",")
			data_dict = {}
			data_dict["name"] = fields[0]
			data_dict["start_date_time"] = fields[1]
			data_dict["end_date_time"] = fields[2]
			data_dict["notes"] = fields[3]
			try:
				form = EventsForm(data_dict)
				if form.is_valid():
					form.save()					
				else:
					logging.getLogger("error_logger").error(form.errors.as_json())												
			except Exception as e:
				logging.getLogger("error_logger").error(repr(e))					
				pass

	except Exception as e:
		logging.getLogger("error_logger").error("Unable to upload file. "+repr(e))
		messages.error(request,"Unable to upload file. "+repr(e))

	return HttpResponseRedirect(reverse("myapp:upload_csv"))
 

In the above code we are performing below actions:

      - If this is a GET request then render the upload csv html file.

      - If this is a POST request then proceed.

      - First check if file name is not ending with .csv then this is not the valid file. You may implement you own checks as well.

      - Then we check if file is too large. If these tests fail, we return to html form page with appropriate error message. For displaying error/success messages, we are using messages framework. Please import required modules.

      - Then we read the file and split the content by new line character.

      - Iterate over each line and split the line using comma.

      - We are assuming that our csv file have 4 columns of data. We stored the data in a dictionary and then pass the data dictionary to a form.

      - If form is valid then we proceed to save the form and hence creating entry in DB.

      - If form is not valid, or any other error is thrown then we log the error in log file.


      Read here about logging the errors in log files. This might be useful on live servers where debug is set to false.


        Please provide your inputs.


        tips   8   21120

        Related Articles:
        Adding Robots.txt file to Django Application
        Adding robots.txt file in your Django application, Easiest way to add robots.txt file in Django, Django application robots.txt file, Why should you add robots.txt file in your Django Application,...
        How to upgrade to paid account on PythonAnyWhere
        Which is the best server for hosting Django Apps. Best hosting provider for Django Apps. Cheapest Django Hosting. PythonAnyWhere Reviews. Django Hosting....
        Server Access Logging in Django using middleware
        Creating access logs in Django application, Logging using middleware in Django app, Creating custom middleware in Django, Server access logging in Django...
        What is the meaning of different aphorism in zen of python
        What is zen of python. What is the meaning of zen of python. Explanation of zen of python terms with example. Easter egg Zen of python. import this....

        8 thoughts on 'How To Upload And Process The Csv File In Django'
        Bhavik Gorajiya :
        Thank You for this post.I have tried this code in my project but it gives me following error messagename 'logging' is not definedcan you help me?
        Admin :
        You can comment logging line in your code. This is for logging purpose. If you want to keep logging, please refer this article: https://www.pythoncircle.com/post/46/how-to-start-logging-errors-in-django-app/
        Viagra Generika :
        Thanks for sharing your thoughts about %meta_keyword%. Regards

        Mohammad Asrar A :
        Thank you for this post.I have tried for my project.But I am finding it difficult to relate forms and also not able to understand this Line "forms = EventsForms(data_dict)".Can you please help
        Admin :
        Hi Asrar, In the above line we are creating form object using the data received from html form. We can validate the post data using default or our own validation rules. I will write an article on forms soon and will share it with you. Thanks for commenting.

        Jason Ngu :
        hello please i am getting this error Exception Type: TypeError at /upload/csv/Exception Value: uploadFile() takes 0 positional arguments but 1 was givenplease how can i fix this?
        Admin :
        Please share your code using pastebin service.
        Jason Ngu :
        hello please can you provide the full code to this? the model, view. and html file? so i can follow up perfectly
        Admin :
        I don't have code for this scenario exactly. But you can refer this similar project : https://github.com/anuragrana/excel-file-upload-django

        Raza Sheikh :
        how i import the csv file data on the django project and simple display in html tags (no on the forms html tags)? for news article post

        Md. Shadd :
        HI,Thanks for such a good guide.I've followed it through, but couldn't display the output. How can I display the output?
        Admin :
        Instead of saving the csv data in DB via forms, you can collect it in a dictionary and then pass to template context to display on next page

        Vishesh Arora :
        Hello! Thanks for such a simple guide. I have run the server without any error but when I click on Submit after uploading the particular file it gets refreshed to No File Chosen screen and I can't find any trace of the uploaded csv file being saved in the working directory. Can you please help me to access the csv data?
        Admin :
        In the example above, csv data is being saved to DB via forms.

        Rolph :
        I am very confused with what to replace the various references of myapp with?
        Admin :
        Hi Rolph, you need to replace myapp with your actul app name.

        Jesus :
        works! but show Unable to upload file. IndexError('list index out of range')
        Sara :
        you have to ajdust code to the file you are uploading.I did it like this just to check if upload works for line in lines: fields = line.split(",") data_dict = {} for i in range(len(fields)): data_dict[str(i)] = fields[i]

        Leave a comment:


        *All Fields are mandatory. **Email Id will not be published publicly.


        SUBSCRIBE
        Please subscribe to get the latest articles in your mailbox.


        Recent Posts:






        © pythoncircle.com 2018-2019
        Contact Us: code108labs [at] gmail.com
        Address: 3747 Smithfield Avenue, Houston, Texas