Time Tracker: comparison TimeTracker/TimeTrackEntry.py

-:44ec4168b442
+:693e42176007
 """
 Module implementing the time track entry class.
 """
-from PyQt5.QtCore import Qt, QDateTime, QTime
+from PyQt6.QtCore import Qt, QDateTime, QTime
 class TimeTrackEntry:
 """
 Class implementing the time track entry.
 def __init__(self, plugin):
 """
 Constructor
-@param plugin reference to the plugin object (TimeTrackerPlugin)
+@param plugin reference to the plugin object
+@type TimeTrackerPlugin
 """
 self.__plugin = plugin
 self.__entryMembersCount = 5
 self.__id = -1
 def __lt__(self, other):
 """
 Special method implementing the less than function.
-@param other reference to the other object (TimeTrackEntry)
+@param other reference to the other object
-@return flag indicating that self is less than other (boolean)
+@type TimeTrackEntry
+@return flag indicating that self is less than other
+@rtype bool
 """
 return self.__startDateTime < other.getStartDateTime()
-def toString(self):
+def toDict(self):
 """
-Public method to get a string representation of the entry.
+Public method to convert the time track entry into a dictionary.
-@return string representation of the entry (string)
+@return dictionary containing the time track entry data
+@rtype dict
 """
 if self.__valid:
-dataLine = TimeTrackEntry.Separator.join([
+return {
-str(self.__id),
+"id": self.__id,
-self.__startDateTime.toString(Qt.ISODate),
+"start": self.__startDateTime.toString(Qt.DateFormat.ISODate),
-str(self.__duration),
+"duration": self.__duration,
-self.__task,
+"task": self.__task,
-self.__comment,
+"comment": self.__comment,
-])
+}
-return "{0}{1}".format(TimeTrackEntry.LineMarker, dataLine)
 else:
-return ""
+return {}
-def fromString(self, line):
+def fromDict(self, data):
 """
-Public method to populate the entry from the given string.
+Public method to populate the time track entry from a dictionary.
-@param line stringified entry data as generated by toString() (string)
+@param data dictionary containing the time track entry data
-@return ID of the tracker entry; -1 indicates an error (integer)
+@type dict
-"""
+@return ID of the tracker entry; -1 indicates an error
-if not line.startswith(TimeTrackEntry.LineMarker):
+@rtype int
+"""
+if len(data) != self.__entryMembersCount:
 return -1
-line = line.replace(TimeTrackEntry.LineMarker, "")
+self.__id = data["id"]
-dataList = line.split(TimeTrackEntry.Separator)
-if len(dataList) != self.__entryMembersCount:
+dt = QDateTime.fromString(data["start"], Qt.DateFormat.ISODate)
-return -1
-try:
-self.__id = int(dataList[0])
-except ValueError:
-return -1
-dt = QDateTime.fromString(dataList[1], Qt.ISODate)
 if not dt.isValid():
 return -1
 self.__startDateTime = dt
-try:
+self.__duration = data["duration"]
-dt = int(dataList[2])
+self.__task = data["task"]
-except ValueError:
+self.__comment = data["comment"]
-return -1
-self.__duration = dt
-self.__task = dataList[3]
-self.__comment = dataList[4]
 self.__valid = True
 return self.__id
+##    def toString(self):
+##        """
+##        Public method to get a string representation of the entry.
+##
+##        @return string representation of the entry (string)
+##        """
+##        if self.__valid:
+##            dataLine = TimeTrackEntry.Separator.join([
+##                str(self.__id),
+##                self.__startDateTime.toString(Qt.DateFormat.ISODate),
+##                str(self.__duration),
+##                self.__task,
+##                self.__comment,
+##            ])
+##            return "{0}{1}".format(TimeTrackEntry.LineMarker, dataLine)
+##        else:
+##            return ""
+##
+##    def fromString(self, line):
+##        """
+##        Public method to populate the entry from the given string.
+##
+##        @param line stringified entry data as generated by toString() (string)
+##        @return ID of the tracker entry; -1 indicates an error (integer)
+##        """
+##        if not line.startswith(TimeTrackEntry.LineMarker):
+##            return -1
+##
+##        line = line.replace(TimeTrackEntry.LineMarker, "")
+##        dataList = line.split(TimeTrackEntry.Separator)
+##        if len(dataList) != self.__entryMembersCount:
+##            return -1
+##
+##        try:
+##            self.__id = int(dataList[0])
+##        except ValueError:
+##            return -1
+##
+##        dt = QDateTime.fromString(dataList[1], Qt.DateFormat.ISODate)
+##        if not dt.isValid():
+##            return -1
+##        self.__startDateTime = dt
+##
+##        try:
+##            dt = int(dataList[2])
+##        except ValueError:
+##            return -1
+##        self.__duration = dt
+##
+##        self.__task = dataList[3]
+##        self.__comment = dataList[4]
+##
+##        self.__valid = True
+##        return self.__id
+##
 def isValid(self):
 """
 Public method to check the validity of the entry.
-@return validity of the entry (boolean)
+@return validity of the entry
+@rtype bool
 """
 return self.__valid
 def start(self):
 """
 def isPaused(self):
 """
 Public method to check for a paused state.
-@return flag indicating a paused state (boolean)
+@return flag indicating a paused state
+@rtype bool
 """
 return self.__paused
 def __currentDateTime(self):
 """
 Private method to get the current date and time without milliseconds.
-@return current date and time (QDateTime)
+@return current date and time
+@rtype QDateTime
 """
 dt = QDateTime.currentDateTime()
 t = dt.time()
 t2 = QTime(t.hour(), t.minute(), t.second())
 dt.setTime(t2)
 def __calculateDuration(self, start, stop):
 """
 Private method to calculate the duration in minutes.
-@param start start date and time (QDateTime)
+@param start start date and time
-@param stop end date and time (QDateTime)
+@type QDateTime
-@return duration in minutes (int)
+@param stop end date and time
+@type QDateTime
+@return duration in minutes
+@rtype int
 """
 secs = start.secsTo(stop)
 minutes = secs // 60
 secsRemaining = secs % 60
 if secsRemaining >= 30:
 def getID(self):
 """
 Public method to get the ID of the entry.
-@return ID of the entry (integer)
+@return ID of the entry
+@rtype int
 """
 return self.__id
 def setID(self, eid):
 """
 Public method to assign an ID to the entry.
-@param eid ID for the entry (integer)
+@param eid ID for the entry
+@type int
 """
 self.__id = eid
 def getStartDateTime(self):
 """
 Public method to get the start date and time.
-@return start date and time (QDateTime)
+@return start date and time
+@rtype QDateTime
 """
 return self.__startDateTime
 def setStartDateTime(self, startDateTime):
 """
 Public method to set the start date and time.
-@param startDateTime start date and time (QDateTime)
+@param startDateTime start date and time
+@type QDateTime
 """
 if startDateTime.isValid():
 self.__startDateTime = startDateTime
 self.__valid = (
 self.__startDateTime.isValid() and
 def getDuration(self):
 """
 Public slot to get the duration.
-@return duration (integer)
+@return duration
+@rtype int
 """
 return self.__duration
 def setDuration(self, duration):
 """
 Public method to set the duration.
-@param duration duration in minutes (integer)
+@param duration duration in minutes
+@type int
 """
 if duration >= self.__plugin.getPreferences("MinimumDuration"):
 self.__duration = duration
 self.__valid = (
 self.__startDateTime.isValid() and
 def addDuration(self, duration):
 """
 Public method to add a duration.
-@param duration duration to be added in minutes (integer). Negative
+@param duration duration to be added in minutes. Negative values are
-values are ignored.
+ignored.
+@type int
 """
 if duration > 0:
 self.__duration += duration
 def getTask(self):
 """
 Public method to get the task description.
-@return task description (string)
+@return task description
+@rtype str
 """
 return self.__task
 def setTask(self, description):
 """
 Public method to set the task description.
-@param description task description (string)
+@param description task description
+@type str
 """
 self.__task = (
 description.replace("\r\n", " ").replace("\n", " ")
 .replace("\r", " ")
 )
 def getComment(self):
 """
 Public method to get the comment.
-@return comment (string)
+@return comment
+@rtype str
 """
 return self.__comment
 def setComment(self, comment):
 """
 Public method to set a comment.
-@param comment comment to set (string)
+@param comment comment to set
+@type str
 """
 self.__comment = (
 comment.replace("\r\n", " ").replace("\n", " ").replace("\r", " ")
 )
 def getEntryData(self):
 """
 Public method to get the entry data.
-@return entry data as a tuple of start date (string), start time
+@return entry data as a dictionary with keys 'id', 'paused',
-(string), duration (integer), task (string), comment (string)
+'start_date', 'start_time', 'duration', 'task' and 'comment'
-and flag indicating a paused state (boolean)
+containing the entry ID, a flag indicating a paused
-"""
+state, the start date as a string, the start time as a string,
-return (
+the duration, the task and a comment
-self.__id,
+@rtype dict
-self.__startDateTime.toString("yyyy-MM-dd"),
+"""
-self.__startDateTime.toString("hh:mm"),
+return {
-self.__duration,
+"id": self.__id,
-self.__task,
+"paused": self.__paused,
-self.__comment,
+"start_date": self.__startDateTime.toString("yyyy-MM-dd"),
-self.__paused,
+"start_time": self.__startDateTime.toString("hh:mm:ss"),
-)
+"duration": self.__duration,
+"task": self.__task,
+"comment": self.__comment,
+}

Mercurial Repositories > Time Tracker / file comparison

comparison: TimeTracker/TimeTrackEntry.py

TimeTracker/TimeTrackEntry.py