pyshiftsla

Pyshiftsla

 Highly customizable SLA calculator and Work shift Generator,
    for any time-keeping and days-off policies

• 回购：https：//github.com/duriandan/pyshiftsla
• PYPI：https：//pypi.org/project/pyshiftsla/

---

安装

 pip install pyshiftsla

QuickStart-越南法律中的一个案件：

• 让我们计算SLA并为在越南工作的美国女性雇员带来工作转变，即将休产假。
• 法律参考：（1）; （2）

1。她将有：

• 产假4个月。
• 假期离开：
  • 所有越南假期。
  • 从本国的新年天（2024-01-01）（与越南太阳新年相同） 1天（+0假期休假）
  • 从本国的独立日（2024-07-04）（+1假期休假） 1天
• 太阳新年的加时性转移：从13:30到14:30
• 加上随机3天

2。ShiftsBuilder的ShiftsBuilder

 from pyshiftsla . shifts_builder import ShiftsBuilder , DateRange , DailyShift , ShiftRange
from pyshiftsla . shift import Shift
from datetime import time , date

US_WOMAN_LIVING_IN_VIETNAM_MATERNITY_LEAVE_4MONTHS_2024 = ShiftsBuilder (
    workdays_weekly = [ 0 , 1 , 2 , 3 , 4 ], # weekday indexes: Monday to Friday
    daily_shifts = DailyShift ([
        # Usual Morning shift: 8:30 to 11:45
        # Created using a string, easier to read but slower
        Shift . fromstr ( "08301145" ),
        # Usual Afternoon shift: 13:30 to 18:00
        # Parsed the timestamps straight to parameters, faster
        Shift ( start = time ( 13 , 30 ), end = time ( 18 ))
    ]),
    days_off_ranges = [ # you can parse `date` or `DateRange`
        date ( 2024 , 1 , 1 ), # SOLAR_NEW_YEAR
        date ( 2024 , 7 , 4 ), # US_INDEPENDENCE_DAY
        DateRange . fromstr ( "20240430-20240501" ), #VIETNAM_VICTORY_DAY
        DateRange . fromstr ( "20240902-20240903" ), #VIETNAM_INDEPENDENCE_DAY
        #VIETNAMESE_LUNAR_NEW_YEAR,
        # Lunar DateRange will automatically turn into Solar DateRange
        DateRange . fromstr ( "20240101-20240105" , calendar_type = "lunar" ),
        #VIETNAM_LUNAR_HUNG_KINGS_FESTIVAL
        DateRange . fromstr ( "20240310" , calendar_type = "lunar" ),

        # 4 months of maternity leave
        DateRange . fromstr ( "20240801-20241201" ),

        date ( 2024 , 2 , 9 ),  # custom days off
        date ( 2024 , 6 , 3 ),  # custom days off
        date ( 2024 , 12 , 10 ),  # custom days off
    ],
    special_shifts = ShiftRange (
        {
            # Urgent overtime in the Solar New Year
            # 13:30 to 14:30
            date ( 2024 , 1 , 1 ): DailyShift ([ Shift . fromstr ( "13301430" )]),
        }
    ),
)

• 为了产生Shift s，这是ShiftsBuilder优先级：

special_shift> days_off_ranges> daily_shifts + workday_weekly

3。生成2024年的ShiftRange

• ShiftRange工作方式就像词典一样，可以在特定date检查生成的Shift 。

 generated_shiftrange = ( # ShiftRange for 2024
    US_WOMAN_LIVING_IN_VIETNAM_MATERNITY_LEAVE_4MONTHS_2024
    . build_shifts_from_daterange (
        from_date = date ( 2024 , 1 , 1 ),
        to_date = date ( 2024 , 12 , 30 ))
    )
# Get Shifts in New Year 2024-01-01
generated_shiftrange [ date ( 2024 , 1 , 1 )] 
# [Shift(start=time(13, 30), end=time(14, 30))]

# Get Shifts in a random working day
generated_shiftrange [ date ( 2024 , 2 , 8 )]
# [
#   Shift(start=time(8, 30), end=time(11, 45)), 
#   Shift(start=time(13, 30), end=time(18, 0)) 
# ]

# Get Shifts in a day off (holiday leave) 2024-07-04
generated_shiftrange [ date ( 2024 , 7 , 4 )] # KeyError: date(2024, 7, 4)
generated_shiftrange . get ( date ( 2024 , 7 , 4 )) # None 

4。计算SLA（服务级协议）

• 结果将以Milliseconds为单位：

 sla_millis = (
    US_WOMAN_LIVING_IN_VIETNAM_MATERNITY_LEAVE_4MONTHS_2024
    . calculate_sla (
        start_deal = datetime ( 2024 , 1 , 1 , 14 ),
        end_deal = datetime ( 2024 , 1 , 2 , 9 , 30 ),
        use_generated_shifts = True , # for faster execution, 
        # reuse the cached results from `build_shifts_from_daterange`,
        # if "False", set re-generated `ShiftsRange` from `start_deal` to `end_deal`
    )
)
sla_hours = sla_millis / ( 1000 * 60 * 60 ) # 1.5 hours

您公司/团队的全球ShiftsBuilder配置

 from pyshiftsla . shifts_builder import ShiftsBuilder , Shift
from datetime import time

COMPANY_SHIFTS_BUILDER = ShiftsBuilder (
    daily_shifts = DailyShift ([
        Shift . fromstr ( "08301145" ), # morning shift, created using a string, easier to read but slower
        Shift ( start = time ( 13 , 30 ), end = time ( 18 )) # afternoon shift, parsed the timestamps straight to parameters, faster
    ]),
    workdays_weekly = [ 0 , 1 , 2 , 3 , 4 ] # Monday to Friday
)

• 将配置复制到特定的employee 。

 employee_takes_4_days_off = (
    COMPANY_SHIFTS_BUILDER
    . add_days_off_range (
        [
            DateRange . fromstr ( "20241204-20241205" ), # 2days off
            DateRange . fromstr ( "20240930-20241001" ) # 2days off
        ],
        inplace = False # if `False` will return a copied `ShiftsBuilder`,
        # if `True`, will change `COMPANY_SHIFTS_BUILDER` and return `None`
    ))