python.acmdlib Namespace Reference

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

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

Variables
str	__doc__ = "a library to ease the writing of sub-command scripts"
str	__author__ = "Sebastien Binet"
list	__all__
str	ACMD_GROUPNAME = 'acmdlib.commands'
	globals ----------------------------------------------------------------—
	ACMD_PARSER
	ACMD_SUBPARSERS

Function Documentation

argument()

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()

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()

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__

list python.acmdlib.__all__

private

Initial value:

=  [
    'Command',
    'command',
    'argument',
    'register',
    ]

Definition at line 11 of file acmdlib.py.

__author__

str python.acmdlib.__author__ = "Sebastien Binet"

private

Definition at line 9 of file acmdlib.py.

__doc__

str python.acmdlib.__doc__ = "a library to ease the writing of sub-command scripts"

private

Definition at line 8 of file acmdlib.py.

ACMD_GROUPNAME

str python.acmdlib.ACMD_GROUPNAME = 'acmdlib.commands'

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

Definition at line 24 of file acmdlib.py.

ACMD_PARSER

python.acmdlib.ACMD_PARSER

Initial value:

=  argparse.ArgumentParser(
    prog="acmd",
    description="a general script interface with sub-commands",
    )

Definition at line 28 of file acmdlib.py.

ACMD_SUBPARSERS

python.acmdlib.ACMD_SUBPARSERS

Initial value:

=  ACMD_PARSER.add_subparsers(
    dest='command',
    title='commands',
    metavar='COMMAND',
    )

Definition at line 33 of file acmdlib.py.