Flask-PyMongo

MongoDB 是一个开源的数据库，它存储着灵活的类-JSON 的“文档”。与关系数据库中的数据行相反，它能够存储任何的数字，名称，或者复杂的层级结构。Python 开发者可以考虑把 MongoDB 作为一个持久化，可搜索的 Python 字典的“仓库”(实际上，这是如何用 PyMongo 来表示 MongoDB 中的“文档”)。

Flask-PyMongo 架起来 Flask 和 PyMongo 之间的桥梁，因此你能够使用 Flask 正常的机制去配置和连接 MongoDB。

快速入门

首先，安装 Flask-PyMongo:

$ pip install Flask-PyMongo

Flask-PyMongo 的各种依赖，比如，最新版本的 Flask（0.8或者以上）以及 PyMongo（2.4或者以上） ，也会为你安装的。Flask-PyMongo 是兼容 Python 2.6, 2.7, 和 3.3 版本并且通过测试。

接着，在你的代码中添加一个 PyMongo:

from flask import Flask
from flask.ext.pymongo import PyMongo

app = Flask(__name__)
mongo = PyMongo(app)

PyMongo 连接运行在本机上且端口为 27017 的 MongoDB 服务器，并且假设默认的数据库名为 app.name (换而言之，你可以使用传入到 Flask 中的任何数据库名)。这个数据库能够作为 db 属性被导入。

你可以在视图中直接使用 db :

@app.route('/')
def home_page():
    online_users = mongo.db.users.find({'online': True})
    return render_template('index.html',
        online_users=online_users)

Helpers

Flask-PyMongo 提供一些通用任务的现成方法:

Collection.find_one_or_404(*args, **kwargs)

Find and return a single document, or raise a 404 Not Found exception if no document matches the query spec. See find_one() for details.

@app.route('/user/<username>')
def user_profile(username):
    user = mongo.db.users.find_one_or_404({'_id': username})
    return render_template('user.html',
        user=user)

PyMongo.send_file(filename, base='fs', version=-1, cache_for=31536000)

Return an instance of the response_class containing the named file, and implement conditional GET semantics (using make_conditional()).

@app.route('/uploads/<path:filename>')
def get_upload(filename):
    return mongo.send_file(filename)

Parameters:

• filename (str) – the filename of the file to return
• base (str) – the base name of the GridFS collections to use
• version (bool) – if positive, return the Nth revision of the file identified by filename; if negative, return the Nth most recent revision. If no such version exists, return with HTTP status 404.
• cache_for (int) – number of seconds that browsers should be instructed to cache responses

PyMongo.save_file(filename, fileobj, base='fs', content_type=None)

Save the file-like object to GridFS using the given filename. Returns None.

@app.route('/uploads/<path:filename>', methods=['POST'])
def save_upload(filename):
    mongo.save_file(filename, request.files['file'])
    return redirect(url_for('get_upload', filename=filename))

Parameters:

• filename (str) – the filename of the file to return
• fileobj (file) – the file-like object to save
• base (str) – base the base name of the GridFS collections to use
• content_type (str) – the MIME content-type of the file. If None, the content-type is guessed from the filename using guess_type()

class flask_pymongo.BSONObjectIdConverter(map)

A simple converter for the RESTful URL routing system of Flask.

@app.route('/<ObjectId:task_id>')
def show_task(task_id):
    task = mongo.db.tasks.find_one_or_404(task_id)
    return render_template('task.html', task=task)

Valid object ID strings are converted into ObjectId objects; invalid strings result in a 404 error. The converter is automatically registered by the initialization of PyMongo with keyword ObjectId.

Configuration

PyMongo 直接支持如下的配置项:

当 PyMongo 或者 init_app() 仅仅只有一个参数调用的时候 (the Flask 实例)，会假设配置值的前缀是 MONGO；能够用 config_prefix 来覆盖这个前缀。

这个技术能够用于连接多个数据库或者数据服务器:

app = Flask(__name__)

# connect to MongoDB with the defaults
mongo1 = PyMongo(app)

# connect to another MongoDB database on the same host
app.config['MONGO2_DBNAME'] = 'dbname_two'
mongo2 = PyMongo(app, config_prefix='MONGO2')

# connect to another MongoDB server altogether
app.config['MONGO3_HOST'] = 'another.host.example.com'
app.config['MONGO3_PORT'] = 27017
app.config['MONGO3_DBNAME'] = 'dbname_three'
mongo3 = PyMongo(app, config_prefix='MONGO3')

你应该需要注意一些自动配置的设置:

tz_aware:

Flask-PyMongo 一直使用通用时区的 datetime 对象。这是因为当建立连接的时候它设置 tz_aware 参数为 True。从 MongoDB 返回的 datetime 对象一直是 UTC。

safe:

Flask-PyMongo 默认地设置成 “safe” 模式，这会导致 save(), insert(), update(), 和 remove() 在返回前一直等待着服务器的应答。你可以在调用的时候通过传入 safe=False 参数到任何一个受影响的方法中来覆盖它。