python.acmdlib Namespace Reference

Classes
class	Command
	classes ----------------------------------------------------------------— More...
class	Plugins

Functions
def	command (*args, **kwargs)
def	argument (*args, **kwargs)
def	register (name, value)

Variables
	__doc__
	__author__
	__all__
	ACMD_GROUPNAME
	globals ----------------------------------------------------------------— More...
	ACMD_PARSER
	prog
	description
	ACMD_SUBPARSERS
	dest
	title
	metavar

Function Documentation

argument()

def python.acmdlib.argument	(	*	args,
		**	kwargs
	)

Decorator to add an argument to a command.
Use the `mutual=True` keyword to specify that the argument should belong to a mutual exclusion group.

Definition at line 179 of file acmdlib.py.

def argument(*args, **kwargs):
    """Decorator to add an argument to a command.
    Use the `mutual=True` keyword to specify that the argument should belong to a mutual exclusion group.
    """
    is_mutual = kwargs.pop('mutual', False)
 
    def deco(fct):
        if isinstance(fct, Command):
            cmd = fct
            if is_mutual:
                if not hasattr(cmd, '_acmdlib_mutual_group'):
                    cmd._acmdlib_mutual_group = cmd.add_mutually_exclusive_group()
                cmd._acmdlib_mutual_group.add_argument(*args, **kwargs)
            else:
                cmd.add_argument(*args, **kwargs)
        else:
            store_as = '_acmdlib_arguments_mutual' if is_mutual else '_acmdlib_arguments'
            if not hasattr(fct, store_as):
                setattr(fct, store_as, [])
            getattr(fct, store_as).append((args, kwargs))
        #print "===",args,kwargs,type(fct),fct
        return fct
    return deco
    

command()

def python.acmdlib.command	(	*	args,
		**	kwargs
	)

Decorator to declare that a function is a command.

Definition at line 170 of file acmdlib.py.

def command(*args, **kwargs):
    """Decorator to declare that a function is a command.
    """
    def deco(fct):
        return Command(fct, **kwargs)
    if args:
        return deco(*args)
    return deco
 

register()

def python.acmdlib.register	(		name,
			value
	)

Registers a plugin, given a name and value.

ex: register('check-file', 'PyUtils.CheckFileLib:fct')

Definition at line 203 of file acmdlib.py.

def register(name, value):
    """Registers a plugin, given a name and value.
 
    ex: register('check-file', 'PyUtils.CheckFileLib:fct')
    """
 
    return Plugins.register(name, value)

Variable Documentation

__all__

python.acmdlib.__all__

private

Definition at line 11 of file acmdlib.py.

__author__

python.acmdlib.__author__

private

Definition at line 9 of file acmdlib.py.

__doc__

python.acmdlib.__doc__

private

Definition at line 8 of file acmdlib.py.

ACMD_GROUPNAME

python.acmdlib.ACMD_GROUPNAME

globals ----------------------------------------------------------------—

Definition at line 24 of file acmdlib.py.

ACMD_PARSER

python.acmdlib.ACMD_PARSER

Definition at line 28 of file acmdlib.py.

ACMD_SUBPARSERS

python.acmdlib.ACMD_SUBPARSERS

Definition at line 33 of file acmdlib.py.

description

python.acmdlib.description

Definition at line 30 of file acmdlib.py.

dest

python.acmdlib.dest

Definition at line 34 of file acmdlib.py.

metavar

python.acmdlib.metavar

Definition at line 36 of file acmdlib.py.

prog

python.acmdlib.prog

Definition at line 29 of file acmdlib.py.

title

python.acmdlib.title

Definition at line 35 of file acmdlib.py.