اجعل جدولك المعقد بسيطًا باستخدام timeboard ، مكتبة Python

timeboardهي مكتبة بايثون تنشئ جداول لفترات العمل وتقوم بحسابات التقويم عليها. يمكنك إنشاء تقاويم قياسية ليوم العمل بالإضافة إلى مجموعة متنوعة من الجداول الأخرى ، بسيطة أو معقدة.

يمكنك العثور على التوثيق هنا.

تحقق من GitHub repo هنا.

يمكنك العثور عليها على PyPI هنا.

القصة

بدأ الأمر بقضية عدد الموظفين. قدمت شركتنا مؤشرات الأداء الرئيسية التي تتضمن الإيرادات لكل موظف ، لذلك كنا بحاجة إلى معرفة متوسط ​​عدد الموظفين السنوي لكل فريق. كنت قد كتبت بالفعل نصوص لغة بايثون ، لذا لم أخاف.

للحصول على عدد الموظفين ، كان علي حساب عدد أيام العمل التي قضاها كل موظف مع الشركة خلال العام. اعتقدت أن الباندا سيتعامل معها في ثانية. لكن تبين أن الباندا لا تستطيع ذلك.

تقويم الأعمال الروسي مرهق. يتبادلون أيام الأسبوع بأيام السبت أو الأحد لملء الفجوات بين العطلات وعطلات نهاية الأسبوع. على سبيل المثال ، يجب أن تأتي للعمل في يوم سبت من شهر فبراير ليتم تعويضك يوم الاثنين المجاني الذي يسبق يوم الثلاثاء في مكان ما في شهر مايو.

مخطط كل عام فريد من نوعه. يدعم تقويم يوم عمل Pandas التعديلات أحادية الاتجاه فقط لملاحظات العطلات. لذلك ، يمكنني تحويل يوم عمل إلى يوم عطلة ، لكن ليس العكس.

ثم كان هناك عاملون في مركز الاتصال ، وتأرجح قلقي في الاتجاه الآخر. إنهم يعملون في نوبات متفاوتة الطول ، وردية واحدة تليها ثلاث نوبات. للحصول على إحصائيات مركز الاتصال ، لم أكن بحاجة إلى تقويم يوم العمل. ومع ذلك ، كان علي حساب عدد نوبات المشغل المعين في فترة زمنية.

وأخيرا ، مشكلة شاذة. في وكيل هوندا المحلي ، يعمل الميكانيكيون على جداول أسبوعية بديلة: الاثنين والثلاثاء والسبت والأحد من هذا الأسبوع ، والأربعاء حتى الجمعة من الأسبوع التالي. كنت أرغب دائمًا في أن يتم خدمتي من قبل ميكانيكي معين ، لأن الآخر قد أفسد الفرامل ذات مرة. أردت طريقة بسيطة لتحديد التحول التالي للميكانيكي "الخاص بي".

هذه الحالات لها أساس مشترك. تعتمد حلولهم على جدول زمني لفترات "أثناء العمل" و "خارج الخدمة". يجب أن نكون قادرين على إنشاء جداول زمنية منظمة بشكل مختلف ومناسبة لحالات العمل المختلفة. يجب أن تميز الاستفسارات والحسابات التي تجري على مدار الجدول الزمني بين فترات "العمل" و "خارج الخدمة".

لم أتمكن من العثور على حزمة Python التي توفر الوسائل لبناء مثل هذه الجداول والاستعلام عنها. كما حدث ، كان لدي بعض وقت الفراغ لكتابته بنفسي.

المفهوم

timeboardهي مكتبة بايثون تنشئ جداول لفترات العمل وتقوم بحسابات التقويم عليها. تسمى هذه الأشياء نفسها الألواح الزمنية.

هناك ثلاث خطوات رئيسية في التفكير حول لوحة زمنية.

تبدأ بفترة زمنية تحدد حدود التقويم الخاص بك. كل شيء سيقتصر على هذه الفترة. يطلق عليه الإطار (المرجعي). يتكون الإطار من وحدات أساسية. الوحدة الأساسية هي أصغر فترة زمنية تحتاجها لقياس التقويم الخاص بك. على سبيل المثال ، إذا كنت تفكر من حيث أيام العمل ، فإن الوحدة الأساسية هي اليوم. بدلاً من ذلك ، إذا قمت ببناء جدول زمني للورديات متعددة الساعات ، فإن الوحدة الأساسية هي ساعة واحدة.

في الخطوة التالية ، تقوم بتعريف قواعد ترميز الإطار في ووركشتيفت. نوبات العمل هي فترات زمنية تهتم بها. هم يشكلون التقويم الخاص بك. إن الورديات هي التي تريد جدولتها أو احتسابها. في تقويم أيام العمل القياسية ، يكون وركش العمل يومًا (والوحدة الأساسية هي يوم أيضًا ، لذا فهي تتزامن).

في مركز الاتصال ، تكون فترة العمل عبارة عن عدة ساعات عندما يكون هناك نوبة معينة من المشغلين في الخدمة. من المحتمل أن تكون الوحدة الأساسية ساعة واحدة ، وتشتمل كل وحدة عمل على عدد (ربما متغير) من الوحدات الأساسية.

يسمى تسلسل ورشات العمل التي تملأ الإطار بالجدول الزمني.

أخيرًا ، تقوم بإنشاء جدول واحد أو أكثر. الجدول الزمني يشبه الاستنسل الموضوع على الخط الزمني. والغرض منه هو معرفة ورشات العمل أثناء العمل من تلك الموجودة خارج أوقات العمل.

يحتاج الجدول الزمني إلى شيء للعمل معه من أجل الإعلان عن وظيفة عمل في العمل أو خارج الخدمة. هذا هو السبب في أنك تقدم تسمية لكل وردية عمل ، أو بالأحرى قاعدة لتصنيفها أثناء وضع علامة على الإطار في المخطط الزمني. يحدد كل جدول وظيفة محدد تقوم بفحص ملصق ورشة العمل وإرجاع True لـورشات العمل أثناء العمل و False خلاف ذلك. ما لم تقم بتجاوزه ، فإن المخطط الزمني يكون مصحوبًا بالجدول الافتراضي الذي يقوم محدده بإرجاع القيمة المنطقية للتسمية.

في بعض الأحيان تريد تحديد عدة جداول زمنية لنفس الجدول الزمني. على سبيل المثال ، في مركز الاتصال ، سيكون هناك جدول زمني لمركز الاتصال ككل ، وجدول منفصل لكل فريق من المشغلين. يمكن العثور على نفس فترة العمل في الخدمة بموجب بعض الجداول الزمنية وخارج العمل في ظل البعض الآخر.

لوحة الوقت = الجدول الزمني + الجداول الزمنية. بتعبير أدق، timeboard هو عبارة عن مجموعة عمل الجداول الزمنية على أساس محددة زمنيا من workshifts البناء عليها إشارة إطار .

بمجرد حصولك على لوحة زمنية ، يمكنك تنفيذ العمل المفيد: قم بحسابات التقويم من أجل حل المشكلات مثل تلك الموضحة في المقدمة.

كل عملية حسابية يتم إجراؤها باستخدام لوحة الوقت تكون مدركة للواجب. الأسلوب الذي تم استدعاؤه "يرى" يعمل فقط على العمل مع الواجب المحدد ويتجاهل الآخرين. من أجل الكشف عن واجب نوبات العمل ، يجب إعطاء الطريقة جدولاً زمنيًا. لذلك ، يتم تحديد كل حساب على اللوحة الزمنية بواجب وجدول زمني.

بشكل افتراضي ، تكون المهمة "تشغيل" والجدول هو الجدول الزمني الافتراضي للوحة الوقت. على سبيل المثال ، إذا اتصلت 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']

كم عدد المناوبات التي قام بها مشغلو فريق A في نوفمبر 2017؟

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

وكم ساعة كانت هناك إجمالاً؟

>>> nov2017.worktime()176

تم توظيف شخص كمشغل في الفريق "أ" اعتبارًا من 4 نوفمبر 2017. يتم دفع الراتب شهريًا. ما هو الجزء من راتب شهر نوفمبر الذي حصل عليه الموظف؟

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

المزيد من حالات الاستخدام

يمكنك العثور على المزيد من حالات الاستخدام (المأخوذة من الحياة الواقعية تقريبًا) في دفتر jupyter الذي يعد جزءًا من وثائق المشروع.

لا تتردد في الاستخدام timeboardولا تتردد في ترك تعليقات أو فتح مشكلات على GitHub.