summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJoffrey F <joffrey@docker.com>2018-11-08 15:05:22 -0800
committerJoffrey F <joffrey@docker.com>2018-11-08 15:05:22 -0800
commit9987c1bc42bc36160bc7fbdf17849a32fcf11808 (patch)
tree9714f85ac7c8b1a999b2d3e94e2d2397018049b8
parent5467658bbc22828a17312198dbe8ceb41f4cb77a (diff)
downloaddocker-py-9987c1bc42bc36160bc7fbdf17849a32fcf11808.tar.gz
Fix docs examples to work with Python 3
Signed-off-by: Joffrey F <joffrey@docker.com>
-rw-r--r--docker/api/daemon.py6
-rw-r--r--docker/api/image.py16
-rw-r--r--docker/api/mixin.py57
-rw-r--r--docker/types/daemon.py2
4 files changed, 69 insertions, 12 deletions
diff --git a/docker/api/daemon.py b/docker/api/daemon.py
index 76a94cf..431e7d4 100644
--- a/docker/api/daemon.py
+++ b/docker/api/daemon.py
@@ -42,8 +42,8 @@ class DaemonApiMixin(object):
Example:
- >>> for event in client.events()
- ... print event
+ >>> for event in client.events(decode=True)
+ ... print(event)
{u'from': u'image/with:tag',
u'id': u'container-id',
u'status': u'start',
@@ -54,7 +54,7 @@ class DaemonApiMixin(object):
>>> events = client.events()
>>> for event in events:
- ... print event
+ ... print(event)
>>> # and cancel from another thread
>>> events.close()
"""
diff --git a/docker/api/image.py b/docker/api/image.py
index 5f05d88..1c1fcde 100644
--- a/docker/api/image.py
+++ b/docker/api/image.py
@@ -352,8 +352,8 @@ class ImageApiMixin(object):
Example:
- >>> for line in cli.pull('busybox', stream=True):
- ... print(json.dumps(json.loads(line), indent=4))
+ >>> for line in cli.pull('busybox', stream=True, decode=True):
+ ... print(json.dumps(line, indent=4))
{
"status": "Pulling image (latest) from busybox",
"progressDetail": {},
@@ -428,12 +428,12 @@ class ImageApiMixin(object):
If the server returns an error.
Example:
- >>> for line in cli.push('yourname/app', stream=True):
- ... print line
- {"status":"Pushing repository yourname/app (1 tags)"}
- {"status":"Pushing","progressDetail":{},"id":"511136ea3c5a"}
- {"status":"Image already pushed, skipping","progressDetail":{},
- "id":"511136ea3c5a"}
+ >>> for line in cli.push('yourname/app', stream=True, decode=True):
+ ... print(line)
+ {'status': 'Pushing repository yourname/app (1 tags)'}
+ {'status': 'Pushing','progressDetail': {}, 'id': '511136ea3c5a'}
+ {'status': 'Image already pushed, skipping', 'progressDetail':{},
+ 'id': '511136ea3c5a'}
...
"""
diff --git a/docker/api/mixin.py b/docker/api/mixin.py
new file mode 100644
index 0000000..1353568
--- /dev/null
+++ b/docker/api/mixin.py
@@ -0,0 +1,57 @@
+from typing import Any, Dict, Iterable, List, Optional, Union
+
+import requests
+
+from ..constants import DEFAULT_DOCKER_API_VERSION, DEFAULT_TIMEOUT_SECONDS
+
+class BaseMixin(object):
+ base_url: str = ''
+ credstore_env: Optional[Dict[str, str]] = None
+ timeout: int = DEFAULT_TIMEOUT_SECONDS
+ _auth_configs: Dict[str, Dict]
+ _general_configs: Dict[str, Dict]
+ _version: str = DEFAULT_DOCKER_API_VERSION
+
+ def _url(self, pathfmt: str, *args, **kwargs) -> str:
+ raise NotImplemented
+
+ def _post(self, url: str, **kwargs) -> requests.Response:
+ raise NotImplemented
+
+ def _get(self, url: str, **kwargs) -> requests.Response:
+ raise NotImplemented
+
+ def _put(self, url: str, **kwargs) -> requests.Response:
+ raise NotImplemented
+
+ def _delete(self, url: str, **kwargs) -> requests.Response:
+ raise NotImplemented
+
+ def _post_json(self, url: str, data: Optional[Union[Dict[str, Any], List[Any]]], **kwargs) -> requests.Response:
+ raise NotImplemented
+
+ def _raise_for_status(self, response: requests.Response) -> None:
+ raise NotImplemented
+
+ def _result(self, response: requests.Response, json: bool=False, binary: bool=False) -> Any:
+ raise NotImplemented
+
+ def _stream_helper(self, response: requests.Response, decode: bool = False) -> Iterable:
+ raise NotImplemented
+
+ def _get_raw_response_socket(self, response: requests.Response) -> Iterable:
+ raise NotImplemented
+
+ def _read_from_socket(
+ self,
+ response: requests.Response,
+ stream: bool,
+ tty: bool = False) -> Union[Iterable[bytes], bytes]:
+ raise NotImplemented
+
+ def _stream_raw_result(
+ self,
+ response: requests.Response,
+ chunk_size: int = 1,
+ decode: bool = True) -> Iterable[bytes]:
+ raise NotImplemented
diff --git a/docker/types/daemon.py b/docker/types/daemon.py
index 700f9a9..af3e5bc 100644
--- a/docker/types/daemon.py
+++ b/docker/types/daemon.py
@@ -15,7 +15,7 @@ class CancellableStream(object):
Example:
>>> events = client.events()
>>> for event in events:
- ... print event
+ ... print(event)
>>> # and cancel from another thread
>>> events.close()
"""