Dynamically generate a heading for Extension Docs API pages

chrome/common/extensions/docs/server2/branch_utility.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 json
 import logging
 import operator
 
 from appengine_wrappers import GetAppVersion
 from object_store_creator import ObjectStoreCreator
 
 class BranchUtility(object):
   def __init__(self, fetch_url, fetcher, object_store=None):
     self._fetch_url = fetch_url
     self._fetcher = fetcher
     if object_store is None:
       object_store = (ObjectStoreCreator.SharedFactory(GetAppVersion())
           .Create(BranchUtility).Create())
     self._object_store = object_store
 
   @staticmethod
   def GetAllBranchNames():
     return ['stable', 'beta', 'dev', 'trunk']
 
   def GetAllBranchNumbers(self):
-    return [(branch, self.GetBranchNumberForChannelName(branch))
+    return [(branch, self.GetChannelInfoForChannelName(branch)['branch'])
             for branch in BranchUtility.GetAllBranchNames()]
 
+  def GetAllVersionNumbers(self):
+    return [self.GetChannelInfoForChannelName(branch)['version']
+            for branch in self.GetAllBranchNames()]
+
+  def GetChannelInfoForAllChannels(self):
+    return [self.GetChannelInfoForChannelName(branch)
+            for branch in self.GetAllBranchNames()]
+
   @staticmethod
   def SplitChannelNameFromPath(path):
     """Splits the channel name out of |path|, returning the tuple
     (channel_name, real_path). If the channel cannot be determined then returns
     (None, path).
     """
     if '/' in path:
       first, second = path.split('/', 1)
     else:
       first, second = (path, '')
     if first in ['trunk', 'dev', 'beta', 'stable']:
       return (first, second)
     return (None, path)
 
-  def GetBranchNumberForChannelName(self, channel_name):
-    """Returns the branch number for a channel name.
+  def GetChannelInfoForChannelName(self, channel):
+    return {
+      'name': channel,
+      'branch': self._ExtractFromVersionJson(channel, 'branch'),
+      'version': self._ExtractFromVersionJson(channel, 'version')
+    }

[not at google - send to devlin, 2013/04/27 01:48:34]

can you make this return an actual struct so that field are accessed like
info.branch not info['branch']?

[epeterson, 2013/04/27 23:17:23]

Done(?) Is this what you had in mind?

[not at google - send to devlin, 2013/04/30 17:20:30]

Yep, thanks.

+
+  def _ExtractFromVersionJson(self, channel_name, data_type):
+    """Returns the branch or version number for a channel name.
     """
     if channel_name == 'trunk':
       return 'trunk'
 
-    branch_number = self._object_store.Get(channel_name).Get()
-    if branch_number is not None:
-      return branch_number
+    data = self._object_store.Get('%s.%s' % (channel_name, data_type)).Get()
+    if data is not None:
+      return data
 
     try:
       version_json = json.loads(self._fetcher.Fetch(self._fetch_url).content)
     except Exception as e:
       # This can happen if omahaproxy is misbehaving, which we've seen before.
       # Quick hack fix: just serve from trunk until it's fixed.
       logging.error('Failed to fetch or parse branch from omahaproxy: %s! '
                     'Falling back to "trunk".' % e)
       return 'trunk'
 
-    branch_numbers = {}
+    numbers = {}
     for entry in version_json:
       if entry['os'] not in ['win', 'linux', 'mac', 'cros']:
         continue
       for version in entry['versions']:
         if version['channel'] != channel_name:
           continue
-        branch = version['version'].split('.')[2]
-        if branch not in branch_numbers:
-          branch_numbers[branch] = 0
+        if data_type == 'branch':
+          number = version['version'].split('.')[2]
+        elif data_type == 'version':
+          number = version['version'].split('.')[0]
+        if number not in numbers:
+          numbers[number] = 0
         else:
-          branch_numbers[branch] += 1
+          numbers[number] += 1
 
-    sorted_branches = sorted(branch_numbers.iteritems(),
-                             None,
-                             operator.itemgetter(1),
-                             True)
-    self._object_store.Set(channel_name, sorted_branches[0][0])
+    sorted_numbers = sorted(numbers.iteritems(),
+                            None,
+                            operator.itemgetter(1),
+                            True)
+    self._object_store.Set('%s.%s' % (channel_name, data_type),
+                           sorted_numbers[0][0])
 
-    return sorted_branches[0][0]
+    return sorted_numbers[0][0]