opensource/galaxy
3
0
Fork 0
mirror of https://github.com/galaxyproject/galaxy.git synced 2026-10-24 02:04:04 +08:00
Code Issues Packages Projects Releases Wiki Activity

Provide better guidance on what to override

Browse Source
This commit is contained in:
John Davis
2023-09-08 14:02:12 -04:00
parent c014ae1e8b
commit 0ab66ae045
1 changed files with 16 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/source/dev/build_a_job_runner.rst
+16 -6
View File
@@ -24,17 +24,27 @@ contains the base runner implementation. To create a new runner, the base
runner class (in most cases, ``AsynchronousJobRunner``) must be inherited and only certain methods need to be
overridden with your logic.
These are the methods that need to be implemented, with custom logic added as needed:
These are the methods that need to be implemented:
1. ``__init__(app, nworkers, **kwargs)``
1. ``queue_job(job_wrapper)``
2. ``queue_job(job_wrapper)``
2. ``check_watched_item(job_state)``
3. ``check_watched_item(job_state)``
3. ``stop_job(job)``
4. ``stop_job(job)``
4. ``recover(job, job_wrapper)``
5. ``recover(job, job_wrapper)``
In addition, you will almost certainly override the ``__init__(app, nworkers, **kwargs)``
method in order to add custom logic to initialize your runner. In
doing so, make sure to call the parent class constructor:
.. code-block:: python
super().__init__(app, nworkers, **kwargs)
Keep in mind that when you override a method, you should not reimplement any of
the logic that is present in the base class: the above call to ``super()``
ensures that all that such logic is handled automatically.
The big picture
---------------