Collect license version as an optional_key in licenses.py

tools/licenses.py

 #!/usr/bin/env python
 # 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.
 
 """Utility for checking and processing licensing information in third_party
 directories.
 
 Usage: licenses.py <command>
 
@@ skipping 236 matching lines @@
     if filename.startswith('/'):
         # Absolute-looking paths are relative to the source root
         # (which is the directory we're run from).
         absolute_path = os.path.join(root, filename[1:])
     else:
         absolute_path = os.path.join(root, path, filename)
     if os.path.exists(absolute_path):
         return absolute_path
     return None
 
-def ParseDir(path, root, require_license_file=True):
+def ParseDir(path, root, require_license_file=True, optional_keys=None):
     """Examine a third_party/foo component and extract its metadata."""
 
     # Parse metadata fields out of README.chromium.
     # We examine "LICENSE" for the license file by default.
     metadata = {
         "License File": "LICENSE",  # Relative path to license text.
         "Name": None,               # Short name (for header on about:credits).
         "URL": None,                # Project home page.
         "License": None,            # Software license.
         }
 
-    # Relative path to a file containing some html we're required to place in
-    # about:credits.
-    optional_keys = ["Required Text", "License Android Compatible"]
+    if optional_keys is None:
+        optional_keys = []
 
     if path in SPECIAL_CASES:
         metadata.update(SPECIAL_CASES[path])
     else:
         # Try to find README.chromium.
         readme_path = os.path.join(root, path, 'README.chromium')
         if not os.path.exists(readme_path):
             raise LicenseError("missing README.chromium or licenses.py "
                                "SPECIAL_CASES entry")
 
@@ skipping 23 matching lines @@
                 break
 
         if require_license_file and not license_path:
             raise LicenseError("License file not found. "
                                "Either add a file named LICENSE, "
                                "import upstream's COPYING if available, "
                                "or add a 'License File:' line to "
                                "README.chromium with the appropriate path.")
         metadata["License File"] = license_path
 
-    if "Required Text" in metadata:
-        required_path = AbsolutePath(path, metadata["Required Text"], root)
-        if required_path is not None:
-            metadata["Required Text"] = required_path
-        else:
-            raise LicenseError("Required text file listed but not found.")
-
     return metadata
 
 
 def ContainsFiles(path, root):
     """Determines whether any files exist in a directory or in any of its
     subdirectories."""
     for _, dirs, files in os.walk(os.path.join(root, path)):
         if files:
             return True
         for vcs_metadata in VCS_METADATA_DIRS:
@@ skipping 86 matching lines @@
         return template
 
     root = os.path.join(os.path.dirname(__file__), '..')
     third_party_dirs = FindThirdPartyDirs(PRUNE_PATHS, root)
 
     entry_template = open(os.path.join(root, 'chrome', 'browser', 'resources',
                                        'about_credits_entry.tmpl'), 'rb').read()
     entries = []
     for path in sorted(third_party_dirs):
         try:
-            metadata = ParseDir(path, root)
+            metadata = ParseDir(path, root, optional_keys=['Required Text'])
         except LicenseError:
             # TODO(phajdan.jr): Convert to fatal error (http://crbug.com/39240).
             continue
         if metadata['License File'] == NOT_SHIPPED:
             continue
         env = {
             'name': metadata['Name'],
             'url': metadata['URL'],
             'license': open(metadata['License File'], 'rb').read(),
             'license_unescaped': '',
         }
+        # 'Required Text' is a relative path to a file containing some html

[Lei Zhang, 2014/10/30 09:14:11]

Fun fact, nobody uses this anymore. It was added solely for swiftshader, which
no longer needs it.

[mckev, 2014/10/30 16:45:13]

Interesting.  Would you advocate removing it now, or doing so in a separate CL?

[Lei Zhang, 2014/10/30 19:06:13]

I'd just remove it and mention it in the CL description.

[mckev, 2014/10/30 20:45:54]

Sounds good to me!

+        # we're required to place in about:credits.
         if 'Required Text' in metadata:
-            required_text = open(metadata['Required Text'], 'rb').read()
+            required_path = AbsolutePath(path, metadata["Required Text"], root)
+            if required_path is not None:
+                required_text = open(required_path, 'rb').read()
+            else:
+                # TODO(phajdan.jr): Convert to fatal error (http://crbug.com/39240).

[Lei Zhang, 2014/10/30 09:14:11]

BTW, 79 chars / line in general with Python. See PEP-8.

[mckev, 2014/10/30 16:45:13]

Whoops, sorry about that.  I'll fix it right away.  Weird that presubmit didn't
catch this one.

+                continue
             env["license_unescaped"] = required_text
         entries.append(EvaluateTemplate(entry_template, env))
 
     file_template = open(os.path.join(root, 'chrome', 'browser', 'resources',
                                       'about_credits.tmpl'), 'rb').read()
     template_contents = "<!-- Generated by licenses.py; do not edit. -->"
     template_contents += EvaluateTemplate(file_template,
                                           {'entries': '\n'.join(entries)},
                                           escape=False)
 
@@ skipping 17 matching lines @@
     elif command == 'credits':
         if not GenerateCredits():
             return 1
     else:
         print __doc__
         return 1
 
 
 if __name__ == '__main__':
   sys.exit(main())