diff options
| author | Joffrey F <f.joffrey@gmail.com> | 2018-11-28 12:11:38 -0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-11-28 12:11:38 -0800 |
| commit | d74bfa69ab1b44e0a745efe15e4b771d10c9cd54 (patch) | |
| tree | 100a9a7232379cc6eb3f5c48c6e1935c3ce0dc8f /docker/models/images.py | |
| parent | 7cc0a1b6eb157e4a740099f66b98d9cbb40e71ad (diff) | |
| parent | 24ed2f356bd522f413a5e01765f63f2da3975f31 (diff) | |
| download | docker-py-3.6.0.tar.gz | |
Merge pull request #2187 from docker/3.6.0-release3.6.0
3.6.0 release
Diffstat (limited to 'docker/models/images.py')
| -rw-r--r-- | docker/models/images.py | 39 |
1 files changed, 35 insertions, 4 deletions
diff --git a/docker/models/images.py b/docker/models/images.py index 7d9ab70..30e86f1 100644 --- a/docker/models/images.py +++ b/docker/models/images.py @@ -1,5 +1,6 @@ import itertools import re +import warnings import six @@ -59,7 +60,7 @@ class Image(Model): """ return self.client.api.history(self.id) - def save(self, chunk_size=DEFAULT_DATA_CHUNK_SIZE): + def save(self, chunk_size=DEFAULT_DATA_CHUNK_SIZE, named=False): """ Get a tarball of an image. Similar to the ``docker save`` command. @@ -67,6 +68,12 @@ class Image(Model): chunk_size (int): The generator will return up to that much data per iteration, but may return less. If ``None``, data will be streamed as it is received. Default: 2 MB + named (str or bool): If ``False`` (default), the tarball will not + retain repository and tag information for this image. If set + to ``True``, the first tag in the :py:attr:`~tags` list will + be used to identify the image. Alternatively, any element of + the :py:attr:`~tags` list can be used as an argument to use + that specific tag as the saved identifier. Returns: (generator): A stream of raw archive data. @@ -78,12 +85,22 @@ class Image(Model): Example: >>> image = cli.get_image("busybox:latest") - >>> f = open('/tmp/busybox-latest.tar', 'w') + >>> f = open('/tmp/busybox-latest.tar', 'wb') >>> for chunk in image: >>> f.write(chunk) >>> f.close() """ - return self.client.api.get_image(self.id, chunk_size) + img = self.id + if named: + img = self.tags[0] if self.tags else img + if isinstance(named, six.string_types): + if named not in self.tags: + raise InvalidArgument( + "{} is not a valid tag for this image".format(named) + ) + img = named + + return self.client.api.get_image(img, chunk_size) def tag(self, repository, tag=None, **kwargs): """ @@ -409,7 +426,21 @@ class ImageCollection(Collection): if not tag: repository, tag = parse_repository_tag(repository) - self.client.api.pull(repository, tag=tag, **kwargs) + if 'stream' in kwargs: + warnings.warn( + '`stream` is not a valid parameter for this method' + ' and will be overridden' + ) + del kwargs['stream'] + + pull_log = self.client.api.pull( + repository, tag=tag, stream=True, **kwargs + ) + for _ in pull_log: + # We don't do anything with the logs, but we need + # to keep the connection alive and wait for the image + # to be pulled. + pass if tag: return self.get('{0}{2}{1}'.format( repository, tag, '@' if tag.startswith('sha256:') else ':' |
