[19.0] [MIG] base_import_async: migrate

.pre-commit-config.yaml

@@ -1,7 +1,6 @@
 exclude: |
   (?x)
   # NOT INSTALLABLE ADDONS
-  ^base_import_async/|
   ^queue_job/|
   ^queue_job_batch/|
   ^queue_job_cron/|

base_import_async/README.rst

@@ -1,3 +1,7 @@
+.. image:: https://odoo-community.org/readme-banner-image
+   :target: https://odoo-community.org/get-involved?utm_source=readme
+   :alt: Odoo Community Association
+
 ===================
 Asynchronous Import
 ===================
@@ -13,17 +17,17 @@ Asynchronous Import
 .. |badge1| image:: https://img.shields.io/badge/maturity-Production%2FStable-green.png
     :target: https://odoo-community.org/page/development-status
     :alt: Production/Stable
-.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
+.. |badge2| image:: https://img.shields.io/badge/license-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%2Fqueue-lightgray.png?logo=github
-    :target: https://github.com/OCA/queue/tree/18.0/base_import_async
+    :target: https://github.com/OCA/queue/tree/19.0/base_import_async
     :alt: OCA/queue
 .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
-    :target: https://translation.odoo-community.org/projects/queue-18-0/queue-18-0-base_import_async
+    :target: https://translation.odoo-community.org/projects/queue-19-0/queue-19-0-base_import_async
     :alt: Translate me on Weblate
 .. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
-    :target: https://runboat.odoo-community.org/builds?repo=OCA/queue&target_branch=18.0
+    :target: https://runboat.odoo-community.org/builds?repo=OCA/queue&target_branch=19.0
     :alt: Try me on Runboat
 
 |badge1| |badge2| |badge3| |badge4| |badge5|
@@ -87,7 +91,7 @@ Bug Tracker
 Bugs are tracked on `GitHub Issues <https://github.com/OCA/queue/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 <https://github.com/OCA/queue/issues/new?body=module:%20base_import_async%0Aversion:%2018.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
+`feedback <https://github.com/OCA/queue/issues/new?body=module:%20base_import_async%0Aversion:%2019.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
 
 Do not contact contributors directly about support or help with technical issues.
 
@@ -149,6 +153,6 @@ 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/queue <https://github.com/OCA/queue/tree/18.0/base_import_async>`_ project on GitHub.
+This module is part of the `OCA/queue <https://github.com/OCA/queue/tree/19.0/base_import_async>`_ project on GitHub.
 
 You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

base_import_async/__init__.py

@@ -1,3 +1,4 @@
 # License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
 
 from . import models
+from . import wizard

base_import_async/__manifest__.py

@@ -5,7 +5,7 @@
 {
     "name": "Asynchronous Import",
     "summary": "Import CSV files in the background",
-    "version": "18.0.1.0.0",
+    "version": "19.0.1.0.0",
     "author": "Akretion, ACSONE SA/NV, Odoo Community Association (OCA)",
     "license": "AGPL-3",
     "website": "https://github.com/OCA/queue",
@@ -20,6 +20,6 @@
             "base_import_async/static/src/xml/import_data_sidepanel.xml",
         ],
     },
-    "installable": False,
+    "installable": True,
     "development_status": "Production/Stable",
 }

base_import_async/models/__init__.py

@@ -1,4 +1,3 @@
 # License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
 
-from . import base_import_import
 from . import queue_job

base_import_async/models/queue_job.py

@@ -1,7 +1,7 @@
 # Copyright 2017 ACSONE SA/NV
 # License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
 
-from odoo import _, models
+from odoo import models
 
 
 class QueueJob(models.Model):
@@ -11,7 +11,7 @@ class QueueJob(models.Model):
 
     def _related_action_attachment(self):
         return {
-            "name": _("Attachment"),
+            "name": self.env._("Attachment"),
             "type": "ir.actions.act_window",
             "res_model": "ir.attachment",
             "view_mode": "form",

base_import_async/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>Asynchronous Import</title>
+<title>README.rst</title>
 <style type="text/css">
 
 /*
@@ -360,16 +360,21 @@
 </style>
 </head>
 <body>
-<div class="document" id="asynchronous-import">
-<h1 class="title">Asynchronous Import</h1>
+<div class="document">
 
+
+<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="asynchronous-import">
+<h1>Asynchronous Import</h1>
 <!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
 !! This file is generated by oca-gen-addon-readme !!
 !! changes will be overwritten.                   !!
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
 !! source digest: sha256:299c64b165f6348dfa062b8925a95235390daa6063964f21a5a1d0757cdf1614
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
-<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Production/Stable" src="https://img.shields.io/badge/maturity-Production%2FStable-green.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/queue/tree/18.0/base_import_async"><img alt="OCA/queue" src="https://img.shields.io/badge/github-OCA%2Fqueue-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/queue-18-0/queue-18-0-base_import_async"><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/queue&amp;target_branch=18.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="Production/Stable" src="https://img.shields.io/badge/maturity-Production%2FStable-green.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/queue/tree/19.0/base_import_async"><img alt="OCA/queue" src="https://img.shields.io/badge/github-OCA%2Fqueue-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/queue-19-0/queue-19-0-base_import_async"><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/queue&amp;target_branch=19.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
 <p>This module extends the standard CSV import functionality to import
 files in the background using the OCA/queue framework.</p>
 <p><strong>Table of contents</strong></p>
@@ -392,7 +397,7 @@ <h1 class="title">Asynchronous Import</h1>
 </ul>
 </div>
 <div class="section" id="usage">
-<h1><a class="toc-backref" href="#toc-entry-1">Usage</a></h1>
+<h2><a class="toc-backref" href="#toc-entry-1">Usage</a></h2>
 <p>The user is presented with a new checkbox in the import screen. When
 selected, the import is delayed in a background job.</p>
 <p>This job in turn splits the CSV file in chunks of minimum 100 lines (or
@@ -416,7 +421,7 @@ <h1><a class="toc-backref" href="#toc-entry-1">Usage</a></h1>
 </ol>
 </div>
 <div class="section" id="known-issues-roadmap">
-<h1><a class="toc-backref" href="#toc-entry-2">Known issues / Roadmap</a></h1>
+<h2><a class="toc-backref" href="#toc-entry-2">Known issues / Roadmap</a></h2>
 <ul class="simple">
 <li>There is currently no user interface to control the chunk size, which
 is currently 100 by default. Should this proves to be an issue, it is
@@ -425,33 +430,33 @@ <h1><a class="toc-backref" href="#toc-entry-2">Known issues / Roadmap</a></h1>
 </ul>
 </div>
 <div class="section" id="changelog">
-<h1><a class="toc-backref" href="#toc-entry-3">Changelog</a></h1>
+<h2><a class="toc-backref" href="#toc-entry-3">Changelog</a></h2>
 <div class="section" id="section-1">
-<h2><a class="toc-backref" href="#toc-entry-4">13.0.1.0.0 (2019-12-20)</a></h2>
+<h3><a class="toc-backref" href="#toc-entry-4">13.0.1.0.0 (2019-12-20)</a></h3>
 <ul class="simple">
 <li>[MIGRATION] from 12.0 branched at rev. a7f8031</li>
 </ul>
 </div>
 </div>
 <div class="section" id="bug-tracker">
-<h1><a class="toc-backref" href="#toc-entry-5">Bug Tracker</a></h1>
+<h2><a class="toc-backref" href="#toc-entry-5">Bug Tracker</a></h2>
 <p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/queue/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/queue/issues/new?body=module:%20base_import_async%0Aversion:%2018.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
+<a class="reference external" href="https://github.com/OCA/queue/issues/new?body=module:%20base_import_async%0Aversion:%2019.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">
-<h1><a class="toc-backref" href="#toc-entry-6">Credits</a></h1>
+<h2><a class="toc-backref" href="#toc-entry-6">Credits</a></h2>
 <div class="section" id="authors">
-<h2><a class="toc-backref" href="#toc-entry-7">Authors</a></h2>
+<h3><a class="toc-backref" href="#toc-entry-7">Authors</a></h3>
 <ul class="simple">
 <li>Akretion</li>
 <li>ACSONE SA/NV</li>
 </ul>
 </div>
 <div class="section" id="contributors">
-<h2><a class="toc-backref" href="#toc-entry-8">Contributors</a></h2>
+<h3><a class="toc-backref" href="#toc-entry-8">Contributors</a></h3>
 <p>Sébastien Beau (Akretion) authored the initial prototype.</p>
 <p>Stéphane Bidoul (ACSONE) extended it to version 1.0 to support
 multi-line records, store data to import as attachments and let the user
@@ -473,23 +478,24 @@ <h2><a class="toc-backref" href="#toc-entry-8">Contributors</a></h2>
 </ul>
 </div>
 <div class="section" id="other-credits">
-<h2><a class="toc-backref" href="#toc-entry-9">Other credits</a></h2>
+<h3><a class="toc-backref" href="#toc-entry-9">Other credits</a></h3>
 <p>The migration of this module from 17.0 to 18.0 was financially supported
 by Camptocamp</p>
 </div>
 <div class="section" id="maintainers">
-<h2><a class="toc-backref" href="#toc-entry-10">Maintainers</a></h2>
+<h3><a class="toc-backref" href="#toc-entry-10">Maintainers</a></h3>
 <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" />
 </a>
 <p>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.</p>
-<p>This module is part of the <a class="reference external" href="https://github.com/OCA/queue/tree/18.0/base_import_async">OCA/queue</a> project on GitHub.</p>
+<p>This module is part of the <a class="reference external" href="https://github.com/OCA/queue/tree/19.0/base_import_async">OCA/queue</a> project on GitHub.</p>
 <p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>
 </div>
 </div>
 </div>
+</div>
 </body>
 </html>

base_import_async/tests/test_base_import_import.py

@@ -3,7 +3,7 @@
 
 from odoo.tests.common import RecordCapturer, TransactionCase
 
-from ..models.base_import_import import OPT_USE_QUEUE
+from ..wizard.base_import_import import OPT_USE_QUEUE
 
 
 class TestBaseImportImport(TransactionCase):

base_import_async/wizard/__init__.py

@@ -0,0 +1,3 @@
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
+
+from . import base_import_import

base_import_async/models/base_import_import.py → base_import_async/wizard/base_import_import.py

@@ -9,7 +9,7 @@
 from io import BytesIO, StringIO, TextIOWrapper
 from os.path import splitext
 
-from odoo import _, api, models
+from odoo import models
 from odoo.models import fix_import_export_id_paths
 
 from odoo.addons.base_import.models.base_import import ImportValidationError
@@ -55,10 +55,11 @@ def execute_import(self, fields, columns, options, dryrun=False):
             translated_model_name = search_result[0][1]
         else:
             translated_model_name = self._description
-        description = _("Import %(model)s from file %(from_file)s") % {
-            "model": translated_model_name,
-            "from_file": self.file_name,
-        }
+        description = self.env._(
+            "Import %(model)s from file %(file_name)s",
+            model=translated_model_name,
+            file_name=self.file_name,
+        )
         attachment = self._create_csv_attachment(
             import_fields, data, options, self.file_name
         )
@@ -78,8 +79,8 @@ def _link_attachment_to_job(self, delayed_job, attachment):
         )
         attachment.write({"res_model": "queue.job", "res_id": queue_job.id})
 
-    @api.returns("ir.attachment")
     def _create_csv_attachment(self, fields, data, options, file_name):
+        # Odoo 19: @api.returns decorator removed; just return the recordset.
         # write csv
         f = StringIO()
         writer = csv.writer(
@@ -146,26 +147,23 @@ def _split_file(
         fields, data = self._read_csv_attachment(attachment, options)
         padding = len(str(len(data)))
         priority = options.get(OPT_PRIORITY, INIT_PRIORITY)
-        if options.get(OPT_HAS_HEADER):
-            header_offset = 1
-        else:
-            header_offset = 0
+        header_offset = 1 if options.get(OPT_HAS_HEADER) else 0
         chunk_size = options.get(OPT_CHUNK_SIZE) or DEFAULT_CHUNK_SIZE
         for row_from, row_to in self._extract_chunks(
             model_obj, fields, data, chunk_size
         ):
             chunk = str(priority - INIT_PRIORITY).zfill(padding)
-            description = _(
-                "Import %(model)s from file %(file_name)s - "
-                "#%(chunk)s - lines %(from)s to %(to)s"
+            description = self.env._(
+                (
+                    "Import %(model)s from file %(file_name)s - #%(chunk)s - "
+                    "lines %(from_line)s to %(to_line)s"
+                ),
+                model=translated_model_name,
+                file_name=file_name,
+                chunk=chunk,
+                from_line=row_from + 1 + header_offset,
+                to_line=row_to + 1 + header_offset,
             )
-            description = description % {
-                "model": translated_model_name,
-                "file_name": file_name,
-                "chunk": chunk,
-                "from": row_from + 1 + header_offset,
-                "to": row_to + 1 + header_offset,
-            }
             # create a CSV attachment and enqueue the job
             root, ext = splitext(file_name)
             attachment = self._create_csv_attachment(

test-requirements.txt

@@ -0,0 +1 @@
+odoo-addon-queue_job @ git+https://github.com/OCA/queue.git@refs/pull/840/head#subdirectory=queue_job