fix: Plugin broke with last update

Author: Mara-Li

environment.yml

@@ -0,0 +1 @@
+name: Publish

mkdocs_embed_file_plugins/plugin.py

@@ -21,56 +21,56 @@ def search_in_file(citation_part: str, contents: str):
         contents: The file contents
     Returns: the part found
     """
-    data = contents.split("\n")
-    if "#" not in citation_part:
+    data = contents.split('\n')
+    if '#' not in citation_part:
         # All text citation
         return contents
-    elif "#" in citation_part and not "^" in citation_part:
+    elif '#' in citation_part and not '^' in citation_part:
         # cite from title
         sub_section = []
-        citation_part = citation_part.replace("-", " ").replace("#", "# ")
+        citation_part = citation_part.replace('-', ' ').replace('#', '# ')
         heading = 0
         for i in data:
-            if citation_part in i and i.startswith("#"):
-                heading = i.count("#") * (-1)
+            if citation_part in i and i.startswith('#'):
+                heading = i.count('#') * (-1)
                 sub_section.append([i])
             elif heading != 0:
-                inverse = i.count("#") * (-1)
+                inverse = i.count('#') * (-1)
                 if inverse == 0 or heading > inverse:
                     sub_section.append([i])
                 elif inverse >= heading:
                     break
         sub_section = [x for y in sub_section for x in y]
-        sub_section = "\n".join(sub_section)
+        sub_section = '\n'.join(sub_section)
         return sub_section
-    elif "#^" in citation_part:
+    elif '#^' in citation_part:
         # cite from block
-        citation_part = citation_part.replace("#", "")
+        citation_part = citation_part.replace('#', '')
         for i in data:
             if citation_part in i:
-                return i.replace(citation_part, "")
+                return i.replace(citation_part, '')
     return []
 
 
 def mini_ez_links(urlo, base, end, url_whitespace, url_case):
     base, url_blog = base
-    url_blog_path = [x for x in url_blog.split("/") if len(x) > 0]
+    url_blog_path = [x for x in url_blog.split('/') if len(x) > 0]
     url_blog_path = url_blog_path[len(url_blog_path) - 1]
     all_docs = [
-        re.sub(rf"(.*)({url_blog_path})?/docs/*", "", x.replace("\\", "/")).replace(
-            ".md", ""
+        re.sub(rf"(.*)({url_blog_path})?/docs/*", '', x.replace('\\', '/')).replace(
+            '.md', ''
         )
-        for x in iglob(str(base) + os.sep + "**", recursive=True)
+        for x in iglob(str(base) + os.sep + '**', recursive=True)
         if os.path.isfile(x)
     ]
-    file_name = urlo[2].replace("index", "")
+    file_name = urlo[2].replace('index', '')
     file_found = [
-        "/" + x for x in all_docs if os.path.basename(x) == file_name or x == file_name
+        '/' + x for x in all_docs if os.path.basename(x) == file_name or x == file_name
     ]
     if file_found:
-        file_path = file_found[0].replace(base, "")
-        url = file_path.replace("\\", "/").replace(".md", "")
-        url = url.replace("//", "/")
+        file_path = file_found[0].replace(base, '')
+        url = file_path.replace('\\', '/').replace('.md', '')
+        url = url.replace('//', '/')
         url = url_blog[:-1] + quote(url)
         if not url.startswith(('https:/', 'http:/')):
             url = 'https://' + url
@@ -82,8 +82,8 @@ def mini_ez_links(urlo, base, end, url_whitespace, url_case):
 
 
 def cite(md_link_path, link, soup, citation_part, config):
-    """
-    Append the content of the founded file to the original file.
+    """Append the content of the founded file to the original file.
+
     Args:
         md_link_path: File found
         link: Line with the citation
@@ -92,21 +92,21 @@ def cite(md_link_path, link, soup, citation_part, config):
         config: the config file
     Returns: updated HTML
     """
-    docs = config["docs_dir"]
-    url = config["site_url"]
+    docs = config['docs_dir']
+    url = config['site_url']
     md_config = {
-        "mdx_wikilink_plus": {
-            "base_url": (docs, url),
-            "build_url": mini_ez_links,
-            "image_class": "wikilink",
+        'mdx_wikilink_plus': {
+            'base_url': (docs, url),
+            'build_url': mini_ez_links,
+            'image_class': 'wikilink',
         }
     }
     new_uri = str(md_link_path).replace(str(docs), str(url))
-    new_uri = new_uri.replace("\\", "/")
-    new_uri = new_uri.replace(".md", "/")
-    new_uri = new_uri.replace("//", "/")
-    new_uri = re.sub("https?:\/", "\g<0>/", new_uri)
-    input_file = codecs.open(str(md_link_path), mode="r", encoding="utf-8")
+    new_uri = new_uri.replace('\\', '/')
+    new_uri = new_uri.replace('.md', '/')
+    new_uri = new_uri.replace('//', '/')
+    new_uri = re.sub('https?:\/', '\g<0>/', new_uri)
+    input_file = codecs.open(str(md_link_path), mode='r', encoding='utf-8')
     text = input_file.read()
 
     contents = frontmatter.loads(text).content
@@ -115,35 +115,36 @@ def cite(md_link_path, link, soup, citation_part, config):
         html = markdown.markdown(
             quote,
             extensions=[
-                "nl2br",
-                "footnotes",
-                "attr_list",
-                "mdx_breakless_lists",
-                "smarty",
-                "sane_lists",
-                "tables",
-                "admonition",
-                WikiLinkPlusExtension(md_config["mdx_wikilink_plus"]),
+                'nl2br',
+                'footnotes',
+                'attr_list',
+                'mdx_breakless_lists',
+                'smarty',
+                'sane_lists',
+                'tables',
+                'admonition',
+                WikiLinkPlusExtension(md_config['mdx_wikilink_plus']),
             ],
         )
-        link_soup = BeautifulSoup(html, "html.parser")
+        link_soup = BeautifulSoup(html, 'html.parser')
         if link_soup:
             tooltip_template = (
-                "<a href='"
-                + str(new_uri)
-                + "' class='link_citation'><i class='fas fa-link'></i> </a> <div"
-                " class='citation'>"
-                + str(link_soup).replace(
-                    '!<img class="wikilink', '<img class="wikilink'
-                )
-                + "</div>"
+                    "<a href='"
+                    + str(new_uri)
+                    + "' class='link_citation'><i class='fas fa-link'></i> </a> <div"
+                      " class='citation'>"
+                    + str(link_soup).replace(
+                '!<img class="wikilink', '<img class="wikilink'
+            )
+                    + '</div>'
             )
     else:
         tooltip_template = (
-            "<div class='not_found'>" + str(link["src"].replace("/", "")) + "</div>"
+                "<div class='not_found'>" +
+                str(link['src'].replace('/', '')) + '</div>'
         )
     new_soup = str(soup).replace(str(link), str(tooltip_template))
-    soup = BeautifulSoup(new_soup, "html.parser")
+    soup = BeautifulSoup(new_soup, 'html.parser')
     return soup
 
 
@@ -156,92 +157,94 @@ def search_doc(md_link_path, all_docs):
     Returns: Path to link found or 0 otherwise
 
     """
-    if os.path.basename(md_link_path) == ".md":
-        md_link_path = str(md_link_path).replace(f"{os.sep}.md", f"{os.sep}index.md")
+    if os.path.basename(md_link_path) == '.md':
+        md_link_path = str(md_link_path).replace(
+            f'{os.sep}.md', f'{os.sep}index.md')
     else:
-        md_link_path = str(md_link_path).replace(f"{os.sep}.md", "")
+        md_link_path = str(md_link_path).replace(f'{os.sep}.md', '')
     file = [x for x in all_docs if Path(x) == Path(md_link_path)]
     if len(file) > 0:
         return file[0]
     return 0
 
 
-def on_post_page(output_content, page, config):
-    soup = BeautifulSoup(output_content, "html.parser")
-    docs = Path(config["docs_dir"])
-    md_link_path = ""
-    all_docs = [
-        x
-        for x in iglob(str(docs) + os.sep + "**", recursive=True)
-        if x.endswith(".md")
-    ]
-
-    for link in soup.findAll(
-        "img",
-        src=lambda src: src is not None
-        and "favicon" not in src
-        and not src.endswith(("png", "jpg", "jpeg", "gif")),
-    ):
-        if len(link["src"]) > 0:
-
-            if link["src"][0] == ".":
-                md_src_path = link["src"][3:-1] + ".md"
-                md_src_path = md_src_path.replace(".m.md", ".md")
-                md_link_path = os.path.join(
-                    os.path.dirname(page.file.abs_src_path), md_src_path
-                )
-                md_link_path = Path(unquote(md_link_path)).resolve()
-
-            elif link["src"][0] == "/":
-                if link["src"].endswith("/"):
-                    md_src_path = link["src"][:-1] + ".md"
-                else:
-                    md_src_path = link["src"] + ".md"
-                md_link_path = os.path.join(config["docs_dir"], md_src_path)
-                md_link_path = Path(unquote(md_link_path)).resolve()
+class EmbedFile(BasePlugin):
+    config_scheme = (('param', config_options.Type(str, default='')),)
 
-            elif link["src"][0] != "#":
-                if link["src"].endswith("/"):
-                    md_src_path = link["src"][:-1] + ".md"
-                else:
-                    md_src_path = link["src"] + ".md"
+    def __init__(self):
+        self.enabled = True
+        self.total_time = 0
 
+    def on_post_page(self, output_content, page, config):
+        soup = BeautifulSoup(output_content, 'html.parser')
+        docs = Path(config['docs_dir'])
+        md_link_path = ''
+        all_docs = [
+            x
+            for x in iglob(str(docs) + os.sep + '**', recursive=True)
+            if x.endswith('.md')
+        ]
+
+        for link in soup.findAll(
+                'img',
+                src=lambda src: src is not None and 'favicon' not in src and not src.endswith(
+                    ('png', 'jpg', 'jpeg', 'gif')),
+        ):
+            if len(link['src']) > 0:
+
+                if link['src'][0] == '.':
+                    md_src_path = link['src'][3:-1] + '.md'
+                    md_src_path = md_src_path.replace('.m.md', '.md')
+                    md_link_path = os.path.join(
+                        os.path.dirname(page.file.abs_src_path), md_src_path
+                    )
+                    md_link_path = Path(unquote(md_link_path)).resolve()
+
+                elif link['src'][0] == '/':
+                    if link['src'].endswith('/'):
+                        md_src_path = link['src'][:-1] + '.md'
+                    else:
+                        md_src_path = link['src'] + '.md'
+                    md_link_path = os.path.join(
+                        config['docs_dir'], md_src_path)
+                    md_link_path = Path(unquote(md_link_path)).resolve()
+
+                elif link['src'][0] != '#':
+                    if link['src'].endswith('/'):
+                        md_src_path = link['src'][:-1] + '.md'
+                    else:
+                        md_src_path = link['src'] + '.md'
+
+                    md_link_path = os.path.join(
+                        os.path.dirname(page.file.abs_src_path), md_src_path
+                    )
+                    md_link_path = Path(unquote(md_link_path)).resolve()
+            else:
+                md_src_path = link['src'] + '.md'
                 md_link_path = os.path.join(
                     os.path.dirname(page.file.abs_src_path), md_src_path
                 )
                 md_link_path = Path(unquote(md_link_path)).resolve()
-        else:
-            md_src_path = link["src"] + ".md"
-            md_link_path = os.path.join(
-                os.path.dirname(page.file.abs_src_path), md_src_path
-            )
-            md_link_path = Path(unquote(md_link_path)).resolve()
-
-        if md_link_path != "" and len(link["src"]) > 0:
-            if "#" in link.get("alt", ""):
-                # heading
-                citation_part = re.sub("^(.*)#", "#", link["alt"])
-            elif "#" in link.get("src", ""):
-                citation_part = re.sub("^(.*)#", "#", link["src"])
-            else:
-                citation_part = link.get("alt", False)
-            if citation_part:
-                md_link_path = re.sub("#(.*)\.md", ".md", str(md_link_path))
-                md_link_path = md_link_path.replace("\.md", ".md")
-                md_link_path = Path(md_link_path)
-                if os.path.isfile(md_link_path):
-                    soup = cite(md_link_path, link, soup, citation_part, config)
-                else:
-                    link_found = search_doc(md_link_path, all_docs)
-                    if link_found != 0:
-                        soup = cite(link_found, link, soup, citation_part, config)
-    return soup.original_encoding
-
 
-class EmbedFile(BasePlugin):
-
-    config_scheme = (("param", config_options.Type(str, default="")),)
-
-    def __init__(self):
-        self.enabled = True
-        self.total_time = 0
+            if md_link_path != '' and len(link['src']) > 0:
+                if '#' in link.get('alt', ''):
+                    # heading
+                    citation_part = re.sub('^(.*)#', '#', link['alt'])
+                elif '#' in link.get('src', ''):
+                    citation_part = re.sub('^(.*)#', '#', link['src'])
+                else:
+                    citation_part = link.get('alt', False)
+                if citation_part:
+                    md_link_path = re.sub(
+                        '#(.*)\.md', '.md', str(md_link_path))
+                    md_link_path = md_link_path.replace('\.md', '.md')
+                    md_link_path = Path(md_link_path)
+                    if os.path.isfile(md_link_path):
+                        soup = cite(md_link_path, link, soup,
+                                    citation_part, config)
+                    else:
+                        link_found = search_doc(md_link_path, all_docs)
+                        if link_found != 0:
+                            soup = cite(link_found, link, soup,
+                                        citation_part, config)
+        return str(soup)