Docserver: fix bug where we were overriding hand-written descriptions of

chrome/common/extensions/docs/server2/permissions_data_source.py

 # Copyright 2013 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 itertools import ifilter
 from operator import itemgetter
 
 import features_utility as features
 from third_party.json_schema_compiler.json_parse import Parse
 
 def _ListifyPermissions(permissions):
   '''Filter out any permissions that do not have a description or with a name
   that ends with Private then sort permissions features by name into a list.
   '''
   def filter_permissions(perm):
     return 'description' in perm and not perm['name'].endswith('Private')
 
   return sorted(
       ifilter(filter_permissions, permissions.values()),
       key=itemgetter('name'))
 
 def _AddDependencyDescriptions(permissions, api_features):
   '''Use |api_features| to determine the dependencies APIs have on permissions.
   Add descriptions to |permissions| based on those dependencies.
   '''
   for name, permission in permissions.iteritems():
     # Don't overwrite the description created by expanding a partial template.
-    if 'description' in permission or not permission['platforms']:

[Jeffrey Yasskin, 2013/08/30 19:55:47]

Do "description" keys never appear in the permission dictionary? (This is one
reason it would be nicer to use classes for storing data rather than
dictionaries.)
If "description" keys do appear in the dictionary, where should I look for the
test covering them?

[not at google - send to devlin, 2013/08/30 20:35:33]

Nope, no description. The "partial" key has a string value, the name of the
partial. We add a "description" key which links to the partial named.

Less confusing would be for "partial" to be called "partial_name" and
"description" to be called "partial", but these things come from hindsight and
don't seem a big enough pain to fix.

+    if 'partial' in permission or not permission['platforms']:
       continue
 
     has_deps = False
     if name in api_features:
       for dependency in api_features[name].get('dependencies', ()):
         if dependency.startswith('permission:'):
           has_deps = True
 
     if has_deps:
       permission['partial'] = 'permissions/generic_description'
@@ skipping 48 matching lines @@
         del permission['partial']
 
     return {
       'declare_apps': filter_for_platform(permission_features, 'app'),
       'declare_extensions': filter_for_platform(
           permission_features, 'extension')
     }
 
   def get(self, key):
     return self._cache.GetFromFile(self._permissions_features_path)[key]