Extensions Docs Server: Split apps from extensions

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.
 
 import os
 
 import third_party.json_schema_compiler.model as model
 from docs_server_utils import SanitizeAPIName
 
 class APIListDataSource(object):
   """ This class creates a list of chrome.* APIs and chrome.experimental.* APIs
   that are used in the api_index.html and experimental.html pages.
   """
   def __init__(self, cache_builder, file_system, api_path, public_path):
     self._cache = cache_builder.build(self._ListAPIs)
     self._file_system = file_system
     self._api_path = api_path + '/'
     self._public_path = public_path + '/'
 
   def _ListAPIs(self, apis):
     api_names = set(SanitizeAPIName(name, self._api_path) for name in apis)
-    public_templates = self._file_system.ReadSingle(self._public_path)
-    template_names = [os.path.splitext(name)[0] for name in public_templates]
-    experimental_apis = []
-    chrome_apis = []
-    for i, template_name in enumerate(sorted(template_names)):
-      if model.UnixName(template_name) in api_names:
-        if template_name.startswith('experimental'):
-          experimental_apis.append({ 'name': template_name.replace('_', '.') })
-        else:
-          chrome_apis.append({ 'name': template_name.replace('_', '.') })
-    chrome_apis[-1]['last'] = True
-    experimental_apis[-1]['last'] = True
-    return {
-      'chrome': chrome_apis,
-      'experimental': experimental_apis
-    }
+    return_dict = {}

[not at google - send to devlin, 2012/08/06 08:38:33]

nit: I would have structured this like

return {
  'apps': self._GetAPIsInSubdirectory(api_names, doc_type),
  'extensions': ...
}

Declaratively clearer exactly what is being returned, so it's easier to
associate it with what's in the templates.

[cduvall, 2012/08/06 18:36:16]

Done.

+    for doc_type in ['apps', 'extensions']:
+      public_templates = self._file_system.ReadSingle(
+          self._public_path + doc_type + '/')
+      template_names = [os.path.splitext(name)[0]
+                        for name in public_templates]
+      experimental_apis = []
+      chrome_apis = []
+      for i, template_name in enumerate(sorted(template_names)):
+        if model.UnixName(template_name) in api_names:
+          if template_name.startswith('experimental'):
+            experimental_apis.append({
+              'name': template_name.replace('_', '.')
+            })
+          else:
+            chrome_apis.append({ 'name': template_name.replace('_', '.') })
+      chrome_apis[-1]['last'] = True
+      experimental_apis[-1]['last'] = True
+      return_dict[doc_type] = {
+        'chrome': chrome_apis,
+        'experimental': experimental_apis
+      }
+    return return_dict
 
   def __getitem__(self, key):
     return self.get(key)
 
   def get(self, key):
     try:
       return self._cache.GetFromFileListing(self._api_path)[key]
     except Exception as e:
       return None