Utilities¶

Sequence to split into groups.

Maximum number of items in each group.

Consecutive slices of the input sequence.

If size is less than one.

Iterable containing hashable values.

A list containing each distinct input value once.

Image to run, as returned by build_container_image.

Command and arguments to execute inside the container.

Absolute path of the file to retrieve, inside the container.

Directory on this machine to place the retrieved file in.

Filename to save the artifact under. Defaults to a per-build name, so that concurrent builds cannot overwrite each other's output.

Environment variables to set inside the container. This is the supported way to vary a build (compiler targets, feature flags), since the same image is reused across builds.

Path of the retrieved artifact. The caller owns the file and is responsible

for moving or deleting it.

If the build command fails, or the artifact cannot be retrieved from the container.

Directory sent to the engine as the build context. Its Dockerfile is used unless dockerfile is given.

Dockerfile to build with, when it does not sit at the root of the build context.

Tag to apply. Defaults to a stable tag derived from the context directory, which keeps the layer cache warm across builds and cannot collide with another component's image.

The tag the image was built under, to be passed to

build_artifact_in_container.

If the image fails to build.

If the docker client is not on the system path, or no engine is currently reachable through it.

Local address against which to test each port.

First port in the search range.

Last port in the search range.

The first bindable port, or None when no port is available.

If the range is reversed or either boundary is invalid.

Address to return when the local address cannot be determined.

The selected local IP address or the fallback address.

Interface-name and IP-address pairs discovered from the operating system.

Maximum time to wait for the external request.

The reported public IP address, or None when it cannot be resolved.

Local address to bind.

Port to bind.

True when the socket can be bound, otherwise False.

Address string to validate.

True when the value is a valid IP address, otherwise False.

Port number to validate.

True when the port is in the range 1 through 65535, otherwise False.

Path to resolve and validate.

Directory that must contain the resolved path.

The resolved path.

If the resolved path is outside the resolved root directory.

Preferred path to use.

The preferred path when available, otherwise a suffixed alternative path.

Characters from which to sample each output character.

Number of characters to generate.

A string containing characters sampled from the supplied character set.

If character_set is empty or length is negative.

Original string in which to replace substrings.

Substrings and their replacement values.

The string after all replacements have been applied.