docker
/
docker-py
mirror of https://github.com/docker/docker-py.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

api: add `one-shot` option to container `stats` (#3089) 

Signed-off-by: Andy Roxby <107427605+aroxby-wayscript@users.noreply.github.com>
This commit is contained in:
Andy Roxby 2023-02-16 10:27:45 -05:00 committed by GitHub
parent aca129dd69
commit e9d4ddfaec
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 32 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
docker/api/container.py
View File

@ -1126,7 +1126,7 @@ class ContainerApiMixin:
self._raise_for_status(res) self._raise_for_status(res)
@utils.check_resource('container') @utils.check_resource('container')
def stats(self, container, decode=None, stream=True): def stats(self, container, decode=None, stream=True, one_shot=None):
""" """
Stream statistics for a specific container. Similar to the Stream statistics for a specific container. Similar to the
``docker stats`` command. ``docker stats`` command.
@ -1138,6 +1138,9 @@ class ContainerApiMixin:
False by default. False by default.
stream (bool): If set to false, only the current stats will be stream (bool): If set to false, only the current stats will be
returned instead of a stream. True by default. returned instead of a stream. True by default.
one_shot (bool): If set to true, Only get a single stat instead of
waiting for 2 cycles. Must be used with stream=false. False by
default.
Raises: Raises:
:py:class:`docker.errors.APIError` :py:class:`docker.errors.APIError`
@ -1145,16 +1148,29 @@ class ContainerApiMixin:
""" """
url = self._url("/containers/{0}/stats", container) url = self._url("/containers/{0}/stats", container)
params = {
'stream': stream
}
if one_shot is not None:
if utils.version_lt(self._version, '1.41'):
raise errors.InvalidVersion(
'one_shot is not supported for API version < 1.41'
)
params['one-shot'] = one_shot
if stream: if stream:
return self._stream_helper(self._get(url, stream=True), if one_shot:
raise errors.InvalidArgument(
'one_shot is only available in conjunction with '
'stream=False'
)
return self._stream_helper(self._get(url, params=params),
decode=decode) decode=decode)
else: else:
if decode: if decode:
raise errors.InvalidArgument( raise errors.InvalidArgument(
"decode is only available in conjunction with stream=True" "decode is only available in conjunction with stream=True"
) )
return self._result(self._get(url, params={'stream': False}), return self._result(self._get(url, params=params), json=True)
json=True)
@utils.check_resource('container') @utils.check_resource('container')
def stop(self, container, timeout=None): def stop(self, container, timeout=None):

13
tests/unit/api_container_test.py
View File

@ -1529,7 +1529,18 @@ class ContainerTest(BaseAPIClientTest):
'GET', 'GET',
url_prefix + 'containers/' + fake_api.FAKE_CONTAINER_ID + '/stats', url_prefix + 'containers/' + fake_api.FAKE_CONTAINER_ID + '/stats',
timeout=60, timeout=60,
stream=True params={'stream': True}
)
def test_container_stats_with_one_shot(self):
self.client.stats(
fake_api.FAKE_CONTAINER_ID, stream=False, one_shot=True)
fake_request.assert_called_with(
'GET',
url_prefix + 'containers/' + fake_api.FAKE_CONTAINER_ID + '/stats',
timeout=60,
params={'stream': False, 'one-shot': True}
) )
def test_container_top(self): def test_container_top(self):