Extensions Docs Server: devtools API

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
 
 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 _SanitizeAPIName(self, name):
+    filename = os.path.splitext(name)[0][len(self._api_path):].replace('/', '_')
+    if 'experimental' in filename:
+      filename = 'experimental_' + filename.replace('experimental_', '')
+    return filename

[not at google - send to devlin, 2012/07/30 08:17:20]

This will have to play well with things like
- links within the API (like $ref:experimental.devtools.foo)
- API lists
- basically any time that a link to an API needs to be generated.

and I note that similar logic is repeated in a few places.

so you might want to pull this logic into a separate module.

[cduvall, 2012/07/31 18:41:45]

This is not used for handling $refs, this is just for handling filenames (like
devtools/panels.json). It handles things like devtools/experimental_panels.json
correctly.

Once this change and the conversion script are in, I'm going to make sure all
the $refs are handled right.

+
   def _ListAPIs(self, apis):
-    api_names = set(os.path.splitext(name)[0] for name in apis)
+    api_names = set(self._SanitizeAPIName(name) 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(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': sorted(chrome_apis),
       'experimental': sorted(experimental_apis)
     }
 
   def __getitem__(self, key):
     return self.get(key)
 
   def get(self, key):
     try:
-      return self._cache.GetFromFile(self._api_path)[key]
+      return self._cache.GetFromFileListing(self._api_path)[key]
     except Exception as e:
       return None