Using mongo with FLASK and python

Question

I am trying to learn python, mongodb and flask and am using the VERY EXCELLENT blog from Miguel Grinberg who provides a great set of tutorials at blog.miguelgrinberg.com

I got a small RESTful server working fine but now want to pull stuff from mongo not mysql

I can pull a mongo record out using the code below but am struggling to get it to render.

I have used arrows in the code below to show where I am struggling, lack of experience I think. Any thoughts would be appreciated.

#!flask/bin/python
from flask import Flask, jsonify, abort, make_response, url_for
from pymongo import MongoClient

# connect to mongo database hosted on AWS
# the script expects the host name to be in  /etc/hosts file

'''
Set up global variables here
'''
mongo_server = "mongo_api"
mongo_port = "27017"
mongo_user = "admin"
mongo_passwd = ":mysecretpassword@"
connect_string = "mongodb://"+ mongo_user 
                             + mongo_passwd 
                             + mongo_server 
                             + ":" 
                             + mongo_port

app = Flask(__name__)

@app.errorhandler(404)
def not_found(error):
    return make_response(jsonify( { 'error': 'Notfound' } ), 404)


def make_public_page(page):
    new_page = {}
    for field in page:
        if field == 'id':
            new_page['uri'] = url_for('get_page', page_id = page['id'], _external = True)
        else:
            new_page[field] = page[field]
    return new_page



@app.route('/api/v1.0/pages/<int:page_id>',methods = ['GET'])
def get_page(page_id):
    '''
    Can connect otherwise exit with message
    '''
    try:
        connection = MongoClient(connect_string)    # equal to > show dbs
    except:
        exit("Error: Unable to connect to the database") # exit with an error
    '''
    connect to database and pull back collections
    '''
    db = connection.test_database # equal to > use test_database                
    pages = db.pages
    page = pages.find_one({"id": int(page_id)})   <------ this pulls back a document
    if page == None:  <---- if a null set comes back then this works great
        abort(404)
    return jsonify( { 'page' : make_public_page(page[0])} ) <- error says its not json

if __name__ == '__main__':
    app.run(debug = True)

Any help appreciated, page[0] is the code that's just not working I get a

TypeError: ObjectId('527e17c538320915e9893f17') is not JSON serializable

Thanks in advance

BTW Can't recommend Miguel's mega tutorial enough as a place to start to build stuff

Answer 1

First of all find_one will return single dictionary or None if there is no matching element in collection. So I think that page[0] is equivalent to getting value of page dictionary for key 0

If returned documents contains ObjectId as _id you cannot simply use jsonify because, like ObjectId is not JSON serializable. You can use something like this:

jsonify({ 'page': make_public_page({k:v for k, v in page.items() if k != '_id'}))

or you can simply remove _id by calling page.pop('_id')

You can also use bson.json_util. It contains tools for conversion between BSON and JSON.

from flask import Response 
from bson import json_util

And then replace jsonify with something similar to this:

return Response(
    json_util.dumps({'page' : make_public_page(page)}),
    mimetype='application/json'
)

Edit

If you want short and dirty way of dealing with the problem you can do it like this:

from bson import json_util, ObjectId
import json

#Lets create some dummy document to prove it will work
page = {'foo': ObjectId(), 'bar': [ObjectId(), ObjectId()]}

#Dump loaded BSON to valid JSON string and reload it as dict
page_sanitized = json.loads(json_util.dumps(page))