Time Tracker: comparison TimeTracker/TimeTracker.py

-:44ec4168b442
+:693e42176007
 """
 Module implementing the time tracker object.
 """
+import json
 import os
-from PyQt5.QtCore import Qt, QObject
+from PyQt6.QtCore import Qt, QObject
-from PyQt5.QtGui import QKeySequence
+from PyQt6.QtGui import QKeySequence
-from E5Gui.E5Application import e5App
+from EricWidgets.EricApplication import ericApp
-from E5Gui import E5MessageBox
+from EricWidgets import EricMessageBox
-from E5Gui.E5Action import E5Action
+from EricGui.EricAction import EricAction
 import UI.PixmapCache
 class TimeTracker(QObject):
 """
 Class implementing the time tracker object.
 """
-FileName = "TimeTracker.txt"
+FileName = "TimeTracker.ttj"
 def __init__(self, plugin, iconSuffix, parent=None):
 """
 Constructor
 self.__plugin = plugin
 self.__iconSuffix = iconSuffix
 self.__ui = parent
-self.__e5project = e5App().getObject("Project")
+self.__ericProject = ericApp().getObject("Project")
 def __initialize(self):
 """
 Private slot to initialize some member variables.
 """
 os.path.join("TimeTracker", "icons",
 "clock-{0}".format(self.__iconSuffix))
 ),
 self.tr("Time Tracker"))
-self.__activateAct = E5Action(
+self.__activateAct = EricAction(
 self.tr('Time Tracker'),
 self.tr('T&ime Tracker'),
 QKeySequence(self.tr("Alt+Shift+I")),
 0, self,
 'time_tracker_activate')
 """<p>This switches the input focus to the Time Tracker"""
 """ window.</p>"""
 ))
 self.__activateAct.triggered.connect(self.__activateWidget)
-self.__ui.addE5Actions([self.__activateAct], 'ui')
+self.__ui.addEricActions([self.__activateAct], 'ui')
 menu = self.__ui.getMenu("subwindow")
 menu.addAction(self.__activateAct)
 self.__initialize()
 """
 Public method to deactivate the time tracker.
 """
 menu = self.__ui.getMenu("subwindow")
 menu.removeAction(self.__activateAct)
-self.__ui.removeE5Actions([self.__activateAct], 'ui')
+self.__ui.removeEricActions([self.__activateAct], 'ui')
 self.__ui.removeSideWidget(self.__widget)
 def projectOpened(self):
 """
 Public slot to handle the projectOpened signal.
 """
 if self.__projectOpen:
 self.projectClosed()
 self.__projectOpen = True
-self.__projectPath = self.__e5project.getProjectPath()
+self.__projectPath = self.__ericProject.getProjectPath()
 self.__trackerFilePath = os.path.join(
-self.__e5project.getProjectManagementDir(),
+self.__ericProject.getProjectManagementDir(),
 TimeTracker.FileName)
 self.__readTrackerEntries()
 self.__widget.showTrackerEntries(sorted(self.__entries.values(),
 reverse=True))
 """
 Private slot to read the time tracker entries from a file.
 """
 if os.path.exists(self.__trackerFilePath):
 try:
-with open(self.__trackerFilePath, "r", encoding="utf-8") as f:
+with open(self.__trackerFilePath, "r") as f:
-data = f.read()
+jsonString = f.read()
-except OSError as err:
+entriesDataList = json.loads(jsonString)
-E5MessageBox.critical(
+except (OSError, json.JSONDecodeError) as err:
+EricMessageBox.critical(
 self.__ui,
 self.tr("Read Time Tracker File"),
 self.tr("""<p>The time tracker file <b>{0}</b> could"""
 """ not be read.</p><p>Reason: {1}</p>""")
 .format(self.__trackerFilePath, str(err)))
 return
 from .TimeTrackEntry import TimeTrackEntry
 invalidCount = 0
-for line in data.splitlines():
+for data in entriesDataList:
-entry = TimeTrackEntry(self.__plugin)
+entry  = TimeTrackEntry(self.__plugin)
-eid = entry.fromString(line.strip())
+eid = entry.fromDict(data)
 if eid > -1:
 self.__entries[eid] = entry
 else:
 invalidCount += 1
 if invalidCount:
-E5MessageBox.information(
+EricMessageBox.information(
 self.__ui,
 self.tr("Read Time Tracker File"),
 self.tr("""<p>The time tracker file <b>{0}</b>"""
 """ contained %n invalid entries. These"""
 """ have been discarded.</p>""", "",
 def saveTrackerEntries(self, filePath="", ids=None):
 """
 Public slot to save the tracker entries to a file.
-@keyparam filePath path and name of the file to write the entries to
+@param filePath path and name of the file to write the entries to
-(string)
+@type str
-@keyparam ids list of entry IDs to be written (list of integer)
+@param ids list of entry IDs to be written
+@type list of int
 """
 if not filePath:
 filePath = self.__trackerFilePath
-entriesList = (
+entriesDataList = (
-[self.__entries[eid] for eid in ids if eid in self.__entries]
+[self.__entries[eid].toDict()
+for eid in ids if eid in self.__entries]
 if ids else
-self.__entries.values()
+[e.toDict() for e in self.__entries.values()]
 )
 try:
-with open(filePath, "w", encoding="utf-8") as f:
+jsonString = json.dumps(entriesDataList, indent=2)
-for entry in entriesList:
+with open(filePath, "w") as f:
-if entry.isValid():
+f.write(jsonString)
-f.write(entry.toString() + "\n")
+except (TypeError, OSError) as err:
-except OSError as err:
+EricMessageBox.critical(
-E5MessageBox.critical(
 self.__ui,
 self.tr("Save Time Tracker File"),
 self.tr("""<p>The time tracker file <b>{0}</b> could"""
 """ not be saved.</p><p>Reason: {1}</p>""")
 .format(self.__trackerFilePath, str(err)))
 @param fname name of the file to import (string)
 """
 try:
 with open(fname, "r", encoding="utf-8") as f:
-data = f.read()
+jsonString = f.read()
-except OSError as err:
+entriesDataList = json.loads(jsonString)
-E5MessageBox.critical(
+except (OSError, json.JSONDecodeError) as err:
+EricMessageBox.critical(
 self.__ui,
 self.tr("Import Time Tracker File"),
 self.tr("""<p>The time tracker file <b>{0}</b> could"""
 """ not be read.</p><p>Reason: {1}</p>""")
 .format(fname, str(err)))
 from .TimeTrackEntry import TimeTrackEntry
 invalidCount = 0
 duplicateCount = 0
 entries = []
-for line in data.splitlines():
+for data in entriesDataList:
 entry = TimeTrackEntry(self.__plugin)
-eid = entry.fromString(line.strip())
+eid = entry.fromDict(data)
 if eid > -1:
 entries.append(entry)
 else:
 invalidCount += 1
 """ %n invalid entries.""",
 "", invalidCount).format(fname)
 msg += " " + self.tr(
 """ %n entries have been ignored.</p>""",
 "", invalidCount + duplicateCount)
-E5MessageBox.information(
+EricMessageBox.information(
 self.__ui,
 self.tr("Import Time Tracker File"),
 msg)
 self.__widget.clear()
 def addTrackerEntry(self, startDateTime, duration, task, comment):
 """
 Public method to add a new tracker entry based on the given data.
-@param startDateTime start date and time (QDateTime)
+@param startDateTime start date and time
-@param duration duration in minutes (integer)
+@type QDateTime
-@param task task description (string)
+@param duration duration in minutes
-@param comment comment (string)
+@type int
+@param task task description
+@type str
+@param comment comment
+@type str
 """
 if not self.__plugin.getPreferences("AllowDuplicates"):
 startDateTimes = [
 entry.getStartDateTime() for entry in self.__entries.values()]
 if startDateTime in startDateTimes:
 entry.setTask(task)
 entry.setComment(comment)
 self.__entries[nextID] = entry
 self.__widget.clear()
-self.__widget.showTrackerEntries(sorted(self.__entries.values(),
+self.__widget.showTrackerEntries(
-reverse=True))
+sorted(self.__entries.values(), reverse=True))
 self.__widget.setCurrentEntry(self.__currentEntry)
 def pauseTrackerEntry(self):
 """
 Public method to pause the current tracker entry.
 def stopTrackerEntry(self):
 """
 Public method to stop the current tracker entry.
 @return tuple of the ID assigned to the stopped tracker entry and
-the duration (integer, integer)
+the duration
+@rtype tuple of (int, int)
 """
 duration = 0
 nextID = -1
 if self.__currentEntry is not None:
 self.__currentEntry.stop()
 if self.__currentEntry.isValid():
-if len(self.__entries.keys()):
+nextID = (
-nextID = max(self.__entries.keys()) + 1
+max(self.__entries.keys()) + 1
-else:
+if len(self.__entries.keys()) else
-nextID = 0
+0
+)
 self.__currentEntry.setID(nextID)
 self.__entries[nextID] = self.__currentEntry
 if self.__plugin.getPreferences("AutoSave"):
 self.saveTrackerEntries()
 duration = self.__currentEntry.getDuration()
 def getCurrentEntry(self):
 """
 Public method to get a reference to the current tracker entry.
-@return reference to the current entry (TimeTrackEntry)
+@return reference to the current entry
+@rtype TimeTrackEntry
 """
 return self.__currentEntry
 def getEntry(self, eid):
 """
 Public method to get a tracker entry given its ID.
-@param eid ID of the tracker entry (integer)
+@param eid ID of the tracker entry
-@return entry for the given ID (TimeTrackEntry) or None
+@type int
+@return entry for the given ID or None
+@rtype TimeTrackEntry
 """
 if eid in self.__entries:
 return self.__entries[eid]
 else:
 return None
 def deleteTrackerEntry(self, eid):
 """
 Public method to delete a tracker entry given its ID.
-@param eid ID of the tracker entry (integer)
+@param eid ID of the tracker entry
+@type int
 """
 if eid in self.__entries:
 del self.__entries[eid]
 def removeDuplicateTrackerEntries(self):
 if self.__plugin.getPreferences("AutoSave"):
 self.saveTrackerEntries()
 self.__widget.clear()
-self.__widget.showTrackerEntries(sorted(self.__entries.values(),
+self.__widget.showTrackerEntries(
-reverse=True))
+sorted(self.__entries.values(), reverse=True))
 self.__widget.setCurrentEntry(self.__currentEntry)
 def mergeDuplicateTrackerEntries(self):
 """
 Public slot to merge duplicate time tracker entries.
 if self.__plugin.getPreferences("AutoSave"):
 self.saveTrackerEntries()
 self.__widget.clear()
-self.__widget.showTrackerEntries(sorted(self.__entries.values(),
+self.__widget.showTrackerEntries(
-reverse=True))
+sorted(self.__entries.values(), reverse=True))
 self.__widget.setCurrentEntry(self.__currentEntry)
 def entryChanged(self):
 """
 Public method to indicate an external change to any of the entries.
 def getPreferences(self, key):
 """
 Public method to retrieve the various settings.
-@param key the key of the value to get
+@param key key of the value to get
-@return the requested setting
+@type str
+@return value of the requested setting
+@rtype Any
 """
 return self.__plugin.getPreferences(key)
 def __activateWidget(self):
 """
-Private slot to handle the activation of the project browser.
+Private slot to handle the activation of the time tracker widget.
 """
 uiLayoutType = self.__ui.getLayoutType()
 if uiLayoutType == "Toolboxes":
 self.__ui.hToolboxDock.show()
 elif uiLayoutType == "Sidebars":
 self.__ui.bottomSidebar.show()
 self.__ui.bottomSidebar.setCurrentWidget(self.__widget)
 else:
 self.__widget.show()
-self.__widget.setFocus(Qt.ActiveWindowFocusReason)
+self.__widget.setFocus(Qt.FocusReason.ActiveWindowFocusReason)

Mercurial Repositories > Time Tracker / file comparison

comparison: TimeTracker/TimeTracker.py

TimeTracker/TimeTracker.py