def contentSet():
try:
setRequest = request.json
except:
return error_json("JSON parse error")
towrite = {}
if "contentID" not in setRequest:
return error_json('Did not specify contentID')
contentBefore = content.find_one({'_id': setRequest['contentID']})
if not contentBefore:
return error_json("Content not found")
if not validate(session):
return error_json("Invalid session")
userData = users.find_one({'username': session['username']})
owner = contentBefore['owner'] == userData['_id']
# extraWarn = None
if 'code' in setRequest and owner:
towrite['code'] = setRequest['code']
towrite['modified'] = float(time.time())
if 'args_mutable' in setRequest and owner:
if type(setRequest['args_mutable']) == list:
towrite['args_mutable'] = setRequest['args_mutable']
towrite['modified'] = float(time.time())
if 'description' in setRequest and owner:
# if type(setRequest['description']) == string:
towrite['description'] = setRequest['description']
towrite['modified'] = float(time.time())
if contentBefore['type'] == 'challenge':
if 'instructions' in setRequest and owner:
setRequest['instructions'] = setRequest['instructions'].replace(
"<safe>", "")
setRequest['instructions'] = setRequest['instructions'].replace(
"</safe>", "")
towrite['instructions'] = setRequest['instructions']
towrite['modified'] = float(time.time())
if 'starterCode' in setRequest and owner:
towrite['starterCode'] = setRequest['starterCode']
towrite['modified'] = float(time.time())
if contentBefore['type'] in ['challenge', 'editor_standalone']:
if 'title' in setRequest and owner:
towrite['title'] = setRequest['title']
if 'timeout' in setRequest and owner and type(
setRequest['timeout']) == int:
towrite['timeout'] = setRequest['timeout']
towrite['modified'] = float(time.time())
if not towrite:
if owner:
return warn_json("Did not write anything, maybe formatted wrong")
else:
return warn_json(
"Did not write anything, maybe formatted wrong, fyi: you do not own this content"
)
else:
content.update_one({'_id': setRequest['contentID']}, {'$set': towrite})
return json.dumps({
'status': 'success',
'modified': [key for key in towrite]
})
def api_newContent(contentType):
if validate(session):
userData = users.find_one({'username': session['username']})
print(contentType)
if contentType not in ['challenge', 'editor_standalone']:
return error_json("api_new_contentType")
linkID = make_linkID()
newContent = {
'type': contentType,
'_id': str(uuid.uuid4()),
'description': '## Edit me in the Description tab with Markdown',
'title': 'Untitled',
'name': linkID,
'linkID': linkID,
'owner': userData['_id'],
'created': float(time.time()),
'modified': float(time.time()),
'args_mutable': [],
'visibility': 'private',
}
if contentType == "challenge":
newContent = {
**newContent, 'code': DEFAULT_SOLUTION,
'starterCode': DEFAULT_STARTER_CODE
}
if contentType == "editor_standalone":
newContent = {
**newContent, 'code': DEFAULT_CODE,
'starterCode': DEFAULT_STARTER_CODE
}
content.insert_one(newContent)
return success_json(newContent)
else:
return error_json("api_general_session")
def api_account():
if validate(session):
accountData = users.find_one({'username': session['username']})
for sess in accountData['sessions']:
if sess['id'] == session['sessionID']:
sess['current'] = True
userAgent = user_agents.parse(sess['userAgent'])
sess['readableUserAgent'] = userAgent.browser.family + \
" on " + userAgent.os.family
sess.pop('hash')
sess.pop('salt')
accountData['sessions'] = sorted(accountData['sessions'],
key=lambda k: k['time'],
reverse=True)
if not 'actualname' in accountData:
users.update_one({'username': accountData['username']},
{'$set': {
'actualname': accountData['username']
}})
accountData = users.find_one({'username': session['username']})
accountData.pop("password_hash")
accountData.pop("password_salt")
return success_json(accountData)
else:
return error_json("api_general_session")
def api_changePassword():
requestData = request.get_json(force=True)
if validate(session):
if request.method == 'POST':
data = users.find_one({'username': session['username']})
if hashing.check_value(data['password_hash'],
requestData['oldpass'],
salt=data['password_salt']):
if len(requestData['newpass']) > 7:
some_salt = make_salt()
users.update_one({'username': session['username']}, {
'$set': {
'password_hash':
hashing.hash_value(requestData['newpass'],
salt=some_salt),
'password_salt':
some_salt,
}
})
return success_json()
else:
return error_json("api_changepassword_length")
else:
return error_json("api_general_wrongPassword")
else:
error_json("api_general_session")
def listSessions():
if validate(session):
data = users.find_one({'username': session['username']})
return success_json(data['sessions'])
else:
session['intent'] = "/sessions"
return redirect("/signin")
def getCode():
if validate(session):
userData = users.find_one({'username': session['username']})
userCode = codes.find_one({'owner': userData['_id']})
return userCode['content']
else:
return "session invalid"
def api_challengeResults(contentID):
contentData = content.find_one({'_id': contentID})
if contentData == None:
return error_json("api_general_contentNotFound")
if validate(session):
if contentData['type'] == 'challenge':
responses = list(content.find({'assocChallenge': contentID}))
owners = list(
users.find({
'_id': {
'$in': [element['owner'] for element in responses]
}
}))
output = []
for element in responses:
newDict = element.copy()
COPYKEYS = ['username', 'actualname']
try:
owner = [
owner for owner in owners
if owner['_id'] == element['owner']
][0]
newDict['owner'] = {key: owner[key] for key in COPYKEYS}
except Exception as e:
print(e)
newDict['owner'] = {
"[ERROR] User not found"
for key in COPYKEYS
}
output.append(newDict)
return success_json(output)
else:
return error_json("api_challengeresults_contentType")
else:
return error_json("api_general_session")
def contentGet():
try:
contentID = request.args['id']
except:
return error_json("api_general_contentId")
userContent = content.find_one({'_id': contentID})
if not userContent:
return error_json("api_general_contentNotFound")
if not validate(session):
return error_json("api_general_session")
userData = users.find_one({'username': session['username']})
owner = userContent['owner'] == userData['_id']
signature = signee.sign(userContent['_id'])
userContent['id_sig'] = signature
if userContent['type'] == 'challenge' and not owner:
ALLOWED_CHALLENGE_FIELDS = [
'_id', 'title', 'description', 'owner', 'modified'
]
return success_json({
key: userContent[key]
for key in userContent if key in ALLOWED_CHALLENGE_FIELDS
})
if owner:
return success_json(userContent)
else:
return error_json("api_general_contentReadPermission")
def newChallenge():
if validate(session):
userData = users.find_one({'username': session['username']})
userCode = content.find_one({
'owner': userData['_id'],
'type': 'challenge'
})
if userCode == None:
linkID = make_linkID()
content.insert_one({
'_id': str(uuid.uuid4()),
'type': 'challenge',
'name': 'testchallenge',
'title': 'Title?',
'owner': userData['_id'],
'created': float(time.time()),
'modified': float(time.time()),
'args_mutable': [],
'visibility': 'private',
'linkID': linkID,
'description':
'This is the description. Visit the Description tab to edit it.',
'code': DEFAULT_SOLUTION,
'starterCode': DEFAULT_STARTER_CODE
})
else:
linkID = userCode['linkID']
return redirect('/' + linkID)
else:
session['intent'] = "/newchallenge"
return redirect("/signin")
def listSessions():
if validate(session):
data = users.find_one({'username': session['username']})
return '<br>'.join(
f'<a href="/sessions/kill/{i["id"]}">(kill)</a> {i["time"]} {i["userAgent"]}'
for i in data['sessions'])
else:
session['intent'] = "/sessions"
return redirect("/signin")
def getContent(linkID):
contentData = content.find_one({'linkID': linkID})
if contentData == None:
return "Not found."
if validate(session):
userData = users.find_one({'username': session['username']})
pageName = "Challenge"
if contentData['type'] == 'challenge':
pageName = contentData['name'] + ": editing challenge"
if contentData['type'] == 'editor_standalone':
pageName = contentData['name'] + ": editing"
if contentData['owner'] == userData['_id']:
return render_template('challenge.html',
username=session['username'],
myContentID=contentData['_id'],
editorType=contentData['type'],
pageName=pageName)
elif contentData['type'] == 'challenge':
editorChallenge = content.find_one({
'owner':
userData['_id'],
'type':
'editor_challenge',
'assocChallenge':
contentData['_id']
})
if not editorChallenge:
contentID = str(uuid.uuid4())
args_immutable = [{
'id': arg['id'],
'arg': arg['arg'],
'match': False
} for arg in contentData['args_mutable']]
content.insert_one({
'_id': contentID,
'type': 'editor_challenge',
'owner': userData['_id'],
'assocChallenge': contentData['_id'],
'created': float(time.time()),
'modified': float(time.time()),
'args_mutable': [],
'args_immutable': args_immutable,
'code': contentData['starterCode']
})
else:
contentID = editorChallenge['_id']
return render_template('challenge.html',
username=session['username'],
myContentID=contentID,
editorType='editor_challenge',
pageName="Challenge")
else:
return "You do not have permission to view this content."
else:
session['intent'] = '/' + linkID
return redirect('/signin')
def setCode():
if validate(session):
userData = users.find_one({'username': session['username']})
userCode = codes.update_one(
{'owner': userData['_id']},
{'$set': {
'content': request.json['code']
}})
return json.dumps({'type': 'ok'})
else:
return "session invalid"
def validate_options(opts):
"""Validates and normalizes options passed in a MongoDB URI.
Returns a new dictionary of validated and normalized options.
:Parameters:
- `opts`: A dict of MongoDB URI options.
"""
normalized = {}
for option, value in opts.iteritems():
option, value = validate(option, value)
normalized[option] = value
return normalized
def api_deleteContent(contentID):
contentData = content.find_one({'_id': contentID})
if contentData == None:
return error_json("api_general_contentNotFound")
if validate(session):
userData = users.find_one({'username': session['username']})
if contentData['owner'] == userData['_id']:
content.delete_one({'_id': contentID})
return success_json()
else:
return error_json("api_general_contentWritePermission")
else:
error_json("api_general_session")
def nosql_database_connector(name, config, include=None):
if name not in config:
raise ConfigurationError('Database %s not supported' % name)
db_config = copy.deepcopy(config[name])
db_name = db_config.get('name', 'test')
db_settings = db_config.get('settings', {})
for key, value in db_settings.items():
try:
if not include or key not in include:
validate(key, value)
except:
del db_settings[key]
if 'replicaset' not in db_settings:
client = MongoClient(**db_settings)
else:
client = MongoReplicaSetClient(**db_settings)
database = client[db_name]
db_username = db_config.get('username', False)
db_password = db_config.get('password', False)
if db_username and db_password:
database.authenticate(db_username, db_password)
return database
def validate_options(opts):
"""Validates and normalizes options passed in a MongoDB URI.
Returns a new dictionary of validated and normalized options.
:Parameters:
- `opts`: A dict of MongoDB URI options.
"""
normalized = {}
for option, value in opts.iteritems():
option, value = validate(option, value)
normalized[option] = value
return normalized
def api_mycontent():
if validate(session):
accountData = users.find_one({'username': session['username']})
myContent = list(content.find({'owner': accountData['_id']}))
# myContent = sorted(myContent, key=lambda k: k['modified'], reverse=True)
attemptedChallenges = [
element for element in myContent
if element['type'] == "editor_challenge"
]
assocChallenges = list(
content.find({
'_id': {
'$in': [
element['assocChallenge']
for element in attemptedChallenges
]
}
}))
output = []
for element in myContent:
newDict = {}
for key in ['_id', 'type', 'modified']:
newDict[key] = element[key]
if element['type'] == "editor_challenge":
try:
assocChallenge = [
challenge for challenge in assocChallenges
if challenge['_id'] == element['assocChallenge']
][0]
newDict['linkID'] = assocChallenge['linkID']
except Exception as e:
print(e)
assocChallenge = {
'title': '[ERROR] Original challenge missing'
}
newDict['title'] = assocChallenge['title']
else:
for key in ['title', 'linkID']:
newDict[key] = element[key]
output.append(newDict)
output = sorted(output, key=lambda k: k['modified'], reverse=True)
print(output)
if not output:
return Response(json.dumps({
'status': 'success',
'data': []
}),
mimetype="application/json")
return success_json(output)
else:
return error_json("api_general_session")
def api_deleteAccount():
requestData = request.get_json(force=True)
if validate(session):
if request.method == 'POST':
data = users.find_one({'username': session['username']})
if hashing.check_value(data['password_hash'],
requestData['password'],
salt=data['password_salt']):
users.delete_one({'username': session['username']})
return success_json()
else:
return error_json("api_general_wrongPassword")
else:
return error_json("api_general_session")
def api_killSession(sessionID):
if validate(session):
try:
users.update_one({'username': session['username']},
{'$pull': {
'sessions': {
'id': sessionID
}
}})
return success_json()
except:
return error_json("Failed to kill session")
else:
return error_json("api_general_session")
def api_getContent(linkID):
contentData = content.find_one({'linkID': linkID})
if contentData == None:
return error_json("api_general_contentNotFound")
if validate(session):
userData = users.find_one({'username': session['username']})
# pageName = "Challenge"
# if contentData['type'] == 'challenge':
# pageName = contentData['name']+": editing challenge"
# if contentData['type'] == 'editor_standalone':
# pageName = contentData['name']+": editing"
if contentData['owner'] == userData['_id']:
return success_json(contentData)
elif contentData['type'] == 'challenge':
editorChallenge = content.find_one({
'owner':
userData['_id'],
'type':
'editor_challenge',
'assocChallenge':
contentData['_id']
})
if not editorChallenge:
contentID = str(uuid.uuid4())
args_immutable = [{
'id': arg['id'],
'arg': arg['arg'],
'match': False
} for arg in contentData['args_mutable']]
newContent = {
'_id': contentID,
'type': 'editor_challenge',
'owner': userData['_id'],
'assocChallenge': contentData['_id'],
'description': contentData['description'],
'created': float(time.time()),
'modified': float(time.time()),
'args_mutable': [],
'args_immutable': args_immutable,
'code': contentData['starterCode']
}
content.insert_one(newContent)
else:
contentID = editorChallenge['_id']
return success_json({'_id': contentID, 'type': 'editor_challenge'})
else:
return error_json("api_general_contentReadPermission")
else:
return error_json("api_general_session")
def api_republish(contentID):
contentData = content.find_one({'_id': contentID})
if contentData == None:
return error_json("api_general_contentNotFound")
if validate(session):
if contentData['type'] == 'challenge':
updateKeys = ['description', 'args', 'starterCode']
if request.method == "POST":
requestData = request.get_json(force=True)
updateKeys = requestData
if len(updateKeys) < 1:
return error_json("api_republish_noneSelected")
change = {}
if 'description' in updateKeys:
change['description'] = contentData['description']
if 'args' in updateKeys:
change['args_immutable'] = [{
'id': arg['id'],
'arg': arg['arg'],
'match': False
} for arg in contentData['args_mutable']]
if 'starterCode' in updateKeys:
change['code'] = {
'$concat': [
'$code',
'\n\n//STARTER CODE REPUBLISHED, SEE BELOW\n//' +
contentData['starterCode'].replace('\n', '\n//')
]
}
print(change)
content.update_many({'assocChallenge': contentID}, [{
'$set': change
}])
eventKey = make_ID(64)
eventKeySignature = signee.sign(eventKey)
republishKeyData = {
'key': eventKey,
'key_sig': eventKeySignature,
'expiration': float(time.time()) + REPUBLISH_EVENTKEY_TIMEOUT
}
content.update_one({'_id': contentID},
{'$set': {
'republishKey': republishKeyData
}})
return success_json(republishKeyData)
else:
return error_json("api_republish_contentType")
else:
return error_json("api_general_session")
def __init__(self, username, password, database, options):
options = dict([validate(opt, val) for opt, val in iteritems(options)])
self.__codec_options = _parse_codec_options(options)
self.__credentials = _parse_credentials(
username, password, database, options)
self.__local_threshold_ms = options.get('localthresholdms', 15)
# self.__server_selection_timeout is in seconds. Must use full name for
# common.SERVER_SELECTION_TIMEOUT because it is set directly by tests.
self.__server_selection_timeout = options.get(
'serverselectiontimeoutms', common.SERVER_SELECTION_TIMEOUT)
self.__pool_options = _parse_pool_options(options)
self.__read_preference = _parse_read_preference(options)
self.__replica_set_name = options.get('replicaset')
self.__write_concern = _parse_write_concern(options)
def api_changeActualName():
requestData = request.get_json(force=True)
if validate(session):
if request.method == 'POST':
if len(requestData['newName']) > 0:
users.update_one(
{'username': session['username']},
{'$set': {
'actualname': requestData['newName']
}})
else:
return error_json("api_changeactualname_length")
return success_json()
else:
return error_json("api_general_session")
def killSession(sessionID):
if validate(session):
try:
users.update_one({'username': session['username']},
{'$pull': {
'sessions': {
'id': sessionID
}
}})
return redirect('/account')
except:
return "failed"
else:
session['intent'] = "/sessions/kill/" + sessionID
return redirect("/signin")
def validate_options(opts):
"""Validates and normalizes options passed in a MongoDB URI.
Returns a new dictionary of validated and normalized options.
:Parameters:
- `opts`: A dict of MongoDB URI options.
"""
normalized = {}
for option, value in opts.items():
option, value = validate(option, value)
# str(option) to ensure that a unicode URI results in plain 'str'
# option names. 'normalized' is then suitable to be passed as kwargs
# in all Python versions.
normalized[str(option)] = value
return normalized
def __init__(self, username, password, database, options):
options = dict([validate(opt, val) for opt, val in iteritems(options)])
self.__codec_options = _parse_codec_options(options)
self.__credentials = _parse_credentials(
username, password, database, options)
self.__local_threshold_ms = options.get(
'localthresholdms', common.LOCAL_THRESHOLD_MS)
# self.__server_selection_timeout is in seconds. Must use full name for
# common.SERVER_SELECTION_TIMEOUT because it is set directly by tests.
self.__server_selection_timeout = options.get(
'serverselectiontimeoutms', common.SERVER_SELECTION_TIMEOUT)
self.__pool_options = _parse_pool_options(options)
self.__read_preference = _parse_read_preference(options)
self.__replica_set_name = options.get('replicaset')
self.__write_concern = _parse_write_concern(options)
def validate_options(opts):
"""Validates and normalizes options passed in a MongoDB URI.
Returns a new dictionary of validated and normalized options.
:Parameters:
- `opts`: A dict of MongoDB URI options.
"""
normalized = {}
for option, value in opts.iteritems():
option, value = validate(option, value)
# str(option) to ensure that a unicode URI results in plain 'str'
# option names. 'normalized' is then suitable to be passed as kwargs
# in all Python versions.
normalized[str(option)] = value
return normalized
def contentPermission():
try:
contentID = request.args['id']
except:
return error_json("Could not read id")
userContent = content.find_one({'_id': contentID})
if not userContent:
return error_json("Content not found")
if validate(session):
userData = users.find_one({'username': session['username']})
if userContent['owner'] == userData['_id']:
return success_json({'owner': True})
if userContent['visibility']:
return success_json({
'owner': False,
'visibility': userContent['visibility']
})
else:
return success_json({'owner': False, 'visibility': 'none'})
def changePassword():
if validate(session):
if request.method == 'GET':
return render_template("changepassword.html",
username=session['username'])
if request.method == 'POST':
data = users.find_one({'username': session['username']})
if hashing.check_value(data['password_hash'],
request.form['oldpass'],
salt=data['password_salt']):
if len(request.form['newpass']) > 7:
some_salt = make_salt()
users.update_one({'username': session['username']}, {
'$set': {
'password_hash':
hashing.hash_value(request.form['newpass'],
salt=some_salt),
'password_salt':
some_salt,
}
})
return render_template(
'messageandredirect.html',
messageTitle="Password changed.",
redirectDescription=
"Returning to the My Account page...",
countdownFrom="3",
redirectTo="/account")
else:
return render_template(
"changepassword.html",
username=session['username'],
nowerrors="New password must be 8 or more characters.")
else:
return render_template("changepassword.html",
username=session['username'],
nowerrors="Wrong password.")
else:
session['intent'] = '/changepassword'
return redirect("/signin")
def deleteAccount():
if validate(session):
if request.method == 'GET':
return render_template("deleteaccount.html",
username=session['username'])
if request.method == 'POST':
data = users.find_one({'username': session['username']})
if hashing.check_value(data['password_hash'],
request.form['password'],
salt=data['password_salt']):
users.delete_one({'username': session['username']})
return render_template('messageandredirect.html',
messageTitle="Account Deleted.",
redirectDescription="Good riddance.",
countdownFrom="5",
redirectTo="/")
else:
return render_template("changepassword.html",
username=session['username'],
nowerrors="Wrong password.")
else:
session['intent'] = '/deleteaccount'
return redirect("/signin")
def account():
if validate(session):
accountData = users.find_one({'username': session['username']})
for sess in accountData['sessions']:
if sess['id'] == session['sessionID']:
sess['current'] = True
userAgent = user_agents.parse(sess['userAgent'])
sess['readableUserAgent'] = userAgent.browser.family + \
" on " + userAgent.os.family
accountData['sessions'] = sorted(accountData['sessions'],
key=lambda k: k['time'],
reverse=True)
if not 'actualname' in accountData:
users.update_one({'username': accountData['username']},
{'$set': {
'actualname': accountData['username']
}})
accountData = users.find_one({'username': session['username']})
return render_template('myaccount.html',
user=accountData,
username=session['username'])
else:
session['intent'] = '/account'
return redirect('/signin')
def changeActualName():
if validate(session):
userData = users.find_one({'username': session['username']})
if request.method == 'GET':
return render_template("changeactualname.html",
username=session['username'],
currentName=userData['actualname'])
if request.method == 'POST':
if len(request.form['newname']) > 0:
users.update_one(
{'username': session['username']},
{'$set': {
'actualname': request.form['newname']
}})
else:
return render_template(
"changeactualname.html",
username=session['username'],
currentName=userData['actualname'],
nowerrors="Name must be at least one character.")
return redirect('/account')
else:
session['intent'] = '/changepassword'
return redirect("/signin")
def contentGet():
try:
contentID = request.args['id']
except:
return error_json("Could not read id")
userContent = content.find_one({'_id': contentID})
if not userContent:
return error_json("Content not found")
if not validate(session):
return error_json("Invalid session")
userData = users.find_one({'username': session['username']})
owner = userContent['owner'] == userData['_id']
if userContent['type'] == 'challenge' and not owner:
ALLOWED_CHALLENGE_FIELDS = [
'_id', 'title', 'description', 'owner', 'modified'
]
return success_json({
key: userContent[key]
for key in userContent if key in ALLOWED_CHALLENGE_FIELDS
})
if owner:
return success_json(userContent)
else:
return error_json("You do not have permission to get this content.")
def __init__(
self, host=None, port=None, max_pool_size=10, document_class=dict, tz_aware=False, _connect=True, **kwargs
):
"""Create a new connection to a single MongoDB instance at *host:port*.
The resultant connection object has connection-pooling built
in. It also performs auto-reconnection when necessary. If an
operation fails because of a connection error,
:class:`~pymongo.errors.ConnectionFailure` is raised. If
auto-reconnection will be performed,
:class:`~pymongo.errors.AutoReconnect` will be
raised. Application code should handle this exception
(recognizing that the operation failed) and then continue to
execute.
Raises :class:`TypeError` if port is not an instance of
``int``. Raises :class:`~pymongo.errors.ConnectionFailure` if
the connection cannot be made.
The `host` parameter can be a full `mongodb URI
<http://dochub.mongodb.org/core/connections>`_, in addition to
a simple hostname. It can also be a list of hostnames or
URIs. Any port specified in the host string(s) will override
the `port` parameter. If multiple mongodb URIs containing
database or auth information are passed, the last database,
username, and password present will be used. For username and
passwords reserved characters like ':', '/', '+' and '@' must be
escaped following RFC 2396.
:Parameters:
- `host` (optional): hostname or IP address of the
instance to connect to, or a mongodb URI, or a list of
hostnames / mongodb URIs. If `host` is an IPv6 literal
it must be enclosed in '[' and ']' characters following
the RFC2732 URL syntax (e.g. '[::1]' for localhost)
- `port` (optional): port number on which to connect
- `max_pool_size` (optional): The maximum number of idle connections
to keep open in the pool for future use
- `document_class` (optional): default class to use for
documents returned from queries on this connection
- `tz_aware` (optional): if ``True``,
:class:`~datetime.datetime` instances returned as values
in a document by this :class:`MongoClient` will be timezone
aware (otherwise they will be naive)
**Other optional parameters can be passed as keyword arguments:**
- `w`: (integer or string) If this is a replica set, write operations
will block until they have been replicated to the specified number
or tagged set of servers. `w=<int>` always includes the replica set
primary (e.g. w=3 means write to the primary and wait until
replicated to **two** secondaries). **Passing w=0 disables write
acknowledgement and all other write concern options.**
- `wtimeout`: (integer) Used in conjunction with `w`. Specify a value
in milliseconds to control how long to wait for write propagation
to complete. If replication does not complete in the given
timeframe, a timeout exception is raised.
- `j`: If ``True`` block until write operations have been committed
to the journal. Ignored if the server is running without journaling.
- `fsync`: If ``True`` force the database to fsync all files before
returning. When used with `j` the server awaits the next group
commit before returning.
- `replicaSet`: (string) The name of the replica set to connect to.
The driver will verify that the replica set it connects to matches
this name. Implies that the hosts specified are a seed list and the
driver should attempt to find all members of the set.
- `socketTimeoutMS`: (integer) How long (in milliseconds) a send or
receive on a socket can take before timing out.
- `connectTimeoutMS`: (integer) How long (in milliseconds) a
connection can take to be opened before timing out.
- `ssl`: If ``True``, create the connection to the server using SSL.
- `read_preference`: The read preference for this connection.
See :class:`~pymongo.read_preferences.ReadPreference` for available
options.
- `auto_start_request`: If ``True``, each thread that accesses
this :class:`MongoClient` has a socket allocated to it for the
thread's lifetime. This ensures consistent reads, even if you
read after an unacknowledged write. Defaults to ``False``
- `use_greenlets`: If ``True``, :meth:`start_request()` will ensure
that the current greenlet uses the same socket for all
operations until :meth:`end_request()`
.. seealso:: :meth:`end_request`
.. mongodoc:: connections
.. versionadded:: 2.4
"""
if host is None:
host = self.HOST
if isinstance(host, basestring):
host = [host]
if port is None:
port = self.PORT
if not isinstance(port, int):
raise TypeError("port must be an instance of int")
seeds = set()
username = None
password = None
db = None
opts = {}
for entity in host:
if "://" in entity:
if entity.startswith("mongodb://"):
res = uri_parser.parse_uri(entity, port)
seeds.update(res["nodelist"])
username = res["username"] or username
password = res["password"] or password
db = res["database"] or db
opts = res["options"]
else:
idx = entity.find("://")
raise InvalidURI("Invalid URI scheme: " "%s" % (entity[:idx],))
else:
seeds.update(uri_parser.split_hosts(entity, port))
if not seeds:
raise ConfigurationError("need to specify at least one host")
self.__nodes = seeds
self.__host = None
self.__port = None
self.__is_primary = False
self.__is_mongos = False
options = {}
for option, value in kwargs.iteritems():
option, value = common.validate(option, value)
options[option] = value
options.update(opts)
self.__max_pool_size = common.validate_positive_integer("max_pool_size", max_pool_size)
self.__cursor_manager = CursorManager(self)
self.__repl = options.get("replicaset")
if len(seeds) == 1 and not self.__repl:
self.__direct = True
else:
self.__direct = False
self.__nodes = set()
self.__net_timeout = options.get("sockettimeoutms")
self.__conn_timeout = options.get("connecttimeoutms")
self.__use_ssl = options.get("ssl", False)
if self.__use_ssl and not pool.have_ssl:
raise ConfigurationError(
"The ssl module is not available. If you "
"are using a python version previous to "
"2.6 you must install the ssl package "
"from PyPI."
)
use_greenlets = options.get("use_greenlets", False)
self.__pool = pool.Pool(
None, self.__max_pool_size, self.__net_timeout, self.__conn_timeout, self.__use_ssl, use_greenlets
)
self.__document_class = document_class
self.__tz_aware = common.validate_boolean("tz_aware", tz_aware)
self.__auto_start_request = options.get("auto_start_request", False)
# cache of existing indexes used by ensure_index ops
self.__index_cache = {}
self.__auth_credentials = {}
super(MongoClient, self).__init__(**options)
if self.slave_okay:
warnings.warn("slave_okay is deprecated. Please " "use read_preference instead.", DeprecationWarning)
if _connect:
try:
self.__find_node(seeds)
except AutoReconnect, e:
# ConnectionFailure makes more sense here than AutoReconnect
raise ConnectionFailure(str(e))
def __init__(self, host=None, port=None, max_pool_size=10,
document_class=dict, tz_aware=False, _connect=True, **kwargs):
"""Create a new connection to a single MongoDB instance at *host:port*.
The resultant client object has connection-pooling built
in. It also performs auto-reconnection when necessary. If an
operation fails because of a connection error,
:class:`~pymongo.errors.ConnectionFailure` is raised. If
auto-reconnection will be performed,
:class:`~pymongo.errors.AutoReconnect` will be
raised. Application code should handle this exception
(recognizing that the operation failed) and then continue to
execute.
Raises :class:`TypeError` if port is not an instance of
``int``. Raises :class:`~pymongo.errors.ConnectionFailure` if
the connection cannot be made.
The `host` parameter can be a full `mongodb URI
<http://dochub.mongodb.org/core/connections>`_, in addition to
a simple hostname. It can also be a list of hostnames or
URIs. Any port specified in the host string(s) will override
the `port` parameter. If multiple mongodb URIs containing
database or auth information are passed, the last database,
username, and password present will be used. For username and
passwords reserved characters like ':', '/', '+' and '@' must be
escaped following RFC 2396.
:Parameters:
- `host` (optional): hostname or IP address of the
instance to connect to, or a mongodb URI, or a list of
hostnames / mongodb URIs. If `host` is an IPv6 literal
it must be enclosed in '[' and ']' characters following
the RFC2732 URL syntax (e.g. '[::1]' for localhost)
- `port` (optional): port number on which to connect
- `max_pool_size` (optional): The maximum number of idle connections
to keep open in the pool for future use
- `document_class` (optional): default class to use for
documents returned from queries on this client
- `tz_aware` (optional): if ``True``,
:class:`~datetime.datetime` instances returned as values
in a document by this :class:`MongoClient` will be timezone
aware (otherwise they will be naive)
| **Other optional parameters can be passed as keyword arguments:**
- `socketTimeoutMS`: (integer) How long (in milliseconds) a send or
receive on a socket can take before timing out.
- `connectTimeoutMS`: (integer) How long (in milliseconds) a
connection can take to be opened before timing out.
- `auto_start_request`: If ``True``, each thread that accesses
this :class:`MongoClient` has a socket allocated to it for the
thread's lifetime. This ensures consistent reads, even if you
read after an unacknowledged write. Defaults to ``False``
- `use_greenlets`: If ``True``, :meth:`start_request()` will ensure
that the current greenlet uses the same socket for all
operations until :meth:`end_request()`
| **Write Concern options:**
- `w`: (integer or string) If this is a replica set, write operations
will block until they have been replicated to the specified number
or tagged set of servers. `w=<int>` always includes the replica set
primary (e.g. w=3 means write to the primary and wait until
replicated to **two** secondaries). Passing w=0 **disables write
acknowledgement** and all other write concern options.
- `wtimeout`: (integer) Used in conjunction with `w`. Specify a value
in milliseconds to control how long to wait for write propagation
to complete. If replication does not complete in the given
timeframe, a timeout exception is raised.
- `j`: If ``True`` block until write operations have been committed
to the journal. Ignored if the server is running without journaling.
- `fsync`: If ``True`` force the database to fsync all files before
returning. When used with `j` the server awaits the next group
commit before returning.
| **Replica set keyword arguments for connecting with a replica set
- either directly or via a mongos:**
| (ignored by standalone mongod instances)
- `replicaSet`: (string) The name of the replica set to connect to.
The driver will verify that the replica set it connects to matches
this name. Implies that the hosts specified are a seed list and the
driver should attempt to find all members of the set. *Ignored by
mongos*.
- `read_preference`: The read preference for this client. If
connecting to a secondary then a read preference mode *other* than
PRIMARY is required - otherwise all queries will throw
:class:`~pymongo.errors.AutoReconnect` "not master".
See :class:`~pymongo.read_preferences.ReadPreference` for all
available read preference options.
- `tag_sets`: Ignored unless connecting to a replica set via mongos.
Specify a priority-order for tag sets, provide a list of
tag sets: ``[{'dc': 'ny'}, {'dc': 'la'}, {}]``. A final, empty tag
set, ``{}``, means "read from any member that matches the mode,
ignoring tags.
| **SSL configuration:**
- `ssl`: If ``True``, create the connection to the server using SSL.
- `ssl_keyfile`: The private keyfile used to identify the local
connection against mongod. If included with the ``certfile` then
only the ``ssl_certfile`` is needed. Implies ``ssl=True``.
- `ssl_certfile`: The certificate file used to identify the local
connection against mongod. Implies ``ssl=True``.
- `ssl_cert_reqs`: Specifies whether a certificate is required from
the other side of the connection, and whether it will be validated
if provided. It must be one of the three values ``ssl.CERT_NONE``
(certificates ignored), ``ssl.CERT_OPTIONAL``
(not required, but validated if provided), or ``ssl.CERT_REQUIRED``
(required and validated). If the value of this parameter is not
``ssl.CERT_NONE``, then the ``ssl_ca_certs`` parameter must point
to a file of CA certificates. Implies ``ssl=True``.
- `ssl_ca_certs`: The ca_certs file contains a set of concatenated
"certification authority" certificates, which are used to validate
certificates passed from the other end of the connection.
Implies ``ssl=True``.
.. seealso:: :meth:`end_request`
.. mongodoc:: connections
.. versionchanged:: 2.5
Added additional ssl options
.. versionadded:: 2.4
"""
if host is None:
host = self.HOST
if isinstance(host, basestring):
host = [host]
if port is None:
port = self.PORT
if not isinstance(port, int):
raise TypeError("port must be an instance of int")
seeds = set()
username = None
password = None
db_name = None
opts = {}
for entity in host:
if "://" in entity:
if entity.startswith("mongodb://"):
res = uri_parser.parse_uri(entity, port)
seeds.update(res["nodelist"])
username = res["username"] or username
password = res["password"] or password
db_name = res["database"] or db_name
opts = res["options"]
else:
idx = entity.find("://")
raise InvalidURI("Invalid URI scheme: "
"%s" % (entity[:idx],))
else:
seeds.update(uri_parser.split_hosts(entity, port))
if not seeds:
raise ConfigurationError("need to specify at least one host")
self.__nodes = seeds
self.__host = None
self.__port = None
self.__is_primary = False
self.__is_mongos = False
# _pool_class option is for deep customization of PyMongo, e.g. Motor.
# SHOULD NOT BE USED BY DEVELOPERS EXTERNAL TO 10GEN.
pool_class = kwargs.pop('_pool_class', pool.Pool)
options = {}
for option, value in kwargs.iteritems():
option, value = common.validate(option, value)
options[option] = value
options.update(opts)
self.__max_pool_size = common.validate_positive_integer(
'max_pool_size', max_pool_size)
self.__cursor_manager = CursorManager(self)
self.__repl = options.get('replicaset')
if len(seeds) == 1 and not self.__repl:
self.__direct = True
else:
self.__direct = False
self.__nodes = set()
self.__net_timeout = options.get('sockettimeoutms')
self.__conn_timeout = options.get('connecttimeoutms')
self.__use_ssl = options.get('ssl', None)
self.__ssl_keyfile = options.get('ssl_keyfile', None)
self.__ssl_certfile = options.get('ssl_certfile', None)
self.__ssl_cert_reqs = options.get('ssl_cert_reqs', None)
self.__ssl_ca_certs = options.get('ssl_ca_certs', None)
ssl_kwarg_keys = [k for k in kwargs.keys() if k.startswith('ssl_')]
if self.__use_ssl == False and ssl_kwarg_keys:
raise ConfigurationError("ssl has not been enabled but the "
"following ssl parameters have been set: "
"%s. Please set `ssl=True` or remove."
% ', '.join(ssl_kwarg_keys))
if self.__ssl_cert_reqs and not self.__ssl_ca_certs:
raise ConfigurationError("If `ssl_cert_reqs` is not "
"`ssl.CERT_NONE` then you must "
"include `ssl_ca_certs` to be able "
"to validate the server.")
if ssl_kwarg_keys and self.__use_ssl is None:
# ssl options imply ssl = True
self.__use_ssl = True
if self.__use_ssl and not HAS_SSL:
raise ConfigurationError("The ssl module is not available. If you "
"are using a python version previous to "
"2.6 you must install the ssl package "
"from PyPI.")
self.__use_greenlets = options.get('use_greenlets', False)
self.__pool = pool_class(
None,
self.__max_pool_size,
self.__net_timeout,
self.__conn_timeout,
self.__use_ssl,
use_greenlets=self.__use_greenlets,
ssl_keyfile=self.__ssl_keyfile,
ssl_certfile=self.__ssl_certfile,
ssl_cert_reqs=self.__ssl_cert_reqs,
ssl_ca_certs=self.__ssl_ca_certs)
self.__document_class = document_class
self.__tz_aware = common.validate_boolean('tz_aware', tz_aware)
self.__auto_start_request = options.get('auto_start_request', False)
# cache of existing indexes used by ensure_index ops
self.__index_cache = {}
self.__auth_credentials = {}
super(MongoClient, self).__init__(**options)
if self.slave_okay:
warnings.warn("slave_okay is deprecated. Please "
"use read_preference instead.", DeprecationWarning,
stacklevel=2)
if _connect:
try:
self.__find_node(seeds)
except AutoReconnect, e:
# ConnectionFailure makes more sense here than AutoReconnect
raise ConnectionFailure(str(e))
def run_scenario(self):
compressors = (test.get('options') or {}).get('compressors', [])
if 'snappy' in compressors and not _HAVE_SNAPPY:
self.skipTest('This test needs the snappy module.')
valid = True
warning = False
with warnings.catch_warnings(record=True) as ctx:
warnings.simplefilter('always')
try:
options = parse_uri(test['uri'], warn=True)
except Exception:
valid = False
else:
warning = len(ctx) > 0
expected_valid = test.get('valid', True)
self.assertEqual(
valid, expected_valid, get_error_message_template(
not expected_valid, "error") % test['description'])
if expected_valid:
expected_warning = test.get('warning', False)
self.assertEqual(
warning, expected_warning, get_error_message_template(
expected_warning, "warning") % test['description'])
# Compare hosts and port.
if test['hosts'] is not None:
self.assertEqual(
len(test['hosts']), len(options['nodelist']),
"Incorrect number of hosts parsed from URI")
for exp, actual in zip(test['hosts'],
options['nodelist']):
self.assertEqual(exp['host'], actual[0],
"Expected host %s but got %s"
% (exp['host'], actual[0]))
if exp['port'] is not None:
self.assertEqual(exp['port'], actual[1],
"Expected port %s but got %s"
% (exp['port'], actual))
# Compare auth options.
auth = test['auth']
if auth is not None:
auth['database'] = auth.pop('db') # db == database
# Special case for PyMongo's collection parsing.
if options.get('collection') is not None:
options['database'] += "." + options['collection']
for elm in auth:
if auth[elm] is not None:
self.assertEqual(auth[elm], options[elm],
"Expected %s but got %s"
% (auth[elm], options[elm]))
# Compare URI options.
err_msg = "For option %s expected %s but got %s"
if test['options'] is not None:
opts = options['options']
for opt in test['options']:
lopt = opt.lower()
optname = INTERNAL_URI_OPTION_NAME_MAP.get(lopt, lopt)
if opts.get(optname) is not None:
if opts[optname] == test['options'][opt]:
expected_value = test['options'][opt]
else:
expected_value = validate(
lopt, test['options'][opt])[1]
self.assertEqual(
opts[optname], expected_value,
err_msg % (opt, expected_value, opts[optname],))
else:
self.fail(
"Missing expected option %s" % (opt,))
def username_button(session):
if validate(session):
return session['username']
else:
return ""
def __init__(self, hosts_or_uri, max_pool_size=10,
document_class=dict, tz_aware=False, **kwargs):
"""Create a new connection to a MongoDB replica set.
The resultant connection object has connection-pooling built
in. It also performs auto-reconnection when necessary. If an
operation fails because of a connection error,
:class:`~pymongo.errors.ConnectionFailure` is raised. If
auto-reconnection will be performed,
:class:`~pymongo.errors.AutoReconnect` will be
raised. Application code should handle this exception
(recognizing that the operation failed) and then continue to
execute.
Raises :class:`~pymongo.errors.ConnectionFailure` if
the connection cannot be made.
The `hosts_or_uri` parameter can be a full `mongodb URI
<http://dochub.mongodb.org/core/connections>`_, in addition to
a string of `host:port` pairs (e.g. 'host1:port1,host2:port2').
:Parameters:
- `hosts_or_uri`: A MongoDB URI or string of `host:port` pairs.
If a host is an IPv6 literal it must be enclosed in '[' and ']'
characters following the RFC2732 URL syntax (e.g. '[::1]' for
localhost)
- `max_pool_size` (optional): The maximum size limit for
each connection pool.
- `document_class` (optional): default class to use for
documents returned from queries on this connection
- `tz_aware` (optional): if ``True``,
:class:`~datetime.datetime` instances returned as values
in a document by this :class:`Connection` will be timezone
aware (otherwise they will be naive)
- `replicaset`: (required) The name of the replica set to connect to.
The driver will verify that each host it connects to is a member
of this replica set.
Other optional parameters can be passed as keyword arguments:
- `safe`: Use getlasterror for each write operation?
- `j` or `journal`: Block until write operations have been commited
to the journal. Ignored if the server is running without
journaling. Implies safe=True.
- `w`: (integer or string) If this is a replica set write operations
won't return until they have been replicated to the specified
number or tagged set of servers.
Implies safe=True.
- `wtimeout`: Used in conjunction with `j` and/or `w`. Wait this many
milliseconds for journal acknowledgement and/or write replication.
Implies safe=True.
- `fsync`: Force the database to fsync all files before returning
When used with `j` the server awaits the next group commit before
returning. Implies safe=True.
- `socketTimeoutMS`: How long a send or receive on a socket can take
before timing out.
- `connectTimeoutMS`: How long a connection can take to be opened
before timing out.
.. versionadded:: 2.0.1+
"""
warnings.warn("ReplicaSetConnection IS NOT READY "
"FOR PRODUCTION USE. USE AT YOUR OWN RISK!")
self.__max_pool_size = max_pool_size
self.__document_class = document_class
self.__tz_aware = tz_aware
self.__opts = {}
self.__hosts = set()
self.__arbiters = set()
self.__writer = None
self.__readers = []
self.__reader_pools = {}
self.__index_cache = {}
self.__auth_credentials = {}
self.__read_pref = SECONDARY
username = None
db_name = None
if '://' in hosts_or_uri:
res = uri_parser.parse_uri(hosts_or_uri)
self.__seeds = res['nodes']
username = res['username']
password = res['password']
db_name = res['database']
self.__opts = res['options']
else:
self.__seeds = uri_parser.split_hosts(hosts_or_uri)
for option, value in kwargs.iteritems():
option, value = common.validate(option, value)
self.__opts[option] = value
self.__name = self.__opts.get('replicaset')
if not self.__name:
raise ConfigurationError("You must provide a replica set name.")
self.__net_timeout = self.__opts.get('sockettimeoutms')
self.__conn_timeout = self.__opts.get('connecttimeoutms')
super(ReplicaSetConnection, self).__init__(**self.__opts)
self.slave_okay = True
if db_name and username is None:
warnings.warn("must provide a username and password "
"to authenticate to %s" % (db_name,))
if username:
db_name = db_name or 'admin'
if not self[db_name].authenticate(username, password):
raise ConfigurationError("authentication failed")
def __init__(self, hosts_or_uri=None, max_pool_size=10,
document_class=dict, tz_aware=False, **kwargs):
"""Create a new connection to a MongoDB replica set.
The resultant connection object has connection-pooling built
in. It also performs auto-reconnection when necessary. If an
operation fails because of a connection error,
:class:`~pymongo.errors.ConnectionFailure` is raised. If
auto-reconnection will be performed,
:class:`~pymongo.errors.AutoReconnect` will be
raised. Application code should handle this exception
(recognizing that the operation failed) and then continue to
execute.
Raises :class:`~pymongo.errors.ConnectionFailure` if
the connection cannot be made.
The `hosts_or_uri` parameter can be a full `mongodb URI
<http://dochub.mongodb.org/core/connections>`_, in addition to
a string of `host:port` pairs (e.g. 'host1:port1,host2:port2').
If `hosts_or_uri` is None 'localhost:27017' will be used.
:Parameters:
- `hosts_or_uri` (optional): A MongoDB URI or string of `host:port`
pairs. If a host is an IPv6 literal it must be enclosed in '[' and
']' characters following the RFC2732 URL syntax (e.g. '[::1]' for
localhost)
- `max_pool_size` (optional): The maximum size limit for
each connection pool.
- `document_class` (optional): default class to use for
documents returned from queries on this connection
- `tz_aware` (optional): if ``True``,
:class:`~datetime.datetime` instances returned as values
in a document by this :class:`ReplicaSetConnection` will be timezone
aware (otherwise they will be naive)
- `replicaSet`: (required) The name of the replica set to connect to.
The driver will verify that each host it connects to is a member of
this replica set. Can be passed as a keyword argument or as a
MongoDB URI option.
Other optional parameters can be passed as keyword arguments:
- `safe`: Use getlasterror for each write operation?
- `j` or `journal`: Block until write operations have been commited
to the journal. Ignored if the server is running without
journaling. Implies safe=True.
- `w`: (integer or string) If this is a replica set write operations
won't return until they have been replicated to the specified
number or tagged set of servers.
Implies safe=True.
- `wtimeoutMS`: Used in conjunction with `j` and/or `w`. Wait this
many milliseconds for journal acknowledgement and/or write
replication. Implies safe=True.
- `fsync`: Force the database to fsync all files before returning
When used with `j` the server awaits the next group commit before
returning. Implies safe=True.
- `socketTimeoutMS`: How long a send or receive on a socket can take
before timing out.
- `connectTimeoutMS`: How long a connection can take to be opened
before timing out.
- `ssl`: If True, create the connection to the servers using SSL.
- `read_preference`: The read preference for this connection.
See :class:`~pymongo.ReadPreference` for available options.
- `auto_start_request`: If True (the default), each thread that
accesses this :class:`ReplicaSetConnection` has a socket allocated
to it for the thread's lifetime, for each member of the set. For
:class:`~pymongo.ReadPreference` PRIMARY, auto_start_request=True
ensures consistent reads, even if you read after an unsafe
write. For read preferences other than PRIMARY, there are no
consistency guarantees. (The semantics of auto_start_request,
:class:`~pymongo.ReadPreference`, and :class:`ReplicaSetConnection`
may change in future releases of PyMongo.)
- `use_greenlets` (optional): if ``True``, :meth:`start_request()`
will ensure that the current greenlet uses the same socket for all
operations until :meth:`end_request()`
- `slave_okay` or `slaveOk` (deprecated): Use `read_preference`
instead.
- `host`: For compatibility with connection.Connection. If both
`host` and `hosts_or_uri` are specified `host` takes precedence.
- `port`: For compatibility with connection.Connection. The default
port number to use for hosts.
- `network_timeout`: For compatibility with connection.Connection.
The timeout (in seconds) to use for socket operations - default
is no timeout. If both `network_timeout` and `socketTimeoutMS` are
are specified `network_timeout` takes precedence, matching
connection.Connection.
.. versionchanged:: 2.1.1+
Added `auto_start_request` option.
Added support for `host`, `port`, and `network_timeout` keyword
arguments for compatibility with connection.Connection.
.. versionadded:: 2.1
"""
self.__opts = {}
self.__seeds = set()
self.__hosts = None
self.__arbiters = set()
self.__writer = None
self.__readers = []
self.__pools = {}
self.__index_cache = {}
self.__auth_credentials = {}
self.__max_pool_size = common.validate_positive_integer(
'max_pool_size', max_pool_size)
self.__tz_aware = common.validate_boolean('tz_aware', tz_aware)
self.__document_class = document_class
# Compatibility with connection.Connection
host = kwargs.pop('host', hosts_or_uri)
port = kwargs.pop('port', 27017)
if not isinstance(port, int):
raise TypeError("port must be an instance of int")
network_timeout = kwargs.pop('network_timeout', None)
if network_timeout is not None:
if (not isinstance(network_timeout, (int, float)) or
network_timeout <= 0):
raise ConfigurationError("network_timeout must "
"be a positive integer")
username = None
db_name = None
if host is None:
self.__seeds.add(('localhost', port))
elif '://' in host:
res = uri_parser.parse_uri(host, port)
self.__seeds.update(res['nodelist'])
username = res['username']
password = res['password']
db_name = res['database']
self.__opts = res['options']
else:
self.__seeds.update(uri_parser.split_hosts(host, port))
for option, value in kwargs.iteritems():
option, value = common.validate(option, value)
self.__opts[option] = value
if self.__opts.get('use_greenlets', False):
if not have_gevent:
raise ConfigurationError(
"The gevent module is not available. "
"Install the gevent package from PyPI."
)
self.pool_class = pool.GreenletPool
else:
self.pool_class = pool.Pool
self.__auto_start_request = self.__opts.get('auto_start_request', True)
self.__in_request = self.__auto_start_request
self.__name = self.__opts.get('replicaset')
if not self.__name:
raise ConfigurationError("the replicaSet "
"keyword parameter is required.")
self.__net_timeout = (network_timeout or
self.__opts.get('sockettimeoutms'))
self.__conn_timeout = self.__opts.get('connecttimeoutms')
self.__use_ssl = self.__opts.get('ssl', False)
if self.__use_ssl and not pool.have_ssl:
raise ConfigurationError("The ssl module is not available. If you "
"are using a python version previous to "
"2.6 you must install the ssl package "
"from PyPI.")
super(ReplicaSetConnection, self).__init__(**self.__opts)
if self.slave_okay:
warnings.warn("slave_okay is deprecated. Please "
"use read_preference instead.", DeprecationWarning)
self.refresh()
if self.__opts.get('use_greenlets', False):
monitor = MonitorGreenlet(self)
else:
monitor = MonitorThread(self)
monitor.start()
if db_name and username is None:
warnings.warn("must provide a username and password "
"to authenticate to %s" % (db_name,))
if username:
db_name = db_name or 'admin'
if not self[db_name].authenticate(username, password):
raise ConfigurationError("authentication failed")
def __init__(
self,
host=None,
port=None,
document_class=dict,
tz_aware=False,
connect=True,
**kwargs):
"""Client for a MongoDB instance, a replica set, or a set of mongoses.
The client object is thread-safe and has connection-pooling built in.
If an operation fails because of a network error,
:class:`~pymongo.errors.ConnectionFailure` is raised and the client
reconnects in the background. Application code should handle this
exception (recognizing that the operation failed) and then continue to
execute.
The `host` parameter can be a full `mongodb URI
<http://dochub.mongodb.org/core/connections>`_, in addition to
a simple hostname. It can also be a list of hostnames or
URIs. Any port specified in the host string(s) will override
the `port` parameter. If multiple mongodb URIs containing
database or auth information are passed, the last database,
username, and password present will be used. For username and
passwords reserved characters like ':', '/', '+' and '@' must be
escaped following RFC 2396.
.. warning:: When using PyMongo in a multiprocessing context, please
read :ref:`multiprocessing` first.
:Parameters:
- `host` (optional): hostname or IP address of the
instance to connect to, or a mongodb URI, or a list of
hostnames / mongodb URIs. If `host` is an IPv6 literal
it must be enclosed in '[' and ']' characters following
the RFC2732 URL syntax (e.g. '[::1]' for localhost)
- `port` (optional): port number on which to connect
- `document_class` (optional): default class to use for
documents returned from queries on this client
- `tz_aware` (optional): if ``True``,
:class:`~datetime.datetime` instances returned as values
in a document by this :class:`MongoClient` will be timezone
aware (otherwise they will be naive)
- `connect` (optional): if ``True`` (the default), immediately
begin connecting to MongoDB in the background. Otherwise connect
on the first operation.
| **Other optional parameters can be passed as keyword arguments:**
- `maxPoolSize` (optional): The maximum number of connections
that the pool will open simultaneously. If this is set, operations
will block if there are `maxPoolSize` outstanding connections
from the pool. Defaults to 100. Cannot be 0.
- `socketTimeoutMS`: (integer or None) Controls how long (in
milliseconds) the driver will wait for a response after sending an
ordinary (non-monitoring) database operation before concluding that
a network error has occurred. Defaults to ``None`` (no timeout).
- `connectTimeoutMS`: (integer or None) Controls how long (in
milliseconds) the driver will wait during server monitoring when
connecting a new socket to a server before concluding the server
is unavailable. Defaults to ``20000`` (20 seconds).
- `serverSelectionTimeoutMS`: (integer) Controls how long (in
milliseconds) the driver will wait to find an available,
appropriate server to carry out a database operation; while it is
waiting, multiple server monitoring operations may be carried out,
each controlled by `connectTimeoutMS`. Defaults to ``30000`` (30
seconds).
- `waitQueueTimeoutMS`: (integer or None) How long (in milliseconds)
a thread will wait for a socket from the pool if the pool has no
free sockets. Defaults to ``None`` (no timeout).
- `waitQueueMultiple`: (integer or None) Multiplied by maxPoolSize
to give the number of threads allowed to wait for a socket at one
time. Defaults to ``None`` (no limit).
- `socketKeepAlive`: (boolean) Whether to send periodic keep-alive
packets on connected sockets. Defaults to ``False`` (do not send
keep-alive packets).
| **Write Concern options:**
| (Only set if passed. No default values.)
- `w`: (integer or string) If this is a replica set, write operations
will block until they have been replicated to the specified number
or tagged set of servers. `w=<int>` always includes the replica set
primary (e.g. w=3 means write to the primary and wait until
replicated to **two** secondaries). Passing w=0 **disables write
acknowledgement** and all other write concern options.
- `wtimeout`: (integer) Used in conjunction with `w`. Specify a value
in milliseconds to control how long to wait for write propagation
to complete. If replication does not complete in the given
timeframe, a timeout exception is raised.
- `j`: If ``True`` block until write operations have been committed
to the journal. Cannot be used in combination with `fsync`. Prior
to MongoDB 2.6 this option was ignored if the server was running
without journaling. Starting with MongoDB 2.6 write operations will
fail with an exception if this option is used when the server is
running without journaling.
- `fsync`: If ``True`` and the server is running without journaling,
blocks until the server has synced all data files to disk. If the
server is running with journaling, this acts the same as the `j`
option, blocking until write operations have been committed to the
journal. Cannot be used in combination with `j`.
| **Replica set keyword arguments for connecting with a replica set
- either directly or via a mongos:**
- `replicaSet`: (string or None) The name of the replica set to
connect to. The driver will verify that all servers it connects to
match this name. Implies that the hosts specified are a seed list
and the driver should attempt to find all members of the set.
Defaults to ``None``.
- `read_preference`: The read preference for this client. If
connecting directly to a secondary then a read preference mode
*other* than PRIMARY is required - otherwise all queries will throw
:class:`~pymongo.errors.AutoReconnect` "not master".
See :class:`~pymongo.read_preferences.ReadPreference` for all
available read preference options. Defaults to ``PRIMARY``.
| **SSL configuration:**
- `ssl`: If ``True``, create the connection to the server using SSL.
Defaults to ``False``.
- `ssl_keyfile`: The private keyfile used to identify the local
connection against mongod. If included with the ``certfile`` then
only the ``ssl_certfile`` is needed. Implies ``ssl=True``.
Defaults to ``None``.
- `ssl_certfile`: The certificate file used to identify the local
connection against mongod. Implies ``ssl=True``. Defaults to
``None``.
- `ssl_cert_reqs`: Specifies whether a certificate is required from
the other side of the connection, and whether it will be validated
if provided. It must be one of the three values ``ssl.CERT_NONE``
(certificates ignored), ``ssl.CERT_OPTIONAL``
(not required, but validated if provided), or ``ssl.CERT_REQUIRED``
(required and validated). If the value of this parameter is not
``ssl.CERT_NONE`` and a value is not provided for ``ssl_ca_certs``
PyMongo will attempt to load system provided CA certificates.
If the python version in use does not support loading system CA
certificates then the ``ssl_ca_certs`` parameter must point
to a file of CA certificates. Implies ``ssl=True``. Defaults to
``ssl.CERT_REQUIRED`` if not provided and ``ssl=True``.
- `ssl_ca_certs`: The ca_certs file contains a set of concatenated
"certification authority" certificates, which are used to validate
certificates passed from the other end of the connection.
Implies ``ssl=True``. Defaults to ``None``.
- `ssl_match_hostname`: If ``True`` (the default), and
`ssl_cert_reqs` is not ``ssl.CERT_NONE``, enables hostname
verification using the :func:`~ssl.match_hostname` function from
python's :mod:`~ssl` module. Think very carefully before setting
this to ``False`` as that could make your application vulnerable to
man-in-the-middle attacks.
.. mongodoc:: connections
.. versionchanged:: 3.0
:class:`~pymongo.mongo_client.MongoClient` is now the one and only
client class for a standalone server, mongos, or replica set.
It includes the functionality that had been split into
:class:`~pymongo.mongo_client.MongoReplicaSetClient`: it can connect
to a replica set, discover all its members, and monitor the set for
stepdowns, elections, and reconfigs.
The :class:`~pymongo.mongo_client.MongoClient` constructor no
longer blocks while connecting to the server or servers, and it no
longer raises :class:`~pymongo.errors.ConnectionFailure` if they
are unavailable, nor :class:`~pymongo.errors.ConfigurationError`
if the user's credentials are wrong. Instead, the constructor
returns immediately and launches the connection process on
background threads.
Therefore the ``alive`` method is removed since it no longer
provides meaningful information; even if the client is disconnected,
it may discover a server in time to fulfill the next operation.
In PyMongo 2.x, :class:`~pymongo.MongoClient` accepted a list of
standalone MongoDB servers and used the first it could connect to::
MongoClient(['host1.com:27017', 'host2.com:27017'])
A list of multiple standalones is no longer supported; if multiple
servers are listed they must be members of the same replica set, or
mongoses in the same sharded cluster.
The behavior for a list of mongoses is changed from "high
availability" to "load balancing". Before, the client connected to
the lowest-latency mongos in the list, and used it until a network
error prompted it to re-evaluate all mongoses' latencies and
reconnect to one of them. In PyMongo 3, the client monitors its
network latency to all the mongoses continuously, and distributes
operations evenly among those with the lowest latency. See
:ref:`mongos-load-balancing` for more information.
The ``connect`` option is added.
The ``start_request``, ``in_request``, and ``end_request`` methods
are removed, as well as the ``auto_start_request`` option.
The ``copy_database`` method is removed, see the
:doc:`copy_database examples </examples/copydb>` for alternatives.
The :meth:`MongoClient.disconnect` method is removed; it was a
synonym for :meth:`~pymongo.MongoClient.close`.
:class:`~pymongo.mongo_client.MongoClient` no longer returns an
instance of :class:`~pymongo.database.Database` for attribute names
with leading underscores. You must use dict-style lookups instead::
client['__my_database__']
Not::
client.__my_database__
"""
if host is None:
host = self.HOST
if isinstance(host, string_type):
host = [host]
if port is None:
port = self.PORT
if not isinstance(port, int):
raise TypeError("port must be an instance of int")
seeds = set()
username = None
password = None
dbase = None
opts = {}
for entity in host:
if "://" in entity:
if entity.startswith("mongodb://"):
res = uri_parser.parse_uri(entity, port, warn=True)
seeds.update(res["nodelist"])
username = res["username"] or username
password = res["password"] or password
dbase = res["database"] or dbase
opts = res["options"]
else:
idx = entity.find("://")
raise InvalidURI("Invalid URI scheme: "
"%s" % (entity[:idx],))
else:
seeds.update(uri_parser.split_hosts(entity, port))
if not seeds:
raise ConfigurationError("need to specify at least one host")
# _pool_class, _monitor_class, and _condition_class are for deep
# customization of PyMongo, e.g. Motor.
pool_class = kwargs.pop('_pool_class', None)
monitor_class = kwargs.pop('_monitor_class', None)
condition_class = kwargs.pop('_condition_class', None)
keyword_opts = kwargs
keyword_opts['document_class'] = document_class
keyword_opts['tz_aware'] = tz_aware
keyword_opts['connect'] = connect
# Validate all keyword options.
keyword_opts = dict(common.validate(k, v)
for k, v in keyword_opts.items())
opts.update(keyword_opts)
self.__options = options = ClientOptions(
username, password, dbase, opts)
self.__default_database_name = dbase
self.__lock = threading.Lock()
self.__cursor_manager = CursorManager(self)
self.__kill_cursors_queue = []
# Cache of existing indexes used by ensure_index ops.
self.__index_cache = {}
super(MongoClient, self).__init__(options.codec_options,
options.read_preference,
options.write_concern)
self.__all_credentials = {}
creds = options.credentials
if creds:
self._cache_credentials(creds.source, creds)
self._topology_settings = TopologySettings(
seeds=seeds,
replica_set_name=options.replica_set_name,
pool_class=pool_class,
pool_options=options.pool_options,
monitor_class=monitor_class,
condition_class=condition_class,
local_threshold_ms=options.local_threshold_ms,
server_selection_timeout=options.server_selection_timeout)
self._topology = Topology(self._topology_settings)
if connect:
self._topology.open()
def target():
client = self_ref()
if client is None:
return False # Stop the executor.
MongoClient._process_kill_cursors_queue(client)
return True
executor = periodic_executor.PeriodicExecutor(
condition_class=self._topology_settings.condition_class,
interval=common.KILL_CURSOR_FREQUENCY,
min_interval=0,
target=target)
# We strongly reference the executor and it weakly references us via
# this closure. When the client is freed, stop the executor soon.
self_ref = weakref.ref(self, executor.close)
self._kill_cursors_executor = executor
executor.open()
def __init__(self, host=None, port=None, max_pool_size=10,
network_timeout=None, document_class=dict,
tz_aware=False, _connect=True, **kwargs):
"""Create a new connection to a single MongoDB instance at *host:port*.
The resultant connection object has connection-pooling built
in. It also performs auto-reconnection when necessary. If an
operation fails because of a connection error,
:class:`~pymongo.errors.ConnectionFailure` is raised. If
auto-reconnection will be performed,
:class:`~pymongo.errors.AutoReconnect` will be
raised. Application code should handle this exception
(recognizing that the operation failed) and then continue to
execute.
Raises :class:`TypeError` if port is not an instance of
``int``. Raises :class:`~pymongo.errors.ConnectionFailure` if
the connection cannot be made.
The `host` parameter can be a full `mongodb URI
<http://dochub.mongodb.org/core/connections>`_, in addition to
a simple hostname. It can also be a list of hostnames or
URIs. Any port specified in the host string(s) will override
the `port` parameter. If multiple mongodb URIs containing
database or auth information are passed, the last database,
username, and password present will be used.
:Parameters:
- `host` (optional): hostname or IP address of the
instance to connect to, or a mongodb URI, or a list of
hostnames / mongodb URIs. If `host` is an IPv6 literal
it must be enclosed in '[' and ']' characters following
the RFC2732 URL syntax (e.g. '[::1]' for localhost)
- `port` (optional): port number on which to connect
- `max_pool_size` (optional): The maximum size limit for
the connection pool.
- `network_timeout` (optional): timeout (in seconds) to use
for socket operations - default is no timeout
- `document_class` (optional): default class to use for
documents returned from queries on this connection
- `tz_aware` (optional): if ``True``,
:class:`~datetime.datetime` instances returned as values
in a document by this :class:`Connection` will be timezone
aware (otherwise they will be naive)
Other optional parameters can be passed as keyword arguments:
- `slave_okay` or `slaveOk`: Is it OK to perform queries if
this connection is to a secondary?
- `safe`: Use getlasterror for each write operation?
- `j` or `journal`: Block until write operations have been commited
to the journal. Ignored if the server is running without journaling.
Implies safe=True.
- `w`: (integer or string) If this is a replica set write operations
won't return until they have been replicated to the specified
number or tagged set of servers.
Implies safe=True.
- `wtimeout`: Used in conjunction with `j` and/or `w`. Wait this many
milliseconds for journal acknowledgement and/or write replication.
Implies safe=True.
- `fsync`: Force the database to fsync all files before returning
When used with `j` the server awaits the next group commit before
returning.
Implies safe=True.
- `replicaSet`: The name of the replica set to connect to. The driver
will verify that the replica set it connects to matches this name.
Implies that the hosts specified are a seed list and the driver should
attempt to find all members of the set.
- `socketTimeoutMS`: How long a send or receive on a socket can take
before timing out.
- `connectTimeoutMS`: How long a connection can take to be opened
before timing out.
.. seealso:: :meth:`end_request`
.. versionchanged:: 2.0.1+
Support `w` = integer or string.
.. versionchanged:: 2.0
`slave_okay` is a pure keyword argument. Added support for safe,
and getlasterror options as keyword arguments.
.. versionchanged:: 1.11
Added `max_pool_size`. Completely removed previously deprecated
`pool_size`, `auto_start_request` and `timeout` parameters.
.. versionchanged:: 1.8
The `host` parameter can now be a full `mongodb URI
<http://dochub.mongodb.org/core/connections>`_, in addition
to a simple hostname. It can also be a list of hostnames or
URIs.
.. versionadded:: 1.8
The `tz_aware` parameter.
.. versionadded:: 1.7
The `document_class` parameter.
.. versionchanged:: 1.4
DEPRECATED The `pool_size`, `auto_start_request`, and `timeout`
parameters.
.. versionadded:: 1.1
The `network_timeout` parameter.
.. mongodoc:: connections
"""
if host is None:
host = self.HOST
if isinstance(host, basestring):
host = [host]
if port is None:
port = self.PORT
if not isinstance(port, int):
raise TypeError("port must be an instance of int")
nodes = set()
username = None
password = None
db = None
options = {}
for entity in host:
if "://" in entity:
if entity.startswith("mongodb://"):
res = uri_parser.parse_uri(entity, port)
nodes.update(res["nodelist"])
username = res["username"] or username
password = res["password"] or password
db = res["database"] or db
options = res["options"]
else:
idx = entity.find("://")
raise InvalidURI("Invalid URI scheme: "
"%s" % (entity[:idx],))
else:
nodes.update(uri_parser.split_hosts(entity, port))
if not nodes:
raise ConfigurationError("need to specify at least one host")
self.__nodes = nodes
self.__host = None
self.__port = None
for option, value in kwargs.iteritems():
option, value = common.validate(option, value)
options[option] = value
if not isinstance(max_pool_size, int):
raise ConfigurationError("max_pool_size must be an integer")
if max_pool_size < 0:
raise ValueError("max_pool_size must be >= 0")
self.__max_pool_size = max_pool_size
self.__cursor_manager = CursorManager(self)
self.__repl = options.get('replicaset')
if network_timeout is not None:
if (not isinstance(network_timeout, (int, float)) or
network_timeout <= 0):
raise ConfigurationError("network_timeout must "
"be a positive integer")
self.__net_timeout = (network_timeout or
options.get('sockettimeoutms'))
self.__conn_timeout = options.get('connectiontimeoutms')
self.__pool = _Pool(self.__max_pool_size,
self.__net_timeout,
self.__conn_timeout)
self.__last_checkout = time.time()
self.__document_class = document_class
self.__tz_aware = tz_aware
# cache of existing indexes used by ensure_index ops
self.__index_cache = {}
self.__auth_credentials = {}
super(Connection, self).__init__(**options)
if _connect:
self.__find_node()
if db and username is None:
warnings.warn("must provide a username and password "
"to authenticate to %s" % (db,))
if username:
db = db or "admin"
if not self[db].authenticate(username, password):
raise ConfigurationError("authentication failed")
def __init__(self, host=None, port=None, max_pool_size=10,
network_timeout=None, document_class=dict,
tz_aware=False, _connect=True, **kwargs):
"""Create a new connection to a single MongoDB instance at *host:port*.
The resultant connection object has connection-pooling built
in. It also performs auto-reconnection when necessary. If an
operation fails because of a connection error,
:class:`~pymongo.errors.ConnectionFailure` is raised. If
auto-reconnection will be performed,
:class:`~pymongo.errors.AutoReconnect` will be
raised. Application code should handle this exception
(recognizing that the operation failed) and then continue to
execute.
Raises :class:`TypeError` if port is not an instance of
``int``. Raises :class:`~pymongo.errors.ConnectionFailure` if
the connection cannot be made.
The `host` parameter can be a full `mongodb URI
<http://dochub.mongodb.org/core/connections>`_, in addition to
a simple hostname. It can also be a list of hostnames or
URIs. Any port specified in the host string(s) will override
the `port` parameter. If multiple mongodb URIs containing
database or auth information are passed, the last database,
username, and password present will be used. For username and
passwords reserved characters like ':', '/', '+' and '@' must be
escaped following RFC 2396.
:Parameters:
- `host` (optional): hostname or IP address of the
instance to connect to, or a mongodb URI, or a list of
hostnames / mongodb URIs. If `host` is an IPv6 literal
it must be enclosed in '[' and ']' characters following
the RFC2732 URL syntax (e.g. '[::1]' for localhost)
- `port` (optional): port number on which to connect
- `max_pool_size` (optional): The maximum size limit for
the connection pool.
- `network_timeout` (optional): timeout (in seconds) to use
for socket operations - default is no timeout
- `document_class` (optional): default class to use for
documents returned from queries on this connection
- `tz_aware` (optional): if ``True``,
:class:`~datetime.datetime` instances returned as values
in a document by this :class:`Connection` will be timezone
aware (otherwise they will be naive)
Other optional parameters can be passed as keyword arguments:
- `safe`: Use getlasterror for each write operation?
- `j` or `journal`: Block until write operations have been committed
to the journal. Ignored if the server is running without journaling.
Implies safe=True.
- `w`: (integer or string) If this is a replica set write operations
won't return until they have been replicated to the specified
number or tagged set of servers. `w` always includes the replica set
primary (e.g. w=3 means write to the primary and wait until replicated
to **two** secondaries). Implies safe=True.
- `wtimeout`: Used in conjunction with `j` and/or `w`. Wait this many
milliseconds for journal acknowledgement and/or write replication.
Implies safe=True.
- `fsync`: Force the database to fsync all files before returning
When used with `j` the server awaits the next group commit before
returning.
Implies safe=True.
- `replicaSet`: The name of the replica set to connect to. The driver
will verify that the replica set it connects to matches this name.
Implies that the hosts specified are a seed list and the driver should
attempt to find all members of the set.
- `socketTimeoutMS`: How long (in milliseconds) a send or receive on a
socket can take before timing out.
- `connectTimeoutMS`: How long (in milliseconds) a connection can take
to be opened before timing out.
- `ssl`: If True, create the connection to the server using SSL.
- `read_preference`: The read preference for this connection.
See :class:`~pymongo.read_preferences.ReadPreference` for available
options.
- `auto_start_request`: If True (the default), each thread that
accesses this Connection has a socket allocated to it for the
thread's lifetime. This ensures consistent reads, even if you read
after an unsafe write.
- `use_greenlets` (optional): if ``True``, :meth:`start_request()`
will ensure that the current greenlet uses the same socket for all
operations until :meth:`end_request()`
- `slave_okay` or `slaveOk` (deprecated): Use `read_preference`
instead.
.. seealso:: :meth:`end_request`
.. versionchanged:: 2.3
Added support for failover between mongos seed list members.
.. versionchanged:: 2.2
Added `auto_start_request` option back. Added `use_greenlets`
option.
.. versionchanged:: 2.1
Support `w` = integer or string.
Added `ssl` option.
DEPRECATED slave_okay/slaveOk.
.. versionchanged:: 2.0
`slave_okay` is a pure keyword argument. Added support for safe,
and getlasterror options as keyword arguments.
.. versionchanged:: 1.11
Added `max_pool_size`. Completely removed previously deprecated
`pool_size`, `auto_start_request` and `timeout` parameters.
.. versionchanged:: 1.8
The `host` parameter can now be a full `mongodb URI
<http://dochub.mongodb.org/core/connections>`_, in addition
to a simple hostname. It can also be a list of hostnames or
URIs.
.. versionadded:: 1.8
The `tz_aware` parameter.
.. versionadded:: 1.7
The `document_class` parameter.
.. versionadded:: 1.1
The `network_timeout` parameter.
.. mongodoc:: connections
"""
if host is None:
host = self.HOST
if isinstance(host, basestring):
host = [host]
if port is None:
port = self.PORT
if not isinstance(port, int):
raise TypeError("port must be an instance of int")
seeds = set()
username = None
password = None
db = None
options = {}
for entity in host:
if "://" in entity:
if entity.startswith("mongodb://"):
res = uri_parser.parse_uri(entity, port)
seeds.update(res["nodelist"])
username = res["username"] or username
password = res["password"] or password
db = res["database"] or db
options = res["options"]
else:
idx = entity.find("://")
raise InvalidURI("Invalid URI scheme: "
"%s" % (entity[:idx],))
else:
seeds.update(uri_parser.split_hosts(entity, port))
if not seeds:
raise ConfigurationError("need to specify at least one host")
self.__nodes = seeds
self.__host = None
self.__port = None
self.__is_primary = False
self.__is_mongos = False
for option, value in kwargs.iteritems():
option, value = common.validate(option, value)
options[option] = value
self.__max_pool_size = common.validate_positive_integer(
'max_pool_size', max_pool_size)
self.__cursor_manager = CursorManager(self)
self.__repl = options.get('replicaset')
if len(seeds) == 1 and not self.__repl:
self.__direct = True
else:
self.__direct = False
self.__nodes = set()
if network_timeout is not None:
if (not isinstance(network_timeout, (int, float)) or
network_timeout <= 0):
raise ConfigurationError("network_timeout must "
"be a positive integer")
self.__net_timeout = (network_timeout or
options.get('sockettimeoutms'))
self.__conn_timeout = options.get('connecttimeoutms')
self.__use_ssl = options.get('ssl', False)
if self.__use_ssl and not pool.have_ssl:
raise ConfigurationError("The ssl module is not available. If you "
"are using a python version previous to "
"2.6 you must install the ssl package "
"from PyPI.")
if options.get('use_greenlets', False):
if not pool.have_greenlet:
raise ConfigurationError(
"The greenlet module is not available. "
"Install the greenlet package from PyPI."
)
self.pool_class = pool.GreenletPool
else:
self.pool_class = pool.Pool
self.__pool = self.pool_class(
None,
self.__max_pool_size,
self.__net_timeout,
self.__conn_timeout,
self.__use_ssl
)
self.__document_class = document_class
self.__tz_aware = common.validate_boolean('tz_aware', tz_aware)
self.__auto_start_request = options.get('auto_start_request', True)
# cache of existing indexes used by ensure_index ops
self.__index_cache = {}
self.__auth_credentials = {}
super(Connection, self).__init__(**options)
if self.slave_okay:
warnings.warn("slave_okay is deprecated. Please "
"use read_preference instead.", DeprecationWarning)
if _connect:
try:
self.__find_node(seeds)
except AutoReconnect, e:
# ConnectionFailure makes more sense here than AutoReconnect
raise ConnectionFailure(str(e))
def __init__(self, hosts_or_uri=None, max_pool_size=10,
document_class=dict, tz_aware=False, **kwargs):
"""Create a new connection to a MongoDB replica set.
The resultant connection object has connection-pooling built
in. It also performs auto-reconnection when necessary. If an
operation fails because of a connection error,
:class:`~pymongo.errors.ConnectionFailure` is raised. If
auto-reconnection will be performed,
:class:`~pymongo.errors.AutoReconnect` will be
raised. Application code should handle this exception
(recognizing that the operation failed) and then continue to
execute.
Raises :class:`~pymongo.errors.ConnectionFailure` if
the connection cannot be made.
The `hosts_or_uri` parameter can be a full `mongodb URI
<http://dochub.mongodb.org/core/connections>`_, in addition to
a string of `host:port` pairs (e.g. 'host1:port1,host2:port2').
If `hosts_or_uri` is None 'localhost:27017' will be used.
:Parameters:
- `hosts_or_uri` (optional): A MongoDB URI or string of `host:port`
pairs. If a host is an IPv6 literal it must be enclosed in '[' and
']' characters following the RFC2732 URL syntax (e.g. '[::1]' for
localhost)
- `max_pool_size` (optional): The maximum size limit for
each connection pool.
- `document_class` (optional): default class to use for
documents returned from queries on this connection
- `tz_aware` (optional): if ``True``,
:class:`~datetime.datetime` instances returned as values
in a document by this :class:`Connection` will be timezone
aware (otherwise they will be naive)
- `replicaSet`: (required) The name of the replica set to connect to.
The driver will verify that each host it connects to is a member of
this replica set. Can be passed as a keyword argument or as a
MongoDB URI option.
Other optional parameters can be passed as keyword arguments:
- `safe`: Use getlasterror for each write operation?
- `j` or `journal`: Block until write operations have been commited
to the journal. Ignored if the server is running without
journaling. Implies safe=True.
- `w`: (integer or string) If this is a replica set write operations
won't return until they have been replicated to the specified
number or tagged set of servers.
Implies safe=True.
- `wtimeoutMS`: Used in conjunction with `j` and/or `w`. Wait this
many milliseconds for journal acknowledgement and/or write
replication. Implies safe=True.
- `fsync`: Force the database to fsync all files before returning
When used with `j` the server awaits the next group commit before
returning. Implies safe=True.
- `socketTimeoutMS`: How long a send or receive on a socket can take
before timing out.
- `connectTimeoutMS`: How long a connection can take to be opened
before timing out.
- `ssl`: If True, create the connection to the servers using SSL.
- `read_preference`: The read preference for this connection.
See :class:`~pymongo.ReadPreference` for available options.
- `slave_okay` or `slaveOk` (deprecated): Use `read_preference`
instead.
.. versionadded:: 2.1
"""
self.__max_pool_size = max_pool_size
self.__document_class = document_class
self.__tz_aware = tz_aware
self.__opts = {}
self.__seeds = set()
self.__hosts = None
self.__arbiters = set()
self.__writer = None
self.__readers = []
self.__pools = {}
self.__index_cache = {}
self.__auth_credentials = {}
username = None
db_name = None
if hosts_or_uri is None:
self.__seeds.add(('localhost', 27017))
elif '://' in hosts_or_uri:
res = uri_parser.parse_uri(hosts_or_uri)
self.__seeds.update(res['nodelist'])
username = res['username']
password = res['password']
db_name = res['database']
self.__opts = res['options']
else:
self.__seeds.update(uri_parser.split_hosts(hosts_or_uri))
for option, value in kwargs.iteritems():
option, value = common.validate(option, value)
self.__opts[option] = value
self.__name = self.__opts.get('replicaset')
if not self.__name:
raise ConfigurationError("the replicaSet "
"keyword parameter is required.")
self.__net_timeout = self.__opts.get('sockettimeoutms')
self.__conn_timeout = self.__opts.get('connecttimeoutms')
self.__use_ssl = self.__opts.get('ssl', False)
if self.__use_ssl and not pool.have_ssl:
raise ConfigurationError("The ssl module is not available. If you "
"are using a python version previous to "
"2.6 you must install the ssl package "
"from PyPI.")
super(ReplicaSetConnection, self).__init__(**self.__opts)
if self.slave_okay:
warnings.warn("slave_okay is deprecated. Please "
"use read_preference instead.", DeprecationWarning)
self.refresh()
monitor_thread = Monitor(self)
monitor_thread.setName("ReplicaSetMonitorThread")
monitor_thread.setDaemon(True)
monitor_thread.start()
if db_name and username is None:
warnings.warn("must provide a username and password "
"to authenticate to %s" % (db_name,))
if username:
db_name = db_name or 'admin'
if not self[db_name].authenticate(username, password):
raise ConfigurationError("authentication failed")
