LonamiWebs/Telethon
1
1
Fork 0
mirror of https://github.com/LonamiWebs/Telethon.git synced 2024-09-21 03:08:49 +03:00
Code Issues Packages Projects Releases Wiki Activity

Make use of the new method info when generating docs

Browse Source
This commit is contained in:
Lonami Exo 2018-11-30 21:47:18 +01:00
parent f05109f186
commit 8eca29be25
2 changed files with 8 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
setup.py
View File

@ -54,7 +54,6 @@ DOCS_OUT = 'docs'
def generate(which): def generate(which):
# TODO make docs generator use the new CSV too
from telethon_generator.parsers import\ from telethon_generator.parsers import\
parse_errors, parse_methods, parse_tl, find_layer parse_errors, parse_methods, parse_tl, find_layer
@ -64,8 +63,7 @@ def generate(which):
layer = find_layer(TLOBJECT_IN_TL) layer = find_layer(TLOBJECT_IN_TL)
errors = list(parse_errors(ERRORS_IN)) errors = list(parse_errors(ERRORS_IN))
methods = list(parse_methods(METHODS_IN, {e.str_code: e for e in errors})) methods = list(parse_methods(METHODS_IN, {e.str_code: e for e in errors}))
invalid_bot_methods = {m.name for m in methods invalid_bot_methods = {m.name for m in methods if m.usability == 'user'}
if not m.usability.startswith('bot')}
tlobjects = list(itertools.chain( tlobjects = list(itertools.chain(
parse_tl(TLOBJECT_IN_CORE_TL, layer, invalid_bot_methods), parse_tl(TLOBJECT_IN_CORE_TL, layer, invalid_bot_methods),
@ -110,7 +108,7 @@ def generate(which):
if os.path.isdir(DOCS_OUT): if os.path.isdir(DOCS_OUT):
shutil.rmtree(DOCS_OUT) shutil.rmtree(DOCS_OUT)
else: else:
generate_docs(tlobjects, errors, layer, DOCS_IN_RES, DOCS_OUT) generate_docs(tlobjects, methods, layer, DOCS_IN_RES, DOCS_OUT)
if 'json' in which: if 'json' in which:
which.remove('json') which.remove('json')

19
telethon_generator/generators/docs.py
View File

@ -231,7 +231,7 @@ def _copy_replace(src, dst, replacements):
)) ))
def _write_html_pages(tlobjects, errors, layer, input_res, output_dir): def _write_html_pages(tlobjects, methods, layer, input_res, output_dir):
""" """
Generates the documentation HTML files from from ``scheme.tl`` Generates the documentation HTML files from from ``scheme.tl``
to ``/methods`` and ``/constructors``, etc. to ``/methods`` and ``/constructors``, etc.
@ -263,15 +263,7 @@ def _write_html_pages(tlobjects, errors, layer, input_res, output_dir):
for t, cs in type_to_constructors.items(): for t, cs in type_to_constructors.items():
type_to_constructors[t] = list(sorted(cs, key=lambda c: c.name)) type_to_constructors[t] = list(sorted(cs, key=lambda c: c.name))
# Telegram may send errors with the same str_code but different int_code. methods = {m.name: m for m in methods}
# They are all imported on telethon.errors anyway so makes no difference.
errors = list(sorted({e.str_code: e for e in errors}.values(),
key=lambda e: e.name))
method_causes_errors = defaultdict(list)
for error in errors:
for method in error.caused_by:
method_causes_errors[method].append(error)
# Since the output directory is needed everywhere partially apply it now # Since the output directory is needed everywhere partially apply it now
create_path_for = functools.partial(_get_create_path_for, output_dir) create_path_for = functools.partial(_get_create_path_for, output_dir)
@ -394,7 +386,8 @@ def _write_html_pages(tlobjects, errors, layer, input_res, output_dir):
if tlobject.is_function: if tlobject.is_function:
docs.write_title('Known RPC errors') docs.write_title('Known RPC errors')
errors = method_causes_errors[tlobject.fullname] method_info = methods.get(tlobject.fullname)
errors = method_info and method_info.errors
if not errors: if not errors:
docs.write_text("This request can't cause any RPC error " docs.write_text("This request can't cause any RPC error "
"as far as we know.") "as far as we know.")
@ -650,7 +643,7 @@ def _copy_resources(res_dir, out_dir):
shutil.copy(os.path.join(res_dir, dirname, file), dirpath) shutil.copy(os.path.join(res_dir, dirname, file), dirpath)
def generate_docs(tlobjects, errors, layer, input_res, output_dir): def generate_docs(tlobjects, methods, layer, input_res, output_dir):
os.makedirs(output_dir, exist_ok=True) os.makedirs(output_dir, exist_ok=True)
_write_html_pages(tlobjects, errors, layer, input_res, output_dir) _write_html_pages(tlobjects, methods, layer, input_res, output_dir)
_copy_resources(input_res, output_dir) _copy_resources(input_res, output_dir)