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

docker/api/image: replace use of deprecated "filter" argument 

The "filter" argument was deprecated in docker 1.13 (API version 1.25),
and removed from API v1.41 and up. See https://github.com/docker/cli/blob/v20.10.0-rc1/docs/deprecated.md#filter-param-for-imagesjson-endpoint

This patch applies the name as "reference" filter, instead of "filter" for API
1.25 and up.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
This commit is contained in:
Sebastiaan van Stijn 2020-11-24 12:04:42 +01:00 committed by Ulysses Souza
parent 4328197660
commit 1757c974fa
2 changed files with 24 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docker/api/image.py
View File

@ -81,10 +81,18 @@ class ImageApiMixin(object):
If the server returns an error. If the server returns an error.
""" """
params = { params = {
'filter': name,
'only_ids': 1 if quiet else 0, 'only_ids': 1 if quiet else 0,
'all': 1 if all else 0, 'all': 1 if all else 0,
} }
if name:
if utils.version_lt(self._version, '1.25'):
# only use "filter" on API 1.24 and under, as it is deprecated
params['filter'] = name
else:
if filters:
filters['reference'] = name
else:
filters = {'reference': name}
if filters: if filters:
params['filters'] = utils.convert_filters(filters) params['filters'] = utils.convert_filters(filters)
res = self._result(self._get(self._url("/images/json"), params=params), res = self._result(self._get(self._url("/images/json"), params=params),

19
tests/unit/api_image_test.py
View File

@ -26,7 +26,18 @@ class ImageTest(BaseAPIClientTest):
fake_request.assert_called_with( fake_request.assert_called_with(
'GET', 'GET',
url_prefix + 'images/json', url_prefix + 'images/json',
params={'filter': None, 'only_ids': 0, 'all': 1}, params={'only_ids': 0, 'all': 1},
timeout=DEFAULT_TIMEOUT_SECONDS
)
def test_images_name(self):
self.client.images('foo:bar')
fake_request.assert_called_with(
'GET',
url_prefix + 'images/json',
params={'only_ids': 0, 'all': 0,
'filters': '{"reference": ["foo:bar"]}'},
timeout=DEFAULT_TIMEOUT_SECONDS timeout=DEFAULT_TIMEOUT_SECONDS
) )
@ -36,7 +47,7 @@ class ImageTest(BaseAPIClientTest):
fake_request.assert_called_with( fake_request.assert_called_with(
'GET', 'GET',
url_prefix + 'images/json', url_prefix + 'images/json',
params={'filter': None, 'only_ids': 1, 'all': 1}, params={'only_ids': 1, 'all': 1},
timeout=DEFAULT_TIMEOUT_SECONDS timeout=DEFAULT_TIMEOUT_SECONDS
) )
@ -46,7 +57,7 @@ class ImageTest(BaseAPIClientTest):
fake_request.assert_called_with( fake_request.assert_called_with(
'GET', 'GET',
url_prefix + 'images/json', url_prefix + 'images/json',
params={'filter': None, 'only_ids': 1, 'all': 0}, params={'only_ids': 1, 'all': 0},
timeout=DEFAULT_TIMEOUT_SECONDS timeout=DEFAULT_TIMEOUT_SECONDS
) )
@ -56,7 +67,7 @@ class ImageTest(BaseAPIClientTest):
fake_request.assert_called_with( fake_request.assert_called_with(
'GET', 'GET',
url_prefix + 'images/json', url_prefix + 'images/json',
params={'filter': None, 'only_ids': 0, 'all': 0, params={'only_ids': 0, 'all': 0,
'filters': '{"dangling": ["true"]}'}, 'filters': '{"dangling": ["true"]}'},
timeout=DEFAULT_TIMEOUT_SECONDS timeout=DEFAULT_TIMEOUT_SECONDS
) )