more code clean up

pchang388 · pchang388 · commit 39214aaef85d · 2023-11-22T06:26:48.000Z
diff --git a/bookstack_file_exporter/archiver/page_archiver.py b/bookstack_file_exporter/archiver/page_archiver.py
@@ -3,13 +3,11 @@
 # pylint: disable=import-error
 from requests import Response
 
-
 from bookstack_file_exporter.exporter.node import Node
 from bookstack_file_exporter.archiver import util as archiver_util
 from bookstack_file_exporter.config_helper.config_helper import ConfigNode
 from bookstack_file_exporter.common import util as common_util
 
-
 _META_FILE_SUFFIX = "_meta.json"
 _TAR_SUFFIX = ".tar"
 _TAR_GZ_SUFFIX = ".tgz"
@@ -26,9 +24,7 @@
     "tgz": _TAR_GZ_SUFFIX
 }
 
-
 _IMAGE_DIR_NAME = "images"
-# _MARKDOWN_IMAGE_REGEX= re.compile(r"\[\!\[^$|.*\].*\]")
 _MARKDOWN_STR_CHECK = "markdown"
 
 class ImageNode:
@@ -54,13 +50,16 @@ def _get_image_name(self) -> str:
 
     @property
     def image_relative_path(self):
+        """return image path local to page directory"""
         return self._image_relative_path
 
     @property
     def markdown_str(self):
+        """return markdown url str to replace"""
         return self._markdown_str
-    
+
     def set_markdown_content(self, img_details: Dict[str, Union[int, str]]):
+        """provide image metadata to set markdown properties"""
         self._markdown_str = self._get_md_url_str(img_details)
 
     @staticmethod
@@ -121,7 +120,6 @@ def _archive_page(self, page: Node, export_format: str, data: bytes,
                       image_nodes: List[ImageNode] = None):
         page_file_name = f"{self.archive_base_path}/" \
             f"{page.file_path}/{page.name}{_FILE_EXTENSION_MAP[export_format]}"
-        # not yet implemented
         if self.modify_md and export_format == _MARKDOWN_STR_CHECK and image_nodes:
             data = self._update_image_links(data, image_nodes)
         self.write_data(page_file_name, data)
@@ -176,12 +174,12 @@ def _update_image_links(self, page_data: bytes, image_nodes: List[ImageNode]) ->
             img_meta_url = f"{self.api_urls['images']}/{img_node.id}"
             img_details = common_util.http_get_request(img_meta_url,
                                                          self._headers, self.verify_ssl)
-            
             img_node.set_markdown_content(img_details.json())
             if not img_node.markdown_str:
                 continue
             # 1 - what to replace, 2 - replace with, 3 is the data to replace
-            page_data = re.sub(img_node.markdown_str.encode(), img_node.image_relative_path().encode(), page_data)
+            page_data = re.sub(img_node.markdown_str.encode(),
+                               img_node.image_relative_path.encode(), page_data)
         return page_data
 
     @property
diff --git a/bookstack_file_exporter/archiver/util.py b/bookstack_file_exporter/archiver/util.py
@@ -27,13 +27,6 @@ def write_tar(base_tar_dir: str, file_path: str, data: bytes):
         log.debug("Adding file: %s with size: %d bytes to tar file", tar_info.name, tar_info.size)
         tar.addfile(tar_info, fileobj=data_obj)
 
-# create files first for manipulation/changes and tar later
-# def write_file(file_path: str, data: bytes):
-#     """write byte data to a local file"""
-#     os.makedirs(os.path.dirname(file_path), exist_ok=True)
-#     with open(file_path, 'wb') as file_obj:
-#         file_obj.write(data)
-
 def get_json_bytes(data: Dict[str, Union[str, int]]) -> bytes:
     """dump dict to json file"""
     return json.dumps(data, indent=4).encode('utf-8')
@@ -55,12 +48,3 @@ def scan_archives(base_dir: str, extension: str) -> str:
     """scan export directory for archives"""
     file_pattern = f"{base_dir}_*{extension}"
     return glob.glob(file_pattern)
-
-# def find_file_matches(file_path: str, regex_expr: re.Pattern) -> List[str]:
-#     """find all matching lines for regex pattern"""
-#     matches=[]
-#     with open(file_path, encoding="utf-8") as open_file:
-#         for line in open_file:
-#             for match in re.finditer(regex_expr, line):
-#                 matches.append(match.group)
-#     return matches
