dirutility.system.SystemCommand.execute() - Code Metrics - sfneal/dirutility - Measure and Improve Code Quality continuously with Scrutinizer

dirutility.system.SystemCommand.execute() A
last analyzed 2022-05-24 16:44 UTC

↳ Parent: dirutility.system

Complexity

Conditions

Size

Total Lines	12
Code Lines	8

Duplication

Lines	11
Ratio	91.67 %

Importance

Changes

Metric	Value
cc	3
eloc	8
nop	1
dl	11
loc	12
rs	10
c	0
b	0
f	0

import os
from subprocess import Popen, PIPE


class SystemCommand:


    def __init__(self, command, decode_output=True, immediate_execution=True):
        """
        Execute a system command.

        When decode_output is True, console output is captured, decoded
        and returned in list a list of strings.

        :param command: Command to execute
        :param decode_output: Optionally capture and decode console output
        :param immediate_execution: Execute system command during initialization
        :return: List of output strings
        """
        # Parameter attributes
        self.command = command
        self._decode_output = decode_output

        # Private attributes
        self._output, self._success = None, False

        # Execute command
        if immediate_execution:
            self.execute()

    def __str__(self):
        return self.command

    def __iter__(self):
        return iter(self._output)

    def __getitem__(self, item):
        return self._output[item]

    def __len__(self):
        return len(self._output)

    @property
    def output(self):
        """Return the standard output produced by execution of the system command."""
        return self._output

    @property
    def success(self):
        """Return a boolean stating weather the command has been successfully executed."""
        return self._success

    def execute(self):
        """Execute a system command."""
        if self._decode_output:
            # Capture and decode system output
            with Popen(self.command, shell=True, stdout=PIPE) as process:
                self._output = [i.decode("utf-8").strip() for i in process.stdout]
                self._success = True
        else:
            # Execute without capturing output
            os.system(self.command)
            self._success = True
        return self


1		import os
2		from subprocess import Popen, PIPE
3
4
5	View Code Duplication	class SystemCommand:
		0 ignored issues – show Duplication introduced 2021-01-20 18:15 UTC by Report Bug Copy Issue Report This code seems to be duplicated in your project. Loading history...
6
7		def __init__(self, command, decode_output=True, immediate_execution=True):
8		"""
9		Execute a system command.
10
11		When decode_output is True, console output is captured, decoded
12		and returned in list a list of strings.
13
14		:param command: Command to execute
15		:param decode_output: Optionally capture and decode console output
16		:param immediate_execution: Execute system command during initialization
17		:return: List of output strings
18		"""
19		# Parameter attributes
20		self.command = command
21		self._decode_output = decode_output
22
23		# Private attributes
24		self._output, self._success = None, False
25
26		# Execute command
27		if immediate_execution:
28		self.execute()
29
30		def __str__(self):
31		return self.command
32
33		def __iter__(self):
34		return iter(self._output)
35
36		def __getitem__(self, item):
37		return self._output[item]
38
39		def __len__(self):
40		return len(self._output)
41
42		@property
43		def output(self):
44		"""Return the standard output produced by execution of the system command."""
45		return self._output
46
47		@property
48		def success(self):
49		"""Return a boolean stating weather the command has been successfully executed."""
50		return self._success
51
52		def execute(self):
53		"""Execute a system command."""
54		if self._decode_output:
55		# Capture and decode system output
56		with Popen(self.command, shell=True, stdout=PIPE) as process:
57		self._output = [i.decode("utf-8").strip() for i in process.stdout]
58		self._success = True
59		else:
60		# Execute without capturing output
61		os.system(self.command)
62		self._success = True
63		return self
64

sfneal / dirutility

dirutility.system.SystemCommand.execute() A last analyzed 2022-05-24 16:44 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

dirutility.system.SystemCommand.execute() A
last analyzed 2022-05-24 16:44 UTC