Skip to content

services

dev_tool.services

__all__ = ['CommandRunnerProtocol', 'DockerServiceProtocol', 'ExecutionStrategyProtocol'] module-attribute

CommandRunnerProtocol

Bases: Protocol

A protocol defining the interface for command execution.

cleanup_build_context

A method that cleans up temporary build context directories.

Source code in dev_tool/services/protocols.py 
53
54
55
def cleanup_build_context(self) -> None:
    """A method that cleans up temporary build context directories."""
    ...

ensure_services

A method that ensures Docker services are running.

Source code in dev_tool/services/protocols.py 
57
58
59
def ensure_services(self) -> None:
    """A method that ensures Docker services are running."""
    ...

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/protocols.py 
61
62
63
64
65
66
67
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.
    """
    ...

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/protocols.py 
69
70
71
72
73
74
75
76
77
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.
    """
    ...

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/protocols.py 
79
80
81
82
83
84
85
86
87
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.
    """
    ...

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/protocols.py 
89
90
91
92
93
94
95
96
97
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.
    """
    ...

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/protocols.py 
 99
100
101
102
103
104
105
106
107
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.
    """
    ...

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/protocols.py 
109
110
111
112
113
114
115
116
117
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.
    """
    ...

DockerServiceProtocol

Bases: Protocol

A protocol defining the interface for Docker service operations.

ensure_local_container

A method that ensures a local database container exists and is running.

Parameters:

  • recreate (bool, default: False ) –

    Whether to recreate the container if it exists.

Source code in dev_tool/services/protocols.py 
124
125
126
127
128
129
130
def ensure_local_container(self, recreate: bool = False) -> None:
    """
    A method that ensures a local database container exists and is running.

    :param recreate: Whether to recreate the container if it exists.
    """
    ...

ExecutionStrategyProtocol

Bases: Protocol

A protocol defining the interface for execution strategies.

cleanup

A method that performs any necessary cleanup.

Source code in dev_tool/services/protocols.py 
137
138
139
def cleanup(self) -> None:
    """A method that performs any necessary cleanup."""
    ...

ensure_database

A method that ensures the database is available.

Parameters:

  • recreate (bool, default: False ) –

    Whether to recreate the database container.

Source code in dev_tool/services/protocols.py 
141
142
143
144
145
146
147
def ensure_database(self, recreate: bool = False) -> None:
    """
    A method that ensures the database is available.

    :param recreate: Whether to recreate the database container.
    """
    ...

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/protocols.py 
149
150
151
152
153
154
155
156
157
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.
    """
    ...

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/protocols.py 
159
160
161
162
163
164
165
166
167
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.
    """
    ...

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/protocols.py 
169
170
171
172
173
174
175
176
177
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.
    """
    ...

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/protocols.py 
179
180
181
182
183
184
185
186
187
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.
    """
    ...

run_seed

A method that runs the database seeding script.

Parameters:

  • seed_script (Path) –

    The path to the seed script.

Source code in dev_tool/services/protocols.py 
189
190
191
192
193
194
195
def run_seed(self, seed_script: Path) -> None:
    """
    A method that runs the database seeding script.

    :param seed_script: The path to the seed script.
    """
    ...

run_server

A method that starts the Django development server.

Parameters:

  • ip_address (str) –

    The IP address to bind to.

  • port (int) –

    The port number to bind to.

Source code in dev_tool/services/protocols.py 
197
198
199
200
201
202
203
204
def run_server(self, ip_address: str, port: int) -> None:
    """
    A method that starts the Django development server.

    :param ip_address: The IP address to bind to.
    :param port: The port number to bind to.
    """
    ...

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/protocols.py 
206
207
208
209
210
211
212
213
214
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.
    """
    ...