From d9e08aedc3743c133bc4bb87917bc0914f9ff63d Mon Sep 17 00:00:00 2001 From: Joffrey F Date: Thu, 8 Nov 2018 17:13:19 -0800 Subject: Disallow incompatible combination stats(decode=True, stream=False) Signed-off-by: Joffrey F --- docker/api/container.py | 7 ++++++- docker/models/containers.py | 3 ++- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/docker/api/container.py b/docker/api/container.py index 8858aa6..753e0a5 100644 --- a/docker/api/container.py +++ b/docker/api/container.py @@ -1071,7 +1071,8 @@ class ContainerApiMixin(object): Args: container (str): The container to stream statistics from decode (bool): If set to true, stream will be decoded into dicts - on the fly. False by default. + on the fly. Only applicable if ``stream`` is True. + False by default. stream (bool): If set to false, only the current stats will be returned instead of a stream. True by default. @@ -1085,6 +1086,10 @@ class ContainerApiMixin(object): return self._stream_helper(self._get(url, stream=True), decode=decode) else: + if decode: + raise errors.InvalidArgument( + "decode is only available in conjuction with stream=True" + ) return self._result(self._get(url, params={'stream': False}), json=True) diff --git a/docker/models/containers.py b/docker/models/containers.py index a3fd1a8..493b9fc 100644 --- a/docker/models/containers.py +++ b/docker/models/containers.py @@ -385,7 +385,8 @@ class Container(Model): Args: decode (bool): If set to true, stream will be decoded into dicts - on the fly. False by default. + on the fly. Only applicable if ``stream`` is True. + False by default. stream (bool): If set to false, only the current stats will be returned instead of a stream. True by default. -- cgit v1.2.1