Skip to content

docker

dev_tool.config.docker

log = logging.getLogger(__name__) module-attribute

DockerConfig

A class for managing Docker configuration settings.

This class provides methods for creating default Docker configurations based on environment variables and user settings.

The constructor for the DockerConfig class.

Source code in dev_tool/config/docker.py 
29
30
31
32
33
def __init__(self) -> None:
    """The constructor for the DockerConfig class."""

    self._notification: NotificationProtocol | None = None
    self._resource_path_getter: Callable[[str], Path] | None = None

create_default_docker_config

A method that creates a default Docker configuration dictionary.

This method combines user-provided configuration with environment variables to create a complete Docker container configuration.

Parameters:

  • container_name (str) –

    The name to use for the Docker container.

  • docker_config (dict) –

    The user-provided Docker configuration dictionary.

Returns:

  • dict –

    A complete Docker configuration dictionary.

Source code in dev_tool/config/docker.py 
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
def create_default_docker_config(self, container_name: str, docker_config: dict) -> dict:
    """
    A method that creates a default Docker configuration dictionary.

    This method combines user-provided configuration with environment variables
    to create a complete Docker container configuration.

    :param container_name: The name to use for the Docker container.
    :param docker_config: The user-provided Docker configuration dictionary.
    :return: A complete Docker configuration dictionary.
    """

    version = docker_config.get('postgres-version', DockerDefault.POSTGRES_VERSION)
    host_port = os.getenv('DATABASE_PORT', DevelopmentDefault.DATABASE_PORT)
    container_port = DockerDefault.CONTAINER_PORT
    postgres_user = os.getenv('DATABASE_USER', DevelopmentDefault.DATABASE_USER)
    postgres_password = os.getenv('DATABASE_PASSWORD', DevelopmentDefault.DATABASE_PASSWORD)
    shm_size = docker_config.get('container-size', DockerDefault.CONTAINER_SIZE)

    return {
        'container_name': container_name,
        'container': f'postgres:{version}',
        'host_port': int(host_port),
        'container_port': int(container_port),
        'environment': {
            'POSTGRES_USER': postgres_user,
            'POSTGRES_PASSWORD': postgres_password,
        },
        'shm_size': shm_size,
        **{
            k: v
            for k, v in docker_config.items()
            if k not in ('postgres-version', 'container-size')
        },
    }

get_dockerfile_path

Get the Dockerfile path - project Dockerfile takes precedence over default.

Returns:

  • Path | None –

    Path to Dockerfile to use, or None if using standard postgres image

Source code in dev_tool/config/docker.py 
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
def get_dockerfile_path(self) -> Path | None:
    """
    Get the Dockerfile path - project Dockerfile takes precedence over default.

    :return: Path to Dockerfile to use, or None if using standard postgres image
    """

    project = BASE / DockerFileDefault.DB

    if project.exists():
        return project

    if self._resource_path_getter is not None:
        default = self._resource_path_getter(f'templates/docker/{DockerFileDefault.DB}')

        if default.exists():
            return default

    return None

set_notification

A method that sets the notification service.

Parameters:

Source code in dev_tool/config/docker.py 
91
92
93
94
95
96
97
98
def set_notification(self, notification: NotificationProtocol) -> None:
    """
    A method that sets the notification service.

    :param notification: The notification service to use.
    """

    self._notification = notification

set_resource_path_getter

A method that sets the resource path getter function.

Parameters:

  • getter (Callable[[str], Path]) –

    A callable that takes a path string and returns an absolute Path.

Source code in dev_tool/config/docker.py 
100
101
102
103
104
105
106
107
def set_resource_path_getter(self, getter: Callable[[str], Path]) -> None:
    """
    A method that sets the resource path getter function.

    :param getter: A callable that takes a path string and returns an absolute Path.
    """

    self._resource_path_getter = getter

should_build_custom_image

Determine if we should build a custom image.

Returns:

  • bool –

    True if we should build custom image

Source code in dev_tool/config/docker.py 
109
110
111
112
113
114
115
116
def should_build_custom_image(self) -> bool:
    """
    Determine if we should build a custom image.

    :return: True if we should build custom image
    """

    return self.get_dockerfile_path() is not None