Skip to content

Commit

Permalink
refactor: files formatted with black and isort
Browse files Browse the repository at this point in the history
  • Loading branch information
@jurgenwigg
jurgenwigg committed Oct 3, 2023
1 parent cd157b6 commit e3c0ba7
Show file tree
Hide file tree
Showing 11 changed files with 204 additions and 198 deletions.
170 changes: 89 additions & 81 deletions mkpdfs_mkdocs/generator.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,87 +3,99 @@
import sys
from uuid import uuid4

from weasyprint import HTML, urls, CSS
from bs4 import BeautifulSoup
from weasyprint import CSS, HTML, urls
from weasyprint.text.fonts import FontConfiguration

from mkpdfs_mkdocs.preprocessor import get_combined as prep_combined
from mkpdfs_mkdocs.preprocessor import get_separate as prep_separate
from mkpdfs_mkdocs.utils import gen_address

from .utils import is_external
from mkpdfs_mkdocs.preprocessor import get_separate as prep_separate, get_combined as prep_combined

log = logging.getLogger(__name__)


class Generator(object):

def __init__(self):
self.config = None
self.design = None
self.mkdconfig = None
self.nav = None
self.title = None
self.logger = logging.getLogger('mkdocs.mkpdfs')
self.logger = logging.getLogger("mkdocs.mkpdfs")
self.generate = True
self._articles = {}
self._page_order = []
self._base_urls = {}
self._toc = None
self.html = BeautifulSoup('<html><head></head>\
<body></body></html>',
'html.parser')
self.html = BeautifulSoup(
"<html><head></head>\
<body></body></html>",
"html.parser",
)
self.dir = os.path.dirname(os.path.realpath(__file__))
self.design = os.path.join(self.dir, 'design/report.css')
self.design = os.path.join(self.dir, "design/report.css")

def set_config(self, local, config):
self.config = local
if self.config['design']:
css_file = os.path.join(os.getcwd(), self.config['design'])
if self.config["design"]:
css_file = os.path.join(os.getcwd(), self.config["design"])
if not os.path.isfile(css_file):
sys.exit('The file {} specified for design has not \
been found.'.format(css_file))
sys.exit(
"The file {} specified for design has not \
been found.".format(
css_file
)
)
self.design = css_file
self.title = config['site_name']
self.config['copyright'] = 'CC-BY-SA\
' if not config['copyright'] else config['copyright']
self.title = config["site_name"]
self.config["copyright"] = (
"CC-BY-SA\
"
if not config["copyright"]
else config["copyright"]
)
self.mkdconfig = config

def write(self):
if not self.generate:
self.logger.log(msg='Unable to generate the PDF Version (See Mkpdfs doc)',
level=logging.WARNING, )
self.logger.log(
msg="Unable to generate the PDF Version (See Mkpdfs doc)",
level=logging.WARNING,
)
return
self.gen_articles()
font_config = FontConfiguration()
self.add_head()
pdf_path = os.path.join(self.mkdconfig['site_dir'],
self.config['output_path'])
pdf_path = os.path.join(self.mkdconfig["site_dir"], self.config["output_path"])
os.makedirs(os.path.dirname(pdf_path), exist_ok=True)
html = HTML(string=str(self.html)).write_pdf(pdf_path,
font_config=font_config)
self.logger.log(msg='The PDF version of the documentation has been generated.', level=logging.INFO, )
html = HTML(string=str(self.html)).write_pdf(pdf_path, font_config=font_config)
self.logger.log(
msg="The PDF version of the documentation has been generated.",
level=logging.INFO,
)

def add_nav(self, nav):
self.nav = nav
for p in nav:
self.add_to_order(p)

def add_to_order(self, page):
if page.is_page and page.meta and 'pdf' in page.meta and not page.meta['pdf']:
if page.is_page and page.meta and "pdf" in page.meta and not page.meta["pdf"]:
return
if page.is_page:
self._page_order.append(page.file.url)
elif page.children:
uuid = str(uuid4())
self._page_order.append(uuid)
title = self.html.new_tag('h1',
id='{}-title'.format(uuid),
**{'class': 'section_title'}
)
title = self.html.new_tag(
"h1", id="{}-title".format(uuid), **{"class": "section_title"}
)
title.append(page.title)
article = self.html.new_tag('article',
id='{}'.format(uuid),
**{'class': 'chapter'}
)
article = self.html.new_tag(
"article", id="{}".format(uuid), **{"class": "chapter"}
)
article.append(title)
self._articles[uuid] = article
for child in page.children:
Expand All @@ -96,60 +108,58 @@ def add_article(self, content, page, base_url):
if not self.generate:
return None
self._base_urls[page.file.url] = base_url
soup = BeautifulSoup(content, 'html.parser')
url = page.url.split('.')[0]
article = soup.find('article')
soup = BeautifulSoup(content, "html.parser")
url = page.url.split(".")[0]
article = soup.find("article")
if not article:
article = self.html.new_tag('article')
eld = soup.find('div', **{'role': 'main'})
article = self.html.new_tag("article")
eld = soup.find("div", **{"role": "main"})
article.append(eld)
article.div['class'] = article.div['role'] = None
article.div["class"] = article.div["role"] = None

if not article:
self.generate = False
return None
article = prep_combined(article, base_url, page.file.url)
if page.meta and 'pdf' in page.meta and not page.meta['pdf']:
if page.meta and "pdf" in page.meta and not page.meta["pdf"]:
# print(page.meta)
return self.get_path_to_pdf(page.file.dest_path)
self._articles[page.file.url] = article
return self.get_path_to_pdf(page.file.dest_path)

def add_head(self):
lines = ['<title>{}</title>'.format(self.title)]
lines = ["<title>{}</title>".format(self.title)]
for key, val in (
("author", self.config['author'] or self.mkdconfig['site_author']),
("description", self.mkdconfig['site_description']),
("author", self.config["author"] or self.mkdconfig["site_author"]),
("description", self.mkdconfig["site_description"]),
):
if val:
lines.append('<meta name="{}" content="{}">'.format(key, val))
for css in (self.design,):
if css:
css_tmpl = '<link rel="stylesheet" href="{}" type="text/css">'
lines.append(css_tmpl.format(urls.path2url(css)))
head = BeautifulSoup('\n'.join(lines), 'html5lib')
head = BeautifulSoup("\n".join(lines), "html5lib")
self.html.head.clear()
self.html.head.insert(0, head)

def get_path_to_pdf(self, start):
pdf_split = os.path.split(self.config['output_path'])
pdf_split = os.path.split(self.config["output_path"])
start_dir = os.path.split(start)[0]
return os.path.join(os.path.relpath(pdf_split[0],
start_dir), pdf_split[1])
return os.path.join(os.path.relpath(pdf_split[0], start_dir), pdf_split[1])

def add_tocs(self):
title = self.html.new_tag('h1', id='toc-title')
title.insert(0, self.config['toc_title'])
self._toc = self.html.new_tag('article', id='contents')
title = self.html.new_tag("h1", id="toc-title")
title.insert(0, self.config["toc_title"])
self._toc = self.html.new_tag("article", id="contents")
self._toc.insert(0, title)
for n in self.nav:
if n.is_page and n.meta and 'pdf' in n.meta \
and not n.meta['pdf']:
if n.is_page and n.meta and "pdf" in n.meta and not n.meta["pdf"]:
continue
if hasattr(n, 'url') and is_external(n.url):
if hasattr(n, "url") and is_external(n.url):
# Skip toc generation for external links
continue
h3 = self.html.new_tag('h3')
h3 = self.html.new_tag("h3")
h3.insert(0, n.title)
self._toc.append(h3)
if n.is_page:
Expand All @@ -160,49 +170,47 @@ def add_tocs(self):
self.html.body.append(self._toc)

def add_cover(self):
a = self.html.new_tag('article', id='doc-cover')
title = self.html.new_tag('h1', id='doc-title')
a = self.html.new_tag("article", id="doc-cover")
title = self.html.new_tag("h1", id="doc-title")
title.insert(0, self.title)
a.insert(0, title)
a.append(gen_address(self.config))
self.html.body.append(a)

def gen_articles(self):
self.add_cover()
if self.config['toc_position'] == 'pre':
if self.config["toc_position"] == "pre":
self.add_tocs()
for url in self._page_order:
if url in self._articles:
self.html.body.append(self._articles[url])
if self.config['toc_position'] == 'post':
if self.config["toc_position"] == "post":
self.add_tocs()

def get_path_to_pdf(self, start):
pdf_split = os.path.split(self.config['output_path'])
start_dir = os.path.split(start)[0] if os.path.split(start)[0] else '.'
return os.path.join(os.path.relpath(pdf_split[0], start_dir),
pdf_split[1])
pdf_split = os.path.split(self.config["output_path"])
start_dir = os.path.split(start)[0] if os.path.split(start)[0] else "."
return os.path.join(os.path.relpath(pdf_split[0], start_dir), pdf_split[1])

def _gen_toc_section(self, section):
if section.children: # External Links do not have children
for p in section.children:
if p.is_page and p.meta and 'pdf' \
in p.meta and not p.meta['pdf']:
if p.is_page and p.meta and "pdf" in p.meta and not p.meta["pdf"]:
continue
if not hasattr(p, 'file'):
if not hasattr(p, "file"):
# Skip external links
continue
stoc = self._gen_toc_for_section(p.file.url, p)
child = self.html.new_tag('div')
child = self.html.new_tag("div")
child.append(stoc)
self._toc.append(child)

def _gen_children(self, url, children):
ul = self.html.new_tag('ul')
ul = self.html.new_tag("ul")
for child in children:
a = self.html.new_tag('a', href=child.url)
a = self.html.new_tag("a", href=child.url)
a.insert(0, child.title)
li = self.html.new_tag('li')
li = self.html.new_tag("li")
li.append(a)
if child.children:
sub = self._gen_children(url, child.children)
Expand All @@ -211,22 +219,22 @@ def _gen_children(self, url, children):
return ul

def _gen_toc_for_section(self, url, p):
div = self.html.new_tag('div')
menu = self.html.new_tag('div')
h4 = self.html.new_tag('h4')
a = self.html.new_tag('a', href='#')
div = self.html.new_tag("div")
menu = self.html.new_tag("div")
h4 = self.html.new_tag("h4")
a = self.html.new_tag("a", href="#")
a.insert(0, p.title)
h4.append(a)
menu.append(h4)
ul = self.html.new_tag('ul')
ul = self.html.new_tag("ul")
if p.toc:
for child in p.toc.items:
a = self.html.new_tag('a', href=child.url)
a = self.html.new_tag("a", href=child.url)
a.insert(0, child.title)
li = self.html.new_tag('li')
li = self.html.new_tag("li")
li.append(a)
if child.title == p.title:
li = self.html.new_tag('div')
li = self.html.new_tag("div")
if child.children:
sub = self._gen_children(url, child.children)
li.append(sub)
Expand All @@ -235,14 +243,14 @@ def _gen_toc_for_section(self, url, p):
menu.append(ul)
div.append(menu)
div = prep_combined(div, self._base_urls[url], url)
return div.find('div')
return div.find("div")

def _gen_toc_page(self, url, toc):
div = self.html.new_tag('div')
menu = self.html.new_tag('ul')
div = self.html.new_tag("div")
menu = self.html.new_tag("ul")
for item in toc.items:
li = self.html.new_tag('li')
a = self.html.new_tag('a', href=item.url)
li = self.html.new_tag("li")
a = self.html.new_tag("a", href=item.url)
a.append(item.title)
li.append(a)
menu.append(li)
Expand All @@ -251,4 +259,4 @@ def _gen_toc_page(self, url, toc):
menu.append(child)
div.append(menu)
div = prep_combined(div, self._base_urls[url], url)
return div.find('ul')
return div.find("ul")
Loading

0 comments on commit e3c0ba7

Please sign in to comment.