File: NewCommand.py

package info (click to toggle)
ilorest 7.0.0.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 3,884 kB
  • sloc: python: 36,313; sh: 2,853; javascript: 482; makefile: 189; ansic: 186; lisp: 137
file content (90 lines) | stat: -rw-r--r-- 2,846 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
# -*- coding: utf-8 -*-
""" New Command for RDMC """

import sys

try:
    from rdmc_helper import ReturnCodes, InvalidCommandLineErrorOPTS
except ImportError:
    from ilorest.rdmc_helper import ReturnCodes, InvalidCommandLineErrorOPTS

class NewCommand():
    """ Main new command template class """
    def __init__(self):
        self.ident = {
            'name':'newcommand',
            'usage' : None,
            'description': "Run to show the new command is "
                     "working\n\texample: newcommand",
            'summary':'New command tutorial.',
            'aliases': [],
            'auxcommands': []
        }

        #self.definearguments(self.parser)
        self.cmdbase = None
        self.rdmc = None
        self.auxcommands = dict()

    def newcommandfunction(self, options=None):
        """ Main new command worker function

        :param options: command options
        :type options: options.
        """

        # TODO: This is where you would add your main worker code
        #       Refer to other commands for an example of this function
        sys.stdout.write(u"Hello World. It's me %s.\n" % options.name)

    def run(self, line, help_disp=False):
        """ Wrapper function for new command main function

        :param line: command line input
        :type line: string.
        """
        try:
            (options, _) = self.rdmc.rdmc_parse_arglist(self, line)
        except (InvalidCommandLineErrorOPTS, SystemExit):
            if ("-h" in line) or ("--help" in line):
                return ReturnCodes.SUCCESS
            else:
                raise InvalidCommandLineErrorOPTS("")

        #validation checks
        self.newcommandvalidation()
        self.newcommandfunction(options)

        #logout routine
        self.cmdbase.logout_routine(self, options)
        #Return code
        return ReturnCodes.SUCCESS

    def newcommandvalidation(self):
        """ new command method validation function """
        try:
			# TODO: Any validation required need to be placed here.
			#       Refer to other commands for an example of this function
            pass
        except:
            raise

    def definearguments(self, customparser):
        """ Wrapper function for new command main function

        :param customparser: command line input
        :type customparser: parser.
        """
        if not customparser:
            return

        # TODO: This is where you add all your command line arguments.
        #       For more information on this section research optparse for python

        customparser.add_argument(
            '--name',
            dest='name',
            help="""Use the provided the output name.""",
            default="REDFISH",
        )