OpenQuizz
Une application de gestion des contenus pédagogiques
CommandCollection Class Reference
Inheritance diagram for CommandCollection:
Collaboration diagram for CommandCollection:

Public Member Functions

def __init__ (self, name=None, sources=None, **attrs)
 
def add_source (self, multi_cmd)
 
def get_command (self, ctx, cmd_name)
 
def list_commands (self, ctx)
 
- Public Member Functions inherited from MultiCommand
def __init__ (self, name=None, invoke_without_command=False, no_args_is_help=None, subcommand_metavar=None, chain=False, result_callback=None, **attrs)
 
def collect_usage_pieces (self, ctx)
 
def format_options (self, ctx, formatter)
 
def resultcallback (self, replace=False)
 
def format_commands (self, ctx, formatter)
 
def parse_args (self, ctx, args)
 
def invoke (self, ctx)
 
def resolve_command (self, ctx, args)
 
- Public Member Functions inherited from Command
def __init__ (self, name, context_settings=None, callback=None, params=None, help=None, epilog=None, short_help=None, options_metavar="[OPTIONS]", add_help_option=True, no_args_is_help=False, hidden=False, deprecated=False)
 
def get_usage (self, ctx)
 
def get_params (self, ctx)
 
def format_usage (self, ctx, formatter)
 
def get_help_option_names (self, ctx)
 
def get_help_option (self, ctx)
 
def make_parser (self, ctx)
 
def get_help (self, ctx)
 
def get_short_help_str (self, limit=45)
 
def format_help (self, ctx, formatter)
 
def format_help_text (self, ctx, formatter)
 
def format_epilog (self, ctx, formatter)
 
- Public Member Functions inherited from BaseCommand
def __init__ (self, name, context_settings=None)
 
def __repr__ (self)
 
def make_context (self, info_name, args, parent=None, **extra)
 
def main (self, args=None, prog_name=None, complete_var=None, standalone_mode=True, **extra)
 
def __call__ (self, *args, **kwargs)
 

Data Fields

 sources
 
- Data Fields inherited from MultiCommand
 no_args_is_help
 
 invoke_without_command
 
 subcommand_metavar
 
 chain
 
 result_callback
 
- Data Fields inherited from Command
 callback
 
 params
 
 help
 
 epilog
 
 options_metavar
 
 short_help
 
 add_help_option
 
 no_args_is_help
 
 hidden
 
 deprecated
 
- Data Fields inherited from BaseCommand
 name
 
 context_settings
 

Additional Inherited Members

- Static Public Attributes inherited from MultiCommand
bool allow_extra_args = True
 
bool allow_interspersed_args = False
 
- Static Public Attributes inherited from BaseCommand
bool allow_extra_args = False
 
bool allow_interspersed_args = True
 
bool ignore_unknown_options = False
 

Detailed Description

A command collection is a multi command that merges multiple multi
commands together into one.  This is a straightforward implementation
that accepts a list of different multi commands as sources and
provides all the commands for each of them.

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self,
  name = None,
  sources = None,
**  attrs 
)

Member Function Documentation

◆ add_source()

def add_source (   self,
  multi_cmd 
)
Adds a new multi command to the chain dispatcher.

◆ get_command()

def get_command (   self,
  ctx,
  cmd_name 
)
Given a context and a command name, this returns a
:class:`Command` object if it exists or returns `None`.

Reimplemented from MultiCommand.

◆ list_commands()

def list_commands (   self,
  ctx 
)
Returns a list of subcommand names in the order they should
appear.

Reimplemented from MultiCommand.

Field Documentation

◆ sources

sources

The documentation for this class was generated from the following file: