Mercurial Repositories > eric / file diff

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/eric6/Project/UserProjectFile.py	Mon Jan 25 20:07:51 2021 +0100
@@ -0,0 +1,112 @@
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2021 Detlev Offenbach <detlev@die-offenbachs.de>
+#
+
+"""
+Module implementing a class representing the user project JSON file.
+"""
+
+import json
+import os
+import time
+import typing
+
+from PyQt5.QtCore import QObject
+
+from E5Gui import E5MessageBox
+from E5Gui.E5OverrideCursor import E5OverridenCursor
+
+import Preferences
+
+Project = typing.Type["Project"]
+
+
+class UserProjectFile(QObject):
+    """
+    Class representing the user project JSON file.
+    """
+    def __init__(self, project: Project, parent: QObject = None):
+        """
+        Constructor
+        
+        @param project reference to the project object
+        @type Project
+        @param parent reference to the parent object
+        @type QObject (optional)
+        """
+        super(UserProjectFile, self).__init__(parent)
+        self.__project = project
+    
+    def writeFile(self, filename: str) -> bool:
+        """
+        Public method to write the user project data to a user project
+        JSON file.
+        
+        @param filename name of the user project file
+        @type str
+        @return flag indicating a successful write
+        @rtype bool
+        """
+        name = os.path.splitext(os.path.basename(filename))[0]
+        
+        userProjectDict = {}
+        userProjectDict["header"] = {
+            "comment": f"eric user project file for project {name}",
+        }
+        
+        # TODO: replace 'XMLTimestamp' by 'Timestamp'
+        if Preferences.getProject("XMLTimestamp"):
+            userProjectDict["header"]["saved"] = (
+                time.strftime('%Y-%m-%d, %H:%M:%S')
+            )
+        
+        userProjectDict["user_data"] = self.__project.pudata
+        
+        try:
+            jsonString = json.dumps(userProjectDict, indent=2)
+            with open(filename, "w") as f:
+                f.write(jsonString)
+        except (TypeError, EnvironmentError) as err:
+            with E5OverridenCursor():
+                E5MessageBox.critical(
+                    None,
+                    self.tr("Save User Project Properties"),
+                    self.tr(
+                        "<p>The user specific project properties file"
+                        " <b>{0}</b> could not be written.</p>"
+                        "<p>Reason: {1}</p>"
+                    ).format(filename, str(err))
+                )
+                return False
+        
+        return True
+    
+    def readFile(self, filename: str) -> bool:
+        """
+        Public method to read the user project data from a user project
+        JSON file.
+        
+        @param filename name of the project file
+        @type str
+        @return flag indicating a successful read
+        @rtype bool
+        """
+        try:
+            with open(filename, "r") as f:
+                jsonString = f.read()
+            userProjectDict = json.loads(jsonString)
+        except (EnvironmentError, json.JSONDecodeError) as err:
+            E5MessageBox.critical(
+                None,
+                self.tr("Read User Project Properties"),
+                self.tr(
+                    "<p>The user specific project properties file <b>{0}</b>"
+                    " could not be read.</p><p>Reason: {1}</p>"
+                ).format(filename, str(err))
+            )
+            return False
+        
+        self.__project.pudata = userProjectDict["user_data"]
+        
+        return True