Passing Python Data to JavaScript via Django

Posted on

Question :

Passing Python Data to JavaScript via Django

I’m using Django and Apache to serve webpages. My JavaScript code currently includes a data object with values to be displayed in various HTML widgets based on the user’s selection from a menu of choices. I want to derive these data from a Python dictionary. I think I know how to embed the JavaScript code in the HTML, but how do I embed the data object in that script (on the fly) so the script’s functions can use it?

Put another way, I want to create a JavaScript object or array from a Python dictionary, then insert that object into the JavaScript code, and then insert that JavaScript code into the HTML.

I suppose this structure (e.g., data embedded in variables in the JavaScript code) is suboptimal, but as a newbie I don’t know the alternatives. I’ve seen write-ups of Django serialization functions, but these don’t help me until I can get the data into my JavaScript code in the first place.

I’m not (yet) using a JavaScript library like jQuery.

Answer #1:

n.b. see 2018 update at the bottom

I recommend against putting much JavaScript in your Django templates – it tends to be hard to write and debug, particularly as your project expands. Instead, try writing all of your JavaScript in a separate script file which your template loads and simply including just a JSON data object in the template. This allows you to do things like run your entire JavaScript app through something like JSLint, minify it, etc. and you can test it with a static HTML file without any dependencies on your Django app. Using a library like simplejson also saves you the time spent writing tedious serialization code.

If you aren’t assuming that you’re building an AJAX app this might simply be done like this:

In the view:

from django.utils import simplejson

def view(request, …):
    js_data = simplejson.dumps(my_dict)
    render_template_to_response("my_template.html", {"my_data": js_data, …})

In the template:

<script type="text/javascript">
    data_from_django = {{ my_data }};

Note that the type of data matters: if my_data is a simple number or a string from a controlled source which doesn’t contain HTML, such as a formatted date, no special handling is required. If it’s possible to have untrusted data provided by a user you will need to sanitize it using something like the escape or escapejs filters and ensure that your JavaScript handles the data safely to avoid cross-site scripting attacks.

As far as dates go, you might also want to think about how you pass dates around. I’ve almost always found it easiest to pass them as Unix timestamps:

In Django:

time_t = time.mktime(my_date.timetuple())

In JavaScript, assuming you’ve done something like time_t = {{ time_t }} with the results of the snippet above:

my_date = new Date();

Finally, pay attention to UTC – you’ll want to have the Python and Django date functions exchange data in UTC to avoid embarrassing shifts from the user’s local time.

EDIT : Note that the setTime in javascript is in millisecond whereas the output of time.mktime is seconds. That’s why we need to multiply by 1000

2018 Update: I still like JSON for complex values but in the intervening decade the HTML5 data API has attained near universal browser support and it’s very convenient for passing simple (non-list/dict) values around, especially if you might want to have CSS rules apply based on those values and you don’t care about unsupported versions of Internet Explorer.

<div id="my-widget" data-view-mode="tabular">…</div>

let myWidget = document.getElementById("my-widget");
console.log(myWidget.dataset.viewMode); // Prints tabular
somethingElse.addEventListener('click', evt => {
    myWidget.dataset.viewMode = "list";

This is a neat way to expose data to CSS if you want to set the initial view state in your Django template and have it automatically update when JavaScript updates the data- attribute. I use this for things like hiding a progress widget until the user selects something to process or to conditionally show/hide errors based on fetch outcomes or even something like displaying an active record count using CSS like #some-element::after { content: attr(data-active-transfers); }.

Answered By: Chris Adams

Answer #2:

For anyone who might be having a problems with this, be sure you are rendering your json object under safe mode in the template. You can manually set this like this

<script type="text/javascript">
    data_from_django = {{ my_data|safe }};
Answered By: wilblack

Answer #3:

As of mid-2018 the simplest approach is to use Python’s JSON module, simplejson is now deprecated. Beware, that as @wilblack mentions you need to prevent Django’s autoescaping either using safe filter or autoescape tag with an off option. In both cases in the view you add the contents of the dictionary to the context

import json
 def get_context_data(self, **kwargs):
    context['my_dictionary'] = json.dumps(self.object.mydict)

and then in the template you add as @wilblack suggested:


    my_data = {{ my_dictionary|safe }};
Answered By: Daniel Kislyuk

Answer #4:

You can include <script> tags inside your .html templates, and then build your data structures however is convenient for you. The template language isn’t only for HTML, it can also do Javascript object literals.

And Paul is right: it might be best to use a json module to create a JSON string, then insert that string into the template. That will handle the quoting issues best, and deal with deep structures with ease.

Answered By: Ned Batchelder

Answer #5:

It is suboptimal. Have you considered passing your data as JSON using django’s built in serializer for that?

Answered By: Paul McMillan

Answer #6:

See the related response to this question. One option is to use jsonpickle to serialize between Python objects and JSON/Javascript objects. It wraps simplejson and handles things that are typically not accepted by simplejson.

Answered By: John Paulett

Answer #7:

Putting Java Script embedded into Django template is rather always bad idea.

Rather, because there are some exceptions from this rule.

Everything depends on the your Java Script code site and functionality.

It is better to have seperately static files, like JS, but the problem is that every seperate file needs another connect/GET/request/response mechanism. Sometimes for small one, two liners code os JS to put this into template, bun then use django templatetags mechanism – you can use is in other templates 😉

About objects – the same. If your site has AJAX construction/web2.0 like favour – you can achieve very good effect putting some count/math operation onto client side. If objects are small – embedded into template, if large – response them in another connection to avoid hangind page for user.

Answered By: bluszcz

Leave a Reply

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