mirror of https://github.com/peter4431/rq.git
Restructure new CLI modules.
A few things have changed. First of all, there is no separate copy of
the argparse-based `rqinfo` anymore. It now fully utilizes the new
Click subcommand. In other words: `rqinfo` and `rq info` both invoke
the same function under the hood.
In order to support this, the main command group now does NOT take
a `url` option and initializes the connection. Besides supporting this
alias pattern, this change was useful for two more reasons: (1) it
allows us to add subcommands that don't need the Redis server running in
the future, and (2) it makes the `--url` option an option underneath
each subcommand. This avoids command invocations that look like this:
$ rq --url <url> info --more --flags
And instead allows us to pass the URL to each subcommand where it's
deemed necessary:
$ rq info --url <url> --more --flags
Which is much friendlier to use/remember.
main
Vincent Driessen
10 years ago
parent
652cd71d2b
commit
b5fbc3992b
@ -0,0 +1,6 @@
|
||||
# flake8: noqa
|
||||
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
|
||||
@ -0,0 +1,115 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
"""
|
||||
RQ command line tool
|
||||
"""
|
||||
from __future__ import (absolute_import, division, print_function,
|
||||
unicode_literals)
|
||||
|
||||
import sys
|
||||
|
||||
import click
|
||||
from redis import StrictRedis
|
||||
from redis.exceptions import ConnectionError
|
||||
from rq import Connection, get_failed_queue, Queue
|
||||
from rq.exceptions import InvalidJobOperationError
|
||||
|
||||
from .helpers import refresh, show_both, show_queues, show_workers
|
||||
|
||||
url_option = click.option('--url', '-u', envvar='URL', default='redis://localhost:6379/0',
|
||||
help='URL describing Redis connection details.')
|
||||
|
||||
|
||||
def connect(url):
|
||||
return StrictRedis.from_url(url)
|
||||
|
||||
|
||||
@click.group()
|
||||
def main():
|
||||
"""RQ command line tool."""
|
||||
pass
|
||||
|
||||
|
||||
@main.command()
|
||||
@url_option
|
||||
@click.option('--all', '-a', is_flag=True, help='Empty all queues')
|
||||
@click.argument('queues', nargs=-1)
|
||||
@click.pass_context
|
||||
def empty(ctx, url, all, queues):
|
||||
"""Empty given queues."""
|
||||
conn = connect(url)
|
||||
|
||||
if all:
|
||||
queues = Queue.all(connection=conn)
|
||||
else:
|
||||
queues = [Queue(queue, connection=conn) for queue in queues]
|
||||
|
||||
if not queues:
|
||||
click.echo('Nothing to do')
|
||||
|
||||
for queue in queues:
|
||||
num_jobs = queue.empty()
|
||||
click.echo('{0} jobs removed from {1} queue'.format(num_jobs, queue.name))
|
||||
|
||||
|
||||
@main.command()
|
||||
@url_option
|
||||
@click.option('--all', '-a', is_flag=True, help='Requeue all failed jobs')
|
||||
@click.argument('job_ids', nargs=-1)
|
||||
@click.pass_context
|
||||
def requeue(ctx, url, all, job_ids):
|
||||
"""Requeue failed jobs."""
|
||||
conn = connect(url)
|
||||
failed_queue = get_failed_queue(connection=conn)
|
||||
|
||||
if all:
|
||||
job_ids = failed_queue.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_queue.requeue(job_id)
|
||||
except InvalidJobOperationError:
|
||||
fail_count += 1
|
||||
|
||||
if fail_count > 0:
|
||||
click.secho('Unable to requeue {0} jobs from failed queue'.format(fail_count), fg='red')
|
||||
|
||||
|
||||
@main.command()
|
||||
@url_option
|
||||
@click.option('--path', '-P', default='.', help='Specify the import path.')
|
||||
@click.option('--interval', '-i', default=None, help='Updates stats every N seconds (default: don\'t poll)') # noqa
|
||||
@click.option('--raw', '-r', is_flag=True, help='Print only the raw numbers, no bar charts') # noqa
|
||||
@click.option('--only-queues', '-Q', is_flag=True, help='Show only queue info') # noqa
|
||||
@click.option('--only-workers', '-W', is_flag=True, help='Show only worker info') # noqa
|
||||
@click.option('--by-queue', '-R', is_flag=True, help='Shows workers by queue') # noqa
|
||||
@click.argument('queues', nargs=-1)
|
||||
@click.pass_context
|
||||
def info(ctx, url, path, interval, raw, only_queues, only_workers, by_queue, queues):
|
||||
"""RQ command-line monitor."""
|
||||
|
||||
if path:
|
||||
sys.path = path.split(':') + sys.path
|
||||
|
||||
if only_queues:
|
||||
func = show_queues
|
||||
elif only_workers:
|
||||
func = show_workers
|
||||
else:
|
||||
func = show_both
|
||||
|
||||
try:
|
||||
with Connection(connect(url)):
|
||||
refresh(interval, func, queues, raw, by_queue)
|
||||
except ConnectionError as e:
|
||||
click.echo(e)
|
||||
sys.exit(1)
|
||||
except KeyboardInterrupt:
|
||||
click.echo()
|
||||
sys.exit(0)
|
||||
@ -1,80 +0,0 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
"""
|
||||
RQ command line tool
|
||||
"""
|
||||
from __future__ import (absolute_import, division, print_function,
|
||||
unicode_literals)
|
||||
|
||||
import sys
|
||||
|
||||
import click
|
||||
import redis
|
||||
from rq import get_failed_queue, Queue
|
||||
from rq.exceptions import InvalidJobOperationError
|
||||
|
||||
from .rqinfo import info
|
||||
|
||||
|
||||
@click.group()
|
||||
@click.option('--url', '-u', envvar='URL', help='URL describing Redis connection details.')
|
||||
@click.pass_context
|
||||
def main(ctx, url):
|
||||
"""RQ CLI"""
|
||||
if url is None:
|
||||
url = "redis://localhost:6379/0"
|
||||
redis_conn = redis.from_url(url)
|
||||
|
||||
ctx.obj = {}
|
||||
ctx.obj['connection'] = redis_conn
|
||||
|
||||
|
||||
@main.command()
|
||||
@click.option('--all', '-a', is_flag=True, help='Empty all queues')
|
||||
@click.argument('queues', nargs=-1)
|
||||
@click.pass_context
|
||||
def empty(ctx, all, queues):
|
||||
"""Empty given queues."""
|
||||
conn = ctx.obj['connection']
|
||||
if all:
|
||||
queues = Queue.all(connection=conn)
|
||||
else:
|
||||
queues = [Queue(queue, connection=conn) for queue in queues]
|
||||
|
||||
if not queues:
|
||||
click.echo('Nothing to do')
|
||||
|
||||
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.argument('job_ids', nargs=-1)
|
||||
@click.pass_context
|
||||
def requeue(ctx, all, job_ids):
|
||||
"""Requeue failed jobs."""
|
||||
conn = ctx.obj['connection']
|
||||
failed_queue = get_failed_queue(connection=conn)
|
||||
|
||||
if all:
|
||||
job_ids = failed_queue.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_queue.requeue(job_id)
|
||||
except InvalidJobOperationError:
|
||||
fail_count += 1
|
||||
|
||||
if fail_count > 0:
|
||||
click.secho('Unable to requeue {0} jobs from failed queue'.format(fail_count), fg='red')
|
||||
|
||||
|
||||
main.add_command(info)
|
||||
Loading…
Reference in New Issue