[16.0] [ADD] volunteer_holiday by Genepi314 · Pull Request #578 · beescoop/Obeesdoo

Genepi314 · 2026-03-02T10:38:26Z

Description

Add holidays for companies and leaves for volunteers.

Odoo task (if applicable)

Checklist before approval

Tests are present (or not needed).
Credits/copyright have been changed correctly.
Change log snippet is present.
(If a new module) Moving this to OCA has been considered.

…for _cancel_holiday_shift(), draft for test_company_holiday

… draft unit tests

volunteer_holiday/models/volunteer_company_holiday.py

remytms · 2026-03-02T14:33:08Z

volunteer_holiday/models/volunteer_company_holiday.py

+        if (
+            (
+                shift_start_date >= holiday_start_date
+                and shift_start_date <= holiday_end_date
+            )
+            or (
+                shift_end_date >= holiday_start_date
+                and shift_start_date <= holiday_end_date
+            )
+            or (
+                shift_start_date <= holiday_start_date
+                and shift_end_date >= holiday_end_date
+            )
+        ):
+            return True


Simply write:

Suggested change

if (

(

shift_start_date >= holiday_start_date

and shift_start_date <= holiday_end_date

)

or (

shift_end_date >= holiday_start_date

and shift_start_date <= holiday_end_date

)

or (

shift_start_date <= holiday_start_date

and shift_end_date >= holiday_end_date

)

):

return True

return (

(

shift_start_date >= holiday_start_date

and shift_start_date <= holiday_end_date

)

or (

shift_end_date >= holiday_start_date

and shift_start_date <= holiday_end_date

)

or (

shift_start_date <= holiday_start_date

and shift_end_date >= holiday_end_date

)

)

Ok, I didn't know about this simplified syntax. It is done.

… some changes to access rights.

…company.

…pany present but hideable in all views.

… leaves.

…e type.

remytms

First partial review.

volunteer_holiday/controllers/__init__.py

remytms · 2026-03-09T17:50:08Z

volunteer_holiday/data/cron.xml

+    <!-- Après test, passer en noupdate=1 -->
+    <record id="ir_cron_cancel_holiday_shift" model="ir.cron">
+        <field name="name">Cancel Generated Shifts During Company Holidays</field>
+        <field name="model_id" ref="model_volunteer_company_holiday" />
+        <field name="state">code</field>
+        <field name="code">model._cancel_holiday_shift()</field>
+        <field name="interval_number">24</field>
+        <field name="interval_type">hours</field>
+        <field name="numbercall">-1</field>
+        <field name="doall" eval="False" />
+    </record>


Apply your comment here. :)

remytms · 2026-03-09T18:23:50Z

volunteer_holiday/demo/volunteer_company_holiday_demo.xml

+        <field name="name">Christmas Holidays</field>
+        <field
+            name="start_date"
+            eval="(datetime.today().replace(month=12, day=24)).strftime('%Y-%m-%d')"


Starting with python 3.9 (odoo 16.0 uses 3.10), prefer using isformat() instead of strftime for standard iso formatting.

See method here.

After some tests on these cases, neither strftime() nor isoformat() seems to be required. On my side, loading works fine without any formatting. That said, I'm not sure of all the details behind it.

After some tests on these cases, neither strftime() nor isoformat() seems to be required. On my side, loading works fine without any formatting. That said, I'm not sure of all the details behind it.

Indeed, it is not needed. Thank you, I removed the strftime() in all demo files :-)

remytms · 2026-03-09T18:24:05Z

volunteer_holiday/demo/volunteer_company_holiday_demo.xml

+        />
+        <field
+            name="end_date"
+            eval="(datetime.today().replace(month=12, day=25)).strftime('%Y-%m-%d')"


isoformat()

I removed all strftime() after aydrpm's suggestion :-)

remytms · 2026-03-09T18:24:18Z

volunteer_holiday/demo/volunteer_company_holiday_demo.xml

+        <field name="name">Store Inventory</field>
+        <field
+            name="start_date"
+            eval="(datetime.today().replace(month=7, day=1)).strftime('%Y-%m-%d')"


I removed all strftime() after aydrpm's suggestion :-)

remytms · 2026-03-09T18:36:50Z

volunteer_holiday/models/volunteer_company_holiday.py

+    # Retirer la limite de temps, regarder les shifts futurs
+    def _cancel_holiday_shift(self, time_in_months=3):


I think that you should apply your comment, and remove the time limit. Just check all shifts, and see if they are overlapping a holiday.

I think that for now it’s ok if the method starts at now() and all future shifts.

Because, we don’t want to change the past.

Just corrected it in the the commit "Refactor _cancel_holiday_shift..."

remytms · 2026-03-09T18:43:34Z

volunteer_holiday/models/volunteer_company_holiday.py

+        # Create dictionary key-company for list of values-shifts
+        shifts_by_company = {}
+        for shift in confirmed_future_generated_shifts_in_range:
+            shifts_by_company.setdefault(shift.company_id, []).append(shift)


Just order them by company_id when using the search() method.

Also, as there is less holiday than shifts, it’s better to do so with holiday, or even fetch holiday for the company when needed.

I used itertools as you suggested recently and ordered the holidays by company. I'm not sure I did it perfectly right though, so don't hesitate to tell me if something is still off.

remytms · 2026-03-09T18:51:27Z

volunteer_holiday/models/volunteer_company_holiday.py

+        for holiday in future_company_holidays_in_range:
+            same_company_shifts = shifts_by_company.get(holiday.company_id, [])
+            for shift in same_company_shifts:
+                if shift.state != "canceled" and self._shift_covers_holiday(
+                    shift.start_time,
+                    shift.end_time,
+                    holiday.start_date,
+                    holiday.end_date,
+                ):
+                    shift.sudo().write(
+                        {
+                            "stage_id": self.env.ref(
+                                "volunteer.volunteer_shift_stage_canceled"
+                            ).id
+                        }
+                    )


If your shifts are ordered by company_id, you can use itertools.groupby() to iterate through all the shifts, company by company. Then you can fetch the holiday of the comany, each time you face a new company.

Using itertools.groupby() is more efficient for such a task.

See comment above.

remytms · 2026-03-09T18:55:22Z

volunteer_holiday/models/volunteer_volunteer.py

+    volunteer_leave_ids = fields.One2many(
+        comodel_name="volunteer.volunteer.leave",
+        inverse_name="volunteer_id",
+        string="Leave",


Here for the user interface you can use plural form.

Suggested change

string="Leave",

string="Leaves",

remytms · 2026-03-09T18:57:05Z

volunteer_holiday/models/volunteer_volunteer_leave.py

+class VolunteerVolunteerLeave(models.Model):
+    _name = "volunteer.volunteer.leave"
+    _description = "Volunteer Leave"
+    _order = "start_date"


Suggested change

_order = "start_date"

_order = "start_date desc, volunteer_id, id"

Same as for company.holiday.

I just did this for volunteer leaves. But I am not sure I understand what you mean for company holidays. Do you mean you also want it to be displayed with _order = "start_date desc" ? Or do you mean I should also add "company_id, id" ?

I didn't put the "desc" after _order = "start_date" because of the difference in the views. Volunteer Leaves has a view that I couldn't get filtered (the one nested in volunteer_volunteer_view, as a page in the notebook), so I thought it would be less tedious to get the most distant in the future as first to appear on the view, rather than the most distant in the past.

This does not apply to company holidays, as they're filtered automatically to show only the future ones. Therefore I thought it would be best to see the closest next one, rather than the most distant in the future one.

But anyway, this is the way I see it. If you don't like it I'll change it to "start_date desc" for company holidays too :-)

…or now commented).

…n to volunteers, corrected README.

…guration in General settings, views, test, and corrected views for company holidays and volunteer leaves.

…d volunteer_company_holiday updated.

…s and clean all tests.

…udo() + remove time_range.

…ed @api.model_create_multi.

remytms

Partial review.

remytms · 2026-03-26T09:24:26Z

volunteer_holiday/models/volunteer_company_holiday.py

+class VolunteerCompanyHoliday(models.Model):
+    _name = "volunteer.company.holiday"
+    _description = "Company Holidays"
+    _order = "start_date"


up for this comment.

remytms · 2026-03-26T09:33:13Z

volunteer_holiday/models/volunteer_company_holiday.py

+        for company, grouped_holidays_by_company in groupby(
+            future_company_holidays, key=lambda holiday: holiday.company_id.id
+        ):
+            grouped_holidays = list(grouped_holidays_by_company)


grouped_holiday_by_company is a iterator. You loop only once over it. So there is no need to convert it to a list.

remytms · 2026-03-26T09:34:23Z

volunteer_holiday/models/volunteer_company_holiday.py

+        for company, grouped_holidays_by_company in groupby(
+            future_company_holidays, key=lambda holiday: holiday.company_id.id
+        ):


Suggested change

for company, grouped_holidays_by_company in groupby(

future_company_holidays, key=lambda holiday: holiday.company_id.id

):

for company_id, grouped_holidays_by_company in groupby(

future_company_holidays, key=lambda holiday: holiday.company_id

):

I found this more readable in terms of Odoo nomenclature.

I see, it is changed.

remytms · 2026-03-26T09:42:38Z

volunteer_holiday/models/volunteer_shift.py

+    def _compute_overlap_holiday(self):
+        """Compute if shift overlaps with any company holiday period."""
+        date_today = datetime.today().date()
+        Holiday = self.env["volunteer.company.holiday"]
+        future_shifts = self.env["volunteer.shift"].search(
+            [("end_time", ">=", datetime.today())]
+        )
+        for shift in future_shifts:
+            found_overlap = False
+            this_company_future_holidays = self.env["volunteer.company.holiday"].search(
+                [
+                    ("end_date", ">=", date_today),
+                    ("company_id", "=", shift.company_id.id),
+                ]
+            )
+            for holiday in this_company_future_holidays:
+                if Holiday._shift_covers_holiday(
+                    shift.start_time,
+                    shift.end_time,
+                    holiday.start_date,
+                    holiday.end_date,
+                ):
+                    found_overlap = True
+                    shift.overlaps_holiday = True
+
+            if not found_overlap:
+                shift.overlaps_holiday = False


Here you should not retrieve all shift and then check them. The compute function must only run on record in self.

So just group self by company_id. Then loop over the shift and fetch company holiday when needed.

Then you must set a value for overlaps_holiday for each record in self.

I wrote this one a bit quickly, so sorry for the lack of optimization already.
I have some questions here:

Should I actually use an iterator like in company_holidays to go through holidays and shifts more efficiently ?

About setting a value for overlaps_holiday, I thought it wasn't needed, as it has a default value set to false already. Should I still set it to false again in the compute function ?

remytms · 2026-03-26T09:44:52Z

volunteer_holiday/models/volunteer_volunteer.py

+        all_companies = self.env["res.company"].search([])
+        for company in all_companies:
+            nb_days = company.nb_days_before_leave_end
+            message_body = ("Your leave ends in {} days.").format(nb_days)


Here import the _ function and use it for you string like this:

_("Your ...")

This way, your string can be translated.

remytms · 2026-03-26T09:50:45Z

volunteer_holiday/models/volunteer_volunteer_leave.py

+        all_future_volunteer_leaves = (
+            self.env["volunteer.volunteer.leave"]
+            .sudo()
+            .search([("end_date", ">=", date.today())])
+        )


I wonder if sudo() is needed, as we can run the cron with a user that has the correct rights to do that.

True, I changed it in company holidays but not in volunteer leaves. Thanks for telling me.

remytms · 2026-03-26T09:50:58Z

volunteer_holiday/models/volunteer_volunteer_leave.py

+                    leave.start_date,
+                    leave.end_date,
+                ):
+                    participation.sudo().write({"registration_state": "canceled"})


Idem here for sudo().

remytms · 2026-03-26T09:52:58Z

volunteer_holiday/models/volunteer_volunteer_leave_type.py

+        comodel_name="res.company",
+        string="Company",
+        default=lambda self: self.env.user.company_id,
+        required=True,


Here we can remove the required=True for company_id. As if it is false it means that it can be used by all company.

I removed it there.

But would that be true for all company_id fields then ? Like in volunteer.company.holiday for example ? Or is it different for this one ? I don't know how it would actually work with the cancel_holiday_shift function, as for now the domain used to retrieve shifts from the same company has a "=" operator for companies, and not a "in"...

…teer.company.holiday, remove unnecessary required attribute.

remytms

Some little changes.

remytms · 2026-03-26T13:49:37Z

volunteer_holiday/data/cron.xml

+    <record id="ir_cron_cancel_holiday_shift" model="ir.cron">
+        <field
+            name="name"
+        >Volunteer: Cancel Generated Shifts During Company Holidays</field>
+        <field name="model_id" ref="model_volunteer_company_holiday" />
+        <field name="state">code</field>
+        <field name="code">model._cancel_holiday_shift()</field>
+        <field name="interval_number">24</field>
+        <field name="interval_type">hours</field>
+        <field name="numbercall">-1</field>
+        <field name="doall" eval="False" />
+    </record>
+
+    <record id="ir_cron_cancel_volunteer_leave_participation" model="ir.cron">
+        <field
+            name="name"
+        >Volunteer: Cancel Participations During Volunteer Leaves</field>
+        <field name="model_id" ref="model_volunteer_volunteer_leave" />
+        <field name="state">code</field>
+        <field name="code">model._cancel_volunteer_leave_participation()</field>
+        <field name="interval_number">24</field>
+        <field name="interval_type">hours</field>
+        <field name="numbercall">-1</field>
+        <field name="doall" eval="False" />
+    </record>
+
+    <record id="ir_cron_send_leave_end_notification" model="ir.cron">
+        <field
+            name="name"
+        >Notification: Send a Reminder to Volunteers Before their Leave Ends</field>
+        <field name="model_id" ref="model_volunteer_volunteer" />
+        <field name="state">code</field>
+        <field name="code">model._send_notification_end_leave()</field>
+        <field name="interval_number">24</field>
+        <field name="interval_type">hours</field>
+        <field name="numbercall">-1</field>
+        <field name="doall" eval="False" />
+    </record>


Here we should set the admin user as user_id.

remytms · 2026-03-26T14:12:55Z

volunteer_holiday/__manifest__.py

+    "maintainers": ["remytms"],
+    "license": "AGPL-3",
+    "application": False,
+    "depends": ["base", "volunteer", "mail"],


Suggested change

"depends": ["base", "volunteer", "mail"],

"depends": ["volunteer", "mail"],

remytms · 2026-03-26T14:26:07Z

volunteer_holiday/views/volunteer_volunteer_leave_view.xml

+        <field name="name">Volunteer Leaves List</field>
+        <field name="model">volunteer.volunteer.leave</field>
+        <field name="arch" type="xml">
+            <tree default_order="start_date asc">


No need to put default_order if it is not different than the one in _order of the model.

Here it is different in the model and in the view. Here is the code in the model:
_order = "start_date desc, volunteer_id, id"
This is because of the notebook page in volunteer_volunteer_view in which no default filter is available, where as in the volunteer_volunteer_leave_view, there is a default filter applied to see only future volunteer leaves.

Genepi314 added 4 commits February 19, 2026 10:58

added volunteer_company_holiday, extended recurrent_generator, draft …

a6b1a6d

…for _cancel_holiday_shift(), draft for test_company_holiday

cancel holiday shift operational, still lacks company implementation,…

fe0dfa4

… draft unit tests

commit before switching branch

79748ee

draft test_cancel_holiday_shift with company + correct README

e7198ae

github-grap-bot added the needs review label Mar 2, 2026

remytms changed the title ~~16.0 add volunteer holiday~~ [16.0] [ADD] volunteer_holiday Mar 2, 2026

remytms reviewed Mar 2, 2026

View reviewed changes

Genepi314 added 10 commits March 3, 2026 10:03

Add models and views for volunteer leaves, volunteer leave types, and…

acc87b7

… some changes to access rights.

Refacto _cancel_holiday_shift, now using a dictionary and filters by …

a584534

…company.

Add tracking to is_maintained_during_holiday (bool) in generator.

130eeb9

Add freezegun for test_company_holiday

5218d91

Syntax and decorator fixes in volunteer_company_holidayù

642f6cf

Add company for volunteer_leave, record rules for all models, row com…

be54c46

…pany present but hideable in all views.

Add cron and function to cancel volunteer participations during their…

57a9f43

… leaves.

small fix _cancel_volunteer_leave_participation().

5e83781

Add test for _cancel_volunteer_leave_participation().

e260401

Add demo data for company holiday, volunteer leave and volunteer leav…

8488f36

…e type.

remytms requested changes Mar 9, 2026

View reviewed changes

Genepi314 added 11 commits March 10, 2026 09:08

draft new function to uncancel shifts in volunteer_company_holiday (f…

15a6db1

…or now commented).

removed copy of method in volunteer_leave, add config for notificatio…

e9688bd

…n to volunteers, corrected README.

Add method to send notification for end of volunteer leave, add confi…

8b1dc76

…guration in General settings, views, test, and corrected views for company holidays and volunteer leaves.

add badge on shift form view if on holiday, models volunteer_shift an…

6992be1

…d volunteer_company_holiday updated.

Changed time range to 12 months, for demonstration purpose.

432576c

Add test for computed field overlaps_holiday, add common for all test…

e8b3d46

…s and clean all tests.

Add ROADMAP.

bfdcddf

reformat ROADMAP.

396fddf

Refactor _cancel_holiday_shift with itertools + remove unnecessary .s…

52f09f1

…udo() + remove time_range.

Corrections after Remy's comments in PR + cleaned code overall.

7896929

small fix, override method create() in volunteer.company.holiday, add…

ec5a3f7

…ed @api.model_create_multi.

remytms requested changes Mar 26, 2026

View reviewed changes

Genepi314 added 2 commits March 26, 2026 14:46

Corrections, rewrite _compute_overlap_holiday(), small fixes in volun…

15601c2

…teer.company.holiday, remove unnecessary required attribute.

Add fields for _order in volunteer_company_holiday.py

e2e9486

remytms requested changes Mar 26, 2026

View reviewed changes

		# Retirer la limite de temps, regarder les shifts futurs
		def _cancel_holiday_shift(self, time_in_months=3):

	_order = "start_date"
	_order = "start_date desc, volunteer_id, id"

	"depends": ["base", "volunteer", "mail"],
	"depends": ["volunteer", "mail"],

Conversation

Genepi314 commented Mar 2, 2026

Description

Odoo task (if applicable)

Checklist before approval

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

remytms left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Genepi314 Mar 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

remytms left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Genepi314 Mar 25, 2026 •

edited

Loading