openerpcommand/common.py

   1 """
   2 Define a few common arguments for server-side command-line tools.
   3 """
   4 import argparse
   5 import os
   6 try:
   7     from setproctitle import setproctitle
   8 except ImportError:
   9     setproctitle = lambda x: None
  10 import sys
  11
  12 def add_addons_argument(parser):
  13     """
  14     Add a common --addons argument to a parser.
  15     """
  16     parser.add_argument('--addons', metavar='ADDONS',
  17         **required_or_default('ADDONS',
  18                               'colon-separated list of paths to addons'))
  19 def set_addons(args):
  20     """
  21     Turn args.addons into a list instead of a column-separated strings.
  22     Set openerp.toools.config accordingly.
  23     """
  24     import openerp.tools.config
  25     config = openerp.tools.config
  26
  27     assert hasattr(args, 'addons')
  28     if args.addons:
  29         args.addons = args.addons.split(':')
  30     else:
  31         args.addons = []
  32
  33     config['addons_path'] = ','.join(args.addons)
  34
  35 def get_addons_from_paths(paths, exclude):
  36     """
  37     Build a list of available modules from a list of addons paths.
  38     """
  39     exclude = exclude or []
  40     module_names = []
  41     for p in paths:
  42         if os.path.exists(p):
  43             names = [n for n in os.listdir(p) if os.path.isfile(os.path.join(p, n, '__openerp__.py')) and not n.startswith('.') and n not in exclude]
  44             module_names.extend(names)
  45         else:
  46             print "The addons path `%s` doesn't exist." % p
  47             sys.exit(1)
  48     return module_names
  49
  50 def required_or_default(name, h):
  51     """
  52     Helper to define `argparse` arguments. If the name is the environment,
  53     the argument is optional and draw its value from the environment if not
  54     supplied on the command-line. If it is not in the environment, make it
  55     a mandatory argument.
  56     """
  57     if os.environ.get('OPENERP_' + name.upper()):
  58         d = {'default': os.environ['OPENERP_' + name.upper()]}
  59     else:
  60         d = {'required': True}
  61     d['help'] = h + '. The environment variable OPENERP_' + \
  62         name.upper() + ' can be used instead.'
  63     return d
  64
  65 class Command(object):
  66     """
  67     Base class to create command-line tools. It must be inherited and the
  68     run() method overriden.
  69     """
  70
  71     command_name = 'stand-alone'
  72
  73     def __init__(self, subparsers=None):
  74         if subparsers:
  75             self.parser = parser = subparsers.add_parser(self.command_name,
  76                 description=self.__class__.__doc__)
  77         else:
  78             self.parser = parser = argparse.ArgumentParser(
  79                 description=self.__class__.__doc__)
  80
  81         parser.add_argument('-d', '--database', metavar='DATABASE',
  82             **required_or_default('DATABASE', 'the database to connect to'))
  83         parser.add_argument('-u', '--user', metavar='USER',
  84             **required_or_default('USER', 'the user login or ID. When using '
  85             'RPC, providing an ID avoid the login() step'))
  86         parser.add_argument('-p', '--password', metavar='PASSWORD',
  87             **required_or_default('PASSWORD', 'the user password')) # TODO read it from the command line or from file.
  88
  89         parser.set_defaults(run=self.run_with_args)
  90
  91     def run_with_args(self, args):
  92         self.args = args
  93         self.run()
  94
  95     def run(self):
  96         print 'Stub Command.run().'
  97
  98     @classmethod
  99     def stand_alone(cls):
 100         """
 101         A single Command object is a complete command-line program. See
 102         `openerp-command/stand-alone` for an example.
 103         """
 104         command = cls()
 105         args = command.parser.parse_args()
 106         args.run(args)