1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471
|
# -*- coding: utf-8 -*-
from __future__ import print_function
from __future__ import unicode_literals
import re
import inspect
import os
import shutil
import six
try:
import pathlib
except ImportError:
import pathlib2 as pathlib
import keras
from keras import backend as K
from keras.backend import numpy_backend
from docs.structure import EXCLUDE
from docs.structure import PAGES
from docs.structure import template_np_implementation
from docs.structure import template_hidden_np_implementation
import sys
if sys.version[0] == '2':
reload(sys)
sys.setdefaultencoding('utf8')
keras_dir = pathlib.Path(__file__).resolve().parents[1]
def get_function_signature(function, method=True):
wrapped = getattr(function, '_original_function', None)
if wrapped is None:
signature = inspect.getfullargspec(function)
else:
signature = inspect.getfullargspec(wrapped)
defaults = signature.defaults
if method:
args = signature.args[1:]
else:
args = signature.args
if defaults:
kwargs = zip(args[-len(defaults):], defaults)
args = args[:-len(defaults)]
else:
kwargs = []
st = '%s.%s(' % (clean_module_name(function.__module__), function.__name__)
for a in args:
st += str(a) + ', '
for a, v in kwargs:
if isinstance(v, str):
v = '\'' + v + '\''
st += str(a) + '=' + str(v) + ', '
if kwargs or args:
signature = st[:-2] + ')'
else:
signature = st + ')'
return post_process_signature(signature)
def get_class_signature(cls):
try:
class_signature = get_function_signature(cls.__init__)
class_signature = class_signature.replace('__init__', cls.__name__)
except (TypeError, AttributeError):
# in case the class inherits from object and does not
# define __init__
class_signature = "{clean_module_name}.{cls_name}()".format(
clean_module_name=cls.__module__,
cls_name=cls.__name__
)
return post_process_signature(class_signature)
def post_process_signature(signature):
parts = re.split(r'\.(?!\d)', signature)
if len(parts) >= 4:
if parts[1] == 'layers':
signature = 'keras.layers.' + '.'.join(parts[3:])
if parts[1] == 'utils':
signature = 'keras.utils.' + '.'.join(parts[3:])
if parts[1] == 'backend':
signature = 'keras.backend.' + '.'.join(parts[3:])
return signature
def clean_module_name(name):
if name.startswith('keras_applications'):
name = name.replace('keras_applications', 'keras.applications')
if name.startswith('keras_preprocessing'):
name = name.replace('keras_preprocessing', 'keras.preprocessing')
return name
def class_to_source_link(cls):
module_name = clean_module_name(cls.__module__)
path = module_name.replace('.', '/')
path += '.py'
line = inspect.getsourcelines(cls)[-1]
link = ('https://github.com/keras-team/'
'keras/blob/master/' + path + '#L' + str(line))
return '[[source]](' + link + ')'
def code_snippet(snippet):
result = '```python\n'
result += snippet.encode('unicode_escape').decode('utf8') + '\n'
result += '```\n'
return result
def count_leading_spaces(s):
ws = re.search(r'\S', s)
if ws:
return ws.start()
else:
return 0
def process_list_block(docstring, starting_point, section_end,
leading_spaces, marker):
ending_point = docstring.find('\n\n', starting_point)
block = docstring[starting_point:
(ending_point - 1 if ending_point > -1
else section_end)]
# Place marker for later reinjection.
docstring_slice = docstring[
starting_point:section_end].replace(block, marker)
docstring = (docstring[:starting_point] +
docstring_slice +
docstring[section_end:])
lines = block.split('\n')
# Remove the computed number of leading white spaces from each line.
lines = [re.sub('^' + ' ' * leading_spaces, '', line) for line in lines]
# Usually lines have at least 4 additional leading spaces.
# These have to be removed, but first the list roots have to be detected.
top_level_regex = r'^ ([^\s\\\(]+):(.*)'
top_level_replacement = r'- __\1__:\2'
lines = [re.sub(top_level_regex, top_level_replacement, line)
for line in lines]
# All the other lines get simply the 4 leading space (if present) removed
lines = [re.sub(r'^ ', '', line) for line in lines]
# Fix text lines after lists
indent = 0
text_block = False
for i in range(len(lines)):
line = lines[i]
spaces = re.search(r'\S', line)
if spaces:
# If it is a list element
if line[spaces.start()] == '-':
indent = spaces.start() + 1
if text_block:
text_block = False
lines[i] = '\n' + line
elif spaces.start() < indent:
text_block = True
indent = spaces.start()
lines[i] = '\n' + line
else:
text_block = False
indent = 0
block = '\n'.join(lines)
return docstring, block
def process_docstring(docstring):
# First, extract code blocks and process them.
code_blocks = []
if '```' in docstring:
tmp = docstring[:]
while '```' in tmp:
tmp = tmp[tmp.find('```'):]
index = tmp[3:].find('```') + 6
snippet = tmp[:index]
# Place marker in docstring for later reinjection.
docstring = docstring.replace(
snippet, '$CODE_BLOCK_%d' % len(code_blocks))
snippet_lines = snippet.split('\n')
# Remove leading spaces.
num_leading_spaces = snippet_lines[-1].find('`')
snippet_lines = ([snippet_lines[0]] +
[line[num_leading_spaces:]
for line in snippet_lines[1:]])
# Most code snippets have 3 or 4 more leading spaces
# on inner lines, but not all. Remove them.
inner_lines = snippet_lines[1:-1]
leading_spaces = None
for line in inner_lines:
if not line or line[0] == '\n':
continue
spaces = count_leading_spaces(line)
if leading_spaces is None:
leading_spaces = spaces
if spaces < leading_spaces:
leading_spaces = spaces
if leading_spaces:
snippet_lines = ([snippet_lines[0]] +
[line[leading_spaces:]
for line in snippet_lines[1:-1]] +
[snippet_lines[-1]])
snippet = '\n'.join(snippet_lines)
code_blocks.append(snippet)
tmp = tmp[index:]
# Format docstring lists.
section_regex = r'\n( +)# (.*)\n'
section_idx = re.search(section_regex, docstring)
shift = 0
sections = {}
while section_idx and section_idx.group(2):
anchor = section_idx.group(2)
leading_spaces = len(section_idx.group(1))
shift += section_idx.end()
next_section_idx = re.search(section_regex, docstring[shift:])
if next_section_idx is None:
section_end = -1
else:
section_end = shift + next_section_idx.start()
marker = '$' + anchor.replace(' ', '_') + '$'
docstring, content = process_list_block(docstring,
shift,
section_end,
leading_spaces,
marker)
sections[marker] = content
# `docstring` has changed, so we can't use `next_section_idx` anymore
# we have to recompute it
section_idx = re.search(section_regex, docstring[shift:])
# Format docstring section titles.
docstring = re.sub(r'\n(\s+)# (.*)\n',
r'\n\1__\2__\n\n',
docstring)
# Strip all remaining leading spaces.
lines = docstring.split('\n')
docstring = '\n'.join([line.lstrip(' ') for line in lines])
# Reinject list blocks.
for marker, content in sections.items():
docstring = docstring.replace(marker, content)
# Reinject code blocks.
for i, code_block in enumerate(code_blocks):
docstring = docstring.replace(
'$CODE_BLOCK_%d' % i, code_block)
return docstring
def add_np_implementation(function, docstring):
np_implementation = getattr(numpy_backend, function.__name__)
code = inspect.getsource(np_implementation)
code_lines = code.split('\n')
for i in range(len(code_lines)):
if code_lines[i]:
# if there is something on the line, add 8 spaces.
code_lines[i] = ' ' + code_lines[i]
code = '\n'.join(code_lines[:-1])
if len(code_lines) < 10:
section = template_np_implementation.replace('{{code}}', code)
else:
section = template_hidden_np_implementation.replace('{{code}}', code)
return docstring.replace('{{np_implementation}}', section)
def read_file(path):
with open(path, encoding='utf-8') as f:
return f.read()
def collect_class_methods(cls, methods):
if isinstance(methods, (list, tuple)):
return [getattr(cls, m) if isinstance(m, str) else m for m in methods]
methods = []
for _, method in inspect.getmembers(cls, predicate=inspect.isroutine):
if method.__name__[0] == '_' or method.__name__ in EXCLUDE:
continue
methods.append(method)
return methods
def render_function(function, method=True):
subblocks = []
signature = get_function_signature(function, method=method)
if method:
signature = signature.replace(
clean_module_name(function.__module__) + '.', '')
subblocks.append('### ' + function.__name__ + '\n')
subblocks.append(code_snippet(signature))
docstring = function.__doc__
if docstring:
if ('backend' in signature and
'{{np_implementation}}' in docstring):
docstring = add_np_implementation(function, docstring)
subblocks.append(process_docstring(docstring))
return '\n\n'.join(subblocks)
def read_page_data(page_data, type):
assert type in ['classes', 'functions', 'methods']
data = page_data.get(type, [])
for module in page_data.get('all_module_{}'.format(type), []):
module_data = []
for name in dir(module):
if name[0] == '_' or name in EXCLUDE:
continue
module_member = getattr(module, name)
if (inspect.isclass(module_member) and type == 'classes' or
inspect.isfunction(module_member) and type == 'functions'):
instance = module_member
if module.__name__ in instance.__module__:
if instance not in module_data:
module_data.append(instance)
module_data.sort(key=lambda x: id(x))
data += module_data
return data
def get_module_docstring(filepath):
"""Extract the module docstring.
Also finds the line at which the docstring ends.
"""
co = compile(open(filepath, encoding='utf-8').read(), filepath, 'exec')
if co.co_consts and isinstance(co.co_consts[0], six.string_types):
docstring = co.co_consts[0]
else:
print('Could not get the docstring from ' + filepath)
docstring = ''
return docstring, co.co_firstlineno
def copy_examples(examples_dir, destination_dir):
"""Copy the examples directory in the documentation.
Prettify files by extracting the docstrings written in Markdown.
"""
pathlib.Path(destination_dir).mkdir(exist_ok=True)
for file in os.listdir(examples_dir):
if not file.endswith('.py'):
continue
module_path = os.path.join(examples_dir, file)
docstring, starting_line = get_module_docstring(module_path)
destination_file = os.path.join(destination_dir, file[:-2] + 'md')
with open(destination_file, 'w+', encoding='utf-8') as f_out, \
open(os.path.join(examples_dir, file),
'r+', encoding='utf-8') as f_in:
f_out.write(docstring + '\n\n')
# skip docstring
for _ in range(starting_line):
next(f_in)
f_out.write('```python\n')
# next line might be empty.
line = next(f_in)
if line != '\n':
f_out.write(line)
# copy the rest of the file.
for line in f_in:
f_out.write(line)
f_out.write('```')
def generate(sources_dir):
"""Generates the markdown files for the documentation.
# Arguments
sources_dir: Where to put the markdown files.
"""
template_dir = os.path.join(str(keras_dir), 'docs', 'templates')
if K.backend() != 'tensorflow':
raise RuntimeError('The documentation must be built '
'with the TensorFlow backend because this '
'is the only backend with docstrings.')
print('Cleaning up existing sources directory.')
if os.path.exists(sources_dir):
shutil.rmtree(sources_dir)
print('Populating sources directory with templates.')
shutil.copytree(template_dir, sources_dir)
readme = read_file(os.path.join(str(keras_dir), 'README.md'))
index = read_file(os.path.join(template_dir, 'index.md'))
index = index.replace('{{autogenerated}}', readme[readme.find('##'):])
with open(os.path.join(sources_dir, 'index.md'), 'w', encoding='utf-8') as f:
f.write(index)
print('Generating docs for Keras %s.' % keras.__version__)
for page_data in PAGES:
classes = read_page_data(page_data, 'classes')
blocks = []
for element in classes:
if not isinstance(element, (list, tuple)):
element = (element, [])
cls = element[0]
subblocks = []
signature = get_class_signature(cls)
subblocks.append('<span style="float:right;">' +
class_to_source_link(cls) + '</span>')
if element[1]:
subblocks.append('## ' + cls.__name__ + ' class\n')
else:
subblocks.append('### ' + cls.__name__ + '\n')
subblocks.append(code_snippet(signature))
docstring = cls.__doc__
if docstring:
subblocks.append(process_docstring(docstring))
methods = collect_class_methods(cls, element[1])
if methods:
subblocks.append('\n---')
subblocks.append('## ' + cls.__name__ + ' methods\n')
subblocks.append('\n---\n'.join(
[render_function(method, method=True)
for method in methods]))
blocks.append('\n'.join(subblocks))
methods = read_page_data(page_data, 'methods')
for method in methods:
blocks.append(render_function(method, method=True))
functions = read_page_data(page_data, 'functions')
for function in functions:
blocks.append(render_function(function, method=False))
if not blocks:
raise RuntimeError('Found no content for page ' +
page_data['page'])
mkdown = '\n----\n\n'.join(blocks)
# Save module page.
# Either insert content into existing page,
# or create page otherwise.
page_name = page_data['page']
path = os.path.join(sources_dir, page_name)
if os.path.exists(path):
template = read_file(path)
if '{{autogenerated}}' not in template:
raise RuntimeError('Template found for ' + path +
' but missing {{autogenerated}}'
' tag.')
mkdown = template.replace('{{autogenerated}}', mkdown)
print('...inserting autogenerated content into template:', path)
else:
print('...creating new page with autogenerated content:', path)
subdir = os.path.dirname(path)
if not os.path.exists(subdir):
os.makedirs(subdir)
with open(path, 'w', encoding='utf-8') as f:
f.write(mkdown)
shutil.copyfile(os.path.join(str(keras_dir), 'CONTRIBUTING.md'),
os.path.join(str(sources_dir), 'contributing.md'))
copy_examples(os.path.join(str(keras_dir), 'examples'),
os.path.join(str(sources_dir), 'examples'))
if __name__ == '__main__':
generate(os.path.join(str(keras_dir), 'docs', 'sources'))
|