Rayed's Real Life

Django CRUD (Create, Retrieve, Update, Delete)

UPDATE 1: The main example use Class Based Views, I also added Function Based Views version of the
same functionality.

UPDATE 2: I added a new example application with user access, user must login and each user has his own
list.
Sample Code: You can download a sample application from https://github.com/rayed/django_crud

UPDATE 3: You might be interested in Django CRUD Parent/Child Edition

In this post I briefly cover the step needed to create a CRUD app in Django, the steps we will need are:

Create an App
Create the Model
Create the Admin Interface (optional)
Create the View
Define the URLs (i.e. URL to View mapping)
Create the Templates

Create new App

From the Django project directory we will create the new app called “servers” to store our servers
information:

./manage.py startapp servers

We will also need to register the new app in our Django project, add the app ‘server’ to the INSTALLED_APPS
in your django_proj_name/settings.py:

INSTALLED_APPS = (
:
'servers',
:
)

Create the Model

The model file would be servers/models.py:

converted by Web2PDFConvert.com
 from django.db import models
from django.core.urlresolvers import reverse
class Server(models.Model):
name = models.CharField(max_length=200)
ip = models.GenericIPAddressField()
order = models.IntegerField()
def __unicode__(self):
return self.name
def get_absolute_url(self):
return reverse('server_edit', kwargs={'pk': self.pk})

After defining the model you need to provision it to the database:

./manage.py makemigrations
./manage.py migrate

To create the table for the new model.

Admin Interface (optional)

Django will give you free CRUD interface from the admin site, just define the file servers/admin.py as:

from django.contrib import admin

from servers.models import Server
admin.site.register(Server)

The Views
We will use Django Class-based views to crete our app pages, the file servers/views.py would look like:

from django.http import HttpResponse

from django.views.generic import TemplateView,ListView
from django.views.generic.edit import CreateView, UpdateView, DeleteView
from django.core.urlresolvers import reverse_lazy
from servers.models import Server
class ServerList(ListView):
model = Server
class ServerCreate(CreateView):
model = Server
success_url = reverse_lazy('server_list')
fields = ['name', 'ip', 'order']
class ServerUpdate(UpdateView):
model = Server
success_url = reverse_lazy('server_list')
fields = ['name', 'ip', 'order']
class ServerDelete(DeleteView):
model = Server
success_url = reverse_lazy('server_list')

converted by Web2PDFConvert.com
Define the URLs
We need to define app URLs in the file __servers/urls.py:

from django.conf.urls import patterns, url

from servers import views
urlpatterns = patterns('',
url(r'^$', views.ServerList.as_view(), name='server_list'),
url(r'^new$', views.ServerCreate.as_view(), name='server_new'),
url(r'^edit/(?P<pk>\d+)$', views.ServerUpdate.as_view(), name='server_edit'),
url(r'^delete/(?P<pk>\d+)$', views.ServerDelete.as_view(), name='server_delete'),
)

This URLs wouldn’t work unless you include the servers/urls.py in the main URLs file
django_proj_name/urls.py:

urlpatterns = patterns('',
:
url(r'^servers/', include('servers.urls')),
:
)

Templates
templates/servers/server_form.html This file will be used by Edit and Update views:

<form method="post">{% csrf_token %}

{{ form.as_p }}
<input type="submit" value="Submit" />
</form>

templates/servers/server_list.html This file will be used by the ListView:

<h1>Servers</h1>
<ul>
{% for server in object_list %}
<li>{{ server.name }} :
<a href="{% url "server_edit" server.id %}">{{ server.ip }}</a>
<a href="{% url "server_delete" server.id %}">delete</a>
</li>
{% endfor %}
</ul>
<a href="{% url "server_new" %}">New</a>

templates/servers/server_confirm_delete.html This file will be used by DeleteView:

<form method="post">{% csrf_token %}

Are you sure you want to delete "{{ object }}" ?
<input type="submit" value="Submit" />
</form>

converted by Web2PDFConvert.com
Function Based View Version
The example above uses Class Based Views (or CBV for short) to implement the views, what I will cover now
is how to implement the same functionality but with Function Based Views i.e. using functions instead of
classes, we will be using the same templates:

servers/views.py:

from django.shortcuts import render, redirect, get_object_or_404

from django.forms import ModelForm
from servers.models import Server
class ServerForm(ModelForm):
class Meta:
model = Server
fields = ['name', 'ip', 'order']
def server_list(request, template_name='servers/server_list.html'):
servers = Server.objects.all()
data = {}
data['object_list'] = servers
return render(request, template_name, data)
def server_create(request, template_name='servers/server_form.html'):
form = ServerForm(request.POST or None)
if form.is_valid():
form.save()
return redirect('server_list')
return render(request, template_name, {'form':form})
def server_update(request, pk, template_name='servers/server_form.html'):
server = get_object_or_404(Server, pk=pk)
form = ServerForm(request.POST or None, instance=server)
if form.is_valid():
form.save()
return redirect('server_list')
return render(request, template_name, {'form':form})
def server_delete(request, pk, template_name='servers/server_confirm_delete.html'):
server = get_object_or_404(Server, pk=pk)
if request.method=='POST':
server.delete()
return redirect('server_list')
return render(request, template_name, {'object':server})

servers/urls.py:

from django.conf.urls import patterns, url

from servers import views
urlpatterns = patterns('',
url(r'^$', views.server_list, name='server_list'),
url(r'^new$', views.server_create, name='server_new'),
url(r'^edit/(?P<pk>\d+)$', views.server_update, name='server_edit'),
url(r'^delete/(?P<pk>\d+)$', views.server_delete, name='server_delete'),
)

p.s. personally I prefer using FBV over CBV, the article Django’s CBVs were a mistake explains why.

 Print  Email  Twitter  Facebook 23

converted by Web2PDFConvert.com
 July 19, 2013 Rayed Uncategorized django, python

64 thoughts on “Django CRUD (Create, Retrieve, Update, Delete)”

OLDER COMMENTS

Sachin Panchal
September 18, 2016 at 9:40 pm

Thank you …

dave
October 18, 2016 at 3:37 pm

instead of “manage.py syncdb” use “manage.py migrate” if Yo are using Django newer than 1.07

Rayed
October 18, 2016 at 3:45 pm

@dave Thanks, updated!

Gio
November 17, 2016 at 4:43 pm

Thanks for tutorial! I’ve a question regarding ClassBased views. How django understands which template to
use. For example in case of Update, how it knows that server_form.html located in
templates/servers/server_form.html is the right template…

Rayed
November 18, 2016 at 1:33 am

@Gio Django will use the value of “template_name” attribute as a template file, and the default value would
depend on the class you would inherit from, e.g.:

ListView => {app_name}/{model_name}_list.htm

CreateView => {app_name}/{model_name}_form.htm
UpdateView => {app_name}/{model_name}_form.htm
DeleteView => {app_name}/{model_name}_confirm_delete.htm

You can also override the suffix only using the attribute “template_name_suffix”, for example if you would
like to have different template for “CreateView” and “UpdateView” you would change

converted by Web2PDFConvert.com
“template_name_suffix” from the default “_form” to “_create_form” and “_update_form” respectively.

Gio
November 18, 2016 at 8:58 pm

Thanks @Rayed. I was getting TemplateNotFound on …/templates/auth/user_form.html and it is obvious,

cause I did not had that auth directory. If I create auth an put inside user_form.html everything woks
perfectly, but my template directory is another …/templates/profile/…, how can I indicate my desired one?

Rayed
November 19, 2016 at 3:09 am

@Gio Sorry I didn’t understand, are you trying to build a CRUD to manage Django users?

Gio
November 19, 2016 at 9:52 am

@Rayed To manage users I will use Django admin, but I’m trying to allow registered users edit their profiles,
which I already did. But I have one issue… I’ve extended user registration with extra fields, it means that
extended fields are located in a separate table ind DB. Now when I’m retrieving records from User model
only default fields are selected. Now thinking how I can take other fields also.. for example: first_name,
last_name, username, email, address.
Why you asked? Am I doing something wrong? I’m new in Django.

Rayed
November 19, 2016 at 2:31 pm

@Gio Not sure how you can do it using CBV but with FBV you would use a view similar to “server_update”
with two forms instead of one.

Gio
November 23, 2016 at 10:18 am

@Rayed Thanks

MD Aftab Alam
December 14, 2016 at 12:11 pm

great job sir !!

Fred
January 11, 2017 at 9:30 pm

Great Job
Thank you

Alok Lal

converted by Web2PDFConvert.com
January 28, 2017 at 4:21 am

Nicely captured detail on simple but fundamental model actions. I particularly appreciate the parallel
implementations of the class based views and function based views. I personally also prefer the function
based views. Sure, it’s more verbose but I think it makes for clear, intuitive code.

Pingback: Python - Django - 2 - View e Template

OLDER COMMENTS

Leave a Reply
Your email address will not be published. Required fields are marked *

COMMENT

NAME *

EMAIL *

WEBSITE

POST COMMENT

Notify me of follow-up comments by email.

Notify me of new posts by email.

Source Code Management with GIT

Supporting Right-to-Left (for Arabic) in WordPress: the Easy Way

converted by Web2PDFConvert.com
Proudly powered by WordPress

converted by Web2PDFConvert.com