- Updated to Python 3.13.4

- DayOff: changed start datetime to time in __int__
- Named:  added Rotation.dayOff; Invalidated cached periods in addSegments()
- Moved ShiftInstance to its own file
- ShiftUtils: Use UTC to avoid timezone issues, improved formatTimedelta(), toRoundedSecond() - Standard rounding, improved compare()
- Team:  calculateWorkingTime() - rename toTime to toTimeOfDay
- TeamMember: added setAddition() and setRemoval()
- TimePeriod:  changed start datetime to time in __int__; simplified timePlus()
- WorkSchedule:  fixed issue with deleteShift()

Author: point85

doc.zip

@@ -10,7 +10,7 @@ exclude = [".settings", ".project", ".pydevproject", "README.md"]
 
 [project]
 name = "PyWorkShift"
-version = "1.1.0"
+version = "1.1.1"
 keywords = ["shift", "work schedule", "shift calendar", "work calendar"]
 authors = [
   { name="Kent Randall", email="point85.llc@gmail.com" },

pyproject.toml

@@ -11,4 +11,15 @@ v1.0.2 January 11, 2024
 
 v1.1.0 December 20, 2024
 - Added team members and shift exceptions for the team
-- Created a PyPI distribution
+- Created a PyPI distribution
+
+v1.1.1 June 5, 2025
+- Updated to  Python 3.13.4
+- DayOff: changed start datetime to time in __int__
+- Named:  added Rotation.dayOff; Invalidated cached periods in addSegments()
+- Moved ShiftInstance to its own file
+- ShiftUtils: Use UTC to avoid timezone issues, improved formatTimedelta(), toRoundedSecond() - Standard rounding, improved compare()
+- Team:  calculateWorkingTime() - rename toTime to toTimeOfDay
+- TeamMember: added setAddition() and setRemoval()
+- TimePeriod:  changed start datetime to time in __int__; simplified timePlus()
+- WorkSchedule:  fixed issue with deleteShift()

release_notes.txt

@@ -3,7 +3,7 @@
 setup(
     name = "PyShift",
     packages = find_packages(),
-    version = "1.1.0",
+    version = "1.1.1",
     description = "Work schedule library for Python",
     author = "Kent Randall",
     author_email = "point85.llc@gmail.com",

setup.py

@@ -1,5 +1,5 @@
 from PyShift.workschedule.time_period import TimePeriod
-from datetime import timedelta, datetime
+from datetime import timedelta, time
 
 ##
 # Class DayOff represents a scheduled non-working period
@@ -16,7 +16,7 @@ class DayOff(TimePeriod):
     # @param start Date and time of day when period starts
     # @param duration Duration of day off
     #
-    def __init__(self, name: str, description: str, start: datetime, duration: timedelta):
+    def __init__(self, name: str, description: str, start: time, duration: timedelta):
         super().__init__(name, description, start, duration)
 
     ##

workschedule/day_off.py

@@ -99,7 +99,7 @@ msgid "shift.already.exists"
 msgstr "Shift {0} has already been created."
 
 msgid "shift.in.use"
-msgstr "Shift {0} is being used in a work schedule."
+msgstr "Shift {0} is being used by team {1}."
 
 msgid "nonworking.period.already.exists"
 msgstr "Non-working period {0} has already been created."

workschedule/locales/en_US/LC_MESSAGES/schedule.mo

@@ -31,10 +31,20 @@ def __ne__(self, other) -> bool:
         return not self.__eq__(other)
 
     def __lt__(self, other) -> bool:
+        if other is None or not isinstance(other, Named):
+            return NotImplemented
         return self.name < other.name
-
+    
     def __gt__(self, other) -> bool:
-        return self.name > other.name     
+        if other is None or not isinstance(other, Named):
+            return NotImplemented
+        return self.name > other.name   
+    
+    def __le__(self, other) -> bool:
+        return self.name <= other.name
+    
+    def __ge__(self, other) -> bool:
+        return self.name >= other.name
 
     def __str__(self) -> str:
         return self.name + " (" + self.description + ")"
@@ -45,6 +55,9 @@ def setName(self, name: str):
             raise PyShiftException(msg)
 
         self.name = name
+        
+    def setDescription(self, description: str):
+        self.description = description or ""        
 
     ##
     # Compare two Named objects by name

workschedule/locales/en_US/LC_MESSAGES/schedule.po

@@ -1,5 +1,6 @@
 from datetime import datetime, time, timedelta, date
 from operator import attrgetter
+from typing import List, Union
 
 from PyShift.workschedule.named import Named
 from PyShift.workschedule.localizer import Localizer
@@ -70,15 +71,15 @@ def __init__(self, name: str, description: str):
     def getDayOff() -> DayOff:
         if (Rotation.dayOff is None):
             midnight = datetime.combine(date.today(), time.min)
-            dayOff = DayOff("DAY_OFF", "24 hour off period", midnight, timedelta(hours=24))
-        return dayOff
+            Rotation.dayOff = DayOff("DAY_OFF", "24 hour off period", midnight, timedelta(hours=24))
+        return Rotation.dayOff 
 
     ##
     # Get the shifts and off-shifts in the rotation
     # 
     # @return List of periods
     #
-    def getPeriods(self) -> []:
+    def getPeriods(self) -> List[Union[Shift, DayOff]]:
         if (self.periods is None):
             self.periods = []
 
@@ -147,6 +148,10 @@ def addSegment(self, startingShift: Shift, daysOn: int, daysOff: int) -> Rotatio
         segment = RotationSegment(startingShift, daysOn, daysOff, self)
         self.rotationSegments.append(segment)
         segment.sequence = len(self.rotationSegments)
+        
+        # Invalidate cached periods
+        self.periods = None
+        
         return segment
 
     def __str__(self) -> str:
@@ -160,7 +165,7 @@ def __str__(self) -> str:
 
         periods= ""
 
-        for period in self.periods:
+        for period in self.getPeriods():
             if (len(periods) > 0):
                 periods += ", "
 

workschedule/named.py

@@ -1,4 +1,4 @@
-from datetime import datetime, time, timedelta
+from datetime import time, timedelta
 
 from PyShift.workschedule.time_period import TimePeriod
 from PyShift.workschedule.work_break import Break
@@ -198,72 +198,4 @@ def __str__(self) -> str:
             text += "\n      " + str(breakPeriod)
 
         return text
-
-##
-# Class ShiftInstance is an instance of a {@link Shift}. A shift instance is
-# worked by a {@link Team}.
-#
-class ShiftInstance: 
-    ##
-    # Construct an instance of a shift
-    # @param shift {@link Shift} definition
-    # @param startDateTime Starting date and time of day
-    # @param team {link Team} working the shift instance
-    def __init__(self, shift: Shift, startDateTime: datetime, team):
-        # definition of the shift instance
-        self.shift = shift
-        
-        # start date and time of day
-        self.startDateTime = startDateTime
-        
-        # team working it
-        self.team = team
-
-    ##
-    # Get the ending date and time of day
-    # 
-    # @return datetime when shift ends
-    #
-    def getEndTime(self) -> datetime:
-        return self.startDateTime + self.shift.duration
-
-    ##
-    # Compare this shift to another such period by start date and time of
-    # day
-    #
-    # @param other Other shift instance
-    # 
-    # @return -1 if less than, 0 if equal and 1 if greater than
-    #
-    def compareTo(self, other) -> int:
-        value = 0
-        
-        if (self.startDateTime < other.startDateTime):
-            value = -1
-        elif (self.startDateTime > other.startDateTime):
-            value = 1
-        return value
-    
-    ##
-    # Determine if this time falls within the shift instance period
-    # 
-    # @param dateTime Date and time to check
-    # @return True if the specified time is in this shift instance
-    #
-    def isInShiftInstance(self, dateTime: datetime) -> bool:
-        return (dateTime.compareTo(self.startDateTime) >= 0 and dateTime.compareTo(self.getEndTime()) <= 0)
-
-    def __str__(self) -> str:
-        t = Localizer.instance().messageStr("team")
-        s = Localizer.instance().messageStr("shift")
-        ps = Localizer.instance().messageStr("period.start")
-        pe = Localizer.instance().messageStr("period.end")
-        members = Localizer.instance().messageStr("team.members")
-
-        text = " " + t + ": " + self.team.name + ", " + s + ": " + self.shift.name + ", " + ps + ": " + str(self.startDateTime) + ", " + pe + ": " + str(self.getEndTime()) + "\n" + members
-        
-        for member in self.team.getMembers(self.startDateTime):
-            text += "\n\t" + str(member)
-
-        return text