list apis by channel info, e.g. dev, stable

chrome/common/extensions/docs/server2/api_list_data_source.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.
 
 from operator import itemgetter
 import os
 
-from third_party.json_schema_compiler.json_parse import Parse
-import third_party.json_schema_compiler.model as model
 import docs_server_utils as utils
 
 def _GetAPICategory(api, documented_apis):
   name = api['name']
   if (name.endswith('Private') or
       name not in documented_apis):
     return 'private'
   if name.startswith('experimental.'):
     return 'experimental'
   return 'chrome'
@@ skipping 13 matching lines @@
     - It has a dependency in _{api,manifest,permission}_features with an
       "extension_types" property where either/both "extension"/"platform_app"
       values are present.
   """
   class Factory(object):
     def __init__(self,
                  compiled_fs_factory,
                  file_system,
                  public_template_path,
                  features_bundle,
-                 object_store_creator):
+                 object_store_creator,
+                 api_data_source_factory,

[not at google - send to devlin, 2013/10/31 00:05:26]

I don't want to introduce a dependency on api_data_source_factory here.

However, I've put https://codereview.chromium.org/46243003/ through the CQ and
hopefully it'll be submitted soon (by the time you read this?). You should be
able to pass in an api_models class and use that: get the model, then read its
description.

[hukun, 2013/11/01 09:31:52]

Done. Remove dependency of api_data_source_factory, and use api_models.

+                 availability_finder):
       self._file_system = file_system
       def NormalizePath(string):
         return string if string.endswith('/') else (string + '/')
       self._public_template_path = NormalizePath(public_template_path)
       self._cache = compiled_fs_factory.Create(file_system,
                                                self._CollectDocumentedAPIs,
                                                APIListDataSource)
       self._features_bundle = features_bundle
       self._object_store_creator = object_store_creator
+      self._api_data_source = api_data_source_factory.Create(None,
+                                                             disable_refs=True)
+      self._availability_finder = availability_finder
+      self._cached_documented_apis = None
+      self._cachhed_api_features = None

[not at google - send to devlin, 2013/10/31 00:05:26]

the places you get these from do their own caching, you don't need to cache it
here too (probably means you don't need those other methods).

[hukun, 2013/11/01 09:31:52]

Done.remove the cache.

+
+    def _GetDocumentedApis(self):
+      if (not self._cached_documented_apis):
+        self._cached_documented_apis = self._cache.GetFromFileListing(
+          self._public_template_path).Get()
+      return self._cached_documented_apis
+
+    def _GetApiFeatures(self):
+      if (not self._cachhed_api_features) :
+        self._cachhed_api_features = self._features_bundle.GetAPIFeatures()
+      return self._cachhed_api_features
 
     def _CollectDocumentedAPIs(self, base_dir, files):
       def GetDocumentedAPIsForPlatform(names, platform):
         public_templates = []
         for root, _, files in self._file_system.Walk(
             self._public_template_path + platform):
           public_templates.extend(
               ('%s/%s' % (root, name)).lstrip('/') for name in files)
         template_names = set(os.path.splitext(name)[0]
                              for name in public_templates)
         return [name.replace('_', '.') for name in template_names]
       api_names = set(utils.SanitizeAPIName(name) for name in files)
       return {
         'apps': GetDocumentedAPIsForPlatform(api_names, 'apps'),
         'extensions': GetDocumentedAPIsForPlatform(api_names, 'extensions')
       }
 
+    def GetAllNames(self):
+      api_features = self._GetApiFeatures().itervalues()
+      return [api['name'] for api in api_features]
+
     def _GenerateAPIDict(self):
-      documented_apis = self._cache.GetFromFileListing(
-          self._public_template_path).Get()
-      api_features = self._features_bundle.GetAPIFeatures()
+      documented_apis = self._GetDocumentedApis()
+      api_features = self._GetApiFeatures()
 
       def FilterAPIs(platform):
         return (api for api in api_features.itervalues()
             if platform in api['platforms'])
 
       def MakeDictForPlatform(platform):
         platform_dict = { 'chrome': [], 'experimental': [], 'private': [] }
         for api in FilterAPIs(platform):
           category = _GetAPICategory(api, documented_apis[platform])
           platform_dict[category].append(api)
         for category, apis in platform_dict.iteritems():
           platform_dict[category] = sorted(apis, key=itemgetter('name'))
           utils.MarkLast(platform_dict[category])
         return platform_dict
 
+      def MakeDictForChannel(dict_for_platform, availability_finder,
+                             api_data_source):

[not at google - send to devlin, 2013/10/31 00:05:26]

this should still [be able to be arranged to] have access to availability_finder
and api_data_source via self, they don't need to be passed in.

[hukun, 2013/11/01 09:31:52]

Done. Use self' point directly.

+        platform_list = [ 'chrome', 'experimental']
+
+        for platform in platform_list:
+          platform_dict = dict_for_platform[platform]
+          channel_dict = { 'stable': [], 'beta': [], 'dev': [], 'trunk': [] }
+          for api in platform_dict:
+            api_name = api['name']
+            description_list = api_data_source.get(api_name)["introList"];
+            for description in description_list:
+              if description["title"] == 'Description':
+                api['description'] = description['content'][0]['text']
+                break
+            channel_info = availability_finder.GetApiAvailability(api_name)
+            channel = channel_info.channel
+            if channel == 'stable':
+              api['version'] = channel_info.version
+            channel_dict[channel].append(api)
+

[not at google - send to devlin, 2013/10/31 00:05:26]

I'm finding this sa bit hard to follow, can you break it up somehow?

[hukun, 2013/11/01 09:31:52]

Done. Remove my func.

+          for channel, apis in channel_dict.iteritems():
+            channel_dict[channel] = sorted(apis, key=itemgetter('name'))
+            utils.MarkLast(channel_dict[channel])
+          dict_for_platform[platform] = channel_dict
+        return  dict_for_platform
+
       return {
-        'apps': MakeDictForPlatform('apps'),
-        'extensions': MakeDictForPlatform('extensions')
+        'apps': MakeDictForChannel(MakeDictForPlatform('apps'),

[not at google - send to devlin, 2013/10/31 00:05:26]

MakeDictForPlatform('apps') here was right. MakeDictForPlatform should be
responsible for separating that into channels.

[hukun, 2013/11/01 09:31:52]

Done. Still use MakeDictForPlatform

+                                   self._availability_finder,
+                                   self._api_data_source),
+        'extensions': MakeDictForChannel(MakeDictForPlatform('extensions'),
+                                         self._availability_finder,
+                                         self._api_data_source)
       }
 
     def Create(self):
       return APIListDataSource(self, self._object_store_creator)
 
   def __init__(self, factory, object_store_creator):
     self._factory = factory
     self._object_store = object_store_creator.Create(APIListDataSource)
 
   def GetAllNames(self):
-    apis = []
-    for platform in ['apps', 'extensions']:
-      for category in ['chrome', 'experimental', 'private']:
-        apis.extend(self.get(platform).get(category))
-    return [api['name'] for api in apis]
+    data = self._object_store.Get('all_names').Get()
+    if data is None:
+      data = self._factory.GetAllNames()
+      self._object_store.Set('all_names', data)
+    return data
 
   def _GetCachedAPIData(self):
     data = self._object_store.Get('api_data').Get()
     if data is None:
       data = self._factory._GenerateAPIDict()
       self._object_store.Set('api_data', data)
     return data
 
   def get(self, key):
     return self._GetCachedAPIData().get(key)