[16.0] [IMP] product_variant_default_code : add sequence to complete or replace patterns

Author: emiliesoutiras

product_variant_default_code/README.rst

@@ -1,7 +1,3 @@
-.. image:: https://odoo-community.org/readme-banner-image
-   :target: https://odoo-community.org/get-involved?utm_source=readme
-   :alt: Odoo Community Association
-
 ============================
 Product Variant Default Code
 ============================
@@ -17,7 +13,7 @@ Product Variant Default Code
 .. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
     :target: https://odoo-community.org/page/development-status
     :alt: Beta
-.. |badge2| image:: https://img.shields.io/badge/license-AGPL--3-blue.png
+.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
     :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
     :alt: License: AGPL-3
 .. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fproduct--variant-lightgray.png?logo=github

product_variant_default_code/__init__.py

@@ -1 +1,2 @@
+from .hooks import pre_init_hook
 from . import models

product_variant_default_code/__manifest__.py

@@ -26,4 +26,5 @@
     ],
     "demo": ["demo/attribute_demo.xml"],
     "installable": True,
+    "pre_init_hook": "pre_init_hook",
 }

product_variant_default_code/hooks.py

@@ -0,0 +1,29 @@
+#  Copyright (c) 2025 Groupe Voltaire
+#  @author Emilie SOUTIRAS  <emilie.soutiras@groupevoltaire.com>
+#  License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
+
+
+def pre_init_hook(cr):
+    # Preserve default_code already set on product
+    cr.execute(
+        """
+        DO $$
+        BEGIN
+            IF NOT EXISTS (
+                SELECT 1
+                FROM information_schema.columns
+                WHERE table_name = 'product_product'
+                AND column_name = 'manual_code'
+            ) THEN
+                ALTER TABLE product_product ADD COLUMN manual_code BOOLEAN;
+            END IF;
+        END $$;
+        """
+    )
+    cr.execute(
+        """
+        UPDATE product_product
+        SET manual_code = true
+        WHERE default_code is not NULL
+    """
+    )

product_variant_default_code/models/config_settings.py

@@ -23,3 +23,15 @@ class BaseConfiguration(models.TransientModel):
         default=False,
         config_parameter="product_variant_default_code.prefix_as_default_code",
     )
+
+    sequence_as_default_code = fields.Many2one(
+        string="Default sequence as default Reference",
+        comodel_name="ir.sequence",
+        config_parameter="product_variant_default_code.sequence_as_default_code",
+    )
+
+    use_sequence_per_product_tmp_as_default_code = fields.Boolean(
+        string="Use specific sequence par Product in Reference",
+        config_parameter="product_variant_default_code."
+        "use_sequence_per_product_tmp_as_default_code",
+    )

product_variant_default_code/models/product.py

@@ -14,6 +14,8 @@
 from odoo import _, api, fields, models
 from odoo.exceptions import UserError
 
+SEQUENCE_PATTERN = "[SEQUENCE]"
+
 
 class ReferenceMask(Template):
     pattern = r"""\[(?:
@@ -33,11 +35,13 @@ def sanitize_reference_mask(product, mask):
     main_lang = product._guess_main_lang()
     tokens = extract_token(mask)
     attribute_names = set()
+    attribute_names.add(SEQUENCE_PATTERN[1:-1])
+    attribute_names.add("ID")
     for line in product.attribute_line_ids:
         attribute_names.add(line.attribute_id.with_context(lang=main_lang).name)
     if not tokens.issubset(attribute_names):
         raise UserError(
-            _('Found unrecognized attribute name in "Variant ' 'Reference Mask"')
+            _('Found unrecognized attribute name in "Variant Reference Mask"')
         )
 
 
@@ -73,13 +77,22 @@ class ProductTemplate(models.Model):
         ' `fancyA/l~r~l` (for variant with Color "Red" and Size "L") '
         ' `fancyA/x~y~x` (for variant with Color "Yellow" and Size "XL")'
         '\nNote: make sure characters "[,]" do not appear in your '
-        "attribute name",
+        "attribute name"
+        "Specific : set `%s` to add séquence number, [ID] for variant identifier"
+        % SEQUENCE_PATTERN,
     )
 
     variant_default_code_error = fields.Text(
         compute="_compute_variant_default_code_error"
     )
 
+    code_sequence_id = fields.Many2one(
+        string="Default sequence as Reference",
+        comodel_name="ir.sequence",
+        default=False,
+        copy=False,
+    )
+
     def is_automask(self):
         return bool(
             not self.user_has_groups(
@@ -196,6 +209,54 @@ def _compute_default_code(self):
                 template.default_code = template.code_prefix
         return True
 
+    def _create_default_code_sequence(self):
+        current_pdt = self if len(self.ids) == 1 else False
+        params = self.env["ir.config_parameter"].sudo()
+        seq_model = self.env["ir.sequence"]
+        for_global = not bool(
+            params.get_param(
+                "product_variant_default_code.use_sequence_per_product_tmp_as_default_code"
+            )
+        )
+        seq = (
+            False
+            if not for_global
+            else seq_model.browse(
+                int(
+                    params.get_param(
+                        "product_variant_default_code.sequence_as_default_code"
+                    )
+                )
+            )
+        )
+        if for_global:
+            seq_name = _("Global Product Sequence")
+        else:
+            assert current_pdt
+            seq = self.code_sequence_id
+            seq_name = _("Product Sequence of %(name)s - %(identifier)s") % {
+                "name": current_pdt.name,
+                "identifier": current_pdt.id,
+            }
+        if not seq:
+            vals = {
+                "name": seq_name,
+                "code": "product_sequence_%s"
+                % (current_pdt.id if not for_global else 0),
+                "implementation": "no_gap",
+                "prefix": "",
+                "suffix": "",
+                "padding": 3,
+            }
+            seq = seq_model.create(vals)
+            if not for_global:
+                self.code_sequence_id = seq.id
+            else:
+                params.set_param(
+                    "product_variant_default_code.sequence_as_default_code", seq.id
+                )
+        return seq
+
 
 class ProductProduct(models.Model):
     _inherit = "product.product"
@@ -231,6 +292,10 @@ def _generate_default_code(self):
             return None
         else:
             product_attrs = defaultdict(str)
+            product_attrs["ID"] = str(self.id)
+            if SEQUENCE_PATTERN in self.product_tmpl_id.reference_mask:
+                seq = self.product_tmpl_id._create_default_code_sequence()
+                product_attrs[SEQUENCE_PATTERN[1:-1]] = seq.next_by_id()
             reference_mask = ReferenceMask(self.product_tmpl_id.reference_mask)
             main_lang = self.product_tmpl_id._guess_main_lang()
             for attr in self.product_template_attribute_value_ids:

product_variant_default_code/static/description/index.html

@@ -3,7 +3,7 @@
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 <meta name="generator" content="Docutils: https://docutils.sourceforge.io/" />
-<title>README.rst</title>
+<title>Product Variant Default Code</title>
 <style type="text/css">
 
 /*
@@ -360,21 +360,16 @@
 </style>
 </head>
 <body>
-<div class="document">
+<div class="document" id="product-variant-default-code">
+<h1 class="title">Product Variant Default Code</h1>
 
-
-<a class="reference external image-reference" href="https://odoo-community.org/get-involved?utm_source=readme">
-<img alt="Odoo Community Association" src="https://odoo-community.org/readme-banner-image" />
-</a>
-<div class="section" id="product-variant-default-code">
-<h1>Product Variant Default Code</h1>
 <!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
 !! This file is generated by oca-gen-addon-readme !!
 !! changes will be overwritten.                   !!
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
 !! source digest: sha256:23782e83708e18c5e26008b1e49622f50b2f53d317111279dd3fe33def16dacd
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
-<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/license-AGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/product-variant/tree/16.0/product_variant_default_code"><img alt="OCA/product-variant" src="https://img.shields.io/badge/github-OCA%2Fproduct--variant-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/product-variant-16-0/product-variant-16-0-product_variant_default_code"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external image-reference" href="https://runboat.odoo-community.org/builds?repo=OCA/product-variant&amp;target_branch=16.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
+<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/product-variant/tree/16.0/product_variant_default_code"><img alt="OCA/product-variant" src="https://img.shields.io/badge/github-OCA%2Fproduct--variant-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/product-variant-16-0/product-variant-16-0-product_variant_default_code"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external image-reference" href="https://runboat.odoo-community.org/builds?repo=OCA/product-variant&amp;target_branch=16.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
 <p>This module automatically generate Product Reference (default_code)
 according to attributes data with a configurable behavior.</p>
 <p>It defines a reference mask on the product templates so the
@@ -411,7 +406,7 @@ <h1>Product Variant Default Code</h1>
 </ul>
 </div>
 <div class="section" id="usage">
-<h2><a class="toc-backref" href="#toc-entry-1">Usage</a></h2>
+<h1><a class="toc-backref" href="#toc-entry-1">Usage</a></h1>
 <p>To set the reference mask up on any product template ‘Variant reference mask’
 new field.</p>
 <p>When creating a new product template without specifying the <em>Variant reference
@@ -444,7 +439,7 @@ <h2><a class="toc-backref" href="#toc-entry-1">Usage</a></h2>
 would give <cite>default_code</cite> like this: <cite>COBl-L</cite>, <cite>COWh-L</cite>, <cite>COBl-XL</cite> and
 <cite>COWh-XL</cite>.</p>
 <div class="section" id="avoiding-mask-in-variants">
-<h3><a class="toc-backref" href="#toc-entry-2">Avoiding mask in variants</a></h3>
+<h2><a class="toc-backref" href="#toc-entry-2">Avoiding mask in variants</a></h2>
 <p>You can avoid this behavior or force a manual default_code on variant. To do
 so, go to <em>Product Variants &gt; [any variant you want to set up]</em> and set
 manually its reference code. The field <cite>manual code</cite> will be set to on and the
@@ -453,23 +448,23 @@ <h3><a class="toc-backref" href="#toc-entry-2">Avoiding mask in variants</a></h3
 </div>
 </div>
 <div class="section" id="known-issues-roadmap">
-<h2><a class="toc-backref" href="#toc-entry-3">Known issues / Roadmap</a></h2>
+<h1><a class="toc-backref" href="#toc-entry-3">Known issues / Roadmap</a></h1>
 <ul class="simple">
 <li>In case of attribute name update, related mask are not updated.</li>
 </ul>
 </div>
 <div class="section" id="bug-tracker">
-<h2><a class="toc-backref" href="#toc-entry-4">Bug Tracker</a></h2>
+<h1><a class="toc-backref" href="#toc-entry-4">Bug Tracker</a></h1>
 <p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/product-variant/issues">GitHub Issues</a>.
 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
 <a class="reference external" href="https://github.com/OCA/product-variant/issues/new?body=module:%20product_variant_default_code%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
 <p>Do not contact contributors directly about support or help with technical issues.</p>
 </div>
 <div class="section" id="credits">
-<h2><a class="toc-backref" href="#toc-entry-5">Credits</a></h2>
+<h1><a class="toc-backref" href="#toc-entry-5">Credits</a></h1>
 <div class="section" id="authors">
-<h3><a class="toc-backref" href="#toc-entry-6">Authors</a></h3>
+<h2><a class="toc-backref" href="#toc-entry-6">Authors</a></h2>
 <ul class="simple">
 <li>AvancOSC</li>
 <li>Shine IT</li>
@@ -478,7 +473,7 @@ <h3><a class="toc-backref" href="#toc-entry-6">Authors</a></h3>
 </ul>
 </div>
 <div class="section" id="contributors">
-<h3><a class="toc-backref" href="#toc-entry-7">Contributors</a></h3>
+<h2><a class="toc-backref" href="#toc-entry-7">Contributors</a></h2>
 <ul class="simple">
 <li>Alfredo de la Fuente &lt;<a class="reference external" href="mailto:alfredodelafuente&#64;avanzosc.es">alfredodelafuente&#64;avanzosc.es</a>&gt;</li>
 <li>Tony Gu &lt;<a class="reference external" href="mailto:tony&#64;openerp.cn">tony&#64;openerp.cn</a>&gt;</li>
@@ -492,7 +487,7 @@ <h3><a class="toc-backref" href="#toc-entry-7">Contributors</a></h3>
 </ul>
 </div>
 <div class="section" id="maintainers">
-<h3><a class="toc-backref" href="#toc-entry-8">Maintainers</a></h3>
+<h2><a class="toc-backref" href="#toc-entry-8">Maintainers</a></h2>
 <p>This module is maintained by the OCA.</p>
 <a class="reference external image-reference" href="https://odoo-community.org">
 <img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" />
@@ -507,6 +502,5 @@ <h3><a class="toc-backref" href="#toc-entry-8">Maintainers</a></h3>
 </div>
 </div>
 </div>
-</div>
 </body>
 </html>