docker-py client.images.list() always shows all images

Question

I'm not able to filter images from client.images.list()

The documentation says "name (str) – Only show images belonging to the repository name"

client.images.list(name="elixir")

EXPECTATION:

[<Image: 'elixir:1.10-alpine'>]

ACTUAL:

[<Image: 'postgres:latest'>, <Image: 'node:15-alpine'>, <Image: 'elixir:1.10-alpine'>, <Image: 'nginx:stable-alpine'>]

Bug?

Versions:

Docker version 20.10.0, build 7287ab3

>>> import docker
>>> docker.__version__
'4.4.0'

@Paul I have all the images in the ACTUAL. However, I would expect client.list(name) to only give images with the repository == name. The docker client is only from_env(). — snakajim, Dec 17 '20 at 16:44
@Martin, `docker images` shows the same images as ACTUAL. i.e. all the images on my local registry. — snakajim, Dec 17 '20 at 16:45
@snakajim this just is not working. The client builds a dict `{'filter': 'yacht', 'only_ids':0, 'all': 0}` and passes it to the docker api (I called `client.image.list(name='yacht')`). Looks like a docker api issue, not the SDK. — Martin, Dec 17 '20 at 20:01

Joe-DN · Answer 1 · 2021-06-09T12:02:33.667

2

I had to use:-

client.images.list(filters = { "reference" : "elixir:1.10-alpine"})

To return a list of images, Martins response appears to be missing the 's' off images

edited Jun 09 '21 at 12:02

answered Jun 08 '21 at 10:13

Joe-DN

2

Welcome to Stackoverflow. You basically copied Martin's answer and fixed a type in that. Rather than posting your "own" answer, just comment on Martin's one. – jhoepken Jun 08 '21 at 12:43
2

I could not comment on Martin's answer, it said I need 50 rep points. Creating a new answer was the only option I had, other than not commenting at all. I will take option 2 next time. – Joe-DN Jun 09 '21 at 12:01
1

You could always suggest an edit. – Ryan M Jun 16 '22 at 03:47

Martin · Answer 2 · 2023-01-04T21:30:09.050

1

client.images.list(filters = { "reference" : "elixir:1.10-alpine"}) will give you what you want.

edited Jan 04 '23 at 21:30

answered Dec 17 '20 at 20:13

Martin

its client.imgaes , not image. a small typo :) – Hassan Jalil Dec 08 '22 at 05:27

2 Answers2