docker / docker/docker-py

[Feature Request] A class for docker's inspect information

Open
#3,087 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

kind/feature-request
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

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 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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.