cwl_utils.image_puller

Classes for docker-extract.

Module Contents

Classes

ImagePuller	Helper class that provides a standard way to create an ABC using
DockerImagePuller	Pull docker image with Docker.
SingularityImagePuller	Pull docker image with Singularity.

class cwl_utils.image_puller.ImagePuller(req, save_directory, cmd, force_pull)

Bases: abc.ABC

Helper class that provides a standard way to create an ABC using inheritance.

Parameters:

• req (str) –

• save_directory (Union[str, pathlib.Path]) –

• cmd (str) –

• force_pull (bool) –

abstract get_image_name()

Get the engine-specific image name.

Return type:

str

abstract save_docker_image()

Download and save the image to disk.

Return type:

None

class cwl_utils.image_puller.DockerImagePuller(req, save_directory, cmd, force_pull)

Bases: ImagePuller

Pull docker image with Docker.

Parameters:

• req (str) –

• save_directory (Union[str, pathlib.Path]) –

• cmd (str) –

• force_pull (bool) –

get_image_name()

Get the name of the tarball.

Return type:

str

generate_udocker_loading_command()

Generate the udocker loading command.

Return type:

str

save_docker_image()

Download and save the software container image to disk as a docker tarball.

Return type:

None

class cwl_utils.image_puller.SingularityImagePuller(req, save_directory, cmd, force_pull)

Bases: ImagePuller

Pull docker image with Singularity.

Parameters:

• req (str) –

• save_directory (Union[str, pathlib.Path]) –

• cmd (str) –

• force_pull (bool) –

CHARS_TO_REPLACE = ['/']

NEW_CHAR = '_'

get_image_name()

Determine the file name appropriate to the installed version of Singularity.

Return type:

str

save_docker_image()

Pull down the Docker software container image and save it in the Singularity image format.

Return type:

None