Source code for runway.cfngin.hooks.docker.hook_data

"""Docker hook_data object."""
from __future__ import annotations

from typing import TYPE_CHECKING, Optional, overload

from docker import DockerClient

from ....compat import cached_property
from ....utils import MutableMap

    from ....context import CfnginContext
    from .data_models import DockerImage

[docs]class DockerHookData(MutableMap): """Docker hook_data object.""" image: Optional["DockerImage"] = None @cached_property def client(self) -> DockerClient: """Docker client.""" return DockerClient.from_env() @overload def update_context(self, context: CfnginContext = ...) -> DockerHookData: # noqa ... @overload def update_context(self, context: None = ...) -> None: # noqa ...
[docs] def update_context( self, context: Optional[CfnginContext] = None ) -> Optional[DockerHookData]: """Update context object with new the current DockerHookData.""" if not context: return None context.hook_data["docker"] = self return self
[docs] @classmethod def from_cfngin_context(cls, context: CfnginContext) -> DockerHookData: """Get existing object or create a new one.""" if "docker" in context.hook_data: found = context.hook_data["docker"] if isinstance(found, cls): return found new_obj = cls() context.hook_data["docker"] = new_obj return new_obj