Tee monimutkaisesta aikataulusta yksinkertaisella Timeboardilla, Python-kirjastolla

timeboardon Python-kirjasto, joka luo aikataulut työjaksoille ja suorittaa niiden kalenterilaskelmat. Voit rakentaa vakiopäivän kalentereita sekä useita muita aikatauluja, yksinkertaisia ​​tai monimutkaisia.

Löydät dokumentaation täältä.

Katso GitHub-repo täältä.

Löydä se PyPI: stä täältä.

Tarina

Se alkoi henkilöstömäärästä. Yrityksemme otti käyttöön KPI: t, joihin sisältyy tulot työntekijää kohti, joten meidän oli tiedettävä kunkin tiimin keskimääräinen vuotuinen henkilöstömäärä. Olin jo kirjoittanut Python-komentosarjoja, joten minua ei pelotella.

Henkilöstömäärän saamiseksi minun oli laskettava niiden työpäivien lukumäärä, jotka kukin työntekijä on viettänyt yrityksen kanssa vuoden sisällä. Pandas hoitaisi sen sekunnissa, ajattelin. Mutta kävi ilmi, että Pandas ei voinut.

Venäjän yrityskalenteri on hankala. He vaihtavat arkipäiviä lauantaisin tai sunnuntaisin täyttääkseen aukkoja lomien ja viikonloppujen välillä. Esimerkiksi joudut tulemaan töihin helmikuun lauantaina saadaksesi korvauksen vapaalla maanantaina, joka edeltää lomapäivää tiistaina toukokuussa.

Kunkin vuoden järjestelmä on ainutlaatuinen. Pandan arkipäivän kalenteri tukee vain yksisuuntaisia ​​muutoksia lomahavaintoihin. Joten voisin muuttaa työpäivän vapaapäiväksi, mutta ei päinvastoin.

Sitten puhelinkeskuksessa oli operaattoreita, ja ahdistukseni heilahti toisinpäin. He työskentelevät vaihtelevissa pituuksissa, ja yhden vuoron, jota seuraa kolme vuoroa. Puhekeskuksen tilastojen saamiseksi en tarvinnut arkipäivän kalenteria. Minun piti kuitenkin laskea tiettyjen operaattoreiden vuorojen määrä tietyllä ajanjaksolla.

Ja lopuksi, outo ongelma. Paikallisessa Honda-jälleenmyyjässäni mekaanikot työskentelevät vaihtoehtoisilla viikoittaisilla aikatauluilla: maanantaista, tiistaina, lauantaina ja sunnuntaina tällä viikolla ja keskiviikosta perjantaihin ensi viikolla. Halusin, että minua palvelee aina tietty mekaanikko, koska toinen oli kerran sekoittanut jarrut. Halusin yksinkertaisen tavan määrittää "minun" mekaanikon seuraava vaihto.

Näillä tapauksilla on yhteinen perusta. Heidän ratkaisunsa perustuivat "päivystys-" ja "päivystys" -aikatauluun. Meidän pitäisi pystyä rakentamaan eri tavoin jäsenneltyjä aikatauluja, jotka sopivat erilaisiin liiketoimintatapauksiin. Aikataulun ylittävissä kyselyissä ja laskelmissa on erotettava toisistaan ​​”päivystysajat” ja ”päivät”.

En löytänyt Python-pakettia, joka tarjoaisi keinot tällaisten aikataulujen rakentamiseen ja kyselyihin. Kun se tapahtui, minulla oli vähän aikaa kirjoittaa se itse.

Käsite

timeboardon Python-kirjasto, joka luo aikataulut työjaksoille ja suorittaa niiden kalenterilaskelmat. Näitä esineitä itse kutsutaan aikalaudiksi.

Aikataulun perusteluissa on kolme päävaihetta.

Aloitat aikavälillä, joka asettaa kalenterisi rajat. Kaikki rajoittuu tähän väliin. Sitä kutsutaan (viite) kehykseksi. Runko koostuu perusyksiköistä. Perusyksikkö on pienin ajanjakso, jota tarvitset kalenterisi mittaamiseen. Esimerkiksi, jos päätät työpäivinä, perusyksikkö on päivä. Vaihtoehtoisesti, jos rakennat aikataulun usean tunnin vuoroista, perusyksikkö on yksi tunti.

Seuraavassa vaiheessa määritetään säännöt kehyksen merkitsemisestä työvuoroksi. Työvuorot ovat ajanjaksoja, joista välität. Ne muodostavat kalenterisi. Työvuorot haluat ajastaa tai laskea. Tavallisessa arkipäivän kalenterissa työvuoro on päivä (ja myös perusyksikkö on päivä, joten ne ovat yhtä aikaa).

Puhelukeskuksessa työvuoro on usean tunnin jakso, jolloin tietty operaattorin vuoro on päivystyksessä. Perusyksikkö on todennäköisesti yksi tunti, ja jokainen työvuoro sisältää (todennäköisesti vaihtelevan) määrän perusyksiköitä.

Kehystä täyttävien työvuorojen sarjaa kutsutaan aikajanaksi.

Lopuksi luot yhden tai useamman aikataulun. Aikataulu on kuin kaava, joka on asetettu aikajanalle. Sen tarkoituksena on erottaa päivystävät työvuorot työvuorosta.

Aikataulu tarvitsee jotain, jotta se voidaan julistaa työvuorosta päivystykseen tai työhön. Siksi annat jokaiselle työvuorolle tarran tai pikemminkin säännön niiden merkitsemiseksi, kun kehys on merkitty aikajanalle. Kukin aikataulu määrittää valitsintoiminnon, joka tarkastaa työvuoron etiketin ja palauttaa työssä olevien työvuorojen arvoksi True ja muuten False. Ellet ohita sitä, aikajanalla on oletusaikataulu, jonka valitsin palauttaa tunnisteen loogisen arvon.

Joskus haluat määrittää useita aikatauluja samalle aikajanalle. Esimerkiksi puhelukeskuksessa on aikataulu koko puhelukeskukselle kokonaisuudessaan ja erillinen aikataulu kullekin operaattoritiimille. Sama työvuoro voi löytyä päivystyksessä joidenkin aikataulujen mukaan ja muualla kuin muissa.

Aikataulu = aikajana + aikataulut. Tarkemmin sanottuna aikalauta on kokoelma työaikatauluja, jotka perustuvat tiettyyn työvuorojen aikajanaan, joka on rakennettu viitekehykseen .

Kun sinulla on aikalauta, voit suorittaa hyödyllisen työn: tehdä kalenterilaskelmia ratkaistaksesi ongelmat, kuten prologessa kuvataan.

Jokainen aikalaudalla suoritettu laskenta on tietoturvallista. Käynnistetty menetelmä "näkee" vain työvuorot määritellyn velvollisuuden kanssa ja jättää muut huomiotta. Työvuorojen velvollisuuden paljastamiseksi menetelmälle on annettava aikataulu. Siksi kukin aikalaudan laskenta parametrisoidaan tehtävällä ja aikataululla.

Oletusarvoisesti työ on "päällä" ja aikataulu on aitajan oletusaikataulu. Esimerkiksi, jos soitat count()ilman argumentteja jossakin aikajanan välissä, saat työvuorojen määrän aikavälillä, jotka ilmoitetaan päivystykseen oletusaikataulun mukaisesti. Nämä oletukset helpottavat elämää, koska käytännössä haluat käsitellä enimmäkseen päivystäviä työvuoroja.

API

Aikataulun koko dokumentaatio on saatavana Lue dokumentit -osiossa.

Paketti voidaan asentaa tavalliseen tapaan pip install timeboard.

Aseta kellotaulu

Yksinkertaisin tapa aloittaa on käyttää valmiiksi määritettyä kalenteria, joka toimitetaan paketin mukana. Otetaan säännöllinen arkipäivän kalenteri Yhdysvalloille.

 >>> 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']

Kuinka monta vuoroa A-ryhmän operaattorit istuivat marraskuussa 2017?

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

Ja kuinka monta tuntia siellä oli yhteensä?

>>> nov2017.worktime()176

Henkilö työskenteli operaattorina A-ryhmässä 4.11.2017 alkaen. Palkka maksetaan kuukausittain. Kuinka suuren osan marraskuun palkasta työntekijä on ansainnut?

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

Lisää käyttötapauksia

Lisää käyttötapauksia (melkein tosielämästä otettuja) löytyy projektin dokumentaatioon kuuluvasta jupyter-muistikirjasta.

Voit vapaasti käyttää timeboardja älä epäröi jättää palautetta tai avoimia kysymyksiä GitHubiin.