|
| 1 | +# Copyright 2016 Google Inc. All rights reserved. |
| 2 | +# |
| 3 | +# Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 | +# you may not use this file except in compliance with the License. |
| 5 | +# You may obtain a copy of the License at |
| 6 | +# |
| 7 | +# http://www.apache.org/licenses/LICENSE-2.0 |
| 8 | +# |
| 9 | +# Unless required by applicable law or agreed to in writing, software |
| 10 | +# distributed under the License is distributed on an "AS IS" BASIS, |
| 11 | +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 | +# See the License for the specific language governing permissions and |
| 13 | +# limitations under the License. |
| 14 | + |
| 15 | +"""Check if all public modules are included in our docs.""" |
| 16 | + |
| 17 | + |
| 18 | +from __future__ import print_function |
| 19 | + |
| 20 | +import os |
| 21 | +import sys |
| 22 | +import warnings |
| 23 | + |
| 24 | +from sphinx.ext.intersphinx import fetch_inventory |
| 25 | + |
| 26 | + |
| 27 | +BASE_DIR = os.path.abspath( |
| 28 | + os.path.join(os.path.dirname(__file__), '..')) |
| 29 | +DOCS_DIR = os.path.join(BASE_DIR, 'docs') |
| 30 | +OBJECT_INVENTORY_RELPATH = os.path.join('_build', 'html', 'objects.inv') |
| 31 | +IGNORED_PREFIXES = ('test_', '_') |
| 32 | +IGNORED_MODULES = frozenset([ |
| 33 | + 'gcloud.bigtable.client', |
| 34 | + 'gcloud.bigtable.cluster', |
| 35 | + 'gcloud.bigtable.column_family', |
| 36 | + 'gcloud.bigtable.happybase.connection', |
| 37 | + 'gcloud.bigtable.row', |
| 38 | + 'gcloud.bigtable.table', |
| 39 | + 'gcloud.datastore.demo.demo', |
| 40 | + 'gcloud.demo', |
| 41 | + 'gcloud.iterator', |
| 42 | + 'gcloud.storage.demo.demo', |
| 43 | + 'gcloud.streaming.buffered_stream', |
| 44 | + 'gcloud.streaming.exceptions', |
| 45 | + 'gcloud.streaming.http_wrapper', |
| 46 | + 'gcloud.streaming.stream_slice', |
| 47 | + 'gcloud.streaming.transfer', |
| 48 | + 'gcloud.streaming.util', |
| 49 | +]) |
| 50 | + |
| 51 | + |
| 52 | +class SphinxApp(object): |
| 53 | + """Mock app to interact with Sphinx helpers.""" |
| 54 | + warn = warnings.warn |
| 55 | + srcdir = DOCS_DIR |
| 56 | + |
| 57 | + |
| 58 | +def is_valid_module(filename): |
| 59 | + """Determines if a filename is a valid Python module. |
| 60 | +
|
| 61 | + Assumes if is just the end of a path (i.e. does not contain |
| 62 | + ``os.path.sep``. |
| 63 | +
|
| 64 | + :type filename: string |
| 65 | + :param filename: The name of a file. |
| 66 | +
|
| 67 | + :rtype: bool |
| 68 | + :returns: Flag indicating if the filename is valid. |
| 69 | + """ |
| 70 | + if not filename.endswith('.py'): |
| 71 | + return False |
| 72 | + for prefix in IGNORED_PREFIXES: |
| 73 | + if filename.startswith(prefix): |
| 74 | + return False |
| 75 | + return True |
| 76 | + |
| 77 | + |
| 78 | +def get_public_modules(path, base_package=None): |
| 79 | + """Get list of all public modules relative to a path. |
| 80 | +
|
| 81 | + :type path: string |
| 82 | + :param path: The path containing the python modules. |
| 83 | +
|
| 84 | + :type base_package: string |
| 85 | + :param base_package: (Optional) A package to prepend in |
| 86 | + front of the path. |
| 87 | +
|
| 88 | + :rtype: list |
| 89 | + :returns: List of all modules found. |
| 90 | + """ |
| 91 | + result = [] |
| 92 | + for subdir, _, files in os.walk(path): |
| 93 | + # Skip folders that start with _. |
| 94 | + if any([part.startswith('_') |
| 95 | + for part in subdir.split(os.path.sep)]): |
| 96 | + continue |
| 97 | + _, rel_dir = subdir.split(path) |
| 98 | + rel_dir = rel_dir.lstrip(os.path.sep) |
| 99 | + for filename in files: |
| 100 | + if is_valid_module(filename): |
| 101 | + mod_name, _ = os.path.splitext(filename) |
| 102 | + rel_path = os.path.join(rel_dir, mod_name) |
| 103 | + if base_package is not None: |
| 104 | + rel_path = os.path.join(base_package, rel_path) |
| 105 | + # Turn into a Python module rather than a file path. |
| 106 | + result.append(rel_path.replace(os.path.sep, '.')) |
| 107 | + |
| 108 | + return result |
| 109 | + |
| 110 | + |
| 111 | +def main(): |
| 112 | + """Main script to verify modules included.""" |
| 113 | + mock_uri = '' |
| 114 | + inventory = fetch_inventory(SphinxApp, mock_uri, |
| 115 | + OBJECT_INVENTORY_RELPATH) |
| 116 | + sphinx_mods = set(inventory['py:module'].keys()) |
| 117 | + |
| 118 | + library_dir = os.path.join(BASE_DIR, 'gcloud') |
| 119 | + public_mods = get_public_modules(library_dir, |
| 120 | + base_package='gcloud') |
| 121 | + public_mods = set(public_mods) |
| 122 | + |
| 123 | + if not sphinx_mods <= public_mods: |
| 124 | + message = ('Unexpected error. There were modules referenced by ' |
| 125 | + 'Sphinx that are not among the public modules.') |
| 126 | + print(message, file=sys.stderr) |
| 127 | + sys.exit(1) |
| 128 | + |
| 129 | + undocumented_mods = public_mods - sphinx_mods |
| 130 | + # Remove ignored modules. |
| 131 | + undocumented_mods -= IGNORED_MODULES |
| 132 | + if undocumented_mods: |
| 133 | + message_parts = ['Found undocumented public modules:'] |
| 134 | + message_parts.extend(['- ' + mod_name |
| 135 | + for mod_name in sorted(undocumented_mods)]) |
| 136 | + print('\n'.join(message_parts), file=sys.stderr) |
| 137 | + sys.exit(1) |
| 138 | + |
| 139 | + |
| 140 | +if __name__ == '__main__': |
| 141 | + main() |
0 commit comments