diff options
author | Joffrey F <joffrey@docker.com> | 2018-11-08 17:31:22 -0800 |
---|---|---|
committer | Joffrey F <joffrey@docker.com> | 2018-11-28 11:56:28 -0800 |
commit | 584204bbddd4f2ad36142cbf2b8b27887ba5c685 (patch) | |
tree | a6cd1ae118f9757599705ac2814fe6ba73d8ba84 | |
parent | 66666f9824a500e402e16c78866ad2a37438448d (diff) | |
download | docker-py-584204bbddd4f2ad36142cbf2b8b27887ba5c685.tar.gz |
Add doc example for get_archive
Signed-off-by: Joffrey F <joffrey@docker.com>
-rw-r--r-- | docker/api/container.py | 12 | ||||
-rw-r--r-- | docker/models/containers.py | 11 |
2 files changed, 23 insertions, 0 deletions
diff --git a/docker/api/container.py b/docker/api/container.py index 753e0a5..fce73af 100644 --- a/docker/api/container.py +++ b/docker/api/container.py @@ -694,6 +694,18 @@ class ContainerApiMixin(object): Raises: :py:class:`docker.errors.APIError` If the server returns an error. + + Example: + + >>> c = docker.APIClient() + >>> f = open('./sh_bin.tar', 'wb') + >>> bits, stat = c.get_archive(container, '/bin/sh') + >>> print(stat) + {'name': 'sh', 'size': 1075464, 'mode': 493, + 'mtime': '2018-10-01T15:37:48-07:00', 'linkTarget': ''} + >>> for chunk in bits: + ... f.write(chunk) + >>> f.close() """ params = { 'path': path diff --git a/docker/models/containers.py b/docker/models/containers.py index 493b9fc..9d6f2cc 100644 --- a/docker/models/containers.py +++ b/docker/models/containers.py @@ -233,6 +233,17 @@ class Container(Model): Raises: :py:class:`docker.errors.APIError` If the server returns an error. + + Example: + + >>> f = open('./sh_bin.tar', 'wb') + >>> bits, stat = container.get_archive('/bin/sh') + >>> print(stat) + {'name': 'sh', 'size': 1075464, 'mode': 493, + 'mtime': '2018-10-01T15:37:48-07:00', 'linkTarget': ''} + >>> for chunk in bits: + ... f.write(chunk) + >>> f.close() """ return self.client.api.get_archive(self.id, path, chunk_size) |