Updated Stone

Author: mbogosian

dropbox/stone_serializers.py

@@ -106,6 +106,10 @@ def encode_sub(self, validator, value):
  # serialization
  validate_f = validator.validate
  encode_f = self.encode_list
+ elif isinstance(validator, bv.Map):
+ # Also validate maps during serialization because they are also mutable
+ validate_f = validator.validate
+ encode_f = self.encode_map
  elif isinstance(validator, bv.Nullable):
  validate_f = validator.validate
  encode_f = self.encode_nullable
@@ -139,6 +143,14 @@ def encode_list(self, validator, value):
  """
  raise NotImplementedError
 
+ def encode_map(self, validator, value):
+ # type: (bv.Map, typing.Any) -> typing.Any
+ """
+ Callback for serializing a ``stone_validators.Map``. Arguments
+ have the same semantics as with the ``encode`` method.
+ """
+ raise NotImplementedError
+
  def encode_nullable(self, validator, value):
  # type: (bv.Nullable, typing.Any) -> typing.Any
  """
@@ -222,6 +234,15 @@ def encode_list(self, validator, value):
  return [self.encode_sub(validator.item_validator, value_item) for value_item in
  validated_value]
 
+ def encode_map(self, validator, value):
+ validated_value = validator.validate(value)
+
+ return {
+ self.encode_sub(validator.key_validator, key):
+ self.encode_sub(validator.value_validator, value) for
+ key, value in validated_value.items()
+ }
+
  def encode_nullable(self, validator, value):
  if value is None:
  return None
@@ -461,6 +482,7 @@ def json_decode(
  - Float -> float
  - Integer -> long
  - List -> list
+ - Map -> dict
  - Nullable -> None or its wrapped type.
  - String -> unicode (PY2) or str (PY3)
  - Struct -> An instance of its definition attribute.
@@ -522,6 +544,9 @@ def _json_compat_obj_decode_helper(
  elif isinstance(data_type, bv.List):
  return _decode_list(
  data_type, obj, alias_validators, strict, old_style, for_msgpack)
+ elif isinstance(data_type, bv.Map):
+ return _decode_map(
+ data_type, obj, alias_validators, strict, old_style, for_msgpack)
  elif isinstance(data_type, bv.Nullable):
  return _decode_nullable(
  data_type, obj, alias_validators, strict, old_style, for_msgpack)
@@ -656,7 +681,7 @@ def _decode_union_dict(data_type, obj, alias_validators, strict, for_msgpack):
  raise bv.ValidationError("unexpected key '%s'" % key)
  val = None
  elif isinstance(val_data_type,
- (bv.Primitive, bv.List, bv.StructTree, bv.Union)):
+ (bv.Primitive, bv.List, bv.StructTree, bv.Union, bv.Map)):
  if tag in obj:
  raw_val = obj[tag]
  try:
@@ -812,6 +837,26 @@ def _decode_list(
  for item in obj]
 
 
+def _decode_map(
+ data_type, obj, alias_validators, strict, old_style, for_msgpack):
+ """
+ The data_type argument must be a Map.
+ See json_compat_obj_decode() for argument descriptions.
+ """
+ if not isinstance(obj, dict):
+ raise bv.ValidationError(
+ 'expected dict, got %s' % bv.generic_type_name(obj))
+ return {
+ _json_compat_obj_decode_helper(
+ data_type.key_validator, key, alias_validators, strict,
+ old_style, for_msgpack):
+ _json_compat_obj_decode_helper(
+ data_type.value_validator, value, alias_validators, strict,
+ old_style, for_msgpack)
+ for key, value in obj.items()
+ }
+
+
 def _decode_nullable(
  data_type, obj, alias_validators, strict, old_style, for_msgpack):
  """

dropbox/stone_validators.py

@@ -408,6 +408,26 @@ def validate(self, val):
  return [self.item_validator.validate(item) for item in val]
 
 
+class Map(Composite):
+ """Assumes map keys and values are homogeneous with respect to types."""
+
+ def __init__(self, key_validator, value_validator):
+ """
+ Every Map key/value pair will be validated with item_validator.
+ key validators must be a subclass of a String validator
+ """
+ self.key_validator = key_validator
+ self.value_validator = value_validator
+
+ def validate(self, val):
+ if not isinstance(val, dict):
+ raise ValidationError('%r is not a valid dict' % val)
+ return {
+ self.key_validator.validate(key):
+ self.value_validator.validate(value) for key, value in val.items()
+ }
+
+
 class Struct(Composite):
 
  def __init__(self, definition):