Extensions Docs Server: Efficient MemcacheFileSystem

chrome/common/extensions/docs/server2/file_system.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
 
 def _ProcessFileData(data, path):
   if os.path.splitext(path)[-1] not in ['.js', '.html', '.json']:
     return data
   try:
     return unicode(data, 'utf-8')
   except:
     return unicode(data, 'latin-1')
 
 class FileSystem(object):
   """A FileSystem interface that can read files and directories.
   """
   class StatInfo(object):
     """The result of calling Stat on a FileSystem.
     """
-    def __init__(self, version):
+    def __init__(self, version, child_versions):
       self.version = version
+      self.child_versions = child_versions
 
   def Read(self, paths, binary=False):
     """Reads each file in paths and returns a dictionary mapping the path to the
     contents. If a path in paths ends with a '/', it is assumed to be a
     directory, and a list of files in the directory is mapped to the path.
 
     If binary=False, the contents of each file will be unicode parsed as utf-8,
     and failing that as latin-1 (some extension docs use latin-1). If
     binary=True then the contents will be a str.
     """
     raise NotImplementedError()
 
   def ReadSingle(self, path):
     """Reads a single file from the FileSystem.
     """
     return self.Read([path]).Get()[path]
 
   def Stat(self, path):
-    """Gets the version number of |path| if it is a directory, or the parent
-    directory if it is a file.
+    """Returns a |StatInfo| object containing the version of the parent
+    directory if a file is specified, or the directory itself if a directory is
+    specified. The |StatInfo| object also has the versions of all the children
+    of the directory.

[not at google - send to devlin, 2012/08/10 06:42:24]

This would be a strange interface.

If a file, it should return a StatInfo for the file. An implementation might end
up getting the stat for the whole directory the pulling just that single file
out (inefficient but whatever).

(If callers want the directory's stat, they should figure out what the directory
is then Stat that).

If a directory... what you've written is correct.

[cduvall, 2012/08/11 00:15:23]

Done.

     """
     raise NotImplementedError()