Update project

application/models/log.py

@@ -7,17 +7,25 @@
 # @Email       : StudentCWZ@outlook.com
 # @Date        : 2023/11/19 14:59
 # @File        : log.py
-# @Description :
+# @Description : Defines the Log model for the application.
 """
 
 
+# Import built-in modules
 import os
 
+# Import custom modules
 from application.extensions.init_sqlalchemy import db
 
 
 class Log(db.Model):
-    """Basic user model"""
+    """
+    The Log model for the application.
+
+    Each instance of this model represents a row in the 'logs' database table
+    which is defined by the 'TableName' environment variable or defaults to 'logs'.
+    """
+
     __tablename__ = os.environ.get('TableName', 'logs')
 
     id = db.Column(db.Integer, primary_key=True, autoincrement=True)
@@ -55,14 +63,25 @@ class Log(db.Model):
     cost_time = db.Column(db.String(80))
 
     def __repr__(self) -> str:
+        """
+        Returns a string representation of a Log instance.
+
+        Returns:
+            str: A string representation of a Log instance.
+        """
         return f'<Log {self.uuid}>'
 
     def to_dict(self) -> dict:
-        """object to dict"""
+        """
+        Converts the Log instance to a dictionary.
+
+        Returns:
+            dict: A dictionary representation of the Log instance.
+        """
         _dic = {}
         for key, value in self.__dict__.items():
             if str(key).startswith("_"):
-                # 前缀带下划线不要
+                # Ignore attributes starting with an underscore
                 continue
             _dic[key] = value
         return _dic