Support automatically adapting to set the encoding format according to the IO stream when performing IO operations on file; Update file:Add encoding data to property<info> of class<File>.

Author: leoweyr

README.md

@@ -21,6 +21,7 @@ pip install easierfile
 ## 🔗Dependencies
 
 - [Dynoptimdict - A dynamic data dict class that inherits and overrides the built-in dict class for special purposes. That provides real-time access to dynamic data, while still allowing the option to get only the specified data without calculating all. It adheres to the concept of program optimization which avoids loading if not used, saving both memory and time](https://github.com/leoweyr/Python-Dynoptimdict)
+- [Chardet - The universal character encoding detector](https://github.com/chardet/chardet)
 
 ## ⚖️License
 

doc/API reference.md

@@ -21,16 +21,14 @@ File(file_path, is_auto_create, is_occupy)
     </tr>
     <tr>
     	<td><code>File().info</code></td>
-        <td>Return a dict of file attribute information.</br>● path: the absolute path of the file</br>● dir_path: the absolute path of the directory where the file is located</br>● full_name: the name of the file</br>● name: the name of the file without file extension</br>● ext: the extension of the file</td>
+        <td>Return a dict of file attribute information.</br>● path: the absolute path of the file</br>● dir_path: the absolute path of the directory where the file is located</br>● full_name: the name of the file</br>● name: the name of the file without file extension</br>● ext: the extension of the file</br>● encoding: the encoding of the file</td>
     </tr>
 	<tr>
 		<td><code>File().status</code></td>
         <td>Return a dict of file status information.</br>● file_lock: whether file lock is on</br>● exist: whether the file exist</td>
 	</tr>
 </table>
 
-
-
 ### Operation
 
 #### File().create()

easierfile/file.py

@@ -21,17 +21,19 @@ def _unlock_file(file):
 
 
 import os
-from dynoptimdict import DynamicDataDict as Dict
+from dynoptimdict import DynamicDict
+import chardet
+
 
 class File:
     def __init__(self, file_path, is_auto_create=True, is_occupy=True):
         # Get static file information.
-        self.__m_info = {}
-        self.__m_info["path"] = os.path.abspath(file_path)
-        self.__m_info["dir_path"] = os.path.dirname(self.__m_info["path"])
-        self.__m_info["full_name"] = os.path.basename(self.__m_info["path"])
-        self.__m_info["name"], self.__m_info["ext"] = os.path.splitext(self.__m_info["full_name"])
-        self.__m_info["ext"] = self.__m_info["ext"].split(".")[-1]  # Format ext of info to remove str<.>.
+        self.__m_static_info = {}
+        self.__m_static_info["path"] = os.path.abspath(file_path)
+        self.__m_static_info["dir_path"] = os.path.dirname(self.__m_static_info["path"])
+        self.__m_static_info["full_name"] = os.path.basename(self.__m_static_info["path"])
+        self.__m_static_info["name"], self.__m_static_info["ext"] = os.path.splitext(self.__m_static_info["full_name"])
+        self.__m_static_info["ext"] = self.__m_static_info["ext"].split(".")[-1]  # Format ext of info to remove str<.>.
 
         self.__m_is_occupy = is_occupy
         self.__m_is_lock = False  # Initialize file lock state.
@@ -56,7 +58,7 @@ def __del__(self):
     def __lock(self, is_lock):
         if self.status["exist"]:
             if is_lock:
-                self.__m_file = open(self.__m_info["path"])
+                self.__m_file = open(self.__m_static_info["path"])
                 _lock_file(self.__m_file)
                 self.__m_is_lock = is_lock
             else:
@@ -65,70 +67,101 @@ def __lock(self, is_lock):
                 self.__m_is_lock = is_lock
         else:
             if is_lock:
-                raise FileNotFoundError("File was about to be occupied, but not found: " + self.__m_info["path"])
+                raise FileNotFoundError("File was about to be occupied, but not found: " + self.__m_static_info["path"])
             else:
-                raise FileNotFoundError("File was about to be unoccupied, but not found: " + self.__m_info["path"])
+                raise FileNotFoundError("File was about to be unoccupied, but not found: " + self.__m_static_info["path"])
 
     def create(self):
         if not self.status["exist"]:
-            if not os.path.exists(self.__m_info["dir_path"]):  # Create the file directory if it doesn't exist, so that code<open()> doesn't throw the exception.
-                os.mkdir(self.__m_info["dir_path"])
+            if not os.path.exists(self.__m_static_info["dir_path"]):  # Create the file directory if it doesn't exist, so that code<open()> doesn't throw the exception.
+                os.mkdir(self.__m_static_info["dir_path"])
             try:
-                file_temp = open(self.__m_info["path"], "x")
+                file_temp = open(self.__m_static_info["path"], "x")
             except FileExistsError:  # Avoid exception caused by creating corresponding file in other ways during program execution intervals.
                 pass
             else:
                 file_temp.close()
             if self.__m_is_occupy:
                 self.__lock(True)
         else:
-            raise FileExistsError("File exists: " + self.__m_info["path"])
+            raise FileExistsError("File exists: " + self.__m_static_info["path"])
 
     def delete(self):
         if self.__m_is_lock:
             self.__lock(False)
         if self.status["exist"]:
-            os.remove(self.__m_info["path"])
+            os.remove(self.__m_static_info["path"])
 
     def rewrite(self,content):
         if self.status["exist"]:
-            file_temp = open(self.__m_info["path"], "w")
+            """
+            Automatically obtain the most suitable encoding format for the input content.
+            
+            :samp: chardet.detect(content.encode())["encoding"]
+            """
+            file_temp = open(self.__m_static_info["path"], "w", encoding=chardet.detect(content.encode())["encoding"])
             file_temp.write(content)
             file_temp.close()
         else:
-            raise FileNotFoundError("File not found: " + self.__m_info["path"])
+            raise FileNotFoundError("File not found: " + self.__m_static_info["path"])
 
     def append(self,content):
         if self.status["exist"]:
-            file_temp = open(self.__m_info["path"], "a")
+            file_temp = open(self.__m_static_info["path"], "a", encoding=chardet.detect(content.encode())["encoding"])
             file_temp.write(content)
             file_temp.close()
         else:
-            raise FileNotFoundError("File not found: " + self.__m_info["path"])
+            raise FileNotFoundError("File not found: " + self.__m_static_info["path"])
 
     @property
     def content(self):
         if self.status["exist"]:
-            file_temp = open(self.__m_info["path"], "r")
+            """
+            Automatically obtain the most suitable encoding format for the output content.
+            
+            :samp: self.info["encoding"]
+            
+            In fact, it gets the encoding format of the read file. 
+            """
+            file_temp = open(self.__m_static_info["path"], "r", encoding=self.info["encoding"])
             content = file_temp.read()
             file_temp.close()
             return content
         else:
-            raise FileNotFoundError("File not found: " + self.__m_info["path"])
+            raise FileNotFoundError("File not found: " + self.__m_static_info["path"])
 
     @property
     def info(self):
-        return self.__m_info
+        # Get dynamic file information.
+        def get_info_encoding():
+            file_temp = open(self.__m_static_info["path"],'rb')
+            encoding = chardet.detect(file_temp.read())["encoding"]
+            file_temp.close()
+            return encoding
+
+        info = DynamicDict()
+
+        # Store static file information directly.
+        info["path"] = self.__m_static_info["path"]
+        info["dir_path"] = self.__m_static_info["dir_path"]
+        info["full_name"] = self.__m_static_info["full_name"]
+        info["name"] = self.__m_static_info["name"]
+        info["ext"] = self.__m_static_info["ext"]
+
+        # Store the acquisition way of dynamic file information.
+        info["encoding"] = get_info_encoding
+
+        return info
 
     @property
     def status(self):
         def get_status_file_lock():
             return self.__m_is_lock
 
         def get_status_exist():
-            return os.path.isfile(self.__m_info["path"])
+            return os.path.isfile(self.__m_static_info["path"])
 
-        status = Dict()
+        status = DynamicDict()
         # Pass function pointers for obtaining dynamic data into object:Dict<status>.
         status["file_lock"] = get_status_file_lock
         status["exist"] = get_status_exist

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "easierfile"
-version = "2.2.0"
+version = "2.3.0"
 description = "An easier-to-use Python package that object-oriented encapsulates Python traditional built-in file operations."
 license = "MIT"
 authors = ["leoweyr <[email protected]>"]
@@ -14,7 +14,8 @@ packages = [{include = "easierfile"}]
 
 [tool.poetry.dependencies]
 python = "^3.8"
-dynoptimdict = "^1.0.0"
+dynoptimdict = "^2.0.0"
+chardet = "^5.1.0"
 
 
 [build-system]