style: formating

Author: Mara-Li

mkdocs_embed_file_plugins/plugin.py

@@ -1,11 +1,10 @@
 import codecs
-from typing import Union, List, Tuple, Dict, Any
+from typing import Union
 import os
 import re
 from glob import iglob
 from pathlib import Path
 from urllib.parse import unquote, quote
-import ast
 import frontmatter
 import markdown
 from bs4 import BeautifulSoup
@@ -14,7 +13,8 @@
 from mkdocs.plugins import BasePlugin
 from mkdocs_callouts.plugin import CalloutsPlugin
 from custom_attributes.plugin import convert_text_attributes
-from mkdocs.exceptions import PluginError
+import logging
+
 
 def search_in_file(citation_part: str, contents: str) -> str:
     """
@@ -31,7 +31,8 @@ def search_in_file(citation_part: str, contents: str) -> str:
     elif '#' in citation_part and not '^' in citation_part:
         # cite from title
         sub_section = []
-        citation_part = citation_part.replace('-', ' ').replace('#', '# ').upper()
+        citation_part = citation_part.replace(
+            '-', ' ').replace('#', '# ').upper()
         heading = 0
 
         for i in data:
@@ -52,7 +53,7 @@ def search_in_file(citation_part: str, contents: str) -> str:
         # cite from block
         citation_part = citation_part.replace('#', '')
         for i in data:
-            if re.search(re.escape(citation_part) + "$", i):
+            if re.search(re.escape(citation_part) + '$', i):
                 return i.replace(citation_part, '')
     return ''
 
@@ -66,8 +67,12 @@ def mini_ez_links(urlo, base, end, url_whitespace, url_case):
         internal_link = str(internal_link).replace(base, '')
     else:  # fallback to searching
         if urlo[2].endswith('.md'):
-            internal_link = str(search_file_in_documentation(Path(urlo[2]).resolve(), Path(md_link_path).parent))
-        if not os.path.isfile(internal_link): # manual search
+            internal_link = str(
+                search_file_in_documentation(
+                    Path(
+                        urlo[2]).resolve(),
+                    Path(md_link_path).parent))
+        if not os.path.isfile(internal_link):  # manual search
             file_name = urlo[2].replace('index', '')
             file_name = file_name.replace('../', '')
             file_name = file_name.replace('./', '')
@@ -91,22 +96,25 @@ def mini_ez_links(urlo, base, end, url_whitespace, url_case):
     url = re.sub(r'\/$', '', str(url_blog)) + '/' + quote(url)
     if not url.startswith('http'):
         url = 'https://' + url
-    if not url.endswith('/') and not url.endswith(('png', 'jpg', 'jpeg', 'gif', 'webm')):
+    if not url.endswith('/') and not url.endswith(('png',
+                                                   'jpg', 'jpeg', 'gif', 'webm')):
         url = url + '/'
     return url
 
+
 def strip_comments(markdown):
     file_content = markdown.split('\n')
     markdown = ''
     for line in file_content:
-        if not re.search(r'%%(.*)%%', line) or not line.startswith('%%') or not line.endswith('%%'):
+        if not re.search(
+                r'%%(.*)%%', line) or not line.startswith('%%') or not line.endswith('%%'):
             markdown += line + '\n'
     markdown = re.sub(r'%%(.*)%%', '', markdown, flags=re.DOTALL)
     return markdown
 
 
-
-def cite(md_link_path, link, soup, citation_part, config, callouts, custom_attr, msg) -> BeautifulSoup:
+def cite(md_link_path, link, soup, citation_part, config,
+         callouts, custom_attr, msg) -> BeautifulSoup:
     """Append the content of the founded file to the original file.
 
     Args:
@@ -131,19 +139,19 @@ def cite(md_link_path, link, soup, citation_part, config, callouts, custom_attr,
     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)
+    new_uri = re.sub('https?:\\/', '\\g<0>/', new_uri)
     new_uri = new_uri.replace('/index/', '/')
     input_file = codecs.open(str(md_link_path), mode='r', encoding='utf-8')
     text = input_file.read()
 
     contents = frontmatter.loads(text).content
     quote = search_in_file(citation_part, contents)
     tooltip_template = (
-            "<div class='citation'> <a href='"
-            + str(link['src'])
-            + "' class='link_citation'><i class='fas fa-link'></i> </a>"
-            + str(link['alt']) + ' not exists.'
-            + '</div>'
+        "<div class='citation'> <a href='"
+        + str(link['src'])
+        + "' class='link_citation'><i class='fas fa-link'></i> </a>"
+        + str(link['alt']) + ' not exists.'
+        + '</div>'
     )
     if len(quote) > 0:
         if callouts:
@@ -156,6 +164,8 @@ def cite(md_link_path, link, soup, citation_part, config, callouts, custom_attr,
             quote = convert_text_attributes(quote, config_attr)
         quote = strip_comments(quote)
         md_extensions = config['markdown_extensions']
+        wiki = WikiLinkPlusExtension(md_config['mdx_wikilink_plus'])
+        md_extensions.append(wiki)
         html = markdown.markdown(
             quote,
             extensions=md_extensions,
@@ -177,30 +187,44 @@ def cite(md_link_path, link, soup, citation_part, config, callouts, custom_attr,
             return soup
     else:
         log = logging.getLogger('mkdocs.plugins.' + __name__)
+        log.info('[EMBED FILE PLUGIN] CITATION NOT FOUND : ' +
+                 unquote(citation_part) +
+                 'for : ' +
+                 str(md_link_path) +
+                 ' with link: ' +
+                 str(link) +
+                 ' and new_uri: ' +
+                 str(new_uri) +
+                 ' and quote: ' +
+                 str(quote))
         return tooltip_not_found(link, soup, msg)
 
 
 def tooltip_not_found(link, soup, msg) -> BeautifulSoup:
     tooltip_template = (
-            "<div class='citation'> <a class='link_citation'><i class='fas fa-link'></i> </a>"
-            + '<p style="text-align: center; display: block"><i class="not_found">' + str(link['alt']) + f'</i> {msg}</p>'
-            + '</div>'
+        "<div class='citation'> <a class='link_citation'><i class='fas fa-link'></i> </a>"
+        + '<p style="text-align: center; display: block"><i class="not_found">' +
+        str(link['alt']) + f'</i> {msg}</p>'
+        + '</div>'
     )
     new_soup = str(soup).replace(str(link), str(tooltip_template))
     soup = BeautifulSoup(new_soup, 'html.parser')
     return soup
 
+
 def create_link(link):
     if link.endswith('/'):
         return link[:-1] + '.md'
     else:
         return link + '.md'
 
-def search_file_in_documentation(link: Union[Path,str], config_dir: Path) -> Union[Path, int]:
+
+def search_file_in_documentation(
+        link: Union[Path, str], config_dir: Path) -> Union[Path, int]:
     file_name = os.path.basename(link)
     if not file_name.endswith('.md'):
         file_name = file_name + '.md'
-    for p in config_dir.rglob(f"*{file_name}"):
+    for p in config_dir.rglob(f'*{file_name}'):
         return p
     return 0
 
@@ -224,12 +248,12 @@ def on_post_page(self, output_content, page, config) -> str:
         language_message = self.config['language_message']
         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', 'svg')) 
-                    and not 'www' in src 
-                    and not 'http' in src 
-                    and not '://' in src,
+                src=lambda src: src is not None
+            and 'favicon' not in src
+            and not src.endswith(('png', 'jpg', 'jpeg', 'gif', 'svg'))
+            and not 'www' in src
+            and not 'http' in src
+            and not '://' in src,
         ):
             if len(link['src']) > 0:
                 if link['src'].startswith('./'):
@@ -238,9 +262,11 @@ def on_post_page(self, output_content, page, config) -> str:
                     md_src = create_link(unquote(link['src']))
                     md_link_path = Path(
                         os.path.dirname(page.file.abs_src_path), md_src).resolve()
-                    md_link_path = re.sub(r'[\/\\]?#(.*)$', '', str(md_link_path))
+                    md_link_path = re.sub(
+                        r'[\/\\]?#(.*)$', '', str(md_link_path))
                     if not os.path.isfile(md_link_path):
-                        md_link_path = search_file_in_documentation(md_link_path, docs)
+                        md_link_path = search_file_in_documentation(
+                            md_link_path, docs)
 
                 elif link['src'][0] == '/':
                     md_src_path = create_link(unquote(link['src']))
@@ -255,7 +281,8 @@ def on_post_page(self, output_content, page, config) -> str:
                     md_link_path = os.path.join(
                         os.path.dirname(page.file.abs_src_path), md_src_path
                     )
-                    md_link_path = re.sub(r'/#(.*).md$', '.md', str(md_link_path))
+                    md_link_path = re.sub(
+                        r'/#(.*).md$', '.md', str(md_link_path))
                     md_link_path = Path(unquote(md_link_path)).resolve()
 
             else:
@@ -266,7 +293,8 @@ def on_post_page(self, output_content, page, config) -> str:
                 md_link_path = Path(unquote(md_link_path)).resolve()
             if (md_link_path == 0):
                 soup = tooltip_not_found(link, soup, language_message)
-            if  (md_link_path != '' or md_link_path == 0) and len(link['src']) > 0:
+            if (md_link_path != '' or md_link_path ==
+                    0) and len(link['src']) > 0:
                 if '#' in link.get('alt', ''):
                     # heading
                     citation_part = re.sub('^(.*)#', '#', link['alt'])
@@ -281,7 +309,8 @@ def on_post_page(self, output_content, page, config) -> str:
                         soup = cite(md_link_path, link, soup,
                                     citation_part, config, callout, self.config['custom-attributes'], language_message)
                     else:
-                        link_found=search_file_in_documentation(md_link_path, docs)
+                        link_found = search_file_in_documentation(
+                            md_link_path, docs)
                         if link_found != 0:
                             soup = cite(link_found, link, soup,
                                         citation_part, config, callout, self.config['custom-attributes'], language_message)