Initial commit: AuroraMusic monorepo
This commit is contained in:
Kris
@@ -0,0 +1,6 @@
|
||||
# ruff: noqa: F401 I001
|
||||
from .cli import main
|
||||
|
||||
# TODO: the following imports can be removed when we drop the `rqinfo` and
|
||||
# `rqworkers` commands in favor of just shipping the `rq` command.
|
||||
from .cli import info, worker
|
||||
@@ -0,0 +1,6 @@
|
||||
import sys
|
||||
|
||||
from . import main
|
||||
|
||||
if __name__ == '__main__':
|
||||
sys.exit(main())
|
||||
BIN
Binary file not shown.
BIN
Binary file not shown.
Binary file not shown.
BIN
Binary file not shown.
+521
@@ -0,0 +1,521 @@
|
||||
"""
|
||||
RQ command line tool
|
||||
"""
|
||||
|
||||
import logging
|
||||
import logging.config
|
||||
import os
|
||||
import sys
|
||||
import warnings
|
||||
from typing import List, Type
|
||||
|
||||
import click
|
||||
from redis.exceptions import ConnectionError
|
||||
|
||||
from rq import Connection, Retry
|
||||
from rq import __version__ as version
|
||||
from rq.cli.helpers import (
|
||||
parse_function_args,
|
||||
parse_schedule,
|
||||
pass_cli_config,
|
||||
read_config_file,
|
||||
refresh,
|
||||
setup_loghandlers_from_args,
|
||||
show_both,
|
||||
show_queues,
|
||||
show_workers,
|
||||
)
|
||||
|
||||
# from rq.cli.pool import pool
|
||||
from rq.contrib.legacy import cleanup_ghosts
|
||||
from rq.defaults import (
|
||||
DEFAULT_JOB_MONITORING_INTERVAL,
|
||||
DEFAULT_LOGGING_DATE_FORMAT,
|
||||
DEFAULT_LOGGING_FORMAT,
|
||||
DEFAULT_MAINTENANCE_TASK_INTERVAL,
|
||||
DEFAULT_RESULT_TTL,
|
||||
DEFAULT_WORKER_TTL,
|
||||
)
|
||||
from rq.exceptions import InvalidJobOperationError
|
||||
from rq.job import Job, JobStatus
|
||||
from rq.logutils import blue
|
||||
from rq.registry import FailedJobRegistry, clean_registries
|
||||
from rq.serializers import DefaultSerializer
|
||||
from rq.suspension import is_suspended
|
||||
from rq.suspension import resume as connection_resume
|
||||
from rq.suspension import suspend as connection_suspend
|
||||
from rq.utils import get_call_string, import_attribute
|
||||
from rq.worker import Worker
|
||||
from rq.worker_pool import WorkerPool
|
||||
from rq.worker_registration import clean_worker_registry
|
||||
|
||||
|
||||
@click.group()
|
||||
@click.version_option(version)
|
||||
def main():
|
||||
"""RQ command line tool."""
|
||||
pass
|
||||
|
||||
|
||||
@main.command()
|
||||
@click.option('--all', '-a', is_flag=True, help='Empty all queues')
|
||||
@click.argument('queues', nargs=-1)
|
||||
@pass_cli_config
|
||||
def empty(cli_config, all, queues, serializer, **options):
|
||||
"""Empty given queues."""
|
||||
|
||||
if all:
|
||||
queues = cli_config.queue_class.all(
|
||||
connection=cli_config.connection,
|
||||
job_class=cli_config.job_class,
|
||||
death_penalty_class=cli_config.death_penalty_class,
|
||||
serializer=serializer,
|
||||
)
|
||||
else:
|
||||
queues = [
|
||||
cli_config.queue_class(
|
||||
queue, connection=cli_config.connection, job_class=cli_config.job_class, serializer=serializer
|
||||
)
|
||||
for queue in queues
|
||||
]
|
||||
|
||||
if not queues:
|
||||
click.echo('Nothing to do')
|
||||
sys.exit(0)
|
||||
|
||||
for queue in queues:
|
||||
num_jobs = queue.empty()
|
||||
click.echo('{0} jobs removed from {1} queue'.format(num_jobs, queue.name))
|
||||
|
||||
|
||||
@main.command()
|
||||
@click.option('--all', '-a', is_flag=True, help='Requeue all failed jobs')
|
||||
@click.option('--queue', required=True, type=str)
|
||||
@click.argument('job_ids', nargs=-1)
|
||||
@pass_cli_config
|
||||
def requeue(cli_config, queue, all, job_class, serializer, job_ids, **options):
|
||||
"""Requeue failed jobs."""
|
||||
|
||||
failed_job_registry = FailedJobRegistry(
|
||||
queue, connection=cli_config.connection, job_class=job_class, serializer=serializer
|
||||
)
|
||||
if all:
|
||||
job_ids = failed_job_registry.get_job_ids()
|
||||
|
||||
if not job_ids:
|
||||
click.echo('Nothing to do')
|
||||
sys.exit(0)
|
||||
|
||||
click.echo('Requeueing {0} jobs from failed queue'.format(len(job_ids)))
|
||||
fail_count = 0
|
||||
with click.progressbar(job_ids) as job_ids:
|
||||
for job_id in job_ids:
|
||||
try:
|
||||
failed_job_registry.requeue(job_id)
|
||||
except InvalidJobOperationError:
|
||||
fail_count += 1
|
||||
|
||||
if fail_count > 0:
|
||||
click.secho('Unable to requeue {0} jobs from failed job registry'.format(fail_count), fg='red')
|
||||
|
||||
|
||||
@main.command()
|
||||
@click.option('--interval', '-i', type=float, help='Updates stats every N seconds (default: don\'t poll)')
|
||||
@click.option('--raw', '-r', is_flag=True, help='Print only the raw numbers, no bar charts')
|
||||
@click.option('--only-queues', '-Q', is_flag=True, help='Show only queue info')
|
||||
@click.option('--only-workers', '-W', is_flag=True, help='Show only worker info')
|
||||
@click.option('--by-queue', '-R', is_flag=True, help='Shows workers by queue')
|
||||
@click.argument('queues', nargs=-1)
|
||||
@pass_cli_config
|
||||
def info(cli_config, interval, raw, only_queues, only_workers, by_queue, queues, **options):
|
||||
"""RQ command-line monitor."""
|
||||
|
||||
if only_queues:
|
||||
func = show_queues
|
||||
elif only_workers:
|
||||
func = show_workers
|
||||
else:
|
||||
func = show_both
|
||||
|
||||
try:
|
||||
with Connection(cli_config.connection):
|
||||
if queues:
|
||||
qs = list(map(cli_config.queue_class, queues))
|
||||
else:
|
||||
qs = cli_config.queue_class.all()
|
||||
|
||||
for queue in qs:
|
||||
clean_registries(queue)
|
||||
clean_worker_registry(queue)
|
||||
|
||||
refresh(interval, func, qs, raw, by_queue, cli_config.queue_class, cli_config.worker_class)
|
||||
except ConnectionError as e:
|
||||
click.echo(e)
|
||||
sys.exit(1)
|
||||
except KeyboardInterrupt:
|
||||
click.echo()
|
||||
sys.exit(0)
|
||||
|
||||
|
||||
@main.command()
|
||||
@click.option('--burst', '-b', is_flag=True, help='Run in burst mode (quit after all work is done)')
|
||||
@click.option('--logging_level', type=str, default="INFO", help='Set logging level')
|
||||
@click.option('--log-format', type=str, default=DEFAULT_LOGGING_FORMAT, help='Set the format of the logs')
|
||||
@click.option('--date-format', type=str, default=DEFAULT_LOGGING_DATE_FORMAT, help='Set the date format of the logs')
|
||||
@click.option('--name', '-n', help='Specify a different name')
|
||||
@click.option('--results-ttl', type=int, default=DEFAULT_RESULT_TTL, help='Default results timeout to be used')
|
||||
@click.option('--worker-ttl', type=int, default=DEFAULT_WORKER_TTL, help='Worker timeout to be used')
|
||||
@click.option(
|
||||
'--maintenance-interval',
|
||||
type=int,
|
||||
default=DEFAULT_MAINTENANCE_TASK_INTERVAL,
|
||||
help='Maintenance task interval (in seconds) to be used',
|
||||
)
|
||||
@click.option(
|
||||
'--job-monitoring-interval',
|
||||
type=int,
|
||||
default=DEFAULT_JOB_MONITORING_INTERVAL,
|
||||
help='Default job monitoring interval to be used',
|
||||
)
|
||||
@click.option('--disable-job-desc-logging', is_flag=True, help='Turn off description logging.')
|
||||
@click.option('--verbose', '-v', is_flag=True, help='Show more output')
|
||||
@click.option('--quiet', '-q', is_flag=True, help='Show less output')
|
||||
@click.option('--sentry-ca-certs', envvar='RQ_SENTRY_CA_CERTS', help='Path to CRT file for Sentry DSN')
|
||||
@click.option('--sentry-debug', envvar='RQ_SENTRY_DEBUG', help='Enable debug')
|
||||
@click.option('--sentry-dsn', envvar='RQ_SENTRY_DSN', help='Report exceptions to this Sentry DSN')
|
||||
@click.option('--exception-handler', help='Exception handler(s) to use', multiple=True)
|
||||
@click.option('--pid', help='Write the process ID number to a file at the specified path')
|
||||
@click.option('--disable-default-exception-handler', '-d', is_flag=True, help='Disable RQ\'s default exception handler')
|
||||
@click.option('--max-jobs', type=int, default=None, help='Maximum number of jobs to execute')
|
||||
@click.option('--max-idle-time', type=int, default=None, help='Maximum seconds to stay alive without jobs to execute')
|
||||
@click.option('--with-scheduler', '-s', is_flag=True, help='Run worker with scheduler')
|
||||
@click.option('--serializer', '-S', default=None, help='Run worker with custom serializer')
|
||||
@click.option(
|
||||
'--dequeue-strategy', '-ds', default='default', help='Sets a custom stratey to dequeue from multiple queues'
|
||||
)
|
||||
@click.argument('queues', nargs=-1)
|
||||
@pass_cli_config
|
||||
def worker(
|
||||
cli_config,
|
||||
burst,
|
||||
logging_level,
|
||||
name,
|
||||
results_ttl,
|
||||
worker_ttl,
|
||||
maintenance_interval,
|
||||
job_monitoring_interval,
|
||||
disable_job_desc_logging,
|
||||
verbose,
|
||||
quiet,
|
||||
sentry_ca_certs,
|
||||
sentry_debug,
|
||||
sentry_dsn,
|
||||
exception_handler,
|
||||
pid,
|
||||
disable_default_exception_handler,
|
||||
max_jobs,
|
||||
max_idle_time,
|
||||
with_scheduler,
|
||||
queues,
|
||||
log_format,
|
||||
date_format,
|
||||
serializer,
|
||||
dequeue_strategy,
|
||||
**options,
|
||||
):
|
||||
"""Starts an RQ worker."""
|
||||
settings = read_config_file(cli_config.config) if cli_config.config else {}
|
||||
# Worker specific default arguments
|
||||
queues = queues or settings.get('QUEUES', ['default'])
|
||||
sentry_ca_certs = sentry_ca_certs or settings.get('SENTRY_CA_CERTS')
|
||||
sentry_debug = sentry_debug or settings.get('SENTRY_DEBUG')
|
||||
sentry_dsn = sentry_dsn or settings.get('SENTRY_DSN')
|
||||
name = name or settings.get('NAME')
|
||||
dict_config = settings.get('DICT_CONFIG')
|
||||
|
||||
if dict_config:
|
||||
logging.config.dictConfig(dict_config)
|
||||
|
||||
if pid:
|
||||
with open(os.path.expanduser(pid), "w") as fp:
|
||||
fp.write(str(os.getpid()))
|
||||
|
||||
worker_name = cli_config.worker_class.__qualname__
|
||||
if worker_name in ["RoundRobinWorker", "RandomWorker"]:
|
||||
strategy_alternative = "random" if worker_name == "RandomWorker" else "round_robin"
|
||||
msg = f"WARNING: {worker_name} is deprecated. Use `--dequeue-strategy {strategy_alternative}` instead."
|
||||
warnings.warn(msg, DeprecationWarning)
|
||||
click.secho(msg, fg='yellow')
|
||||
|
||||
if dequeue_strategy not in ("default", "random", "round_robin"):
|
||||
click.secho(
|
||||
"ERROR: Dequeue Strategy can only be one of `default`, `random` or `round_robin`.", err=True, fg='red'
|
||||
)
|
||||
sys.exit(1)
|
||||
|
||||
setup_loghandlers_from_args(verbose, quiet, date_format, log_format)
|
||||
|
||||
try:
|
||||
cleanup_ghosts(cli_config.connection, worker_class=cli_config.worker_class)
|
||||
exception_handlers = []
|
||||
for h in exception_handler:
|
||||
exception_handlers.append(import_attribute(h))
|
||||
|
||||
if is_suspended(cli_config.connection):
|
||||
click.secho('RQ is currently suspended, to resume job execution run "rq resume"', fg='red')
|
||||
sys.exit(1)
|
||||
|
||||
queues = [
|
||||
cli_config.queue_class(
|
||||
queue, connection=cli_config.connection, job_class=cli_config.job_class, serializer=serializer
|
||||
)
|
||||
for queue in queues
|
||||
]
|
||||
worker = cli_config.worker_class(
|
||||
queues,
|
||||
name=name,
|
||||
connection=cli_config.connection,
|
||||
default_worker_ttl=worker_ttl,
|
||||
default_result_ttl=results_ttl,
|
||||
maintenance_interval=maintenance_interval,
|
||||
job_monitoring_interval=job_monitoring_interval,
|
||||
job_class=cli_config.job_class,
|
||||
queue_class=cli_config.queue_class,
|
||||
exception_handlers=exception_handlers or None,
|
||||
disable_default_exception_handler=disable_default_exception_handler,
|
||||
log_job_description=not disable_job_desc_logging,
|
||||
serializer=serializer,
|
||||
)
|
||||
|
||||
# Should we configure Sentry?
|
||||
if sentry_dsn:
|
||||
sentry_opts = {"ca_certs": sentry_ca_certs, "debug": sentry_debug}
|
||||
from rq.contrib.sentry import register_sentry
|
||||
|
||||
register_sentry(sentry_dsn, **sentry_opts)
|
||||
|
||||
# if --verbose or --quiet, override --logging_level
|
||||
if verbose or quiet:
|
||||
logging_level = None
|
||||
|
||||
worker.work(
|
||||
burst=burst,
|
||||
logging_level=logging_level,
|
||||
date_format=date_format,
|
||||
log_format=log_format,
|
||||
max_jobs=max_jobs,
|
||||
max_idle_time=max_idle_time,
|
||||
with_scheduler=with_scheduler,
|
||||
dequeue_strategy=dequeue_strategy,
|
||||
)
|
||||
except ConnectionError as e:
|
||||
logging.error(e)
|
||||
sys.exit(1)
|
||||
|
||||
|
||||
@main.command()
|
||||
@click.option('--duration', help='Seconds you want the workers to be suspended. Default is forever.', type=int)
|
||||
@pass_cli_config
|
||||
def suspend(cli_config, duration, **options):
|
||||
"""Suspends all workers, to resume run `rq resume`"""
|
||||
|
||||
if duration is not None and duration < 1:
|
||||
click.echo("Duration must be an integer greater than 1")
|
||||
sys.exit(1)
|
||||
|
||||
connection_suspend(cli_config.connection, duration)
|
||||
|
||||
if duration:
|
||||
msg = """Suspending workers for {0} seconds. No new jobs will be started during that time, but then will
|
||||
automatically resume""".format(
|
||||
duration
|
||||
)
|
||||
click.echo(msg)
|
||||
else:
|
||||
click.echo("Suspending workers. No new jobs will be started. But current jobs will be completed")
|
||||
|
||||
|
||||
@main.command()
|
||||
@pass_cli_config
|
||||
def resume(cli_config, **options):
|
||||
"""Resumes processing of queues, that were suspended with `rq suspend`"""
|
||||
connection_resume(cli_config.connection)
|
||||
click.echo("Resuming workers.")
|
||||
|
||||
|
||||
@main.command()
|
||||
@click.option('--queue', '-q', help='The name of the queue.', default='default')
|
||||
@click.option(
|
||||
'--timeout', help='Specifies the maximum runtime of the job before it is interrupted and marked as failed.'
|
||||
)
|
||||
@click.option('--result-ttl', help='Specifies how long successful jobs and their results are kept.')
|
||||
@click.option('--ttl', help='Specifies the maximum queued time of the job before it is discarded.')
|
||||
@click.option('--failure-ttl', help='Specifies how long failed jobs are kept.')
|
||||
@click.option('--description', help='Additional description of the job')
|
||||
@click.option(
|
||||
'--depends-on', help='Specifies another job id that must complete before this job will be queued.', multiple=True
|
||||
)
|
||||
@click.option('--job-id', help='The id of this job')
|
||||
@click.option('--at-front', is_flag=True, help='Will place the job at the front of the queue, instead of the end')
|
||||
@click.option('--retry-max', help='Maximum amount of retries', default=0, type=int)
|
||||
@click.option('--retry-interval', help='Interval between retries in seconds', multiple=True, type=int, default=[0])
|
||||
@click.option('--schedule-in', help='Delay until the function is enqueued (e.g. 10s, 5m, 2d).')
|
||||
@click.option(
|
||||
'--schedule-at',
|
||||
help='Schedule job to be enqueued at a certain time formatted in ISO 8601 without '
|
||||
'timezone (e.g. 2021-05-27T21:45:00).',
|
||||
)
|
||||
@click.option('--quiet', is_flag=True, help='Only logs errors.')
|
||||
@click.argument('function')
|
||||
@click.argument('arguments', nargs=-1)
|
||||
@pass_cli_config
|
||||
def enqueue(
|
||||
cli_config,
|
||||
queue,
|
||||
timeout,
|
||||
result_ttl,
|
||||
ttl,
|
||||
failure_ttl,
|
||||
description,
|
||||
depends_on,
|
||||
job_id,
|
||||
at_front,
|
||||
retry_max,
|
||||
retry_interval,
|
||||
schedule_in,
|
||||
schedule_at,
|
||||
quiet,
|
||||
serializer,
|
||||
function,
|
||||
arguments,
|
||||
**options,
|
||||
):
|
||||
"""Enqueues a job from the command line"""
|
||||
args, kwargs = parse_function_args(arguments)
|
||||
function_string = get_call_string(function, args, kwargs)
|
||||
description = description or function_string
|
||||
|
||||
retry = None
|
||||
if retry_max > 0:
|
||||
retry = Retry(retry_max, retry_interval)
|
||||
|
||||
schedule = parse_schedule(schedule_in, schedule_at)
|
||||
|
||||
with Connection(cli_config.connection):
|
||||
queue = cli_config.queue_class(queue, serializer=serializer)
|
||||
|
||||
if schedule is None:
|
||||
job = queue.enqueue_call(
|
||||
function,
|
||||
args,
|
||||
kwargs,
|
||||
timeout,
|
||||
result_ttl,
|
||||
ttl,
|
||||
failure_ttl,
|
||||
description,
|
||||
depends_on,
|
||||
job_id,
|
||||
at_front,
|
||||
None,
|
||||
retry,
|
||||
)
|
||||
else:
|
||||
job = queue.create_job(
|
||||
function,
|
||||
args,
|
||||
kwargs,
|
||||
timeout,
|
||||
result_ttl,
|
||||
ttl,
|
||||
failure_ttl,
|
||||
description,
|
||||
depends_on,
|
||||
job_id,
|
||||
None,
|
||||
JobStatus.SCHEDULED,
|
||||
retry,
|
||||
)
|
||||
queue.schedule_job(job, schedule)
|
||||
|
||||
if not quiet:
|
||||
click.echo('Enqueued %s with job-id \'%s\'.' % (blue(function_string), job.id))
|
||||
|
||||
|
||||
@main.command()
|
||||
@click.option('--burst', '-b', is_flag=True, help='Run in burst mode (quit after all work is done)')
|
||||
@click.option('--logging-level', '-l', type=str, default="INFO", help='Set logging level')
|
||||
@click.option('--sentry-ca-certs', envvar='RQ_SENTRY_CA_CERTS', help='Path to CRT file for Sentry DSN')
|
||||
@click.option('--sentry-debug', envvar='RQ_SENTRY_DEBUG', help='Enable debug')
|
||||
@click.option('--sentry-dsn', envvar='RQ_SENTRY_DSN', help='Report exceptions to this Sentry DSN')
|
||||
@click.option('--verbose', '-v', is_flag=True, help='Show more output')
|
||||
@click.option('--quiet', '-q', is_flag=True, help='Show less output')
|
||||
@click.option('--log-format', type=str, default=DEFAULT_LOGGING_FORMAT, help='Set the format of the logs')
|
||||
@click.option('--date-format', type=str, default=DEFAULT_LOGGING_DATE_FORMAT, help='Set the date format of the logs')
|
||||
@click.option('--job-class', type=str, default=None, help='Dotted path to a Job class')
|
||||
@click.argument('queues', nargs=-1)
|
||||
@click.option('--num-workers', '-n', type=int, default=1, help='Number of workers to start')
|
||||
@pass_cli_config
|
||||
def worker_pool(
|
||||
cli_config,
|
||||
burst: bool,
|
||||
logging_level,
|
||||
queues,
|
||||
serializer,
|
||||
sentry_ca_certs,
|
||||
sentry_debug,
|
||||
sentry_dsn,
|
||||
verbose,
|
||||
quiet,
|
||||
log_format,
|
||||
date_format,
|
||||
worker_class,
|
||||
job_class,
|
||||
num_workers,
|
||||
**options,
|
||||
):
|
||||
"""Starts a RQ worker pool"""
|
||||
settings = read_config_file(cli_config.config) if cli_config.config else {}
|
||||
# Worker specific default arguments
|
||||
queue_names: List[str] = queues or settings.get('QUEUES', ['default'])
|
||||
sentry_ca_certs = sentry_ca_certs or settings.get('SENTRY_CA_CERTS')
|
||||
sentry_debug = sentry_debug or settings.get('SENTRY_DEBUG')
|
||||
sentry_dsn = sentry_dsn or settings.get('SENTRY_DSN')
|
||||
|
||||
setup_loghandlers_from_args(verbose, quiet, date_format, log_format)
|
||||
|
||||
if serializer:
|
||||
serializer_class: Type[DefaultSerializer] = import_attribute(serializer)
|
||||
else:
|
||||
serializer_class = DefaultSerializer
|
||||
|
||||
if worker_class:
|
||||
worker_class = import_attribute(worker_class)
|
||||
else:
|
||||
worker_class = Worker
|
||||
|
||||
if job_class:
|
||||
job_class = import_attribute(job_class)
|
||||
else:
|
||||
job_class = Job
|
||||
|
||||
pool = WorkerPool(
|
||||
queue_names,
|
||||
connection=cli_config.connection,
|
||||
num_workers=num_workers,
|
||||
serializer=serializer_class,
|
||||
worker_class=worker_class,
|
||||
job_class=job_class,
|
||||
)
|
||||
pool.start(burst=burst, logging_level=logging_level)
|
||||
|
||||
# Should we configure Sentry?
|
||||
if sentry_dsn:
|
||||
sentry_opts = {"ca_certs": sentry_ca_certs, "debug": sentry_debug}
|
||||
from rq.contrib.sentry import register_sentry
|
||||
|
||||
register_sentry(sentry_dsn, **sentry_opts)
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
@@ -0,0 +1,424 @@
|
||||
import importlib
|
||||
import os
|
||||
import sys
|
||||
import time
|
||||
from ast import literal_eval
|
||||
from datetime import datetime, timedelta, timezone
|
||||
from enum import Enum
|
||||
from functools import partial, update_wrapper
|
||||
from json import JSONDecodeError, loads
|
||||
from shutil import get_terminal_size
|
||||
|
||||
import click
|
||||
from redis import Redis
|
||||
from redis.sentinel import Sentinel
|
||||
|
||||
from rq.defaults import (
|
||||
DEFAULT_CONNECTION_CLASS,
|
||||
DEFAULT_DEATH_PENALTY_CLASS,
|
||||
DEFAULT_JOB_CLASS,
|
||||
DEFAULT_QUEUE_CLASS,
|
||||
DEFAULT_SERIALIZER_CLASS,
|
||||
DEFAULT_WORKER_CLASS,
|
||||
)
|
||||
from rq.logutils import setup_loghandlers
|
||||
from rq.utils import import_attribute, parse_timeout
|
||||
from rq.worker import WorkerStatus
|
||||
|
||||
red = partial(click.style, fg='red')
|
||||
green = partial(click.style, fg='green')
|
||||
yellow = partial(click.style, fg='yellow')
|
||||
|
||||
|
||||
def read_config_file(module):
|
||||
"""Reads all UPPERCASE variables defined in the given module file."""
|
||||
settings = importlib.import_module(module)
|
||||
return dict([(k, v) for k, v in settings.__dict__.items() if k.upper() == k])
|
||||
|
||||
|
||||
def get_redis_from_config(settings, connection_class=Redis):
|
||||
"""Returns a StrictRedis instance from a dictionary of settings.
|
||||
To use redis sentinel, you must specify a dictionary in the configuration file.
|
||||
Example of a dictionary with keys without values:
|
||||
SENTINEL = {'INSTANCES':, 'SOCKET_TIMEOUT':, 'USERNAME':, 'PASSWORD':, 'DB':, 'MASTER_NAME':, 'SENTINEL_KWARGS':}
|
||||
"""
|
||||
if settings.get('REDIS_URL') is not None:
|
||||
return connection_class.from_url(settings['REDIS_URL'])
|
||||
|
||||
elif settings.get('SENTINEL') is not None:
|
||||
instances = settings['SENTINEL'].get('INSTANCES', [('localhost', 26379)])
|
||||
master_name = settings['SENTINEL'].get('MASTER_NAME', 'mymaster')
|
||||
|
||||
connection_kwargs = {
|
||||
'db': settings['SENTINEL'].get('DB', 0),
|
||||
'username': settings['SENTINEL'].get('USERNAME', None),
|
||||
'password': settings['SENTINEL'].get('PASSWORD', None),
|
||||
'socket_timeout': settings['SENTINEL'].get('SOCKET_TIMEOUT', None),
|
||||
'ssl': settings['SENTINEL'].get('SSL', False),
|
||||
}
|
||||
connection_kwargs.update(settings['SENTINEL'].get('CONNECTION_KWARGS', {}))
|
||||
sentinel_kwargs = settings['SENTINEL'].get('SENTINEL_KWARGS', {})
|
||||
|
||||
sn = Sentinel(instances, sentinel_kwargs=sentinel_kwargs, **connection_kwargs)
|
||||
return sn.master_for(master_name)
|
||||
|
||||
ssl = settings.get('REDIS_SSL', False)
|
||||
if isinstance(ssl, str):
|
||||
if ssl.lower() in ['y', 'yes', 't', 'true']:
|
||||
ssl = True
|
||||
elif ssl.lower() in ['n', 'no', 'f', 'false', '']:
|
||||
ssl = False
|
||||
else:
|
||||
raise ValueError('REDIS_SSL is a boolean and must be "True" or "False".')
|
||||
|
||||
kwargs = {
|
||||
'host': settings.get('REDIS_HOST', 'localhost'),
|
||||
'port': settings.get('REDIS_PORT', 6379),
|
||||
'db': settings.get('REDIS_DB', 0),
|
||||
'password': settings.get('REDIS_PASSWORD', None),
|
||||
'ssl': ssl,
|
||||
'ssl_ca_certs': settings.get('REDIS_SSL_CA_CERTS', None),
|
||||
'ssl_cert_reqs': settings.get('REDIS_SSL_CERT_REQS', 'required'),
|
||||
}
|
||||
|
||||
return connection_class(**kwargs)
|
||||
|
||||
|
||||
def pad(s, pad_to_length):
|
||||
"""Pads the given string to the given length."""
|
||||
return ('%-' + '%ds' % pad_to_length) % (s,)
|
||||
|
||||
|
||||
def get_scale(x):
|
||||
"""Finds the lowest scale where x <= scale."""
|
||||
scales = [20, 50, 100, 200, 400, 600, 800, 1000]
|
||||
for scale in scales:
|
||||
if x <= scale:
|
||||
return scale
|
||||
return x
|
||||
|
||||
|
||||
def state_symbol(state):
|
||||
symbols = {
|
||||
WorkerStatus.BUSY: red('busy'),
|
||||
WorkerStatus.IDLE: green('idle'),
|
||||
WorkerStatus.SUSPENDED: yellow('suspended'),
|
||||
}
|
||||
try:
|
||||
return symbols[state]
|
||||
except KeyError:
|
||||
return state
|
||||
|
||||
|
||||
def show_queues(queues, raw, by_queue, queue_class, worker_class):
|
||||
num_jobs = 0
|
||||
termwidth = get_terminal_size().columns
|
||||
chartwidth = min(20, termwidth - 20)
|
||||
|
||||
max_count = 0
|
||||
counts = dict()
|
||||
for q in queues:
|
||||
count = q.count
|
||||
counts[q] = count
|
||||
max_count = max(max_count, count)
|
||||
scale = get_scale(max_count)
|
||||
ratio = chartwidth * 1.0 / scale
|
||||
|
||||
for q in queues:
|
||||
count = counts[q]
|
||||
if not raw:
|
||||
chart = green('|' + '█' * int(ratio * count))
|
||||
line = '%-12s %s %d, %d executing, %d finished, %d failed' % (
|
||||
q.name,
|
||||
chart,
|
||||
count,
|
||||
q.started_job_registry.count,
|
||||
q.finished_job_registry.count,
|
||||
q.failed_job_registry.count,
|
||||
)
|
||||
else:
|
||||
line = 'queue %s %d, %d executing, %d finished, %d failed' % (
|
||||
q.name,
|
||||
count,
|
||||
q.started_job_registry.count,
|
||||
q.finished_job_registry.count,
|
||||
q.failed_job_registry.count,
|
||||
)
|
||||
click.echo(line)
|
||||
|
||||
num_jobs += count
|
||||
|
||||
# print summary when not in raw mode
|
||||
if not raw:
|
||||
click.echo('%d queues, %d jobs total' % (len(queues), num_jobs))
|
||||
|
||||
|
||||
def show_workers(queues, raw, by_queue, queue_class, worker_class):
|
||||
workers = set()
|
||||
if queues:
|
||||
for queue in queues:
|
||||
for worker in worker_class.all(queue=queue):
|
||||
workers.add(worker)
|
||||
else:
|
||||
for worker in worker_class.all():
|
||||
workers.add(worker)
|
||||
|
||||
if not by_queue:
|
||||
for worker in workers:
|
||||
queue_names = ', '.join(worker.queue_names())
|
||||
name = '%s (%s %s %s)' % (worker.name, worker.hostname, worker.ip_address, worker.pid)
|
||||
if not raw:
|
||||
line = '%s: %s %s. jobs: %d finished, %d failed' % (
|
||||
name,
|
||||
state_symbol(worker.get_state()),
|
||||
queue_names,
|
||||
worker.successful_job_count,
|
||||
worker.failed_job_count,
|
||||
)
|
||||
click.echo(line)
|
||||
else:
|
||||
line = 'worker %s %s %s. jobs: %d finished, %d failed' % (
|
||||
name,
|
||||
worker.get_state(),
|
||||
queue_names,
|
||||
worker.successful_job_count,
|
||||
worker.failed_job_count,
|
||||
)
|
||||
click.echo(line)
|
||||
|
||||
else:
|
||||
# Display workers by queue
|
||||
queue_dict = {}
|
||||
for queue in queues:
|
||||
queue_dict[queue] = worker_class.all(queue=queue)
|
||||
|
||||
if queue_dict:
|
||||
max_length = max(len(q.name) for q, in queue_dict.keys())
|
||||
else:
|
||||
max_length = 0
|
||||
|
||||
for queue in queue_dict:
|
||||
if queue_dict[queue]:
|
||||
queues_str = ", ".join(
|
||||
sorted(map(lambda w: '%s (%s)' % (w.name, state_symbol(w.get_state())), queue_dict[queue]))
|
||||
)
|
||||
else:
|
||||
queues_str = '–'
|
||||
click.echo('%s %s' % (pad(queue.name + ':', max_length + 1), queues_str))
|
||||
|
||||
if not raw:
|
||||
click.echo('%d workers, %d queues' % (len(workers), len(queues)))
|
||||
|
||||
|
||||
def show_both(queues, raw, by_queue, queue_class, worker_class):
|
||||
show_queues(queues, raw, by_queue, queue_class, worker_class)
|
||||
if not raw:
|
||||
click.echo('')
|
||||
show_workers(queues, raw, by_queue, queue_class, worker_class)
|
||||
if not raw:
|
||||
click.echo('')
|
||||
import datetime
|
||||
|
||||
click.echo('Updated: %s' % datetime.datetime.now())
|
||||
|
||||
|
||||
def refresh(interval, func, *args):
|
||||
while True:
|
||||
if interval:
|
||||
click.clear()
|
||||
func(*args)
|
||||
if interval:
|
||||
time.sleep(interval)
|
||||
else:
|
||||
break
|
||||
|
||||
|
||||
def setup_loghandlers_from_args(verbose, quiet, date_format, log_format):
|
||||
if verbose and quiet:
|
||||
raise RuntimeError("Flags --verbose and --quiet are mutually exclusive.")
|
||||
|
||||
if verbose:
|
||||
level = 'DEBUG'
|
||||
elif quiet:
|
||||
level = 'WARNING'
|
||||
else:
|
||||
level = 'INFO'
|
||||
setup_loghandlers(level, date_format=date_format, log_format=log_format)
|
||||
|
||||
|
||||
def parse_function_arg(argument, arg_pos):
|
||||
class ParsingMode(Enum):
|
||||
PLAIN_TEXT = 0
|
||||
JSON = 1
|
||||
LITERAL_EVAL = 2
|
||||
|
||||
keyword = None
|
||||
if argument.startswith(':'): # no keyword, json
|
||||
mode = ParsingMode.JSON
|
||||
value = argument[1:]
|
||||
elif argument.startswith('%'): # no keyword, literal_eval
|
||||
mode = ParsingMode.LITERAL_EVAL
|
||||
value = argument[1:]
|
||||
else:
|
||||
index = argument.find('=')
|
||||
if index > 0:
|
||||
if ':' in argument and argument.index(':') + 1 == index: # keyword, json
|
||||
mode = ParsingMode.JSON
|
||||
keyword = argument[: index - 1]
|
||||
elif '%' in argument and argument.index('%') + 1 == index: # keyword, literal_eval
|
||||
mode = ParsingMode.LITERAL_EVAL
|
||||
keyword = argument[: index - 1]
|
||||
else: # keyword, text
|
||||
mode = ParsingMode.PLAIN_TEXT
|
||||
keyword = argument[:index]
|
||||
value = argument[index + 1 :]
|
||||
else: # no keyword, text
|
||||
mode = ParsingMode.PLAIN_TEXT
|
||||
value = argument
|
||||
|
||||
if value.startswith('@'):
|
||||
try:
|
||||
with open(value[1:], 'r') as file:
|
||||
value = file.read()
|
||||
except FileNotFoundError:
|
||||
raise click.FileError(value[1:], 'Not found')
|
||||
|
||||
if mode == ParsingMode.JSON: # json
|
||||
try:
|
||||
value = loads(value)
|
||||
except JSONDecodeError:
|
||||
raise click.BadParameter('Unable to parse %s as JSON.' % (keyword or '%s. non keyword argument' % arg_pos))
|
||||
elif mode == ParsingMode.LITERAL_EVAL: # literal_eval
|
||||
try:
|
||||
value = literal_eval(value)
|
||||
except Exception:
|
||||
raise click.BadParameter(
|
||||
'Unable to eval %s as Python object. See '
|
||||
'https://docs.python.org/3/library/ast.html#ast.literal_eval'
|
||||
% (keyword or '%s. non keyword argument' % arg_pos)
|
||||
)
|
||||
|
||||
return keyword, value
|
||||
|
||||
|
||||
def parse_function_args(arguments):
|
||||
args = []
|
||||
kwargs = {}
|
||||
|
||||
for argument in arguments:
|
||||
keyword, value = parse_function_arg(argument, len(args) + 1)
|
||||
if keyword is not None:
|
||||
if keyword in kwargs:
|
||||
raise click.BadParameter('You can\'t specify multiple values for the same keyword.')
|
||||
kwargs[keyword] = value
|
||||
else:
|
||||
args.append(value)
|
||||
return args, kwargs
|
||||
|
||||
|
||||
def parse_schedule(schedule_in, schedule_at):
|
||||
if schedule_in is not None:
|
||||
if schedule_at is not None:
|
||||
raise click.BadArgumentUsage('You can\'t specify both --schedule-in and --schedule-at')
|
||||
return datetime.now(timezone.utc) + timedelta(seconds=parse_timeout(schedule_in))
|
||||
elif schedule_at is not None:
|
||||
return datetime.strptime(schedule_at, '%Y-%m-%dT%H:%M:%S')
|
||||
|
||||
|
||||
class CliConfig:
|
||||
"""A helper class to be used with click commands, to handle shared options"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
url=None,
|
||||
config=None,
|
||||
worker_class=DEFAULT_WORKER_CLASS,
|
||||
job_class=DEFAULT_JOB_CLASS,
|
||||
death_penalty_class=DEFAULT_DEATH_PENALTY_CLASS,
|
||||
queue_class=DEFAULT_QUEUE_CLASS,
|
||||
connection_class=DEFAULT_CONNECTION_CLASS,
|
||||
path=None,
|
||||
*args,
|
||||
**kwargs,
|
||||
):
|
||||
self._connection = None
|
||||
self.url = url
|
||||
self.config = config
|
||||
|
||||
if path:
|
||||
for pth in path:
|
||||
sys.path.append(pth)
|
||||
|
||||
try:
|
||||
self.worker_class = import_attribute(worker_class)
|
||||
except (ImportError, AttributeError) as exc:
|
||||
raise click.BadParameter(str(exc), param_hint='--worker-class')
|
||||
try:
|
||||
self.job_class = import_attribute(job_class)
|
||||
except (ImportError, AttributeError) as exc:
|
||||
raise click.BadParameter(str(exc), param_hint='--job-class')
|
||||
|
||||
try:
|
||||
self.death_penalty_class = import_attribute(death_penalty_class)
|
||||
except (ImportError, AttributeError) as exc:
|
||||
raise click.BadParameter(str(exc), param_hint='--death-penalty-class')
|
||||
|
||||
try:
|
||||
self.queue_class = import_attribute(queue_class)
|
||||
except (ImportError, AttributeError) as exc:
|
||||
raise click.BadParameter(str(exc), param_hint='--queue-class')
|
||||
|
||||
try:
|
||||
self.connection_class = import_attribute(connection_class)
|
||||
except (ImportError, AttributeError) as exc:
|
||||
raise click.BadParameter(str(exc), param_hint='--connection-class')
|
||||
|
||||
@property
|
||||
def connection(self):
|
||||
if self._connection is None:
|
||||
if self.url:
|
||||
self._connection = self.connection_class.from_url(self.url)
|
||||
elif self.config:
|
||||
settings = read_config_file(self.config) if self.config else {}
|
||||
self._connection = get_redis_from_config(settings, self.connection_class)
|
||||
else:
|
||||
self._connection = get_redis_from_config(os.environ, self.connection_class)
|
||||
return self._connection
|
||||
|
||||
|
||||
shared_options = [
|
||||
click.option('--url', '-u', envvar='RQ_REDIS_URL', help='URL describing Redis connection details.'),
|
||||
click.option('--config', '-c', envvar='RQ_CONFIG', help='Module containing RQ settings.'),
|
||||
click.option(
|
||||
'--worker-class', '-w', envvar='RQ_WORKER_CLASS', default=DEFAULT_WORKER_CLASS, help='RQ Worker class to use'
|
||||
),
|
||||
click.option('--job-class', '-j', envvar='RQ_JOB_CLASS', default=DEFAULT_JOB_CLASS, help='RQ Job class to use'),
|
||||
click.option('--queue-class', envvar='RQ_QUEUE_CLASS', default=DEFAULT_QUEUE_CLASS, help='RQ Queue class to use'),
|
||||
click.option(
|
||||
'--connection-class',
|
||||
envvar='RQ_CONNECTION_CLASS',
|
||||
default=DEFAULT_CONNECTION_CLASS,
|
||||
help='Redis client class to use',
|
||||
),
|
||||
click.option('--path', '-P', default=['.'], help='Specify the import path.', multiple=True),
|
||||
click.option(
|
||||
'--serializer',
|
||||
'-S',
|
||||
default=DEFAULT_SERIALIZER_CLASS,
|
||||
help='Path to serializer, defaults to rq.serializers.DefaultSerializer',
|
||||
),
|
||||
]
|
||||
|
||||
|
||||
def pass_cli_config(func):
|
||||
# add all the shared options to the command
|
||||
for option in shared_options:
|
||||
func = option(func)
|
||||
|
||||
# pass the cli config object into the command
|
||||
def wrapper(*args, **kwargs):
|
||||
ctx = click.get_current_context()
|
||||
cli_config = CliConfig(**kwargs)
|
||||
return ctx.invoke(func, cli_config, *args[1:], **kwargs)
|
||||
|
||||
return update_wrapper(wrapper, func)
|
||||
Reference in New Issue
Block a user