Extensions Docs Server: Fix handling of nodocs

chrome/common/extensions/docs/server2/handlebar_dict_generator.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 logging
 import os
 
 from docs_server_utils import GetLinkToRefType
 import third_party.json_schema_compiler.model as model
 
 def _RemoveNoDocs(item):
   if type(item) == dict:
     if item.get('nodoc', False):
       return True
     for key, value in item.items():
@@ skipping 10 matching lines @@
   """
   s = str(value)
   return ','.join([s[max(0, i - 3):i] for i in range(len(s), 0, -3)][::-1])
 
 class HandlebarDictGenerator(object):
   """Uses a Model from the JSON Schema Compiler and generates a dict that
   a Handlebar template can use for a data source.
   """
   def __init__(self, json):
     clean_json = copy.deepcopy(json)
-    _RemoveNoDocs(clean_json)
-    try:
+    if _RemoveNoDocs(clean_json):
+      self._namespace = None
+    else:
       self._namespace = model.Namespace(clean_json, clean_json['namespace'])
-    except Exception as e:
-      logging.error(e)
-      raise
 
   def _StripPrefix(self, name):
     if name.startswith(self._namespace.name + '.'):
       return name[len(self._namespace.name + '.'):]
     return name
 
   def _FormatDescription(self, description):
     if description is None or '$ref:' not in description:
       return description
     refs = description.split('$ref:')
     formatted_description = [refs[0]]
     for ref in refs[1:]:
       parts = ref.split(' ', 1)
       if len(parts) == 1:
         ref = parts[0]
         rest = ''
       else:
         ref, rest = parts
         rest = ' ' + rest
       if not ref[-1].isalnum():
         rest = ref[-1] + rest
         ref = ref[:-1]
       ref_dict = GetLinkToRefType(self._namespace.name, ref)
       formatted_description.append('<a href="%(href)s">%(text)s</a>%(rest)s' %
           { 'href': ref_dict['href'], 'text': ref_dict['text'], 'rest': rest })
     return ''.join(formatted_description)
 
   def Generate(self, samples):
-    try:
-      return {
-        'name': self._namespace.name,
-        'types': map(self._GenerateType, self._namespace.types.values()),
-        'functions': self._GenerateFunctions(self._namespace.functions),
-        'events': map(self._GenerateEvent, self._namespace.events.values()),
-        'properties': self._GenerateProperties(self._namespace.properties),
-        'samples': samples,
-      }
-    except Exception as e:
-      logging.error(e)
-      raise
+    if self._namespace is None:
+      return None

[not at google - send to devlin, 2012/08/10 04:48:22]

Is it useful to still return the samples?

And yeah, would rather return {} than None either way.

[cduvall, 2012/08/10 17:34:18]

Done.

+    return {
+      'name': self._namespace.name,
+      'types': map(self._GenerateType, self._namespace.types.values()),
+      'functions': self._GenerateFunctions(self._namespace.functions),
+      'events': map(self._GenerateEvent, self._namespace.events.values()),
+      'properties': self._GenerateProperties(self._namespace.properties),
+      'samples': samples,
+    }
 
   def _GenerateType(self, type_):
     type_dict = {
       'name': self._StripPrefix(type_.name),
       'description': self._FormatDescription(type_.description),
       'properties': self._GenerateProperties(type_.properties),
       'functions': self._GenerateFunctions(type_.functions),
       'events': map(self._GenerateEvent, type_.events.values())
     }
     self._RenderTypeInformation(type_, type_dict)
@@ skipping 84 matching lines @@
     elif property_.type_ == model.PropertyType.ENUM:
       dst_dict['enum_values'] = []
       for enum_value in property_.enum_values:
         dst_dict['enum_values'].append({'name': enum_value})
       if len(dst_dict['enum_values']) > 0:
         dst_dict['enum_values'][-1]['last'] = True
     elif property_.instance_of:
       dst_dict['simple_type'] = property_.instance_of.lower()
     else:
       dst_dict['simple_type'] = property_.type_.name.lower()