stringbone/swiki
1
0
Fork 1
Code Issues Pull requests Projects Releases Packages Wiki Activity

Random PEP8 fixes

Browse source
This commit is contained in:
Milo Fultz 2024-09-01 12:17:31 -07:00
parent e7c33d0baa
commit 046b771779
1 changed files with 35 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

47
swiki.py
View file

@ -118,7 +118,11 @@ def add_last_modified(content: str, last_modified: time) -> str:
if last_modified == time.gmtime(0):
return content
return f'{content}<p class="last-modified">Last modified: {time.strftime(DATE_FORMAT, last_modified)}</p>'
formatted_lm_time = time.strftime(DATE_FORMAT, last_modified)
return (
f'{content}'
f'<p class="last-modified">Last modified: {formatted_lm_time}</p>'
)
def make_page_dict(root: str, rel_path: str, file: str) -> dict:
@ -215,12 +219,17 @@ def format_recent_list(pages: dict, max_length: int) -> str:
page.get('last_modified')
)
title, filename = page.get('title'), page.get('filename')
html += f'''<li>{formatted_lm_time}: <a href="{filename}.html">{title}</a></li>'''
html += (
f'<li>{formatted_lm_time}: '
f'<a href="{filename}.html">{title}</a>'
'</li>'
)
html += '</ul></section>'
return html
def prepare_page_for_file(page_info: dict, filename: str, tab_size: int) -> str:
def prepare_page_for_file(
page_info: dict, filename: str, tab_size: int) -> str:
logger = logging.getLogger('prepare_page_for_file')
logger.debug(dedent(f'\
Running with:\n\
@ -248,7 +257,9 @@ def prepare_page_for_file(page_info: dict, filename: str, tab_size: int) -> str:
page_info.get('content', 'There\'s currently nothing here.')
)
content = content.replace('\t', ' ' * tab_size)
content = f'<h1 id="title">{page_info["metadata"].get("title")}</h1>{content}'
title_text = page_info["metadata"].get("title")
content = f'<h1 id="title">{title_text}</h1>{content}'
content = links.add_external(content)
content = links.add_local(content)
content = links.add_incoming_links(
@ -265,7 +276,8 @@ def prepare_page_for_file(page_info: dict, filename: str, tab_size: int) -> str:
return content
def make_sitemap_header(index_info: dict, pages: dict, build_config: dict) -> str:
def make_sitemap_header(
index_info: dict, pages: dict, build_config: dict) -> str:
logger = logging.getLogger('make_sitemap_header')
logger.debug(dedent(f'\
Running with:\n\
@ -273,7 +285,8 @@ def make_sitemap_header(index_info: dict, pages: dict, build_config: dict) -> st
pages: {pages}\n\
build_config: {build_config}'))
index_html = f'<h1 id="title">{index_info["metadata"].get("title", "Sitemap")}</h1>'
title_text = index_info["metadata"].get("title", "Sitemap")
index_html = f'<h1 id="title">{title_text}</h1>'
index_html += marko.convert(index_info.get('content', ''))
if build_config.get('recent_list'):
index_html += format_recent_list(
@ -289,7 +302,8 @@ def make_wiki_index(sitemap: dict, pages: dict) -> str:
Running with:\n\
sitemap: {sitemap}'))
def convert_folder_to_html(folder_name: str, display_name: str = None) -> str:
def convert_folder_to_html(
folder_name: str, display_name: str = None) -> str:
inner_logger = logger.getChild('convert_folder_to_html')
inner_logger.debug(dedent(f'\
Running with:\n\
@ -306,7 +320,8 @@ def make_wiki_index(sitemap: dict, pages: dict) -> str:
html = f'<details><summary>{display_name}</summary><ul>'
for filename in sorted_folder_list:
page_info = pages.get(filename)
formatted_title = f'<a href="{filename}.html">{page_info["metadata"].get("title")}</a>'
title_text = page_info["metadata"].get("title")
formatted_title = f'<a href="{filename}.html">{title_text}</a>'
if description := page_info["metadata"].get("description"):
html += f'<li>{formatted_title} - {description}</li>'
else:
@ -374,7 +389,10 @@ def make_wiki(pages_dir: str, output_dir: str, build_config: dict):
if filename[0] == '_' or extension != '.md':
logger.debug(f'Other file found: {file}')
if file in other_files:
raise RuntimeError(f'File "{rel_path}/{file}" conflicts with another file "{file}".')
raise RuntimeError(
f'File "{rel_path}/{file}" '
f'conflicts with file "{file}".'
)
copy_wiki_media(subfolder, file, output_dir)
other_files.add(file)
continue
@ -416,9 +434,14 @@ def make_wiki(pages_dir: str, output_dir: str, build_config: dict):
current_folder_path = current_folder + '/'
if rel_path:
existing_folder_path = existing_folder + '/'
current_page = f"{current_folder_path}{page['metadata'].get('title')}"
existing_page = f"{existing_folder_path}{pages[page_filename]['metadata'].get('title')}"
raise RuntimeError(f'Page "{current_page}" with filename "{page_filename}" conflicts with page "{existing_page}" with filename "{page_filename}".')
title_text = page['metadata'].get('title')
current_page = f"{current_folder_path}{title_text}"
existing_page = f"{existing_folder_path}{title_text}"
raise RuntimeError(
f'Page "{current_page}" with filename "{page_filename}" '
f'conflicts with page "{existing_page}" '
f'with filename "{page_filename}".'
)
# Else if page exists and it *is* a stub
elif pages.get(page_filename):
pages[page_filename] |= page