Files
project-tools/project_dashboard_billable_hours/models/project_project.py

143 lines
5.3 KiB
Python

"""Project extension: billable hours on the project dashboard.
Adds a ``billable_hours`` computed field and a "Billable Time" stat
button to ``project.project``. Billable hours are timesheets linked to
a sales order line (``so_line`` set), so the metric reflects work that
is actually invoiced through a sale order.
"""
from odoo import api, fields, models
class Project(models.Model):
"""Extend projects with billable-hours tracking on the dashboard."""
_inherit = "project.project"
billable_hours = fields.Float(
string="Billable Time",
compute="_compute_billable_hours",
compute_sudo=True,
groups="hr_timesheet.group_hr_timesheet_user",
)
@api.depends('timesheet_ids.unit_amount', 'timesheet_ids.so_line')
def _compute_billable_hours(self):
"""Compute the total hours of timesheets linked to a SO line.
Billable timesheets are those whose ``so_line`` is set. When the
recordset is empty (Odoo's new-record pseudo-computation), each
project is computed from its in-memory ``timesheet_ids``;
otherwise a single ``_read_group`` sums ``unit_amount`` per
project in SQL.
:return: None (writes ``billable_hours`` on each record)
"""
if not any(self._ids):
for project in self:
filtered_timesheets = project.timesheet_ids.filtered(
lambda t: t.so_line
)
project.billable_hours = sum(
filtered_timesheets.mapped("unit_amount")
)
return
timesheet_read_group = self.env["account.analytic.line"]._read_group(
[
("project_id", "in", self.ids),
("so_line", "!=", False),
],
["project_id"],
["unit_amount:sum"],
)
timesheets_per_project = {
project.id: unit_amount for project, unit_amount in timesheet_read_group
}
for project in self:
project.billable_hours = timesheets_per_project.get(project.id, 0.0)
def action_project_billable_timesheets(self):
"""Open the billable timesheets of a single project.
Reuses ``sale_timesheet``'s ``action_billable_time_button`` and
restricts it to this project's timesheets with a SO line.
:return: action dict opening the filtered timesheet list
"""
self.ensure_one()
action = self.action_billable_time_button() # sale_timesheet
action['domain'] = [('project_id', '=', self.id), ('so_line', '!=', False)]
action['display_name'] = self.env._("%(name)s's Billable Timesheets", name=self.name)
return action
def _get_stat_buttons(self):
"""Append the "Billable Time" stat button to the dashboard.
The button shows ``billable / effective <uom>`` (converted to the
company's timesheet encoding unit) with the billable rate when
relevant, and opens the project's billable timesheets on click.
Color coding: red below 50%, orange below 80%, green above.
The button is skipped when billing or timesheets are disabled on
the project, or the user lacks timesheet access rights.
:return: list of stat button dicts (inherited + ours)
"""
buttons = super()._get_stat_buttons()
if not (self.allow_billable and self.allow_timesheets) \
or not self.env.user.has_group("hr_timesheet.group_hr_timesheet_user"):
return buttons
encode_uom = self.env.company.timesheet_encode_uom_id
uom_ratio = self.env.ref('uom.product_uom_hour').factor / encode_uom.factor
billable = self.billable_hours / uom_ratio
effective = self.total_timesheet_time / uom_ratio
color = ""
if billable:
number = f"{round(billable)} / {round(effective)} {encode_uom.name}"
billable_rate = round(100 * billable / effective)
if billable_rate < 50:
number = self.env._(
"%(billable)s / %(effective)s %(uom_name)s",
effective=round(effective),
billable=round(billable),
uom_name=encode_uom.name,
)
color = "text-danger"
else:
number = self.env._(
"%(billable)s / %(effective)s %(uom_name)s (%(billable_rate)s%%)",
effective=round(effective),
billable=round(billable),
uom_name=encode_uom.name,
billable_rate=billable_rate,
)
if billable_rate < 80:
color = "text-warning"
else:
color = "text-success"
else:
number = self.env._(
"%(billable)s %(uom_name)s",
billable=round(billable),
uom_name=encode_uom.name,
)
buttons.append({
"icon": f"money {color}",
"text": self.env._("Billable Time"),
"number": number,
"action_type": "object",
"action": "action_project_billable_timesheets",
"show": True,
"sequence": 3,
})
return buttons