Refactoring

Author: daspecster

scripts/generate_json_docs.py

@@ -1,5 +1,19 @@
 # -*- coding: utf-8 -*-
 
+# Copyright 2016 Google Inc. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 import argparse
 import json
 import inspect
@@ -76,7 +90,6 @@ def to_dict(self):
  'params': [p.to_dict() for p in self.params],
  'exceptions': self.exceptions, 'returns': self.returns}
 
-
  @classmethod
  def from_pdoc(cls, element):
  is_class = isinstance(element, pdoc.Class)
@@ -98,7 +111,7 @@ def from_pdoc(cls, element):
  source_path = source_path + "#L" + str(line)
  method.add_source_line(source_path)
 
- # Get examples
+ # Sketchy get examples from method docstring.
  mod_doctest = doctest.DocTestFinder().find(mod)
  for md in mod_doctest:
  for example in md.examples:
@@ -115,6 +128,7 @@ def from_pdoc(cls, element):
  # Hack for old-style classes
  if str(cls)[0] != '<':
  cls = "<class '" + str(cls) + "'>"
+
  method_info = parse_docstring(element.docstring, cls)
 
  for name, data in method_info['arguments'].items():
@@ -154,49 +168,61 @@ def from_docstring_section(cls, name, data):
  types=[data['type_name']])
 
 
-def main():
- BASE_DIR = os.path.abspath(
- os.path.join(os.path.dirname(__file__), '..'))
- DOCS_DIR = os.path.join(BASE_DIR, 'docs') + '/json/'
+def write_docs_file(path, contents):
+ if not os.path.exists(os.path.dirname(path)):
+ try:
+ os.makedirs(os.path.dirname(path))
+ except OSError:
+ raise
+ output_file = open(path, 'w')
+ output_file.write(contents)
 
- parser = argparse.ArgumentParser(description='Document Python modules.')
- parser.add_argument('tag', help='The version of the documentation.')
- args = parser.parse_args()
-
- library_dir = os.path.join(BASE_DIR, 'gcloud')
- public_mods = get_public_modules(library_dir,
- base_package='gcloud')
 
+def generate_doc_types_json(modules, types_file_path):
  doc_types_list = [{
  "id": "gcloud",
  "contents": "__init__.json",
  "title": "__Init__"
  }]
 
- for module_name in public_mods:
- module = Module.from_module_name(module_name)
+ for module_name in modules:
  module_path = module_name.replace('.', '/').replace('gcloud/', '')
- module_docs_path = (DOCS_DIR + args.tag +
- '/' + module_path + '.json')
- print module_docs_path
-
  doc_type_object = {
  "id": module_path,
  "title": " » ".join(module_path.split('/')).title(),
  "contents": module_path + '.json'
  }
  doc_types_list.append(doc_type_object)
 
- if not os.path.exists(os.path.dirname(module_docs_path)):
- try:
- os.makedirs(os.path.dirname(module_docs_path))
- except OSError:
- raise
- output_file = open(module_docs_path, 'w')
- output_file.write(json.dumps(module.to_dict(),
- indent=2, sort_keys=True))
- types_file = open(DOCS_DIR + args.tag + '/types.json', 'w')
- types_file.write(json.dumps(doc_types_list))
+ write_docs_file(types_file_path,
+ json.dumps(doc_types_list))
+
+
+def generate_module_docs(modules, base_path):
+ for module_name in modules:
+ module = Module.from_module_name(module_name)
+ module_path = module_name.replace('.', '/').replace('gcloud/', '')
+ module_docs_path = (base_path +
+ '/' + module_path + '.json')
+
+ write_docs_file(module_docs_path, json.dumps(module.to_dict(),
+ indent=2, sort_keys=True))
+
+
+def main():
+ BASE_DIR = os.path.abspath(os.path.join(os.path.dirname(__file__), '..'))
+ DOCS_DIR = os.path.join(BASE_DIR, 'docs') + '/json/'
+
+ parser = argparse.ArgumentParser(description='Document Python modules.')
+ parser.add_argument('tag', help='The version of the documentation.')
+ args = parser.parse_args()
+
+ library_dir = os.path.join(BASE_DIR, 'gcloud')
+ public_mods = get_public_modules(library_dir,
+ base_package='gcloud')
+
+ generate_module_docs(public_mods, DOCS_DIR + args.tag)
+ generate_doc_types_json(public_mods, DOCS_DIR + args.tag + '/types.json')
 
  copyfile(DOCS_DIR + 'toc.json', DOCS_DIR + args.tag + '/toc.json')