PYTHON-959 - Connection string spec compliance.

Author: aherlihy

pymongo/client_options.py

@@ -107,8 +107,6 @@ class ClientOptions(object):
  def __init__(self, username, password, database, options):
  self.__options = 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)

pymongo/common.py

@@ -16,11 +16,12 @@
 """Functions and classes common to multiple pymongo modules."""
 
 import collections
+import warnings
 
 from bson.binary import (STANDARD, PYTHON_LEGACY,
  JAVA_LEGACY, CSHARP_LEGACY)
 from bson.codec_options import CodecOptions
-from bson.py3compat import string_type, integer_types
+from bson.py3compat import string_type, integer_types, iteritems
 from pymongo.auth import MECHANISMS
 from pymongo.errors import ConfigurationError
 from pymongo.read_preferences import (read_pref_mode_from_name,
@@ -74,6 +75,7 @@
 # Error codes to ignore if GridFS calls createIndex on a secondary
 UNAUTHORIZED_CODES = (13, 16547, 16548)
 
+
 def partition_node(node):
  """Split a host:port string into (host, int(port)) pair."""
  host = node
@@ -340,15 +342,16 @@ def validate_auth_mechanism_properties(option, value):
  for opt in value.split(','):
  try:
  key, val = opt.split(':')
- if key not in _MECHANISM_PROPS:
- raise ValueError("%s is not a supported auth "
- "mechanism property. Must be one of "
- "%s." % (key, tuple(_MECHANISM_PROPS)))
- props[key] = val
  except ValueError:
  raise ValueError("auth mechanism properties must be "
  "key:value pairs like SERVICE_NAME:"
  "mongodb, not %s." % (opt,))
+ if key not in _MECHANISM_PROPS:
+ raise ValueError("%s is not a supported auth "
+ "mechanism property. Must be one of "
+ "%s." % (key, tuple(_MECHANISM_PROPS)))
+ props[key] = val
+
  return props
 
 
@@ -456,6 +459,23 @@ def validate(option, value):
  return lower, value
 
 
+def get_validated_options(options):
+ """Validate each entry in options and raise a warning if it is not valid.
+ Returns a copy of options with invalid entries removed
+ """
+ validated_options = {}
+ for opt, value in iteritems(options):
+ lower = opt.lower()
+ try:
+ validator = VALIDATORS.get(lower, raise_config_error)
+ value = validator(opt, value)
+ except (ValueError, ConfigurationError) as exc:
+ warnings.warn(str(exc))
+ else:
+ validated_options[lower] = value
+ return validated_options
+
+
 WRITE_CONCERN_OPTIONS = frozenset([
  'w',
  'wtimeout',
@@ -516,4 +536,3 @@ def read_preference(self):
  The :attr:`read_preference` attribute is now read only.
  """
  return self.__read_preference
-

pymongo/mongo_client.py

@@ -300,7 +300,7 @@ def __init__(
  for entity in host:
  if "://" in entity:
  if entity.startswith("mongodb://"):
- res = uri_parser.parse_uri(entity, port, False)
+ res = uri_parser.parse_uri(entity, port, warn=True)
  seeds.update(res["nodelist"])
  username = res["username"] or username
  password = res["password"] or password
@@ -321,10 +321,14 @@ def __init__(
  monitor_class = kwargs.pop('_monitor_class', None)
  condition_class = kwargs.pop('_condition_class', None)
 
- opts['document_class'] = document_class
- opts['tz_aware'] = tz_aware
- opts['connect'] = connect
- opts.update(kwargs)
+ 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)
 
@@ -792,6 +796,9 @@ def option_repr(option, value):
  else:
  return 'document_class=%s.%s' % (value.__module__,
  value.__name__)
+ if "ms" in option:
+ return "%s='%s'" % (option, int(value * 1000))
+
  return '%s=%r' % (option, value)
 
  # Host first...

pymongo/uri_parser.py

@@ -14,6 +14,7 @@
 
 
 """Tools to parse and validate a MongoDB URI."""
+import warnings
 
 from bson.py3compat import PY3, iteritems, string_type
 
@@ -22,7 +23,7 @@
 else:
  from urllib import unquote_plus
 
-from pymongo.common import validate as _validate
+from pymongo.common import (validate as _validate, get_validated_options)
 from pymongo.errors import ConfigurationError, InvalidURI
 
 
@@ -129,6 +130,8 @@ def parse_host(entity, default_port=DEFAULT_PORT):
  port = default_port
  if entity[0] == '[':
  host, port = parse_ipv6_literal_host(entity, default_port)
+ elif entity.endswith(".sock"):
+ return entity, default_port
  elif entity.find(':') != -1:
  if entity.count(':') > 1:
  raise ValueError("Reserved characters such as ':' must be "
@@ -137,8 +140,9 @@ def parse_host(entity, default_port=DEFAULT_PORT):
  "and ']' according to RFC 2732.")
  host, port = host.split(':', 1)
  if isinstance(port, string_type):
- if not port.isdigit():
- raise ValueError("Port number must be an integer.")
+ if not port.isdigit() or int(port) > 65535 or int(port) <= 0:
+ raise ValueError("Port must be an integer between 0 and 65535: %s"
+ % (port,))
  port = int(port)
 
  # Normalize hostname to lowercase, since DNS is case-insensitive:
@@ -148,15 +152,23 @@ def parse_host(entity, default_port=DEFAULT_PORT):
  return host.lower(), port
 
 
-def validate_options(opts):
+def validate_options(opts, warn=False):
  """Validates and normalizes options passed in a MongoDB URI.
 
- Returns a new dictionary of validated and normalized options.
+ Returns a new dictionary of validated and normalized options. If warn is
+ False then errors will be thrown for invalid options, otherwise they will
+ be ignored and a warning will be issued.
 
  :Parameters:
  - `opts`: A dict of MongoDB URI options.
+ - `warn` (optional): If ``True`` then warnigns will be logged and
+ invalid options will be ignored. Otherwise invalid options will
+ cause errors.
  """
- return dict([_validate(opt, val) for opt, val in iteritems(opts)])
+ if warn:
+ return get_validated_options(opts)
+ else:
+ return dict([_validate(opt, val) for opt, val in iteritems(opts)])
 
 
 def _parse_options(opts, delim):
@@ -172,11 +184,21 @@ def _parse_options(opts, delim):
  # 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.
- options[str(key)] = val
+ if str(key) in options:
+ warnings.warn("Duplicate URI option %s" % (str(key),))
+ options[str(key)] = unquote_plus(val)
+
+ # Special case for deprecated options
+ if "wtimeout" in options:
+ if "wtimeoutMS" in options:
+ options.pop("wtimeout")
+ warnings.warn("Option wtimeout is deprecated, use 'wtimeoutMS'"
+ " instead")
+
  return options
 
 
-def split_options(opts, validate=True):
+def split_options(opts, validate=True, warn=False):
  """Takes the options portion of a MongoDB URI, validates each option
  and returns the options in a dictionary.
 
@@ -202,7 +224,7 @@ def split_options(opts, validate=True):
  raise InvalidURI("MongoDB URI options are key=value pairs.")
 
  if validate:
- return validate_options(options)
+ return validate_options(options, warn)
  return options
 
 
@@ -232,7 +254,7 @@ def split_hosts(hosts, default_port=DEFAULT_PORT):
  return nodes
 
 
-def parse_uri(uri, default_port=DEFAULT_PORT, validate=True):
+def parse_uri(uri, default_port=DEFAULT_PORT, validate=True, warn=False):
  """Parse and validate a MongoDB URI.
 
  Returns a dict of the form::
@@ -252,6 +274,13 @@ def parse_uri(uri, default_port=DEFAULT_PORT, validate=True):
  for a host in the URI.
  - `validate`: If ``True`` (the default), validate and normalize all
  options.
+ - `warn` (optional): When validating, if ``True`` then will warn
+ the user then ignore any invalid options or values. If ``False``,
+ validation will error when options are unsupported or values are
+ invalid.
+
+ .. versionchanged:: 3.1
+ ``warn`` added so invalid options can be ignored.
  """
  if not uri.startswith(SCHEME):
  raise InvalidURI("Invalid URI scheme: URI "
@@ -262,7 +291,6 @@ def parse_uri(uri, default_port=DEFAULT_PORT, validate=True):
  if not scheme_free:
  raise InvalidURI("Must provide at least one hostname or IP.")
 
- nodes = None
  user = None
  passwd = None
  dbase = None
@@ -272,11 +300,14 @@ def parse_uri(uri, default_port=DEFAULT_PORT, validate=True):
  # Check for unix domain sockets in the uri
  if '.sock' in scheme_free:
  host_part, _, path_part = _rpartition(scheme_free, '/')
- try:
- parse_uri('%s%s' % (SCHEME, host_part))
- except (ConfigurationError, InvalidURI):
- host_part = scheme_free
+ if not host_part:
+ host_part = path_part
  path_part = ""
+ if '/' in host_part:
+ raise InvalidURI("Any '/' in a unix domain socket must be"
+ " URL encoded: %s" % host_part)
+ host_part = unquote_plus(host_part)
+ path_part = unquote_plus(path_part)
  else:
  host_part, _, path_part = _partition(scheme_free, '/')
 
@@ -302,7 +333,12 @@ def parse_uri(uri, default_port=DEFAULT_PORT, validate=True):
  dbase, collection = dbase.split('.', 1)
 
  if opts:
- options = split_options(opts, validate)
+ options = split_options(opts, validate, warn)
+
+ if dbase is not None:
+ dbase = unquote_plus(dbase)
+ if collection is not None:
+ collection = unquote_plus(collection)
 
  return {
  'nodelist': nodes,