Code generation for extensions api

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 os.path
+
+class Model(object):
+  """Model of the API.
+  """
+  def __init__(self):
+    self.namespaces = {}
+    self.types = {}
+
+  def add_namespace(self, json, source_file, namespace_suffix):
+    """Add a namespace's json to the model if it has a "compile" property set
+    to true. Returns the new namespace or None if a namespac wasn't added.
+    """
+    if not json.get('compile'):
+      return None
+    namespace = Namespace(json, source_file, namespace_suffix)
+    self.namespaces[namespace.name] = namespace
+    for tipe in namespace.types.values():
+      self.types[tipe.name] = namespace
+    return namespace
+
+class Namespace(object):
+  """An API namespace.
+  """
+  def __init__(self, json, source_file, namespace_suffix):
+    self.name = json['namespace']
+    self.source_file = source_file
+    self.source_file_dir, self.source_file_filename = os.path.split(source_file)
+    self.target_namespace = self.name + namespace_suffix
+    self.type_dependencies = {}
+    self.types = {}
+    self.functions = {}
+    for type_json in json['types']:
+      tipe = Type(type_json)
+      self.types[tipe.name] = tipe
+    for function_json in json['functions']:
+      if not function_json.get('nocompile'):
+        function = Function(function_json)
+        self.functions[function.name] = function
+
+class Type(object):
+  """A Type defined in the json.
+  """
+  def __init__(self, json):
+    self.name = json['id']
+    self.description = json.get('description')
+    self.properties = {}
+    for prop_name, prop_json in json['properties'].items():
+      self.properties[prop_name] = Property(prop_name, prop_json)
+
+class Callback(object):
+  """A callback parameter to a Function.
+  """
+  def __init__(self, json):
+    params = json['parameters']
+    if len(params) == 0:
+      self.param = None
+    elif len(params) == 1:
+      param = params[0]
+      self.param = Property(param['name'], param)
+    else:
+      raise AssertionError("Callbacks can have at most a single parameter")
+
+class Function(object):
+  """A Function defined in the API.
+  """
+  def __init__(self, json):
+    self.name = json['name']
+    self.params = []
+    self.description = json['description']
+    self.callback = None
+    self.type_dependencies = {}
+    for param in json['parameters']:
+      if param.get('type') == 'function':
+        assert (not self.callback), "Function has more than one callback"
+        self.callback = Callback(param)
+      else:
+        self.params.append(Property(param['name'], param))
+    assert (self.callback), "Function does not support callback"
+
+# TODO(calamity): handle Enum/choices
+class Property(object):
+  """A property of a type OR a parameter to a function.
+
+  Members will change based on PropertyType. Check self.type to determine which
+  members actually exist.
+  """
+  def __init__(self, name, json):
+    self.name = name
+    self.optional = json.get('optional', False)
+    self.description = json.get('description')
+    # TODO(calamity) maybe check for circular refs? could that be a problem?
+    fundamental_types = {
+      'string': PropertyType.STRING,
+      'boolean': PropertyType.BOOLEAN,
+      'integer': PropertyType.INTEGER,
+      'double': PropertyType.DOUBLE
+    }
+    if '$ref' in json:
+      self.ref_type = json['$ref']
+      self.type = PropertyType.REF
+    elif 'type' in json:
+      json_type = json['type']
+      if json_type in fundamental_types:
+        self.type = fundamental_types[json_type]

[not at google - send to devlin, 2012/01/18 06:57:28]

ditto: be explicit, don't have fundamental_types

[calamity, 2012/01/18 09:35:18]

Done.

+      elif json_type == 'array':
+        self.item_type = Property(name + "_inner", json['items'])
+        self.type = PropertyType.ARRAY
+      elif json_type == 'object':
+        self.properties = {}
+        self.type = PropertyType.OBJECT
+        for key, val in json['properties'].items():
+          self.properties[key] = Property(key, val)
+      else:
+        raise NotImplementedError(json_type)
+    elif 'choices' in json:
+      self.type = PropertyType.CHOICES
+      self.choices = {}
+
+class PropertyType(object):
+  """Enum of different types of properties/parameters.
+  """
+  INTEGER, DOUBLE, BOOLEAN, STRING, ARRAY, REF, CHOICES, OBJECT = range(8)

[not at google - send to devlin, 2012/01/18 06:57:28]

sorry to keep on messing with you here, but it seems like a safer way to express
this would be like

class PropertyType:
  class Info:
    def __init__(self, is_fundamental):
      self.is_fundamental = is_fundamental

  INTEGER = Info(True)
  DOUBLE = Info(True)
  ...
  OBJECT = Info(False)

which would be a Java-style enum.

all the other code would work the same way, except now you can say

property.type.is_fundamental rather than PropertyType.is_fundamental(prop)

and I hate static methods and like instance methods, so that's a nice thing. 
and that also opens up possibilities for putting other things on the object, if
necessary.

[calamity, 2012/01/18 09:35:18]

Done.

+
+  @staticmethod
+  def is_fundamental(prop):

[not at google - send to devlin, 2012/01/18 06:57:28]

comment above notwithstanding, I kind of regret saying it because it seems like
overkill at this point.

in any case, certainly, if this method should exist at all it should take a type
not a property, since the method is in PropertyType.

+    """Returns True if the property is of a fundamental type.
+    """
+    return (prop.type in [
+        PropertyType.INTEGER,
+        PropertyType.DOUBLE,
+        PropertyType.BOOLEAN,
+        PropertyType.STRING
+    ])