Warning

This document is for an in-development version of Galaxy. You can alternatively view this page in the latest release if it exists or view the top of the latest release's documentation.

galaxy.celery package

class galaxy.celery.GalaxyCelery(*args, **kwargs)

Bases: Celery

fork_pool: ProcessPool

__init__(*args, **kwargs)

gen_task_name(name, module)

trim_module_name(module)

Drop “celery.tasks” infix for less verbose task names: - galaxy.celery.tasks.do_foo >> galaxy.do_foo - galaxy.celery.tasks.subtasks.do_fuz >> galaxy.subtasks.do_fuz

class galaxy.celery.GalaxyTask

Bases: Task

Custom celery task used to limit number of tasks executions per user per second.

before_start(task_id, args, kwargs)

Set appropriate before start object from DI container.

ignore_result = False

If enabled the worker won’t store task state and return values for this task. Defaults to the :setting:`task_ignore_result` setting.

priority = None

Default task priority.

rate_limit = None

Rate limit for this task type. Examples: None (no rate limit), ‘100/s’ (hundred tasks a second), ‘100/m’ (hundred tasks a minute),`’100/h’` (hundred tasks an hour)

reject_on_worker_lost = None

Even if acks_late is enabled, the worker will acknowledge tasks when the worker process executing them abruptly exits or is signaled (e.g., :sig:`KILL`/:sig:`INT`, etc).

Setting this to true allows the message to be re-queued instead, so that the task will execute again by the same worker, or another worker.

Warning: Enabling this can cause message loops; make sure you know what you’re doing.

request_stack = <celery.utils.threads._LocalStack object>

Task request stack, the current request will be the topmost.

serializer = 'json'

The name of a serializer that are registered with kombu.serialization.registry. Default is ‘json’.

store_errors_even_if_ignored = False

When enabled errors will be stored even if the task is otherwise configured to ignore results.

track_started = False

If enabled the task will report its status as ‘started’ when the task is executed by a worker. Disabled by default as the normal behavior is to not report that level of granularity. Tasks are either pending, finished, or waiting to be retried.

Having a ‘started’ status can be useful for when there are long running tasks and there’s a need to report what task is currently running.

The application default can be overridden using the :setting:`task_track_started` setting.

typing = True

Enable argument checking. You can set this to false if you don’t want the signature to be checked when calling the task. Defaults to app.strict_typing.

galaxy.celery.set_thread_app(app)

galaxy.celery.get_galaxy_app()

galaxy.celery.build_app()

galaxy.celery.get_app_properties()

galaxy.celery.get_config()

galaxy.celery.init_fork_pool()

galaxy.celery.setup_worker_pool(sender=None, conf=None, instance=None, **kwargs)

galaxy.celery.tear_down_pool(sig, how, exitcode, **kwargs)

galaxy.celery.galaxy_task(*args, action=None, **celery_task_kwd)

galaxy.celery.init_celery_app()

galaxy.celery.config_celery_app(config, celery_app)

galaxy.celery.setup_periodic_tasks(config, celery_app)

Submodules

galaxy.celery.tasks module

galaxy.celery.tasks.setup_data_table_manager(app)

galaxy.celery.tasks.cached_create_tool_from_representation(app: MinimalManagerApp, raw_tool_source: str)

galaxy.celery.tasks.is_aborted(session: galaxy_scoped_session, job_id: int)

galaxy.celery.tasks.abort_when_job_stops(function: Callable, session: galaxy_scoped_session, job_id: int, **kwargs) → Any