diff options
author | Joffrey F <joffrey@docker.com> | 2018-01-26 15:32:04 -0800 |
---|---|---|
committer | Joffrey F <joffrey@docker.com> | 2018-01-26 16:23:55 -0800 |
commit | 388f291b13fca76f4974a1ee89225ff7f3afb85b (patch) | |
tree | d0eebd08f8b1c65448d33295b145d5d5276b681f /docker/models/images.py | |
parent | deb8222d6994dca12be65146189859c9b76ed9a5 (diff) | |
download | docker-py-1774-export-methods.tar.gz |
Update save / export methods to return data generators1774-export-methods
Signed-off-by: Joffrey F <joffrey@docker.com>
Diffstat (limited to 'docker/models/images.py')
-rw-r--r-- | docker/models/images.py | 12 |
1 files changed, 5 insertions, 7 deletions
diff --git a/docker/models/images.py b/docker/models/images.py index dcdeac9..8229cfc 100644 --- a/docker/models/images.py +++ b/docker/models/images.py @@ -61,8 +61,7 @@ class Image(Model): Get a tarball of an image. Similar to the ``docker save`` command. Returns: - (urllib3.response.HTTPResponse object): The response from the - daemon. + (generator): A stream of raw archive data. Raises: :py:class:`docker.errors.APIError` @@ -70,11 +69,10 @@ class Image(Model): Example: - >>> image = cli.images.get("fedora:latest") - >>> resp = image.save() - >>> f = open('/tmp/fedora-latest.tar', 'w') - >>> for chunk in resp.stream(): - >>> f.write(chunk) + >>> image = cli.get_image("busybox:latest") + >>> f = open('/tmp/busybox-latest.tar', 'w') + >>> for chunk in image: + >>> f.write(chunk) >>> f.close() """ return self.client.api.get_image(self.id) |