add the funtions into the Filer to help read and write datas

Author: BertramYe

README.md

@@ -115,6 +115,8 @@ Get help ➡️ [Github issue](https://github.com/BertramYe/preparser/issues)
 
 # Update logs
 
+* `version 2.0.8 `: add the func of `read_datas_from_file` into `Filer`, to help read the datas from the specified type files.
+
 * `version 2.0.7 `: add the `ssl_certi_verified` parameter to control weather ignored the error that caused by ssl certi verification when do the requesting.
 
 * `version 2.0.6 `: add the `html_dynamic_scope` parameters to let user can specified the whole dynamic parse scope, which can help faster the preparser speed when the `parser_mode` is `html_dynamic` . and resort the additional tools into the `ToolsHelper` package.

preparser/FileHelper.py

@@ -1,7 +1,7 @@
 from typing import Literal,Any
 from os import makedirs
-from os.path import dirname
-from json import dump
+from os.path import dirname,exists,abspath
+from json import dump,load
 
 
 FileType = Literal['txt','json']
@@ -14,7 +14,15 @@ class Filer():
             file_type ( Literal['txt','json'] ): to save or read files type, so far mainly support `txt` and `json`, but future will add more
     """
     def __init__(self,file_type:FileType='txt') -> None:
-        self.file_type:FileType = file_type
+        self._available_file_types = ['txt','json']
+        self._file_type:FileType = file_type
+    
+    def __filter_file_types(self,file_path_without_type:str) -> str | None:
+        if self._file_type in self._available_file_types:
+            return abspath(f'{file_path_without_type}.{self._file_type}')
+        else:
+            print(f'error: so fare , the type {self._file_type} is not supported by the preparser, only {','.join(self._available_file_types)} is avaliable')
+            return None
 
     def write_data_into_file(self,new_file_name:str,datas:list[Any],ensure_json_ascii:bool=False):
         """
@@ -25,23 +33,47 @@ def write_data_into_file(self,new_file_name:str,datas:list[Any],ensure_json_asci
                 datas: (list[Any]) : to save the files datas, which should be a `list` Obeject
                 ensure_json_ascii (bool) : for the json file content writing, as from the object `PreParser` result, which no need ensure_ascii , otherwise may result the content ascii can't be decoded, just keep default False is ok.
         """
-        
-        file_name = f'{new_file_name}.{self.file_type}'
-        # 获取文件夹路径
-        dir_path = dirname(file_name)
-
-        # 确保文件夹存在，若不存在则创建
-        makedirs(dir_path, exist_ok=True)
-        try:
-            print(f'begin to save datas into file: {file_name} !')
-            if self.file_type == 'txt' or self.file_type == 'json':
-                with open(file_name,'w',encoding="utf-8")  as file:
-                    if self.file_type == 'json':
+        abs_file_path = self.__filter_file_types(new_file_name)
+        if abs_file_path:
+            # get file's dir path
+            dir_path = dirname(abs_file_path)
+            # make sure files existed
+            makedirs(dir_path, exist_ok=True)
+            try:
+                print(f'begin to save datas into file: {abs_file_path} !')
+                with open(abs_file_path,'w',encoding="utf-8")  as file:
+                    if self._file_type == 'json':
                         dump(datas, file, indent=4,ensure_ascii=ensure_json_ascii)
                     else:
                         file.writelines(datas)
-            else:
-                print(f'failed to save datas into file: {file_name}, as current file type not support, file_type: {self.file_type}')
-            print(f'successd to save datas into file: {file_name} !')
-        except Exception as err:
-            print(f'failed to save datas into file: {file_name}, error: {err}')
+                print(f'successd to save datas into file: {abs_file_path} !')
+            except Exception as err:
+                print(f'failed to save datas into file: {abs_file_path}, error: {err}')
+    
+    def read_datas_from_file(self,file_name:str):
+        """
+            a function to help get the content from txt or json file
+
+            Parameters:
+                file_name ( str ): to read the result filename , it can include absolute or relative path of the files, but the filename can't include files type, 
+                                   which already was defined when the `Filer` class was initial, otherwise, if you want specified the file type, 
+                                   you can change the property `_file_type` after you initial the `Filer` class .
+                                   for example,if you want read a `result.txt` file, file_name can't be `./test/result.txt`, but the `./test/result` is ok.
+        """
+        abs_file_path = self.__filter_file_types(file_name)
+        if abs_file_path:
+            try:
+                if exists(abs_file_path):
+                    with open(abs_file_path,'r',encoding="utf-8")  as file:
+                        if self._file_type == 'json':
+                            return load(file)
+                        else:
+                            return file.read()
+                else:
+                    print(f"read file {file_name} failed, error: we can't find out current file from the path: {abs_file_path}")
+                    return None
+            except Exception as error:
+                print(f"read file {abs_file_path} failed, error: {error}")
+                return None
+        else:
+            return None

setup.py

@@ -19,7 +19,7 @@
     name="preparser",  # packages name
     author="BertramYe",  # author name
     author_email="bertramyerik@gmail.com",  # author's email
-    version="2.0.7",  # pakage version
+    version="2.0.8",  # pakage version
     description="a slight preparser to help parse webpage content or get request from urls,which supports win, mac and unix.",  # short description
     long_description=long_description,  # get descrition from README.md
     long_description_content_type="text/markdown",