Added JSON schema compiler support for serialized types

tools/json_schema_compiler/model.py

 # Copyright (c) 2012 The Chromium Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
 import copy
 import os.path
 import re
 
 class ParseException(Exception):
   """Thrown when data in the model is invalid.
@@ skipping 132 matching lines @@
 class Property(object):
   """A property of a type OR a parameter to a function.
 
   Properties:
   - |name| name of the property as in the json. This shouldn't change since
     it is the key used to access DictionaryValues
   - |unix_name| the unix_style_name of the property. Used as variable name
   - |optional| a boolean representing whether the property is optional
   - |description| a description of the property (if provided)
   - |type_| the model.PropertyType of this property
+  - |serialized_type| the model.PropertyType that this property should be
+    serialized to. Will be None if it's missing from the JSON.
   - |ref_type| the type that the REF property is referencing. Can be used to
     map to its model.Type
   - |item_type| a model.Property representing the type of each element in an
     ARRAY
   - |properties| the properties of an OBJECT parameter
   - |from_client| indicates that instances of the Type can originate from the
     users of generated code, such as top-level types and function results
   - |from_json| indicates that instances of the Type can originate from the
     JSON (as described by the schema), such as top-level types and function
     parameters
   """
 
   def __init__(self, parent, name, json, is_additional_properties=False,
       from_json=False, from_client=False):
     self.name = name
     self._unix_name = UnixName(self.name)
     self._unix_name_used = False
     self.optional = json.get('optional', False)
     self.functions = {}
     self.has_value = False
     self.description = json.get('description')
     self.parent = parent
     self.from_json = from_json
     self.from_client = from_client
     self.instance_of = json.get('isInstanceOf', None)
+    self.serialized_type = None
     _AddProperties(self, json)
     if is_additional_properties:
       self.type_ = PropertyType.ADDITIONAL_PROPERTIES
     elif '$ref' in json:
       self.ref_type = json['$ref']
       self.type_ = PropertyType.REF
     elif 'enum' in json and json.get('type') == 'string':
       # Non-string enums (as in the case of [legalValues=(1,2)]) should fall
       # through to the next elif.
       self.enum_values = []
@@ skipping 21 matching lines @@
         self.type_ = PropertyType.OBJECT
         # These members are read when this OBJECT Property is used as a Type
         type_ = Type(self, self.name, json)
         # self.properties will already have some value from |_AddProperties|.
         self.properties.update(type_.properties)
         self.functions = type_.functions
       elif json_type == 'binary':
         self.type_ = PropertyType.BINARY
       else:
         raise ParseException(self, 'type ' + json_type + ' not recognized')
+
+      if 'serialized_type' in json:
+        json_serialized_type = json['serialized_type']
+        if json_serialized_type == 'integer':
+          self.serialized_type = PropertyType.INTEGER
+        elif json_serialized_type == 'int64':
+          self.serialized_type = PropertyType.INT64
+        else:

[not at google - send to devlin, 2012/07/26 04:51:42]

this might as well be the same code that parses 'type' into a PropertyType. Can
you pull that into a helper?

Let code that uses the model support what it can.

[mitchellwrosen, 2012/07/26 20:00:27]

Hmm. Correct me if I'm wrong but it may not make sense to consider the same set
of types valid for both type_ and compiled_type. What about gurl and int64?
Those could only exist on the c++ side. Furthermore, it may be awkward to pull
into a helper function because there is special handling in the case that
json_type is an array or an object.

What do you think?

[not at google - send to devlin, 2012/07/27 04:14:28]

Yes, that's true. Hmm.

For for the types that only make sense for compiled code, that can be left to
the generators to figure out; nothing bad will happen.

For the types where special stuff is done, we can easily pull that out into
here. Like,

def _JsonTypeToPropertyType(json_type):
  if json_type == 'string':
    return PropertyType.STRING
  if json_type == 'any':
    return PropertyType.ANY
  ...
  if json_type == 'int64'
    return PropertyType.INT_64
  raise NotImplementedError(...)

then here,

self.type_ = _JsonToPropertyType(json['type'])
if self.type_ is PropertyType.ARRAY:
  # normal array stuff
elif self.type_ = PropertyType.OBJECT:
  # normal object stuff

compiled_type = json.get('compiled_type', None)
if compiled_type:
  self.compiled_type = _JsonToPropertyType(compiled_type)

[mitchellwrosen, 2012/07/30 20:52:45]

Done.

+          # TODO(mwrosen): Support more types as necessary.
+          raise ParseException(self, 'type ' + json_serialized_type +
+              ' not recognized')
     elif 'choices' in json:
       if not json['choices'] or len(json['choices']) == 0:
         raise ParseException(self, 'Choices has no choices')
       self.choices = {}
       self.type_ = PropertyType.CHOICES
       for choice_json in json['choices']:
         choice = Property(self, self.name, choice_json,
             from_json=from_json,
             from_client=from_client)
         choice.unix_name = UnixName(self.name + choice.type_.name)
@@ skipping 49 matching lines @@
   """
   class _Info(object):
     def __init__(self, is_fundamental, name):
       self.is_fundamental = is_fundamental
       self.name = name
 
     def __repr__(self):
       return self.name
 
   INTEGER = _Info(True, "INTEGER")
+  INT64 = _Info(True, "INT64")

[not at google - send to devlin, 2012/07/26 04:51:42]

ooh maybe we can use this to serialize GURLs directly later!

[mitchellwrosen, 2012/07/26 20:00:27]

What do you mean?

[not at google - send to devlin, 2012/07/27 04:14:28]

I made this comment first. Just meant what I said about GURL earlier.

   DOUBLE = _Info(True, "DOUBLE")
   BOOLEAN = _Info(True, "BOOLEAN")
   STRING = _Info(True, "STRING")
   ENUM = _Info(False, "ENUM")
   ARRAY = _Info(False, "ARRAY")
   REF = _Info(False, "REF")
   CHOICES = _Info(False, "CHOICES")
   OBJECT = _Info(False, "OBJECT")
   BINARY = _Info(False, "BINARY")
   ANY = _Info(False, "ANY")
@@ skipping 61 matching lines @@
     # handled in pure Javascript on the render process (and .: never reach
     # C++ let alone the browser).
     if property_json.get('type') == 'function':
       continue
     model.properties[name] = Property(
         model,
         name,
         property_json,
         from_json=from_json,
         from_client=from_client)