The docker_instance.py module#

Summary#

LocalDockerInstance

Instantiates a Geometry service as a local Docker container.

GeometryContainers

Provides an enum holding the available Geometry services.

get_geometry_container_type

Given a LocalDockerInstance, provide back the GeometryContainers value.

Description#

Module for connecting to a local Docker container with the Geometry service.

Module detail#

docker_instance.get_geometry_container_type(instance: LocalDockerInstance) beartype.typing.Union[GeometryContainers, None]#

Given a LocalDockerInstance, provide back the GeometryContainers value.

Parameters:
instanceLocalDockerInstance

The LocalDockerInstance object.

Returns:
Union[GeometryContainers, None]

The GeometryContainer value corresponding to the previous image or None if not match.

Notes

This method returns the first hit on the available tags.