Направете сложното си планиране лесно с таймборд, библиотека на Python

timeboardе библиотека на Python, която създава графици на работни периоди и извършва календарни изчисления над тях. Можете да създавате стандартни календари за работни дни, както и множество други графици, прости или сложни.

Можете да намерите документацията тук.

Вижте репозитория на GitHub тук.

Намерете го на PyPI тук.

Историята

Започна със случая с броя на служителите. Нашата компания представи KPI, включващи приходите на служител, така че трябваше да знаем средния годишен брой на всеки екип. Вече бях писал скриптове на Python, така че не се страхувах.

За да получа брой служители, трябваше да изчисля броя работни дни, които всеки служител е прекарал с компанията в рамките на годината. Панди ще се справят за секунда, помислих си. Но се оказа, че Пандас не може.

Руският бизнес календар е тромав. Те сменят делниците със събота или неделя, за да запълнят празнините между празниците и почивните дни. Например, трябва да дойдете на работа в събота през февруари, за да получите възстановяване на безплатен понеделник, предшестващ празничния вторник някъде през май.

Схемата за всяка година е уникална. Календарът на работния ден на Pandas поддържа само еднопосочни изменения за наблюдение на празниците. Така че, бих могъл да превърна един работен ден в почивен ден, но не и обратното.

Тогава имаше оператори в кол центъра и безпокойството ми се обърна в другата посока. Те работят на смени с различна дължина и една смяна, последвана от три смени. За да получа статистика на кол центъра, нямах нужда от календара за работния ден. И все пак трябваше да преброя броя на смените на определен оператор за определен период от време.

И накрая, необичаен проблем. В моя местен дилър на Honda механиците работят по алтернативни седмични графици: понеделник, вторник, събота и неделя тази седмица и от сряда до петък следващата седмица. Исках винаги да бъда обслужван от определен механик, защото другият веднъж беше объркал спирачките. Исках лесен начин да определя следващата смяна на „моя” механик.

Тези случаи имат обща основа. Техните решения биха разчитали на график от периоди на „дежурство“ и „извън дежурство“. Би трябвало да можем да изградим различни структурирани графици, подходящи за различни бизнес казуси. Запитванията и изчисленията, изпълнявани по графика, трябва да правят разлика между периодите на „дежурство“ и „извън дежурството“.

Не можах да намеря пакет на Python, който предоставяше средства за изграждане и заявки за такива графици. Както се случи, имах малко свободно време да го напиша сам.

Концепцията

timeboardе библиотека на Python, която създава графици на работни периоди и извършва календарни изчисления над тях. Самите тези обекти се наричат ​​таймбордове.

Има три основни стъпки в разсъжденията относно времевия график.

Започвате с интервал от време, който определя границите на вашия календар. Всичко ще бъде ограничено до този интервал. Нарича се (референтна) рамка. Рамката се състои от базови единици. Базова единица е най-малкият период от време, необходим за измерване на календара ви. Например, ако разсъждавате по отношение на работни дни, тогава основната единица е ден. Като алтернатива, ако изградите график на многочасови смени, тогава основната единица е един час.

На следващата стъпка дефинирате правилата за маркиране на рамката в работни смени. Работните смени са периоди от време, за които се грижите. Те съставят календара ви. Именно работни смени искате да планирате или да преброите. В стандартния календар на работните дни работната смяна е ден (а основната единица също е ден, така че те съвпадат).

В кол център, работната смяна е период от няколко часа, когато определена смяна на операторите е на работа. Базовата единица вероятно ще бъде един час и всяка работна смяна съдържа (вероятно различен) брой базови единици.

Последователността на работните смени, запълващи рамката, се нарича времева линия.

Накрая създавате един или повече графици. Графикът е като шаблон, положен върху времевата линия. Целта му е да разграничи дежурните работни смени от такива, които не работят.

График се нуждае от нещо, с което да работи, за да декларира работна смяна на дежурство или извън служба. Ето защо предоставяте етикет за всяка работна смяна или по-скоро правило за етикетирането им, докато рамката е маркирана във времевата линия. Всеки график дефинира селекторна функция, която проверява етикета на работната смяна и връща True за дежурните работни смени и False в противен случай. Освен ако не го замените, времевата линия се придружава от графика по подразбиране, чийто селектор връща булевата стойност на етикета.

Понякога искате да дефинирате няколко графика за една и съща времева линия. Например в кол центъра ще има график за кол центъра като цяло и отделен график за всеки екип от оператори. Същият работен дежур може да бъде намерен на дежурство при някои графици и извън дежурството по останалите.

Timeboard = времева линия + графици. По-точно, таймбордът е колекция от работни графици, базирани на конкретна времева линия на работни смени, изградена върху референтна рамка .

След като получите табло, можете да извършите полезната работа: направете изчисления в календара, за да разрешите проблемите като описаните в пролога.

Всяко изчисление, извършено с таймборд, е задължително. Извиканият метод „вижда“ само работни смени с определеното задължение и игнорира останалите. За да се разкрие задължението на работните смени, методът трябва да получи график. Следователно, всяко изчисление на часовия график се параметризира с мито и график.

По подразбиране дежурството е включено, а графикът е графикът по подразбиране на часовия график. Например, ако се обадите count()без аргументи на някакъв интервал от времеви график, ще получите броя работни смени в интервала, които са декларирани по дежурство по график по подразбиране. Тези настройки по подразбиране улесняват живота, защото на практика ще искате да се занимавате най-вече с дежурни работни смени.

API

Пълната документация на таблото е достъпна в Прочетете документите.

Пакетът може да се инсталира с обичайното pip install timeboard.

Настройте времеви график

Най-простият начин да започнете е да използвате предварително конфигуриран календар, който се доставя с пакета. Да вземем обикновен календар на работния ден за САЩ.

 >>> import timeboard.calendars.US as US >>> clnd = US.Weekly8x5()

clnd object is a timeboard (an instance of timeboard.Timeboard class). It has only one default schedule which selects weekdays as on-duty workshifts while weekends, as well as observations of US federal holidays, are declared off duty.

The tools for building your own timeboard will be briefly reviewed later on after we look at what you can do with a timeboard.

Play with workshifts

Calling a timeboard instance clnd() with a single point in time retrieves the workshift that contains this point. How that you have a workshift you can query its duty:

Is a certain date a business day?

>>> ws = clnd('27 May 2017')>>> ws.is_on_duty()False

Indeed, it was a Saturday.

You can also look into the future or in the past from the current workshift:

When was the next business day?

>>> ws.rollforward()Workshift(6359) of 'D' at 2017–05–30

The returned workshift has the sequence number of 6359 and represents the day of 30 May 2017, which, by the way, was the Tuesday after the Memorial Day holiday.

If we were to finish the project in 22 business days starting on 01 May 2017, when would be our deadline?

>>> clnd('01 May 2017') + 22Workshift(6361) of 'D' at 2017–06–01

This is the same as:

>>> clnd('01 May 2017').rollforward(22)Workshift(6361) of 'D' at 2017–06–01

Play with intervals

Calling clnd() with a different set of parameters produces an object representing an interval on the calendar. The interval below contains all workshifts of the month of May 2017:

>>> may2017 = clnd('May 2017', period="M")

How many business days were there in May?

>>> may2017.count()22

How many days off?

>>> may2017.count(duty='off')9

How many working hours?

>>> may2017.worktime()176

An employee was on the staff from April 3, 2017, to May 15, 2017. What portion of April’s salary did the company owe them?

Note that calling clnd() with a tuple of two points in time produces an interval containing all workshifts between these points, inclusively.

>>> time_in_company = clnd(('03 Apr 2017','15 May 2017'))>>> time_in_company.what_portion_of(clnd('Apr 2017', period="M"))1.0

Indeed, the 1st and the 2nd of April in 2017 fell on the weekend, therefore, having started on the 3rd, the employee checked out all the working days in the month.

And what portion of May’s?

>>> time_in_company.what_portion_of(may2017)0.5

How many days had the employee worked in May?

The multiplication operator returns the intersection of two intervals.

>>> (time_in_company * may2017).count()11

How many hours?

>>> (time_in_company * may2017).worktime()88

An employee was on the staff from 01 Jan 2016 to 15 Jul 2017. How many years had this person worked for the company?

>>> clnd(('01 Jan 2016', '15 Jul 2017')).count_periods('A')1.5421686746987953

Build your own timeboard

For the purpose of introduction, I will just plunge into two examples. If it seems too steep, please, find the thorough discussion of the construction tools in the project documentation.

The import statement for this section:

>>> import timeboard as tb

Let me return to a schedule of workshifts in the car dealership which I mentioned in the prologue. A mechanic works on Monday, Tuesday, Saturday, and Sunday this week, and on Wednesday, Thursday, and Friday next week; then the bi-weekly cycle repeats. The timeboard is created by the following code:

>>> biweekly = tb.Organizer(marker='W',... structure=[[1,1,0,0,0,1,1], [0,0,1,1,1,0,0]])>>> clnd = tb.Timeboard(base_unit_freq='D', ... start="01 Oct 2017", end="31 Dec 2018", ... layout=biweekly)

It makes sense to look into the last statement first. It creates a timeboard named clnd. The first three parameters define the frame to be a sequence of days (‘D’) from 01 Oct 2017 to 31 Dec 2018. The layout parameter tells how to organize the frame into the timeline of workshifts. This job is commissioned to an Organizer named biweekly.

The first statement creates this Organizer which takes two parameters: marker and structure. We use amarker to place marks on the frame. The marks are kind of milestones which divide the frame into subframes, or “spans”. In the example marker=’W’ puts a mark at the beginning of each calendar week. Therefore, each span represents a week.

The structure parameter tells how to create workshifts within each span. The first element of structure, the list [1,1,0,0,0,1,1], is applied to the first span (i.e. to the first week of our calendar). Each base unit (that is, each day) within the span becomes a workshift. The workshifts receive labels from the list, in order.

The second element of structure, the list [0,0,1,1,1,0,0], is analogously applied to the second span (the second week). After this, since we’ve gotten no more elements, a structure is replayed in cycles. Hence, the third week is serviced by the first element of structure, the fourth week by the second, and so on.

As a result, our timeline becomes the sequence of days labeled with the number 1 when the mechanic is on duty and with the number 0 when he or she is not. We have not specified any schedule, because the schedule which is built by default suits us fine. The default schedule considers the boolean value of the label, so 1 translates into ‘on duty’, and zero into ‘off duty’.

With this timeboard, we can do any type of calculations that we have done earlier with the business calendar. For example, if a person was employed to this schedule from November 4, 2017, and salary is paid monthly, what portion of November’s salary has the employee earned?

>>> time_in_company = clnd(('4 Nov 2017', None))>>> nov2017 = clnd('Nov 2017', period="M")>>> time_in_company.what_portion_of(nov2017)0.8125

In the second example we will build a timeboard for a call center. The call center operates round-the-clock in shifts of varying length: 08:00 to 18:00 (10 hours), 18:00 to 02:00 (8 hours), and 02:00 to 08:00 (6 hours). An operator’s schedule consists of one on-duty shift followed by three off-duty shifts. Hence, four teams of operators are needed. They are designated as ‘A’, ‘B’, ‘C’, and ‘D’.

>>> day_parts = tb.Marker(each='D', ... at=[{'hours':2}, {'hours':8}, {'hours':18}])>>> shifts = tb.Organizer(marker=day_parts, ... structure=['A', 'B', 'C', 'D'])>>> clnd = tb.Timeboard(base_unit_freq='H', ... start="01 Jan 2009 02:00", end="01 Jan 2019 01:59",... layout=shifts)>>> clnd.add_schedule(name='team_A', ... selector=lambda label: label=='A')

There are four key differences from the dealership case. We will examine them one by one.

First, the frame’s base unit is now a one-hour period (base_unit_freq='H') instead of a one-day period of the dealership’s calendar.

Second, the value of the marker parameter of the Organizer is now a complex object instead of a single calendar frequency it was before. This object is an instance of Marker class. It is used to define rules for placing marks on the frame when the simple division of the frame into uniform calendar units is not sufficient. The signature of the Marker above is almost readable — it says: place a mark on each day (‘D’) at 02:00 hours, 08:00 hours, and 18:00 hours.

Third, the value of the structure is now simpler: it is a one-level list of teams’ labels. When an element of the structure is not an iterable of labels but just one label, its application to a span produces a single workshift which, literally, spans the span.

In our example, the very first span comprises six one-hour base units starting at 2, 3, 4 … 7 o’clock in the morning of 01 Jan 2009. All these base units are combined into the single workshift with label ‘A’. The second span comprises ten one-hour base units starting at 8, 9, 10 … 17 o’clock. These base units are combined into the single workshift with label ‘B’, and so on. When all labels have been taken, the structure is replayed, so the fifth span (08:00:00–17:59:59 on 01 Jan 2009) becomes a workshift with label ‘A’.

To recap, if an element of structure is a list of labels, each base unit of the span becomes a workshift and receives a label from the list. If an element of structure is a single label, all base units of the span are combined to form a single workshift which receives this label.

And finally, we explicitly created a schedule for team A. The default schedule does not serve our purpose as it returns “always on duty”. This is true for the call center as a whole but not so for a particular team. For the new schedule, we supply the name and the selector function which returns True for all workshifts labeled with ‘A’. For the practical use, you will want to create the schedules for the other teams as well.

This timeboard is as good to work with as any other. However, this time we will have to explicitly specify the schedule we want to use.

>>> schedule_A = clnd.schedules['team_A']

How many shifts did the operators of team A sit in November 2017?

>>> nov2017 = clnd('Nov 2017', period="M", schedule=schedule_A)>>> nov2017.count()22

And how many hours were there in total?

>>> nov2017.worktime()176

A person was employed as an operator in team A from November 4, 2017. Salary is paid monthly. What portion of November’s salary has the employee earned?

>>> time_in_company = clnd(('4 Nov 2017',None), schedule=schedule_A)>>> time_in_company.what_portion_of(nov2017)0.9090909090909091

More use cases

You can find more use cases (taken almost from real life) in the jupyter notebook which is the part of the project documentation.

Please feel free to use timeboard and do not hesitate to leave feedback or open issues on GitHub .