docker / docker/docker-py

import_image* methods return serialized json

Open
#1,060 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

kind/enhancement
Dominant language
Python
Stars
7.2k
Forks
1.7k
Avg merge
13d 8h
Merged PRs (30d)
2

Description

For all import_image methods, i.e. import_image_from_file, the result is a JSON string, not a JSON object.

Seems that this can be resolved by passing json=True to the self._result call: https://github.com/docker/docker-py/blob/81edb398ebf7ce5c7ef14aa0739de5329589aabe/docker/api/image.py#L89

From a user point of view, this would make the API easier to use by eliminating the additional step to deserialize the response.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in docker/api/image.py at the _result call around line 89 and review all import_image methods, including import_image_from_file. Confirm the current return value is a serialized JSON string, then verify that the completed change returns a JSON object directly for each import_image method.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker, python
Domain
api, backend
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.