Vereinfachen Sie Ihre komplexe Planung mit Timeboard, einer Python-Bibliothek

timeboardist eine Python-Bibliothek, die Arbeitszeitpläne erstellt und Kalenderberechnungen darüber durchführt. Sie können Standardkalender für Geschäftstage sowie eine Vielzahl anderer einfacher oder komplexer Zeitpläne erstellen.

Die Dokumentation finden Sie hier.

Schauen Sie sich hier das GitHub-Repo an.

Finden Sie es auf PyPI hier.

Die Geschichte

Es begann mit dem Fall der Mitarbeiterzahl. Unser Unternehmen führte KPIs ein, die den Umsatz pro Mitarbeiter betreffen. Daher mussten wir die durchschnittliche jährliche Mitarbeiterzahl jedes Teams kennen. Ich hatte bereits Python-Skripte geschrieben, ließ mich also nicht einschüchtern.

Um eine Mitarbeiterzahl zu erhalten, musste ich die Anzahl der Geschäftstage berechnen, die jeder Mitarbeiter innerhalb eines Jahres im Unternehmen verbracht hat. Pandas würden es in einer Sekunde schaffen, dachte ich. Aber es stellte sich heraus, dass Pandas nicht konnten.

Der russische Geschäftskalender ist umständlich. Sie tauschen Wochentage mit Samstagen oder Sonntagen aus, um Lücken zwischen Feiertagen und Wochenenden zu schließen. Zum Beispiel müssen Sie an einem Samstag im Februar zur Arbeit kommen, um einen freien Montag vor einem Feiertagsdienstag irgendwo im Mai zu erhalten.

Das Schema für jedes Jahr ist einzigartig. Der Geschäftstagskalender von Pandas unterstützt nur Einwegänderungen für Urlaubsbeobachtungen. Ich könnte also einen Arbeitstag in einen freien Tag verwandeln, aber nicht umgekehrt.

Dann waren noch Operatoren im Callcenter, und meine Angst schwang in die andere Richtung. Sie arbeiten in Schichten unterschiedlicher Länge und einer Schicht, gefolgt von drei Schichten. Um die Callcenter-Statistiken zu erhalten, benötigte ich keinen Werktagskalender. Dennoch musste ich die Anzahl der Schichten eines bestimmten Bedieners in einem bestimmten Zeitraum zählen.

Und schließlich ein ungewöhnliches Problem. In meinem örtlichen Honda-Händler arbeiten die Mechaniker abwechselnd wöchentlich: Montag, Dienstag, Samstag und Sonntag in dieser Woche und Mittwoch bis Freitag in der nächsten Woche. Ich wollte immer von einem bestimmten Mechaniker bedient werden, weil der andere einmal die Bremsen durcheinander gebracht hatte. Ich wollte auf einfache Weise die nächste Schicht „meines“ Mechanikers bestimmen.

Diese Fälle haben eine gemeinsame Grundlage. Ihre Lösungen würden sich auf einen Zeitplan von "Dienst" - und "Dienst" -Zeiträumen stützen. Wir sollten in der Lage sein, unterschiedlich strukturierte Zeitpläne zu erstellen, die für verschiedene Geschäftsfälle geeignet sind. Abfragen und Berechnungen, die über den Zeitplan laufen, müssen zwischen "Dienst" - und "Dienst" -Perioden unterscheiden.

Ich konnte kein Python-Paket finden, das die Möglichkeit zum Erstellen und Abfragen solcher Zeitpläne bietet. Zufällig hatte ich etwas Zeit, um es selbst zu schreiben.

Das Konzept

timeboardist eine Python-Bibliothek, die Arbeitszeitpläne erstellt und Kalenderberechnungen darüber durchführt. Diese Objekte selbst werden als Zeittafeln bezeichnet.

Es gibt drei Hauptschritte beim Überlegen eines Timeboards.

Sie beginnen mit einem Zeitintervall, das die Grenzen Ihres Kalenders festlegt. Alles wird auf dieses Intervall beschränkt. Es wird als (Referenz-) Rahmen bezeichnet. Der Rahmen besteht aus Basiseinheiten. Eine Basiseinheit ist die kleinste Zeitspanne, die Sie zum Messen Ihres Kalenders benötigen. Wenn Sie beispielsweise in Werktagen argumentieren, ist die Basiseinheit ein Tag. Wenn Sie alternativ einen Zeitplan für mehrstündige Schichten erstellen, beträgt die Basiseinheit eine Stunde.

Im nächsten Schritt definieren Sie die Regeln für das Markieren des Rahmens in Arbeitsschichten. Arbeitsschichten sind Zeiträume, die Ihnen wichtig sind. Sie bilden Ihren Kalender. Es sind Arbeitsschichten, die Sie planen oder zählen möchten. In einem Standard-Werktagskalender ist die Schicht ein Tag (und die Basiseinheit ist auch ein Tag, sodass sie zusammenfallen).

In einem Callcenter dauert die Schicht mehrere Stunden, wenn eine bestimmte Schicht von Bedienern im Dienst ist. Die Basiseinheit ist wahrscheinlich eine Stunde lang, und jede Arbeitsschicht umfasst eine (wahrscheinlich variierende) Anzahl von Basiseinheiten.

Die Abfolge der Arbeitsschichten, die den Rahmen füllen, wird als Zeitachse bezeichnet.

Schließlich erstellen Sie einen oder mehrere Zeitpläne. Ein Zeitplan ist wie eine Schablone, die über die Zeitachse gelegt wird. Ihr Zweck ist es, diensthabende Arbeitsschichten von dienstfreien zu unterscheiden.

Ein Zeitplan benötigt etwas, mit dem gearbeitet werden kann, um eine diensthabende oder dienstfreie Schicht zu deklarieren. Aus diesem Grund geben Sie für jede Arbeitsschicht eine Beschriftung an, oder vielmehr eine Regel für die Beschriftung, während der Rahmen in der Zeitleiste markiert ist. Jeder Zeitplan definiert eine Auswahlfunktion, die das Etikett der Arbeitsschicht überprüft und True für die Arbeitsschichten im Dienst und False ansonsten zurückgibt. Sofern Sie es nicht überschreiben, wird eine Zeitleiste von dem Standardzeitplan begleitet, dessen Selektor den booleschen Wert der Beschriftung zurückgibt.

Manchmal möchten Sie mehrere Zeitpläne für dieselbe Zeitachse definieren. In einem Callcenter gibt es beispielsweise den Zeitplan für das gesamte Callcenter und einen separaten Zeitplan für jedes Team von Betreibern. Dieselbe Arbeitsschicht kann unter einigen Zeitplänen im Dienst und unter den anderen außerhalb des Dienstes sein.

Zeitleiste = Zeitleiste + Zeitpläne. Genauer gesagt timeboard ist eine Sammlung von Arbeitszeitpläne auf einer bestimmten Basis - Timeline von Arbeitsschichten auf einem Referenz gebaut Rahmen .

Sobald Sie ein Timeboard haben, können Sie die nützliche Arbeit ausführen: Führen Sie Kalenderberechnungen durch, um die im Prolog beschriebenen Probleme zu lösen.

Jede mit Timeboard durchgeführte Berechnung ist pflichtbewusst. Die aufgerufene Methode "sieht" nur Arbeitsschichten mit der angegebenen Pflicht und ignoriert die anderen. Um die Pflicht der Schichtarbeit aufzuzeigen, muss der Methode ein Zeitplan gegeben werden. Daher wird jede Berechnung auf der Zeittafel mit einer Pflicht und einem Zeitplan parametrisiert.

Standardmäßig ist der Dienst aktiviert und der Zeitplan ist der Standardzeitplan der Zeitleiste. Wenn Sie beispielsweise count()in einem bestimmten Intervall einer Zeittafel ohne Argumente aufrufen, erhalten Sie die Anzahl der Arbeitsschichten in dem Intervall, die nach dem Standardzeitplan als im Dienst deklariert sind. Diese Standardeinstellungen erleichtern das Leben, da Sie in der Praxis hauptsächlich mit diensthabenden Arbeitsschichten arbeiten möchten.

Die API

Die vollständige Timeboard-Dokumentation finden Sie unter Lesen Sie die Dokumente.

Das Paket kann mit dem üblichen installiert werden pip install timeboard.

Richten Sie eine Zeitleiste ein

Der einfachste Weg, um loszulegen, ist die Verwendung eines vorkonfigurierten Kalenders, der mit dem Paket geliefert wird. Nehmen wir einen regulären Geschäftstagskalender für die USA.

 >>> 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 .