Django Rest Framework
The Django Rest Framework (DRF) is a very popular Django package that makes it very easy to create an API for your site. It has built-in serializers that make passing Django querysets down to the browser in JSON format a breeze.
In our LobbyBase.jsx, we’re trying to call the /player-games/ api endpoint, but it doesn’t exist yet. Let’s install DRF and set that endpoint up.
Install DRF:
1 |
pip install djangorestframework |
and then add it to your INSTALLED_APPS in settings.py:
1 2 3 4 5 6 7 8 9 10 11 12 |
INSTALLED_APPS = [ 'django.contrib.admin', 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.messages', 'django.contrib.staticfiles', 'game', 'channels', 'webpack_loader', 'rest_framework', ] |
That’s all we need to set up DRF, so let’s create that missing endpoint now.
Inside the views folder, create a new python file named api_views.py. We could just as easily have added these alongside the standard views in views.py, but as I mentioned earlier, I like to organize the views a bit. Since we’ve added a new .py file in that folder, we also need to import it in on the __init__.py file in that folder. Update that file like this:
1 2 |
from .views import * from .api_views import * |
And fill your new api_views.py file with this:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 |
from rest_framework.views import APIView from rest_framework import viewsets from game.serializers import * from rest_framework.response import Response from game.models import * from rest_framework.permissions import IsAuthenticated from django.shortcuts import get_object_or_404 from django.http import Http404 class CurrentUserView(APIView): def get(self, request): serializer = UserSerializer(request.user) return Response(serializer.data) class UserViewSet(viewsets.ModelViewSet): """ API endpoint that allows users to be viewed or edited. """ queryset = User.objects.all().order_by('-date_joined') serializer_class = UserSerializer class PlayerGameViewSet(viewsets.ViewSet): """ API endpoint for player games """ def list(self, request): queryset = Game.get_games_for_player(self.request.user) serializer = GameSerializer( queryset, many=True, context={'request': request}) return Response(serializer.data) |
Basically what we’ve added here are three DRF “views”: UserViewSet, PlayerGameViewSet, and CurrentUserView. These are similar to standard Django Views, but here we will get data from models and send it to the serializer to be converted into JSON, which is what we’re expecting on client-side in React. Now, we’ve yet to create these serializers, so let’s do that.
Create a file name serializers.py inside your game app directory with the following code:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 |
from django.contrib.auth.models import User from .models import Game, GameSquare, GameLog from rest_framework import serializers class UserSerializer(serializers.ModelSerializer): class Meta: model = User fields = ('id', 'username', 'email', 'groups') class GameSerializer(serializers.ModelSerializer): class Meta: model = Game fields = ('id', 'winner', 'creator', 'opponent', 'cols', 'rows', 'completed', 'created', 'current_turn') depth = 1 |
These methods simply define what fields, from which models, will be serialized.
Ok, we have our ViewSet ready to get the user’s list of games, and then return the list in a JSON format to the client. So now, update your urls.py file with the endpoint that will call the ViewSet. Change it to look like this (changes are highlighted):
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 |
from django.conf.urls import url from django.contrib import admin from game.views import * from django.contrib.auth.views import login, logout from rest_framework.routers import DefaultRouter urlpatterns = [ url(r'^admin/', admin.site.urls), url(r'^register/', CreateUserView.as_view()), url(r'^login/$', login, {'template_name': 'login.html'}), url(r'^logout/$', logout, {'next_page': '/'}), url(r'^lobby/$', LobbyView.as_view()), url(r'^$', HomeView.as_view()) ] # urls for api - django rest framework urlpatterns += [ url(r'^current-user/', CurrentUserView.as_view()), ] router = DefaultRouter() router.register(r'player-games', PlayerGameViewSet, 'player_games') urlpatterns += router.urls |
All we’re doing here is adding in a DRF router and adding in the url endpoint for player-games, which calls the new ViewSet we created. We also added a standard URL for /current-user/.
That current-user endpoint will be used to get the…well…current user from the server. Since we need a user to be logged in before we render the lobby, we’ll update the Lobby component to use this endpoint. Replace the code in components/lobby/index.jsx with this :
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 |
import React from 'react'; import LobbyBase from './LobbyBase.jsx' import ReactDOM from 'react-dom' import $ from 'jquery' var lobby_sock = 'ws://' + window.location.host + "/lobby/" var current_user = null $.get('http://localhost:8080/current-user/?format=json', function(result){ // gets the current user information from Django current_user = result render_component() }) function render_component(){ ReactDOM.render(<LobbyBase current_user={current_user} socket={lobby_sock}/>, document.getElementById('lobby_component')) } |
In the code above, we just removed the render_component() call at the bottom of the page and put it inside a jQuery method, which will return with the current user before rendering the lobby components.
If you runserver now and visit the lobby, you’ll see that the API call was successful, although it returns nothing at this point….let’s change that.
You’ll recall from the PlayerGames.jsx file that we had a button click handler method called onCreateGameClick. That method simply calls the Channels backend, sending a message with an action of “create_game”. Channels backend calls go through the consumers.py file, so we’re going to update it and have it handle that particular message, creating a game in the database.
Modify the receive method of the LobbyConsumer in your consumers.py file to look like this:
30 31 32 33 34 35 36 37 38 39 40 41 42 |
def receive(self, content, **kwargs): """ Called when a message is received with either text or bytes filled out. """ channel_session_user = True # get the action that's coming in action = content['action'] if action == 'create_game': # create a new game using the part of the channel name Game.create_new(self.message.user) |
Here, the receive() method takes the call to Channels from the client. We set channel_session_user to True so we can use the user just as we can in the request in standard Django. Instead of request.user, we use message.user. The method then takes the action we passed in and handles it appropriately, creating a new game from our create_new() model method.
Now, we have a new game that has been created, but if we click the “Start New Game” button in the Lobby, nothing appears to happen. This is because the client doesn’t know about the change. You can refresh the page, which would re-render the components, calling the getPlayerGames() method we messed with earlier. But we want this to update automatically after the game is created. We could do this a few ways, but we’ll handle this through Channels.
Updating the Client from Channels
Communicating with Channels is as simple as sending messages. We just need to send a message to the client to let it know about any updates. But how do we want to do that in this case and where does that code go?
Django Channels documentation suggests several ways to handle this — for example, we could send the message directly from the view/consumer, or have a cron run that processes and sends messages. Another way would be to use Django’s post_save signal on the Game model, which is how we’re going to do it.
post_save Signal
If you’re not familiar with Django’s model signals, you can think of them as broadcast messages that are sent out when a model event occurs. In our case, we’re interested in knowing when a new Game object is created. So we’ll create a signal listener that will handle this.
Create a file named signals.py in your game app directory and fill it with:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 |
from django.db.models.signals import post_save from django.dispatch import receiver from game.models import * import json from channels import Group from .serializers import * from .models import Game @receiver(post_save, sender=Game) def new_game_handler(**kwargs): """ When a new game is created, this builds a list of all open games and sends it down to all channels in the 'lobby' group """ # if new if kwargs['created']: # send the latest list to all channels in the "lobby" group # the Group's send method requires a dict # we pass "text" as the key and then serialize the list of open games avail_game_list = Game.get_available_games() avail_serializer = GameSerializer(avail_game_list, many=True) Group('lobby').send({'text': json.dumps(avail_serializer.data)}) |
So what we’re doing there is simply listening to the post_save event for the Game model. If “created” is in the kwargs sent to the handler, a new Game was just created, so the Lobby needs to know. We then just get a list of available games, serialize it, and then send it down to the “lobby” Channels group.
If we wanted, we really could have everything handled within signals going forward. And if this were a real project, it would probably be good to stay consistent with how we do this. But later, we’ll try out different ways to get updates down to the client.
OK, to make signals work from a separate signals.py file (instead of say, directly in the models.py file), we need to add a couple of lines to our apps.py file. So, change your game/apps.py file to this:
1 2 3 4 5 6 7 8 9 |
from django.apps import AppConfig class GameConfig(AppConfig): name = 'game' # importing signals so they are available outside of the models def ready(self): from game import signals |
And then add the following to your currently empty game/__init__.py file:
default_app_config = 'game.apps.GameConfig'With all of that in place, you should now be able to click “Start New Game” in the Lobby and the games will immediately show up in your list…waiting for other players to join. Other players can’t join at this point, though, because they have no clue the games are available.
hello,
when I run your code, but the web don’t show the game, what’s happend?
Are you going through the tutorial? Or are you running the example project from github?
Do you have a similar project but with channels 2.0? Do you plan to update this one?
Yes, I’m actually working on one now. Hopefully I’ll have it ready in October, but my free time is tight right now.
I am getting an error, “ImportError: cannot import name ‘Group'”, while trying to import Group from channels in models.py. I am using channels 2.0.2. Please help.
Yeah, this tutorial is based on a very early version of channels – 0.17, I believe. Version 2.0.2 has quite of few changes from that old version, including requiring Python3. Here is an issue on the official github that deals with the error you’re seeing: https://github.com/django/channels/issues/989
I will try to get the tutorial updated to Django 2.0, Python 3, and the latest channels version soon.
Hey,
I’m trying to follow your tutorial, but I keep running into the following error:
OSError at /lobby/
Error reading [PATH]\webpack-stats.json. Are you sure webpack has generated the file and the path is correct?
Any idea how to fix it?
Sorry, I didn’t reply sooner. If the file is being generated, check your STATS_FILE setting under WEBPACK_LOADER in settings.py. It’s possible that it isn’t pointing to the correct location for the file.
If the file isn’t being generated, webpack may not be running properly. Are you seeing errors when you run wepback?
That is very good, I was making similar stuff as a video on my language and this sharing is very useful.
Power of sharing, thanks again.
When will the index.jsx be called ?
The index.jsx files are bundled with webpack (set on lines 8 and 9 in webpack.config.js). Those are the bundles that are loaded with the Django Webpack Loader and rendered on the related html pages (lobby.html and game.html).
I got a few questions to make the game a little bit more complex
Is it possible to allow to the user give a name for the room?
Is it possible to allow more than 2 players? (obviously adding the correct img stuff)
If the answer from above is yes, can the user choose a “limit” for ppl to connect before starting the game?
Cheers!
Yes, each of those suggestions would work just fine:
Thanks for this django/react tutorial. It is awesome helping me get my head around React and putting all the pieces together!!
Great to hear! I’m glad you found it useful. Thanks for letting me know.
Thank you so much for writing this tutorial!
From your description, it seems like moves and player messages should update automatically, however when I run it, they only update after a manual refresh of the page. Am I misunderstanding how the website works?
Thanks
The log should update when new chat messages are created or moves are made. I would check to make sure the game.send_game_update() method is being called at the appropriate times. Also, check the browser console for any errors on the client-side. That may give you more of a clue to the issue as well.
Thanks for writing this tutorial! However, some things that may be confusing to a beginner:
startapp game
is going to create a game/views.py by default, and anyone that forgets to move views.py is going to have a package conflict. Also,from views import *
inside __init__.py should befrom .views import *
just to avoid any namespace mismatches. I recommend you keep the default views.py.Thanks for your comments, Daniel. Yes, I thought that splitting the views could be confusing, but it’s something I like to do to organize views of different types. So here, I didn’t want to combine the DRF API views with the “standard” Django views. Also, the tutorial wasn’t exactly intended for beginners, but maybe I can clarify the views split a little more in the post. Also, thanks for catching the import fix. I had already updated the imports in the git project, but missed it in the post.
Hello! Great tutorial! I have a question, I want to use foundation-sites in my project. I am following you tutorial and instead of using bootstrap precompiled css I would like to install foundation with bower maybe? I know how to use the “foundation new” command to create a new project but I would like not to create a new project but integrate foundation sites with mine!
Hey David, sorry I haven’t worked with Foundation yet. But it looks like you can just use the CSS itself and avoid the CLI site generation: http://foundation.zurb.com/sites/download/
You could just include this as you would any other CSS, and my guess is that if you install the full Foundation package with NPM, you could just reference the CSS there as well.
not sure if it’s a django versioning thing or what, but on page 1 of this tutorial you are no longer allowed to specify views with strings and they must be callable, suggested edit follows:
original:
from django.conf.urls import url
from django.contrib import admin
from game.views import *
urlpatterns = [
url(r’^admin/’, admin.site.urls),
url(r’^register/’, CreateUserView.as_view()),
url(r’^login/$’, ‘django.contrib.auth.views.login’, {‘template_name’: ‘login.html’}),
url(r’^logout/$’, ‘django.contrib.auth.views.logout’, {‘next_page’: ‘/’}),
url(r’^$’, HomeView.as_view())
]
edit:
from django.conf.urls import url
from django.contrib import admin
from django.contrib.auth.views import login, logout
from game.views import *
urlpatterns = [
url(r’^admin/’, admin.site.urls),
url(r’^register/’, CreateUserView.as_view()),
url(r’^login/$’, login, {‘template_name’: ‘login.html’}),
url(r’^logout/$’, logout, {‘next_page’: ‘/’}),
url(r’^$’, HomeView.as_view())
]
Yep – you’re right, thanks for letting me know! I’ve updated the urls.py code.
Thank you so much, one of the most complete tutorials I have seen. Not all persons are willing to teach this things together, and the complexity of the scenario gives us good bases. This types of tutorials (even paid) are hard to find. Again, thank you.
Thank you for the nice comments! I’m glad you found the tutorial helpful.
Can you please show one example on how I can make api post call from react to django drf?
Is there any reason why all “post” calls are done via sockets not api in this tutorial?
You can see a few examples of calls from React to the DRF backend in my post. For example, take a look at the getGame() method on the GameBoard.jsx component. That method calls the DRF SingleGameViewSet endpoint to get game details.
And as I mentioned in the post, I tried to mix up different ways of getting data from the Django backend to the React frontend. I wanted to show different ways of achieving the same thing: sending data through the standard Django response via context, DRF calls to the backend, and Django Channels websocket calls. In reality, this isn’t how I would structure a production app, but I was hoping it would be informative. Hopefully not confusing at the same time.
Wow! Thanks again for sharing this tutorial. I am amazed by your generosity. The tutorial is intense.
Let me give some suggesting for how you can improve it. I found that very often the flow of tutorial is going from big concepts (code snippets) to a smaller ones. For example several times you are first putting together some views, react components or api_views and then go to show some serializers, consumers, routers, urls and so on. This can be sometimes confusing, since a student can receive error messages that those small parts are not yet existed. I think going from small concepts to bigger would be more easily to understand. Also, please check your github code. I think it does not work if you just download it and want to use. Several imports are configured improperly (signal in apps.py, for instance)
Thank you again!
Thanks for suggestions. Yes this was my first large tutorial so it definitely could be optimized and improved. I did the GitHub project well before the post, but it worked for me when I last tried it. It could be a python2/python3 import issue. I’ll update that tonight and get it working.
not sure if the instruction on page 8 is correct
class ClaimSquareView(APIView):
def get_object(self, pk):
try:
return Game.objects.get(pk=pk)
except Game.DoesNotExist:
raise Http404
def put(self, request, pk):
game = self.get_object(pk)
# update the owner
print(game)
return Response(serializer.errors)
– no import for Http404
– serializer is not defined
You’re right! That view isn’t even needed… I think I started going that direction to claim a square, but moved it to a Channels call using the consumer instead. I’ve removed that reference and the url reference.
Thank you very much for your suggestions and bug reports! I’ve added you to the “Thank you” section at the bottom of the post.
on page 7 views.py also should import
from django.contrib import messages
Added it, thank you.
Also, in my setup in view/__init__.py instead of
from views import *
from api_views import *
I need to enter
from .views import *
from .api_views import *
Yes this is probably because you’re on Python 3 and implicit relative imports like that won’t work. I’m on 2.7 and they work with it. Thanks for pointing that out. I’ll update the post to note this.
on the page 2, it is very important to highlights this setting in the settings.py
STATICFILES_DIRS = [
os.path.join(BASE_DIR, “static”),
]
it is not something that is added by default if start project with django-admin tools
Thanks, yes when I first talk about the settings file, I recommended overwriting all of the default code with what I show in the post. I’ll make sure that it’s more clear.
Thanks, confirm MIDDLEWARE_CLASSES fixed the issue with ‘AsgiRequest’ object has no attribute ‘session’
after following all instruction on the page 4, cannot login, getting this error
AttributeError at /login/
‘AsgiRequest’ object has no attribute ‘session’
Request Method: POST
Request URL: http://127.0.0.1:8080/login/
Django Version: 1.9.12
Exception Type: AttributeError
Exception Value:
‘AsgiRequest’ object has no attribute ‘session’
Exception Location: /home/gideon/virtualenvs/vEnv_my_obstruct_game/lib/python3.4/site-packages/django/contrib/auth/__init__.py in login, line 101
Python Executable: /home/gideon/virtualenvs/vEnv_my_obstruct_game/bin/python
Python Version: 3.4.3
Python Path:
[‘/home/gideon/PycharmProjects/my_obstruct_game’,
‘/home/gideon/virtualenvs/vEnv_my_obstruct_game/lib/python3.4/site-packages/setuptools-18.1-py3.4.egg’,
‘/home/gideon/virtualenvs/vEnv_my_obstruct_game/lib/python3.4/site-packages/pip-7.1.0-py3.4.egg’,
‘/home/gideon/PycharmProjects/my_obstruct_game’,
‘/usr/lib/python3.4’,
‘/usr/lib/python3.4/plat-x86_64-linux-gnu’,
‘/usr/lib/python3.4/lib-dynload’,
‘/home/gideon/virtualenvs/vEnv_my_obstruct_game/lib/python3.4/site-packages’]
Server time: Mon, 6 Feb 2017 15:53:42 +0000
Traceback Switch to copy-and-paste view
/home/gideon/virtualenvs/vEnv_my_obstruct_game/lib/python3.4/site-packages/django/core/handlers/base.py in get_response
response = self.process_exception_by_middleware(e, request) …
▶ Local vars
/home/gideon/virtualenvs/vEnv_my_obstruct_game/lib/python3.4/site-packages/channels/handler.py in process_exception_by_middleware
return super(AsgiHandler, self).process_exception_by_middleware(exception, request)
One thing that could cause this with Django 1.9+ is if you have MIDDLEWARE instead of MIDDLEWARE_CLASSES in your settings.py file. Can you check that?
It seems there is an error in this instruction
npm install –save-dev react react-dom webpack webpack-bundle-tracker babel-core babel babel-loadernpm babel-preset-es2015 react-websocket babel-preset-es2015 babel-preset-react jquery
“babel-loadernpm” should read “babel-loader”
Yep, you’re right – a little copy-paste issue on my part. It’s fixed now. Thanks for letting me know!
I have not yet finished your tutorial, but for what I see I can tell you huge THANK YOU!
Thank you, I hope it you find it useful. Please let me know if you have any issues!