[Feature Request] A class for docker's inspect information
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 7.2k
- Forks
- 1.7k
- Avg merge
- 13d 8h
- Merged PRs (30d)
- 2
Description
Hi 👋,
Information returned by docker inspect should have it's own object type, rather than a simple dict object.
This behavior will be helpful in accessing attributes and apply methods on the data.
Currently insepct_container method returns a plain dict.
inspect_container(container)
Identical to the docker inspect command, but only for containers.
Parameters
container (str) – The container to inspect
Returns
Similar to the output of docker inspect, but as a single dict
Return type
(dict)
Raises
docker.errors.APIError – If the server returns an error.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with inspect_container in docker/api/container.py, the entry point and return contract named in the issue. Read the surrounding API implementation and existing object types to determine the intended representation; done means inspect results are exposed through a dedicated object type rather than a plain dict, with the documented return behavior updated accordingly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker, python
- Domain
- api, backend
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100