recline.commands.builtin_commands module

Original © NetApp 2024

The commands defined here are included with every recline application

exception recline.commands.builtin_commands.DebugInterrupt

Bases: Exception

An exception class to mark that we were interrupted by a debug request

recline.commands.builtin_commands.command_help() → None

Display a list of available commands and their short description

recline.commands.builtin_commands.debug() → None

Drop into the Python debugger for development purposes

recline.commands.builtin_commands.exit_command(abort_jobs: Flag = False) → None

Exit the application

recline.commands.builtin_commands.fg(job: ~recline.arg_types.choices.Choices.define.<locals>._Choices = None) → None

Bring a job to the foreground

If the job has already completed, then its results will be printed to the console. If the job has not yet finished, then the application will wait for it to finish before printing the results.

Args:

job: The identifier of the job to track. If not provided, then the most

recent job will be tracked.

recline.commands.builtin_commands.man(command_name: ~recline.arg_types.remainder.Remainder.define.<locals>._Remainder) → None

Display the full man page for a given command

Args:

command: The name of the command

recline.commands.builtin_commands.man_commands(*_, **__)

A completer function for returning a list of commands the user might want to see the man page for. Don’t show alias names to reduce clutter and confusion.