mirror of
https://github.com/LonamiWebs/Telethon.git
synced 2024-11-22 01:16:35 +03:00
Add a more reusable document writer class
This commit is contained in:
Lonami Exo
parent
4abeb0b14a
commit
b50a85bb93
224
docs/docs_writer.py
Normal file
224
docs/docs_writer.py
Normal file
|
|
@ -0,0 +1,224 @@
|
|||
import os
|
||||
|
||||
|
||||
class DocsWriter:
|
||||
"""Utility class used to write the HTML files used on the documentation"""
|
||||
def __init__(self, filename, type_to_path_function):
|
||||
"""Initializes the writer to the specified output file,
|
||||
creating the parent directories when used if required.
|
||||
|
||||
'type_to_path_function' should be a function which, given a type name
|
||||
and a named argument relative_to, returns the file path for the specified
|
||||
type, relative to the given filename"""
|
||||
self.filename = filename
|
||||
self.handle = None
|
||||
|
||||
# Should be set before calling adding items to the menu
|
||||
self.menu_separator_tag = None
|
||||
|
||||
# Utility functions TODO There must be a better way
|
||||
self.type_to_path = lambda t: type_to_path_function(t, relative_to=self.filename)
|
||||
|
||||
# Control signals
|
||||
self.menu_began = False
|
||||
self.table_columns = 0
|
||||
self.table_columns_left = None
|
||||
|
||||
# High level writing
|
||||
def write_head(self, title, relative_css_path):
|
||||
"""Writes the head part for the generated document, with the given title and CSS"""
|
||||
self.write('''<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>''')
|
||||
|
||||
self.write(title)
|
||||
|
||||
self.write('''</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<link href="''')
|
||||
|
||||
self.write(relative_css_path)
|
||||
|
||||
self.write('''" rel="stylesheet">
|
||||
<link href="https://fonts.googleapis.com/css?family=Nunito|Space+Mono" rel="stylesheet">
|
||||
</head>
|
||||
<body>
|
||||
<div id="main_div">''')
|
||||
|
||||
def set_menu_separator(self, relative_image_path):
|
||||
"""Sets the menu separator. Must be called before adding entries to the menu"""
|
||||
if relative_image_path:
|
||||
self.menu_separator_tag = '<img src="%s" alt="/" />' % relative_image_path
|
||||
else:
|
||||
self.menu_separator_tag = None
|
||||
|
||||
def add_menu(self, name, link=None):
|
||||
"""Adds a menu entry, will create it if it doesn't exist yet"""
|
||||
if self.menu_began:
|
||||
if self.menu_separator_tag:
|
||||
self.write(self.menu_separator_tag)
|
||||
else:
|
||||
# First time, create the menu tag
|
||||
self.write('<ul class="horizontal">')
|
||||
self.menu_began = True
|
||||
|
||||
self.write('<li>')
|
||||
if link:
|
||||
self.write('<a href="')
|
||||
self.write(link)
|
||||
self.write('">')
|
||||
|
||||
# Write the real menu entry text
|
||||
self.write(name)
|
||||
|
||||
if link:
|
||||
self.write('</a>')
|
||||
self.write('</li>')
|
||||
|
||||
def end_menu(self):
|
||||
"""Ends an opened menu"""
|
||||
if not self.menu_began:
|
||||
raise ValueError('No menu had been started in the first place.')
|
||||
self.write('</ul>')
|
||||
|
||||
def write_title(self, title, level=1):
|
||||
"""Writes a title header in the document body, with an optional depth level"""
|
||||
self.write('<h%d>' % level)
|
||||
self.write(title)
|
||||
self.write('</h%d>' % level)
|
||||
|
||||
def write_code(self, tlobject):
|
||||
"""Writes the code for the given 'tlobject' properly formatted ith with hyperlinks"""
|
||||
self.write('<pre>---')
|
||||
self.write('functions' if tlobject.is_function else 'types')
|
||||
self.write('---\n')
|
||||
|
||||
# Write the function or type and its ID
|
||||
if tlobject.namespace:
|
||||
self.write(tlobject.namespace)
|
||||
self.write('.')
|
||||
|
||||
self.write(tlobject.name)
|
||||
self.write('#')
|
||||
self.write(hex(tlobject.id)[2:].rjust(8, '0'))
|
||||
|
||||
# Write all the arguments (or do nothing if there's none)
|
||||
for arg in tlobject.args:
|
||||
self.write(' ')
|
||||
|
||||
# "Opening" modifiers
|
||||
if arg.generic_definition:
|
||||
self.write('{')
|
||||
|
||||
# Argument name
|
||||
self.write(arg.name)
|
||||
self.write(':')
|
||||
|
||||
# "Opening" modifiers
|
||||
if arg.is_flag:
|
||||
self.write('flags.%d?' % arg.flag_index)
|
||||
|
||||
if arg.is_generic:
|
||||
self.write('!')
|
||||
|
||||
if arg.is_vector:
|
||||
self.write('<a href="%s">Vector</a><' % self.type_to_path('vector'))
|
||||
|
||||
# Argument type
|
||||
if arg.type:
|
||||
self.write('<a href="')
|
||||
self.write(self.type_to_path(arg.type))
|
||||
self.write('">%s</a>' % arg.type)
|
||||
else:
|
||||
self.write('#')
|
||||
|
||||
# "Closing" modifiers
|
||||
if arg.is_vector:
|
||||
self.write('>')
|
||||
|
||||
if arg.generic_definition:
|
||||
self.write('}')
|
||||
|
||||
# Now write the resulting type (result from a function, or type for a constructor)
|
||||
self.write(' = <a href="')
|
||||
self.write(self.type_to_path(tlobject.result))
|
||||
self.write('">%s</a>' % tlobject.result)
|
||||
|
||||
self.write('</pre>')
|
||||
|
||||
def begin_table(self, column_count):
|
||||
"""Begins a table with the given 'column_count', required to automatically
|
||||
create the right amount of columns when adding items to the rows"""
|
||||
self.table_columns = column_count
|
||||
self.table_columns_left = 0
|
||||
self.write('<table>')
|
||||
|
||||
def add_row(self, text, link=None, bold=False, align=None):
|
||||
"""This will create a new row, or add text to the next column
|
||||
of the previously created, incomplete row, closing it if complete"""
|
||||
if not self.table_columns_left:
|
||||
# Starting a new row
|
||||
self.write('<tr>')
|
||||
self.table_columns_left = self.table_columns
|
||||
|
||||
self.write('<td')
|
||||
if align:
|
||||
self.write(' style="text-align:')
|
||||
self.write(align)
|
||||
self.write('"')
|
||||
self.write('>')
|
||||
|
||||
if bold:
|
||||
self.write('<b>')
|
||||
if link:
|
||||
self.write('<a href="')
|
||||
self.write(link)
|
||||
self.write('">')
|
||||
|
||||
# Finally write the real table data, the given text
|
||||
self.write(text)
|
||||
|
||||
if link:
|
||||
self.write('</a>')
|
||||
if bold:
|
||||
self.write('</b>')
|
||||
|
||||
self.write('</td>')
|
||||
|
||||
self.table_columns_left -= 1
|
||||
if not self.table_columns_left:
|
||||
self.write('</tr>')
|
||||
|
||||
def end_table(self):
|
||||
# If there was any column left, finish it before closing the table
|
||||
if self.table_columns_left:
|
||||
self.write('</tr>')
|
||||
|
||||
self.write('</table>')
|
||||
|
||||
def write_text(self, text):
|
||||
"""Writes a paragraph of text"""
|
||||
self.write('<p>')
|
||||
self.write(text)
|
||||
self.write('</p>')
|
||||
|
||||
def end_body(self):
|
||||
"""Ends the whole document. This should be called the last"""
|
||||
self.write('</div></body></html>')
|
||||
|
||||
# "Low" level writing
|
||||
def write(self, s):
|
||||
"""Wrapper around handle.write"""
|
||||
self.handle.write(s)
|
||||
|
||||
# With block
|
||||
def __enter__(self):
|
||||
# Sanity check
|
||||
os.makedirs(os.path.dirname(self.filename), exist_ok=True)
|
||||
self.handle = open(self.filename, 'w', encoding='utf-8')
|
||||
return self
|
||||
|
||||
def __exit__(self, exc_type, exc_val, exc_tb):
|
||||
self.handle.close()
|
||||
Loading…
Reference in New Issue
Block a user