python.acmdlib.Command Class Reference

classes ----------------------------------------------------------------— More...

Inheritance diagram for python.acmdlib.Command:

Collaboration diagram for python.acmdlib.Command:

Public Member Functions
def	__init__ (self, fct, **kwargs)
def	name (self)
def	help (self)
def	description (self)
def	add_argument (self)
def	__call__ (self, *args, **kwargs)
def	add_mutually_exclusive_group (self, **kwargs)

Public Attributes
	fct
	parser

Private Member Functions
def	_make_parser (self, **kwargs)
def	_init_arguments (self)

Private Attributes
	_acmdlib_mutual_group

Detailed Description

classes ----------------------------------------------------------------—

A wrapper class to manage the creation of commands and their arguments

this is very heavily inspired from:
http://pypi.python.org/pypi/django-boss (MIT licence)

Definition at line 40 of file acmdlib.py.

Constructor & Destructor Documentation

__init__()

def python.acmdlib.Command.__init__	(		self,
			fct,
		**	kwargs
	)

Definition at line 47 of file acmdlib.py.

    def __init__(self, fct, **kwargs):
        object.__init__(self)
        self.fct = fct
        self.parser = self._make_parser(**kwargs)
        self._init_arguments()
        plugin_name = kwargs.get('name') or self.name
        register(plugin_name, self.fct.__module__)
 

Member Function Documentation

__call__()

def python.acmdlib.Command.__call__	(		self,
		*	args,
		**	kwargs
	)

Definition at line 74 of file acmdlib.py.

    def __call__(self, *args, **kwargs):
        return self.fct(*args, **kwargs)
    

_init_arguments()

def python.acmdlib.Command._init_arguments (   self )

private

Definition at line 120 of file acmdlib.py.

    def _init_arguments(self):
        if hasattr(self.fct, '_acmdlib_arguments'):
            while self.fct._acmdlib_arguments:
                args, kwargs = self.fct._acmdlib_arguments.pop()
                self.add_argument(*args, **kwargs)
        
        if hasattr(self.fct,'_acmdlib_arguments_mutual'):
            if not hasattr(self, '_acmdlib_mutual_group'):
                self._acmdlib_mutual_group = self.add_mutually_exclusive_group()
            while self.fct._acmdlib_arguments_mutual:
                args, kwargs = self.fct._acmdlib_arguments_mutual.pop()
                self._acmdlib_mutual_group.add_argument(*args, **kwargs)
        

_make_parser()

def python.acmdlib.Command._make_parser (   self, **  kwargs  )

private

Create and register a subparser for this command.

Definition at line 77 of file acmdlib.py.

    def _make_parser(self, **kwargs):
        """Create and register a subparser for this command."""
 
        kwargs.setdefault('help', self.help)
        kwargs.setdefault('formatter_class',argparse.RawDescriptionHelpFormatter)
        kwargs.setdefault('description', self.description)
        kwargs.setdefault('name', self.name)
        names = (kwargs.get('name') or self.name).split('.')
        
        def _get_subparser(a):
            if a._subparsers:
                for action in a._subparsers._actions:
                    if isinstance(action, argparse._SubParsersAction):
                        return action
                raise RuntimeError('could not find adequate subparser')
            return a.add_subparsers(dest='command',
                                    title='commands',
                                    metavar='COMMAND')
        def _get_parser(node, idx, names):
            name = names[idx]
            if name in node.choices:
                return node.choices[name]
            args = {
                'name' : name,
                'help' : 'a group of sub-commands',
                }
            return node.add_parser(**args)
        
        parser = ACMD_PARSER
        node   = _get_subparser(parser)
 
        for i,n in enumerate(names[:-1]):
            node = _get_subparser(parser)
            parser = _get_parser(node, i, names)
                
        node = _get_subparser(parser)
        kwargs['name'] = names[-1]
        parser = node.add_parser(**kwargs)
        return parser
 

add_argument()

def python.acmdlib.Command.add_argument

(

self

)

Definition at line 71 of file acmdlib.py.

    def add_argument(self):
        return self.parser.add_argument
 

add_mutually_exclusive_group()

def python.acmdlib.Command.add_mutually_exclusive_group	(		self,
		**	kwargs
	)

Definition at line 117 of file acmdlib.py.

    def add_mutually_exclusive_group(self, **kwargs):
        return self.parser.add_mutually_exclusive_group(**kwargs)
 

description()

def python.acmdlib.Command.description

(

self

)

Definition at line 66 of file acmdlib.py.

    def description(self):
        if getattr(self.fct, '__doc__', None):
            return textwrap.dedent(self.fct.__doc__)
 

help()

def python.acmdlib.Command.help

(

self

)

Definition at line 60 of file acmdlib.py.

    def help(self):
        if getattr(self.fct, '__doc__', None):
            # just the first line of the doc string
            return self.fct.__doc__.splitlines()[0]
 

name()

def python.acmdlib.Command.name

(

self

)

Definition at line 56 of file acmdlib.py.

    def name(self):
        return self.fct.__name__.replace('_','-')
 

Member Data Documentation

_acmdlib_mutual_group

python.acmdlib.Command._acmdlib_mutual_group

private

Definition at line 128 of file acmdlib.py.

fct

python.acmdlib.Command.fct

Definition at line 49 of file acmdlib.py.

parser

python.acmdlib.Command.parser

Definition at line 50 of file acmdlib.py.

---

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

• acmdlib.py