nipoppy.container.DockerHandler

class nipoppy.container.DockerHandler(args=None, logger=None)

Container handler for Docker.

Parameters:

• args (Iterable[str])

• logger (Optional[logging.Logger])

get_pull_command(uri, fpath_container)

Get the command to pull a container image to a specified location.

Parameters:

• uri (Optional[str]) – URI of the container image (e.g. docker://…)

• fpath_container (Optional[nipoppy.env.StrOrPathLike]) – Path where the container image should be saved

Returns:

The command string

Return type:

str

is_image_downloaded(uri, fpath_container)

Check if a container image has been downloaded.

Parameters:

• uri (Optional[str]) – URI of the container image (e.g. docker://…)

• fpath_container (Optional[nipoppy.env.StrOrPathLike]) – Path to the container image (not used)

Returns:

True if the container image exists at the specified path

Return type:

bool

bind_flags = ('--volume', '-v')

Flag for binding paths.

command = 'docker'

Container executable name.