Public Member Functions
	__init__ (self, driver, args, log_file)

	add_option_with_valid_args (self, option, attrs)

	add_option_with_values (self, option, values)

	add_noarg_option_if_valid_arg (self, option, attr)

	run (self)

Data Fields
	cmd

	driver

	args

	log_file

Detailed Description

Definition at line 20 of file Command.py.

Constructor & Destructor Documentation

◆ init()

Command.Command.__init__	(	self,
		driver,
		args,
		log_file
	)

Definition at line 21 of file Command.py.

    def __init__(self, driver, args, log_file):
        self.cmd = [driver]
        self.driver = driver
        self.args = args
        self.log_file = log_file
 

Member Function Documentation

◆ add_noarg_option_if_valid_arg()

Command.Command.add_noarg_option_if_valid_arg	(	self,
		option,
		attr
	)

Definition at line 46 of file Command.py.

    def add_noarg_option_if_valid_arg(self, option, attr):
        if oneutils.is_valid_attr(self.args, attr):
            self.cmd.append(option)
        return self
 

References locop::NodeDesc.args(), locop::NodeDesc.args(), Command.Command.args, Content.args, Event.args, and Command.Command.cmd.

◆ add_option_with_valid_args()

Command.Command.add_option_with_valid_args	(	self,
		option,
		attrs
	)

Definition at line 29 of file Command.py.

    def add_option_with_valid_args(self, option, attrs):
        for attr in attrs:
            if not oneutils.is_valid_attr(self.args, attr):
                return self
        self.cmd.append(option)
        for attr in attrs:
            self.cmd.append(getattr(self.args, attr))
        return self
 

References locop::NodeDesc.args(), locop::NodeDesc.args(), Command.Command.args, Content.args, Event.args, and Command.Command.cmd.

◆ add_option_with_values()

Command.Command.add_option_with_values	(	self,
		option,
		values
	)

Definition at line 39 of file Command.py.

    def add_option_with_values(self, option, values):
        self.cmd.append(option)
        for value in values:
            self.cmd.append(value)
        return self
 

References Command.Command.cmd.

◆ run()

Command.Command.run ( self )

Definition at line 52 of file Command.py.

    def run(self):
        self.log_file.write((' '.join(self.cmd) + '\n').encode())
        oneutils.run(self.cmd, err_prefix=self.driver, logfile=self.log_file)

References Command.Command.cmd, argumentparse.ArgumentParser.driver, Command.Command.driver, and Command.Command.log_file.

Field Documentation

◆ args

Command.Command.args

Definition at line 24 of file Command.py.

Referenced by Command.Command.add_noarg_option_if_valid_arg(), and Command.Command.add_option_with_valid_args().

◆ cmd

Command.Command.cmd

Definition at line 22 of file Command.py.

Referenced by Command.Command.add_noarg_option_if_valid_arg(), Command.Command.add_option_with_valid_args(), Command.Command.add_option_with_values(), and Command.Command.run().

◆ driver

Command.Command.driver

Definition at line 23 of file Command.py.

Referenced by argumentparse.ArgumentParser.__init__(), argumentparse.ArgumentParser.print_help(), and Command.Command.run().

◆ log_file

Command.Command.log_file

Definition at line 25 of file Command.py.

Referenced by Command.Command.run().

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

compiler/one-cmds/onelib/Command.py

Public Member Functions

Data Fields