Merge pull request #11 from ArnoldFeng767/pyi_add

Pyi add

Author: dustin007442

quecpython_stubs/backup_restore.pyi

@@ -0,0 +1,83 @@
+"""
+Backup and Restore Module
+Provides secure backup and restore functionality with CRC32 checksum verification.
+
+Descriptions taken from:
+Not yet.
+"""
+
+class _checkError(Exception):
+    """Custom exception for backup check failures"""
+    
+    def __init__(self, value: str):
+        """
+        :param value: Error description
+        """
+    def __str__(self) -> str:
+        """Returns string representation of the error
+        
+        :return: Error description string
+        """
+
+def bak_update(file: str, data: any) -> int:
+    """Updates or creates a backup file with checksum verification
+    
+    :param file: File path to update (auto-prefixed with '/' if needed)
+    :param data: Data to store (dict for new files, any type for existing)
+    :return: 
+        0 - Success
+        -1 - Invalid input or file exists
+        -2 - Flag check failed
+        -3 - Backup disabled
+        -5 - Operation failed
+    
+    Process:
+    1. Mounts secure backup filesystem
+    2. Creates primary file if missing
+    3. Copies file to backup location
+    4. Updates checksums for both files
+    """
+
+def bak_file(file: str) -> any:
+    """Retrieves a file from backup storage
+    
+    :param file: File path to retrieve (auto-prefixed with '/' if needed)
+    :return: 
+        File content on success
+        -1 - File not found
+        -2 - Flag check failed
+        -3 - Backup disabled
+        -4 - Checksum mismatch
+        -5 - Operation failed
+        -6 - Copy failed
+    
+    Process:
+    1. Mounts secure backup filesystem
+    2. Copies backup file to primary location
+    3. Verifies checksums
+    """
+
+def main() -> None:
+    """Main backup restore procedure
+    
+    Automatically performs:
+    1. Checks backup restore flag
+    2. Compares CRC32 checksums
+    3. Restores mismatched files from backup
+    4. Updates checksum database
+    
+    Note: Runs automatically on module import
+    """
+
+def _get_backup_restore_flag() -> bool:
+    """Internal: Gets backup enable flag (not for direct use)
+    
+    :return: True if backup enabled, False otherwise
+    """
+
+def _check() -> str:
+    """Internal: Validates backup flag file (not for direct use)
+    
+    :return: JSON content of flag file
+    :raises _checkError: If file missing or empty
+    """

quecpython_stubs/bak_util.pyi

@@ -0,0 +1,57 @@
+"""
+Secure Storage Module
+Provides secure storage functionality for configuration data and files with backup support.
+
+Descriptions taken from:
+Not yet.
+"""
+from backup_restore import bak_update, bak_file
+import uos, ujson, ql_fs
+
+class SecureStorage:
+    """Secure storage class for configuration data and file backup"""
+    
+    @classmethod
+    def write(cls, data: dict) -> int:
+        """Writes configuration data to secure storage
+        
+        :param data: Configuration data in dictionary format
+        :return: 
+            0 - Success
+            -1 - Invalid input (not a dictionary)
+            -2 - Write operation failed
+            -3 - Backup file already exists
+        
+        Note: Automatically creates backup if none exists
+        """
+    
+    @classmethod
+    def read(cls) -> dict:
+        """Reads configuration data from secure storage
+        
+        :return: Configuration data dictionary or None if not found
+        
+        Note: Automatically restores from backup if primary file is missing
+        """
+    
+    @classmethod
+    def add(cls, file: str, data: any) -> int:
+        """Adds or updates a file in secure storage
+        
+        :param file: File path to add/update
+        :param data: Data to store in the file
+        :return: 0 if successful, error code otherwise
+        
+        Uses bak_update function for the operation
+        """
+    
+    @classmethod
+    def file(cls, file: str) -> any:
+        """Retrieves a file from secure storage
+        
+        :param file: File path to retrieve
+        :return: File content or None if not found
+        
+        Uses bak_file function for the operation
+        """
+JsonFile = SecureStorage