Module Expr Str ImportFrom alias ImportFrom alias Import alias ImportFrom alias alias alias alias ImportFrom alias alias ImportFrom alias alias alias alias alias alias alias Assign NameStore Call NameLoad Str NameLoad keyword Str keyword Str FunctionDef arguments args defaults body Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr Str If NameLoad body Assign AttributeStore NameLoad attr Call NameLoad NameLoad orelse Assign AttributeStore NameLoad attr Call NameLoad keyword Call AttributeLoad AttributeLoad NameLoad attr attr Str keyword Call AttributeLoad AttributeLoad NameLoad attr attr Str keyword Call AttributeLoad AttributeLoad NameLoad attr attr Str keyword Call AttributeLoad AttributeLoad NameLoad attr attr Str decorator_list AttributeLoad NameLoad attr FunctionDef arguments args defaults body Expr Call NameLoad AttributeLoad NameLoad attr decorator_list AttributeLoad NameLoad attr FunctionDef arguments args NameParam defaults NameLoad body Expr Call NameLoad decorator_list AttributeLoad NameLoad attr FunctionDef arguments args NameParam defaults body FunctionDef arguments args defaults vararg kwarg body ImportFrom alias identifier TryExcept body Assign NameStore Call NameLoad NameLoad NameLoad handlers ExceptHandler type NameLoad name NameStore body Assign NameStore Call NameLoad keyword Str If SubscriptLoad AttributeLoad NameLoad attr Index Str body Assign SubscriptStore NameLoad Index Str Call NameLoad NameLoad ImportFrom alias Assign SubscriptStore NameLoad Index Str Call NameLoad Return Call NameLoad NameLoad decorator_list Call NameLoad NameLoad Return NameLoad decorator_list FunctionDef arguments args NameParam defaults body Return ListComp Call NameLoad keyword AttributeLoad NameLoad attr keyword AttributeLoad NameLoad attr keyword Call NameLoad Str keyword AttributeLoad NameLoad attr comprehension NameStore NameLoad decorator_list FunctionDef arguments args NameParam defaults body If CompareIs NameLoad NameLoad body Return NameLoad Return Call AttributeLoad AttributeLoad Call AttributeLoad Call AttributeLoad NameLoad attr NameLoad attr Str attr attr decorator_list FunctionDef arguments args NameParam defaults body Return Call NameLoad keyword AttributeLoad NameLoad attr keyword Call NameLoad AttributeLoad NameLoad attr keyword Call NameLoad AttributeLoad NameLoad attr keyword Call NameLoad AttributeLoad NameLoad attr keyword AttributeLoad NameLoad attr keyword AttributeLoad NameLoad attr keyword Call NameLoad AttributeLoad NameLoad attr keyword AttributeLoad NameLoad attr decorator_list FunctionDef arguments args NameParam defaults body Return DictComp NameLoad NameLoad comprehension TupleStore NameStore NameStore Call AttributeLoad NameLoad attr CompareIsNot NameLoad NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam defaults Num Num body Assign NameStore Call NameLoad Num BinOpAdd Call NameLoad Call NameLoad BinOpDiv NameLoad Call NameLoad NameLoad Num Assign NameStore NameLoad If CompareGtE NameLoad Num body Assign NameStore Call NameLoad BinOpSub Call NameLoad NameLoad NameLoad BinOpSub BinOpSub NameLoad Num Call NameLoad Call NameLoad BinOpDiv NameLoad Num Assign NameStore Call NameLoad Num NameLoad Assign NameStore BinOpAdd NameLoad NameLoad Assign NameStore SubscriptLoad NameLoad Slice NameLoad NameLoad Return NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body If CompareIs NameLoad NameLoad body Assign NameStore Call NameLoad Str If UnaryOpNot Call AttributeLoad NameLoad attr body Assign NameStore NameLoad orelse Assign NameStore Call NameLoad orelse Assign NameStore Call NameLoad NameLoad Return Call NameLoad Str keyword Call AttributeLoad NameLoad attr keyword NameLoad keyword NameLoad keyword Call AttributeLoad NameLoad attr keyword Call NameLoad Str decorator_list Call AttributeLoad NameLoad attr Str keyword Dict Str Str NameLoad Str Call AttributeLoad NameLoad attr Str keyword Dict Str Str Call AttributeLoad NameLoad attr Str FunctionDef arguments args NameParam defaults body Expr Call NameLoad NameLoad Return Call NameLoad keyword Str decorator_list Call AttributeLoad NameLoad attr Str keyword ListLoad Str NameLoad FunctionDef arguments args NameParam defaults body Expr Call NameLoad NameLoad Return Call NameLoad keyword Str decorator_list Call AttributeLoad NameLoad attr Str keyword ListLoad Str NameLoad FunctionDef arguments args defaults body Assign NameStore Call NameLoad Assign NameStore AttributeLoad NameLoad attr Assign NameStore Call NameLoad NameLoad For NameStore NameLoad body Expr Call NameLoad NameLoad Return Call NameLoad keyword Str keyword NameLoad decorator_list Call AttributeLoad NameLoad attr Str keyword ListLoad Str Str NameLoad FunctionDef arguments args NameParam defaults body Assign NameStore Call NameLoad NameLoad Expr Call AttributeLoad NameLoad attr Return Call NameLoad keyword Str decorator_list Call AttributeLoad NameLoad attr Str keyword ListLoad Str NameLoad FunctionDef arguments args NameParam defaults body Assign NameStore Call NameLoad NameLoad Expr Call AttributeLoad NameLoad attr Return Call NameLoad keyword Str decorator_list Call AttributeLoad NameLoad attr Str keyword ListLoad Str NameLoad FunctionDef arguments args defaults body Assign NameStore Call NameLoad Call NameLoad Call AttributeLoad NameLoad attr Return Call NameLoad keyword NameLoad decorator_list Call AttributeLoad NameLoad attr Str NameLoad FunctionDef arguments args NameParam NameParam defaults body Assign NameStore Call NameLoad NameLoad Assign NameStore Call NameLoad NameLoad Assign NameStore Num Assign NameStore AttributeLoad NameLoad attr Assign NameStore Call NameLoad NameLoad NameLoad NameLoad Assign NameStore ListComp Call NameLoad keyword NameLoad keyword Call NameLoad Str keyword NameLoad keyword NameLoad comprehension NameStore NameLoad Assign NameStore Call NameLoad Call NameLoad BinOpDiv NameLoad Call NameLoad NameLoad Assign NameStore NameLoad If CompareGt NameLoad Num body Assign NameStore Call NameLoad keyword Call NameLoad Str keyword NameLoad keyword BinOpSub NameLoad Num Assign NameStore NameLoad If CompareLt NameLoad NameLoad body Assign NameStore Call NameLoad keyword Call NameLoad Str keyword NameLoad keyword BinOpAdd NameLoad Num Assign NameStore Call NameLoad Call NameLoad keyword NameLoad keyword NameLoad keyword NameLoad Assign NameStore BinOpMult BinOpSub NameLoad Num NameLoad Assign NameStore ListComp Call NameLoad NameLoad comprehension NameStore Call AttributeLoad NameLoad attr NameLoad NameLoad Return Call NameLoad keyword AttributeLoad NameLoad attr keyword NameLoad keyword NameLoad decorator_list Call AttributeLoad NameLoad attr Str NameLoad FunctionDef arguments args defaults body FunctionDef arguments args NameParam defaults body Return ListComp AttributeLoad NameLoad attr comprehension NameStore AttributeLoad NameLoad attr decorator_list Assign NameStore ListComp Call NameLoad keyword AttributeLoad NameLoad attr keyword Call NameLoad NameLoad keyword Call NameLoad Call AttributeLoad NameLoad attr comprehension NameStore Call AttributeLoad NameLoad attr Return Call NameLoad keyword NameLoad decorator_list Call AttributeLoad NameLoad attr Str NameLoad FunctionDef arguments args defaults body Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr Str Return Call NameLoad keyword NameLoad decorator_list AttributeLoad NameLoad attr
N/A N/A RQ Dashboard Flask Blueprint.

Uses the standard Flask configuration mechanism e.g. to set the connection
parameters to REDIS. To keep the documentation and defaults all in once place
the default settings must be loaded from ``rq_dashboard.default_settings``
e.g.  as done in ``cli.py``.

RQ Dashboard does not contain any built-in authentication mechanism because

    1. it is the responsbility of the wider hosting app rather than a
       particular blueprint, and

    2. there are numerous ways of adding security orthogonally.

As a quick-and-dirty convenience, the command line invocation in ``cli.py``
provides the option to require HTTP Basic Auth in a few lines of code.

 functools wraps math ceil N/A arrow flask Blueprint current_app render_template url_for redis Redis from_url rq Queue Worker cancel_job get_failed_queue pop_connection push_connection requeue_job N/A blueprint N/A Blueprint rq_dashboard __name__ template_folder templates static_folder static setup_rq_connection N/A N/A N/A N/A N/A redis_url N/A N/A N/A current_app config get REDIS_URL N/A redis_url N/A N/A N/A current_app redis_conn N/A from_url redis_url N/A N/A N/A current_app redis_conn N/A Redis host N/A N/A N/A current_app config get REDIS_HOST port N/A N/A N/A current_app config get REDIS_PORT password N/A N/A N/A current_app config get REDIS_PASSWORD db N/A N/A N/A current_app config get REDIS_DB N/A N/A blueprint before_app_first_request push_rq_connection N/A N/A N/A N/A N/A N/A push_connection N/A current_app redis_conn N/A N/A blueprint before_request pop_rq_connection N/A N/A exception N/A None N/A N/A N/A pop_connection N/A N/A blueprint teardown_request jsonify N/A N/A f N/A N/A _wrapped N/A N/A N/A args kwargs N/A flask jsonify flask_jsonify N/A N/A N/A result_dict N/A f args kwargs N/A N/A N/A Exception N/A e N/A N/A result_dict N/A dict status error N/A N/A N/A current_app config N/A DEBUG N/A N/A N/A result_dict N/A reason N/A str e traceback format_exc N/A N/A result_dict N/A exc_info N/A format_exc N/A N/A flask_jsonify result_dict N/A N/A wraps f N/A _wrapped N/A serialize_queues N/A N/A queues N/A N/A N/A N/A N/A dict name N/A q name count N/A q count url N/A url_for .overview queue_name N/A q name N/A q queues N/A serialize_date N/A N/A dt N/A N/A N/A N/A dt None N/A N/A None N/A N/A N/A N/A N/A N/A N/A N/A arrow get dt to UTC datetime isoformat N/A serialize_job N/A N/A job N/A N/A N/A N/A dict id N/A job id created_at N/A serialize_date N/A job created_at enqueued_at N/A serialize_date N/A job enqueued_at ended_at N/A serialize_date N/A job ended_at origin N/A job origin result N/A job _result exc_info N/A str N/A job exc_info description N/A job description N/A remove_none_values N/A N/A input_dict N/A N/A N/A N/A k v N/A N/A k v N/A N/A input_dict items N/A v None N/A pagination_window N/A N/A total_items cur_page per_page window_size N/A 5 10 N/A N/A all_pages N/A range 1 N/A N/A int N/A ceil N/A total_items N/A float per_page 1 N/A result all_pages N/A N/A window_size 1 N/A N/A temp N/A min N/A N/A len all_pages window_size N/A N/A cur_page 1 N/A int N/A ceil N/A window_size 2.0 N/A pages_window_start N/A max 0 temp N/A pages_window_end N/A pages_window_start window_size N/A result N/A all_pages N/A pages_window_start pages_window_end N/A result N/A overview N/A N/A queue_name page N/A N/A N/A N/A queue_name None N/A N/A failed N/A Queue failed N/A N/A N/A N/A failed is_empty N/A N/A queue failed N/A N/A queue N/A Queue N/A N/A queue N/A Queue queue_name N/A N/A render_template rq_dashboard/dashboard.html workers N/A N/A Worker all queue queue page page queues N/A N/A Queue all rq_url_prefix N/A url_for .overview N/A N/A N/A blueprint route / defaults N/A queue_name page None 1 N/A N/A blueprint route /<queue_name> defaults N/A page 1 N/A N/A blueprint route /<queue_name>/<page> cancel_job_view N/A N/A job_id N/A N/A N/A N/A cancel_job job_id N/A N/A dict status OK N/A N/A N/A blueprint route /job/<job_id>/cancel methods N/A POST jsonify requeue_job_view N/A N/A job_id N/A N/A N/A N/A requeue_job job_id N/A N/A dict status OK N/A N/A N/A blueprint route /job/<job_id>/requeue methods N/A POST jsonify requeue_all N/A N/A N/A N/A N/A fq N/A get_failed_queue N/A job_ids N/A fq job_ids N/A count N/A len job_ids N/A job_id job_ids N/A N/A N/A requeue_job job_id N/A N/A dict status OK count count N/A N/A N/A blueprint route /requeue-all methods N/A GET POST jsonify empty_queue N/A N/A queue_name N/A N/A N/A q N/A Queue queue_name N/A N/A N/A q empty N/A N/A dict status OK N/A N/A N/A blueprint route /queue/<queue_name>/empty methods N/A POST jsonify compact_queue N/A N/A queue_name N/A N/A N/A q N/A Queue queue_name N/A N/A N/A q compact N/A N/A dict status OK N/A N/A N/A blueprint route /queue/<queue_name>/compact methods N/A POST jsonify list_queues N/A N/A N/A N/A N/A queues N/A serialize_queues N/A sorted N/A N/A Queue all N/A N/A dict queues queues N/A N/A N/A blueprint route /queues.json jsonify list_jobs N/A N/A queue_name page N/A N/A N/A current_page N/A int page N/A queue N/A Queue queue_name N/A per_page 5 N/A total_items N/A queue count N/A pages_numbers_in_window N/A pagination_window total_items current_page per_page N/A pages_in_window N/A N/A dict number p url N/A url_for .overview queue_name queue_name page p N/A p pages_numbers_in_window N/A last_page N/A int N/A ceil N/A total_items N/A float per_page N/A prev_page None N/A N/A current_page 1 N/A N/A prev_page N/A dict url N/A url_for .overview queue_name queue_name page N/A current_page 1 N/A next_page None N/A N/A current_page last_page N/A N/A next_page N/A dict url N/A url_for .overview queue_name queue_name page N/A current_page 1 N/A pagination N/A remove_none_values N/A dict pages_in_window pages_in_window next_page next_page prev_page prev_page N/A offset N/A N/A current_page 1 per_page N/A jobs N/A N/A serialize_job job N/A job N/A N/A queue get_jobs offset per_page N/A N/A dict name N/A queue name jobs jobs pagination pagination N/A N/A N/A blueprint route /jobs/<queue_name>/<page>.json jsonify list_workers N/A N/A N/A N/A serialize_queue_names N/A N/A worker N/A N/A N/A N/A N/A q name N/A q N/A worker queues N/A N/A workers N/A N/A dict name N/A worker name queues N/A serialize_queue_names worker state N/A str N/A N/A worker get_state N/A worker N/A N/A Worker all N/A N/A dict workers workers N/A N/A N/A blueprint route /workers.json jsonify inject_interval N/A N/A N/A N/A N/A interval N/A N/A N/A current_app config get RQ_POLL_INTERVAL N/A N/A dict poll_interval interval N/A N/A blueprint context_processor