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/api/image.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/api/image.py')
| -rw-r--r-- | docker/api/image.py | 13 |
1 files changed, 6 insertions, 7 deletions
diff --git a/docker/api/image.py b/docker/api/image.py index 065fae3..b3dcd3a 100644 --- a/docker/api/image.py +++ b/docker/api/image.py @@ -21,8 +21,7 @@ class ImageApiMixin(object): image (str): Image name to get Returns: - (urllib3.response.HTTPResponse object): The response from the - daemon. + (generator): A stream of raw archive data. Raises: :py:class:`docker.errors.APIError` @@ -30,14 +29,14 @@ class ImageApiMixin(object): Example: - >>> image = cli.get_image("fedora:latest") - >>> f = open('/tmp/fedora-latest.tar', 'w') - >>> f.write(image.data) + >>> image = cli.get_image("busybox:latest") + >>> f = open('/tmp/busybox-latest.tar', 'w') + >>> for chunk in image: + >>> f.write(chunk) >>> f.close() """ res = self._get(self._url("/images/{0}/get", image), stream=True) - self._raise_for_status(res) - return res.raw + return self._stream_raw_result(res) @utils.check_resource('image') def history(self, image): |