woob.tools.application.repl

exception NotEnoughArguments

Bases: Exception

exception TooManyArguments

Bases: Exception

exception ArgSyntaxError

Bases: Exception

class ReplApplication

Bases: ConsoleApplication, Cmd

Base application class for Repl applications.

SYNOPSIS = 'Usage: %prog [-dqv] [-b backends] [-cnfs] [command [arguments..]]\n       %prog [--help] [--version]'

DISABLE_REPL = False

EXTRA_FORMATTERS = {}

DEFAULT_FORMATTER = 'multiline'

COMMANDS_FORMATTERS = {}

COLLECTION_OBJECTS = ()

Objects to allow in do_ls / do_cd

woob_commands = {'backends', 'cd', 'condition', 'count', 'formatter', 'logging', 'ls', 'quit', 'select', 'storage'}

hidden_commands = {'EOF'}

property interactive

change_path(split_path)

add_object(obj)

parse_id(id, unique_backend=False)

get_object(_id, method, fields=None, caps=None)

get_object_list(method=None, *args, **kwargs)

unload_backends(*args, **kwargs)

load_backends(*args, **kwargs)

main(argv)

Main method

Called by run

do(function, *args, **kwargs)

Call Woob.do(), passing count and selected fields given by user.

parse_command_args(line, nb, req_n=None)

postcmd(stop, line)

This REPL method is overridden to return None instead of integers to prevent stopping cmdloop().

parseline(line)

This REPL method is overridden to search “short” alias of commands

onecmd(line)

This REPL method is overridden to catch some particular exceptions.

emptyline()

By default, an emptyline repeats the previous command. Overriding this function disables this behaviour.

default(line)

Called on an input line when the command prefix is not recognized.

If this method is not overridden, it prints an error message and returns.

completenames(text, *ignored)

path_completer(arg)

complete(text, state)

Override of the Cmd.complete() method to:

• add a space at end of proposals

• display only proposals for words which match the text already written by user.

bcall_error_handler(backend, error, backtrace)

Handler for an exception inside the CallErrors exception.

This method can be overridden to support more exceptions types.

bcall_errors_handler(errors, ignore=())

Handler for the CallErrors exception.

get_command_help(command, short=False)

get_commands_doc()

do_quit(arg)

Quit the application.

do_EOF(arg)

Quit the command line interpreter when ^D is pressed.

do_help(arg=None)

help [COMMAND]

List commands, or get information about a command.

complete_backends(text, line, begidx, endidx)

do_storage(line)

storage [ACTION] [BACKEND_NAME]

Manipulation of a backend storage. :rtype: int

• cat display content of the storage

• edit edit the storage

• flush flush storage

do_backends(line)

backends [ACTION] [BACKEND_NAME]…

Select used backends.

ACTION is one of the following (default: list):

• enable enable given backends

• disable disable given backends

• only enable given backends and disable the others

• list list backends

• add add a backend

• register register a new account on a website

• edit edit a backend

• remove remove a backend

• list-modules list modules

complete_logging(text, line, begidx, endidx)

do_logging(line)

logging [LEVEL]

Set logging level.

Availables: debug, info, warning, error. * quiet is an alias for error * default is an alias for warning

do_condition(line)

condition [EXPRESSION | off]

If an argument is given, set the condition expression used to filter the results. See CONDITION section for more details and the expression. If the “off” value is given, conditional filtering is disabled.

If no argument is given, print the current condition expression.

do_count(line)

count [NUMBER | off]

If an argument is given, set the maximum number of results fetched. NUMBER must be at least 1. “off” value disables counting, and allows infinite searches.

If no argument is given, print the current count value.

complete_formatter(text, line, *ignored)

do_formatter(line)

formatter [list | FORMATTER [COMMAND] | option OPTION_NAME [on | off]]

If a FORMATTER is given, set the formatter to use. You can add a COMMAND to apply the formatter change only to a given command.

If the argument is “list”, print the available formatters.

If the argument is “option”, set the formatter options. Valid options are: header, keys. If on/off value is given, set the value of the option. If not, print the current value for the option.

If no argument is given, print the current formatter.

do_select(line)

select [FIELD_NAME]… | “$direct” | “$full”

If an argument is given, set the selected fields. $direct selects all fields loaded in one http request. $full selects all fields using as much http requests as necessary.

If no argument is given, print the currently selected fields.

comp_key(obj)

do_ls(*args, **kwargs)

ls [-d] [-U] [PATH]

List objects in current path. If an argument is given, list the specified path. Use -U option to not sort results. It allows you to use a “fast path” to return results as soon as possible. Use -d option to display information about a collection (and to not display the content of it). It has the same behavior than the well known UNIX “ls” command.

Default is limited to 40 results.

do_cd(line)

cd [PATH]

Follow a path. “..” is a special case and goes up one directory. “” is a special case and goes home.

all_collections()

Get all objects that are collections: regular objects and fake dumb objects.

obj_to_filename(obj, dest=None, default=None)

This method can be used to get a filename from an object, using a mask filled by information of this object.

All patterns are braces-enclosed, and are name of available fields in the object.

Parameters:

• obj (BaseObject) – object

• dest (str) – dest given by user (default None) (default: None)

• default (str) – default file mask (if not given, this is ‘{id}-{title}.{ext}’) (default: None)

Return type:

str

complete_path(text, line, begidx, endidx)

complete_ls(text, line, begidx, endidx)

complete_cd(text, line, begidx, endidx)

set_formatter(name)

Set the current formatter from name.

It returns the name of the formatter which has been really set.

set_formatter_header(string)

start_format(**kwargs)

cached_format(obj)

parse_fields(fields)

format(result, alias=None)

flush()

do_debug(line)

debug

Launch a debug Python shell