forked from celery/celery
-
Notifications
You must be signed in to change notification settings - Fork 40
/
mongodb.py
139 lines (112 loc) · 4.78 KB
/
mongodb.py
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
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
"""MongoDB backend for celery."""
from datetime import datetime
try:
import pymongo
except ImportError:
pymongo = None
from celery import states
from celery.backends.base import BaseDictBackend
from celery.exceptions import ImproperlyConfigured
from celery.utils.serialization import pickle
from celery.utils.timeutils import maybe_timedelta
class Bunch:
def __init__(self, **kw):
self.__dict__.update(kw)
class MongoBackend(BaseDictBackend):
mongodb_host = "localhost"
mongodb_port = 27017
mongodb_user = None
mongodb_password = None
mongodb_database = "celery"
mongodb_taskmeta_collection = "celery_taskmeta"
def __init__(self, *args, **kwargs):
"""Initialize MongoDB backend instance.
:raises celery.exceptions.ImproperlyConfigured: if
module :mod:`pymongo` is not available.
"""
self.result_expires = kwargs.get("result_expires") or \
maybe_timedelta(
self.app.conf.CELERY_TASK_RESULT_EXPIRES)
if not pymongo:
raise ImproperlyConfigured(
"You need to install the pymongo library to use the "
"MongoDB backend.")
config = self.app.conf.get("CELERY_MONGODB_BACKEND_SETTINGS", None)
if config is not None:
if not isinstance(config, dict):
raise ImproperlyConfigured(
"MongoDB backend settings should be grouped in a dict")
self.mongodb_host = config.get("host", self.mongodb_host)
self.mongodb_port = int(config.get("port", self.mongodb_port))
self.mongodb_user = config.get("user", self.mongodb_user)
self.mongodb_password = config.get(
"password", self.mongodb_password)
self.mongodb_database = config.get(
"database", self.mongodb_database)
self.mongodb_taskmeta_collection = config.get(
"taskmeta_collection", self.mongodb_taskmeta_collection)
super(MongoBackend, self).__init__(*args, **kwargs)
self._connection = None
self._database = None
def _get_connection(self):
"""Connect to the MongoDB server."""
if self._connection is None:
from pymongo.connection import Connection
self._connection = Connection(self.mongodb_host,
self.mongodb_port)
return self._connection
def _get_database(self):
""""Get database from MongoDB connection and perform authentication
if necessary."""
if self._database is None:
conn = self._get_connection()
db = conn[self.mongodb_database]
if self.mongodb_user and self.mongodb_password:
auth = db.authenticate(self.mongodb_user,
self.mongodb_password)
if not auth:
raise ImproperlyConfigured(
"Invalid MongoDB username or password.")
self._database = db
return self._database
def process_cleanup(self):
if self._connection is not None:
# MongoDB connection will be closed automatically when object
# goes out of scope
self._connection = None
def _store_result(self, task_id, result, status, traceback=None):
"""Store return value and status of an executed task."""
from pymongo.binary import Binary
meta = {"_id": task_id,
"status": status,
"result": Binary(pickle.dumps(result)),
"date_done": datetime.now(),
"traceback": Binary(pickle.dumps(traceback))}
db = self._get_database()
taskmeta_collection = db[self.mongodb_taskmeta_collection]
taskmeta_collection.save(meta, safe=True)
return result
def _get_task_meta_for(self, task_id):
"""Get task metadata for a task by id."""
db = self._get_database()
taskmeta_collection = db[self.mongodb_taskmeta_collection]
obj = taskmeta_collection.find_one({"_id": task_id})
if not obj:
return {"status": states.PENDING, "result": None}
meta = {
"task_id": obj["_id"],
"status": obj["status"],
"result": pickle.loads(str(obj["result"])),
"date_done": obj["date_done"],
"traceback": pickle.loads(str(obj["traceback"])),
}
return meta
def cleanup(self):
"""Delete expired metadata."""
db = self._get_database()
taskmeta_collection = db[self.mongodb_taskmeta_collection]
taskmeta_collection.remove({
"date_done": {
"$lt": datetime.now() - self.result_expires,
}
})