shell

Start shell session with convenient access to celery symbols.

The following symbols will be added to the main globals:

• celery: the current application.
• chord, group, chain, chunks, xmap, xstarmap subtask, Task
• all registered tasks.

def shell(
    ctx: click.Context,
    ipython: boolean = False,
    bpython: boolean = False,
    python: boolean = False,
    without_tasks: boolean = False,
    eventlet: boolean = False,
    gevent: boolean = False,
    **kwargs: dict
) - > null

Start shell session with convenient access to celery symbols. The following symbols will be added to the main globals: celery, chord, group, chain, chunks, xmap, xstarmap, subtask, Task, and all registered tasks.

Parameters

Name	Type	Description
ctx	click.Context	The Click context object containing the application instance and configuration.
ipython	boolean = False	Flag to force the use of the IPython shell environment.
bpython	boolean = False	Flag to force the use of the bpython shell environment.
python	boolean = False	Flag to force the use of the standard default Python interactive shell.
without_tasks	boolean = False	If true, prevents registered Celery tasks from being automatically added to the shell's local namespace.
eventlet	boolean = False	Flag to enable the eventlet monkey patching for concurrent execution within the shell.
gevent	boolean = False	Flag to enable the gevent monkey patching for concurrent execution within the shell.
**kwargs	dict	Additional keyword arguments passed from the command line interface.

Returns

Type	Description
null	This function does not return a value; it starts an interactive shell session and exits when the session ends.