Skip to content

Commit 584204b

Browse files
committed
Add doc example for get_archive
Signed-off-by: Joffrey F <[email protected]>
1 parent 66666f9 commit 584204b

File tree

2 files changed

+23
-0
lines changed

2 files changed

+23
-0
lines changed

docker/api/container.py

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -694,6 +694,18 @@ def get_archive(self, container, path, chunk_size=DEFAULT_DATA_CHUNK_SIZE):
694694
Raises:
695695
:py:class:`docker.errors.APIError`
696696
If the server returns an error.
697+
698+
Example:
699+
700+
>>> c = docker.APIClient()
701+
>>> f = open('./sh_bin.tar', 'wb')
702+
>>> bits, stat = c.get_archive(container, '/bin/sh')
703+
>>> print(stat)
704+
{'name': 'sh', 'size': 1075464, 'mode': 493,
705+
'mtime': '2018-10-01T15:37:48-07:00', 'linkTarget': ''}
706+
>>> for chunk in bits:
707+
... f.write(chunk)
708+
>>> f.close()
697709
"""
698710
params = {
699711
'path': path

docker/models/containers.py

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -233,6 +233,17 @@ def get_archive(self, path, chunk_size=DEFAULT_DATA_CHUNK_SIZE):
233233
Raises:
234234
:py:class:`docker.errors.APIError`
235235
If the server returns an error.
236+
237+
Example:
238+
239+
>>> f = open('./sh_bin.tar', 'wb')
240+
>>> bits, stat = container.get_archive('/bin/sh')
241+
>>> print(stat)
242+
{'name': 'sh', 'size': 1075464, 'mode': 493,
243+
'mtime': '2018-10-01T15:37:48-07:00', 'linkTarget': ''}
244+
>>> for chunk in bits:
245+
... f.write(chunk)
246+
>>> f.close()
236247
"""
237248
return self.client.api.get_archive(self.id, path, chunk_size)
238249

0 commit comments

Comments
 (0)