Skip to main content
Odoo Community Association

Base Time Window

Beta License: LGPL-3 OCA/server-tools Translate me on Weblate Try me on Runboat

This module provides base classes and models to manage time windows through time.window.mixin.

Table of contents

Usage

Example implementation for the mixin can be found in module test_base_time_window.

As a time window will always be linked to a related model thourgh a M2o relation, when defining the new model inheriting the mixin, one should pay attention to the following points in order to have the overlapping check work properly:

  • Define class property `_overlap_check_field`: This must state the M2o field to use for the to check of overlapping time window records linked to a specific record of the related model.

  • Add the M2o field to the related model in the `api.constrains`:

For example:

class PartnerTimeWindow(models.Model):
    _name = 'partner.time.window'
    _inherit = 'time.window.mixin'

    partner_id = fields.Many2one(
        res.partner', required=True, index=True, ondelete='cascade'
    )

    _overlap_check_field = 'partner_id'

    @api.constrains('partner_id')
    def check_window_no_overlaps(self):
        return super().check_window_no_overlaps()

Known issues / Roadmap

  • Storing times using float_time widget requires extra processing to ensure computations are done in the right timezone, because the value is not stored as UTC in the database, and must therefore be related to a tz field.

    float_time in this sense should only be used for durations and not for a “point in time” as this is always needs a Date for a timezone conversion to be done properly. (Because a conversion from UTC to e.g. Europe/Brussels won’t give the same result in winter or summer because of Daylight Saving Time).

    Therefore the right move would be to use a resource.calendar to define time windows using Datetime with recurrences.

Bug Tracker

Bugs are tracked on GitHub Issues. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us to smash it by providing a detailed and welcomed feedback.

Do not contact contributors directly about support or help with technical issues.

Credits

Authors

  • ACSONE SA/NV

  • Camptocamp

Contributors

Trobz

Other credits

The development of this module has been financially supported by:

  • Camptocamp

The migration of this module from 17.0 to 18.0 was financially supported by:

  • Camptocamp

Maintainers

This module is maintained by the OCA.

Odoo Community Association

OCA, or the Odoo Community Association, is a nonprofit organization whose mission is to support the collaborative development of Odoo features and promote its widespread use.

This module is part of the OCA/server-tools project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

Release files for odoo-addon-base-time-window 19.0.1.0.0.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for odoo-addon-base-time-window 19.0.1.0.0.3
File Interpreter ABI Platform
odoo_addon_base_time_window-19.0.1.0.0.3-py3-none-any.whl Python 3 none any Details

Release files / odoo_addon_base_time_window-19.0.1.0.0.3-py3-none-any.whl

Download URL odoo_addon_base_time_window-19.0.1.0.0.3-py3-none-any.whl
Size 36.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
36763a0b19dda307c44b057b57a1c50674a38f4c7305ab1d1b8e5121dd169bee
BLAKE2b-256 checksum
How to use checksums
c1d13198181ecc3d3c62b98e80dd1b82b91698dcb56249551fb28a69ee1011b9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.3
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page