Skip to content

service

dev_tool.services.command.service

log = logging.getLogger(__name__) module-attribute

CommandRunner

Bases: BaseService

A service that abstracts command execution for local or containerized environments.

The constructor for the CommandRunner class.

Parameters:

Source code in dev_tool/services/command/service.py 
23
24
25
26
27
28
29
30
31
32
def __init__(self, execution_strategy: ExecutionStrategyProtocol) -> None:
    """
    The constructor for the CommandRunner class.

    :param execution_strategy: The execution strategy for running commands.
    """

    super().__init__()

    self._execution_strategy = execution_strategy

execution_strategy property

A property that returns the ExecutionStrategy.

Returns:

cleanup_build_context

A method that cleans up temporary build context directories.

Source code in dev_tool/services/command/service.py 
44
45
46
47
def cleanup_build_context(self) -> None:
    """A method that cleans up temporary build context directories."""

    self.execution_strategy.cleanup()

ensure_services

A method that ensures Docker services are running.

Source code in dev_tool/services/command/service.py 
49
50
51
52
def ensure_services(self) -> None:
    """A method that ensures Docker services are running."""

    self.execution_strategy.ensure_database(recreate=False)

is_containerized_available

A method that checks if Docker and docker-compose are available.

Returns:

  • bool –

    True if Docker is available, False otherwise.

Source code in dev_tool/services/command/service.py 
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
def is_containerized_available(self) -> bool:
    """
    A method that checks if Docker and docker-compose are available.

    :return: True if Docker is available, False otherwise.
    """

    try:
        command = ['docker', '--version']
        subprocess.run(command, capture_output=True, check=True)

        command = ['docker', 'compose', 'version']
        subprocess.run(command, capture_output=True, check=True)
    except Exception:
        return False
    else:
        return True

run_bun_command

A method that executes a Bun command.

Parameters:

  • args (list[str]) –

    The command arguments.

  • kwargs (Any, default: {} ) –

    Additional subprocess arguments.

Returns:

Source code in dev_tool/services/command/service.py 
72
73
74
75
76
77
78
79
80
81
def run_bun_command(self, args: list[str], **kwargs: Any) -> subprocess.CompletedProcess:
    """
    A method that executes a Bun command.

    :param args: The command arguments.
    :param kwargs: Additional subprocess arguments.
    :return: The completed process result.
    """

    return self.execution_strategy.run_bun_command(args, **kwargs)

run_django_command

A method that executes a Django management command.

Parameters:

  • args (list[str]) –

    The command arguments.

  • kwargs (Any, default: {} ) –

    Additional subprocess arguments.

Returns:

Source code in dev_tool/services/command/service.py 
83
84
85
86
87
88
89
90
91
92
def run_django_command(self, args: list[str], **kwargs: Any) -> subprocess.CompletedProcess:
    """
    A method that executes a Django management command.

    :param args: The command arguments.
    :param kwargs: Additional subprocess arguments.
    :return: The completed process result.
    """

    return self.execution_strategy.run_django_command(args, **kwargs)

run_pip_command

A method that executes a pip command.

Parameters:

  • args (list[str]) –

    The command arguments.

  • kwargs (Any, default: {} ) –

    Additional subprocess arguments.

Returns:

Source code in dev_tool/services/command/service.py 
 94
 95
 96
 97
 98
 99
100
101
102
103
def run_pip_command(self, args: list[str], **kwargs: Any) -> subprocess.CompletedProcess:
    """
    A method that executes a pip command.

    :param args: The command arguments.
    :param kwargs: Additional subprocess arguments.
    :return: The completed process result.
    """

    return self.execution_strategy.run_pip_command(args, **kwargs)

run_python_command

A method that executes a Python command.

Parameters:

  • args (list[str]) –

    The command arguments.

  • kwargs (Any, default: {} ) –

    Additional subprocess arguments.

Returns:

Source code in dev_tool/services/command/service.py 
105
106
107
108
109
110
111
112
113
114
def run_python_command(self, args: list[str], **kwargs: Any) -> subprocess.CompletedProcess:
    """
    A method that executes a Python command.

    :param args: The command arguments.
    :param kwargs: Additional subprocess arguments.
    :return: The completed process result.
    """

    return self.execution_strategy.run_python_command(args, **kwargs)

run_shell_script

A method that executes a Django shell script.

Parameters:

  • script (str) –

    The Python script to execute in Django shell.

  • kwargs (Any, default: {} ) –

    Additional subprocess arguments.

Returns:

Source code in dev_tool/services/command/service.py 
116
117
118
119
120
121
122
123
124
125
def run_shell_script(self, script: str, **kwargs: Any) -> subprocess.CompletedProcess:
    """
    A method that executes a Django shell script.

    :param script: The Python script to execute in Django shell.
    :param kwargs: Additional subprocess arguments.
    :return: The completed process result.
    """

    return self.execution_strategy.run_shell_script(script, **kwargs)