Maintainers
+Maintainers
This module is maintained by the OCA.
@@ -982,5 +987,6 @@ 
| Job Queue
+[queue_job](queue_job/) | 15.0.2.3.13 | | Job Queue
[queue_job_cron](queue_job_cron/) | 15.0.1.0.0 | | Scheduled Actions as Queue Jobs
[queue_job_cron_jobrunner](queue_job_cron_jobrunner/) | 15.0.2.0.0 | 
| Run jobs without a dedicated JobRunner
[queue_job_subscribe](queue_job_subscribe/) | 15.0.1.0.0 | | Control which users are subscribed to queue job notifications
diff --git a/queue_job/README.rst b/queue_job/README.rst
index a22f8ad8bb..701c555d5f 100644
--- a/queue_job/README.rst
+++ b/queue_job/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
+
=========
Job Queue
=========
@@ -7,13 +11,13 @@ Job Queue
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
- !! source digest: sha256:273ee23baedfd996e4827a938bd5cd55a7d38f711b36e180dbd35ec55167b94b
+ !! source digest: sha256:ed7fd7063b32513ff7af35e930e1e6d71d5f4c731e62dbdf49f1ba490e22c7d3
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
.. |badge1| image:: https://img.shields.io/badge/maturity-Mature-brightgreen.png
:target: https://odoo-community.org/page/development-status
:alt: Mature
-.. |badge2| image:: https://img.shields.io/badge/licence-LGPL--3-blue.png
+.. |badge2| image:: https://img.shields.io/badge/license-LGPL--3-blue.png
:target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
:alt: License: LGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fqueue-lightgray.png?logo=github
diff --git a/queue_job/__manifest__.py b/queue_job/__manifest__.py
index 43850ac203..ce9b31bbb7 100644
--- a/queue_job/__manifest__.py
+++ b/queue_job/__manifest__.py
@@ -2,7 +2,7 @@
{
"name": "Job Queue",
- "version": "15.0.2.3.12",
+ "version": "15.0.2.3.13",
"author": "Camptocamp,ACSONE SA/NV,Odoo Community Association (OCA)",
"website": "https://github.com/OCA/queue",
"license": "LGPL-3",
diff --git a/queue_job/static/description/index.html b/queue_job/static/description/index.html
index bcd8f0580b..e8cee824a4 100644
--- a/queue_job/static/description/index.html
+++ b/queue_job/static/description/index.html
@@ -3,7 +3,7 @@
-
This addon adds an integrated Job Queue to Odoo.
It allows to postpone method calls executed asynchronously.
Jobs are executed in the background by a Jobrunner, in their own transaction.
Example:
-from odoo import models, fields, api +from odoo import models, fields, api -class MyModel(models.Model): +class MyModel(models.Model): _name = 'my.model' - def my_method(self, a, k=None): + def my_method(self, a, k=None): _logger.info('executed with a: %s and k: %s', a, k) -class MyOtherModel(models.Model): +class MyOtherModel(models.Model): _name = 'my.other.model' - def button_do_stuff(self): + def button_do_stuff(self): self.env['my.model'].with_delay().my_method('a', k=2)
In the snippet of code above, when we call button_do_stuff, a job capturing
@@ -441,11 +446,11 @@ Job Queue
To use this module, you need to:
The fast way to enqueue a job for a method is to use with_delay() on a record or model:
-def button_done(self): +def button_done(self): self.with_delay().print_confirmation_document(self.state) self.write({"state": "done"}) return True @@ -537,7 +542,7 @@Delaying jobs
on a record or model. The following is the equivalent of with_delay() but using the long form:-def button_done(self): +def button_done(self): delayable = self.delayable() delayable.print_confirmation_document(self.state) delayable.delay() @@ -547,7 +552,7 @@Delaying jobs
Methods of Delayable objects return itself, so it can be used as a builder pattern, which in some cases allow to build the jobs dynamically:
-def button_generate_simple_with_delayable(self): +def button_generate_simple_with_delayable(self): self.ensure_one() # Introduction of a delayable object, using a builder pattern # allowing to chain jobs or set properties. The delay() method @@ -563,7 +568,7 @@Delaying jobs
The simplest way to define a dependency is to use .on_done(job) on a Delayable:
-def button_chain_done(self): +def button_chain_done(self): self.ensure_one() job1 = self.browse(1).delayable().generate_thumbnail((50, 50)) job2 = self.browse(1).delayable().generate_thumbnail((50, 50)) @@ -580,9 +585,9 @@Delaying jobs
[B] of jobs. When and only when all the jobs of the group [A] are executed, the jobs of the group [B] are executed. The code would look like:-from odoo.addons.queue_job.delay import group, chain +from odoo.addons.queue_job.delay import group, chain -def button_done(self): +def button_done(self): group_a = group(self.delayable().method_foo(), self.delayable().method_bar()) group_b = group(self.delayable().method_baz(1), self.delayable().method_baz(2)) chain(group_a, group_b).delay() @@ -601,7 +606,7 @@Delaying jobs
would never be delayed (but a warning would be shown).
In earlier versions, jobs could be configured using the @job decorator. This is now obsolete, they can be configured using optional queue.job.function and queue.job.channel XML records.
@@ -674,10 +679,10 @@Example of related action code:
-class QueueJob(models.Model): +class QueueJob(models.Model): _inherit = 'queue.job' - def related_action_partner(self, name): + def related_action_partner(self, name): self.ensure_one() model = self.model_name partner = self.records @@ -719,12 +724,12 @@Configure default options for job be customized in Base._job_prepare_context_before_enqueue_keys.
Example:
-class Base(models.AbstractModel): +class Base(models.AbstractModel): _inherit = "base" @api.model - def _job_prepare_context_before_enqueue_keys(self): + def _job_prepare_context_before_enqueue_keys(self): """Keys to keep in context of stored jobs Empty by default for backward compatibility. @@ -742,7 +747,7 @@Configure default options for job
Tip: you can do this at test case level like this
@classmethod -def setUpClass(cls): +def setUpClass(cls): super().setUpClass() cls.env = cls.env(context=dict( cls.env.context, @@ -753,7 +758,7 @@Configure default options for job without delaying any jobs.
Asserting enqueued jobs
The recommended way to test jobs, rather than running them directly and synchronously is to split the tests in two parts:
@@ -782,20 +787,20 @@A very small example (more details in tests/common.py):
# code -def my_job_method(self, name, count): +def my_job_method(self, name, count): self.write({"name": " ".join([name] * count) -def method_to_test(self): +def method_to_test(self): count = self.env["other.model"].search_count([]) self.with_delay(priority=15).my_job_method("Hi!", count=count) return count # tests -from odoo.addons.queue_job.tests.common import trap_jobs +from odoo.addons.queue_job.tests.common import trap_jobs # first test only check the expected behavior of the method and the proper # enqueuing of jobs -def test_method_to_test(self): +def test_method_to_test(self): with trap_jobs() as trap: result = self.env["model"].method_to_test() expected_count = 12 @@ -811,7 +816,7 @@Testing
# second test to validate the behavior of the job unitarily - def test_my_job_method(self): + def test_my_job_method(self): record = self.env["model"].browse(1) record.my_job_method("Hi!", count=12) self.assertEqual(record.name, "Hi! Hi! Hi! Hi! Hi! Hi! Hi! Hi! Hi! Hi! Hi! Hi!") @@ -819,7 +824,7 @@Testing
If you prefer, you can still test the whole thing in a single test, by calling jobs_tester.perform_enqueued_jobs() in your test.
-def test_method_to_test(self): +def test_method_to_test(self): with trap_jobs() as trap: result = self.env["model"].method_to_test() expected_count = 12 @@ -854,7 +859,7 @@Testing
Tip: you can do this at test case level like this
@classmethod -def setUpClass(cls): +def setUpClass(cls): super().setUpClass() cls.env = cls.env(context=dict( cls.env.context, @@ -873,14 +878,14 @@Testing
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 @@ -941,16 +946,16 @@
Do not contact contributors directly about support or help with technical issues.