Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Open
akhildevelops opened this issue Jan 12, 2023 · 1 comment · May be fixed by #3287
Open

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

akhildevelops opened this issue Jan 12, 2023 · 1 comment · May be fixed by #3287
Labels
kind/feature-request

Comments

@akhildevelops
Copy link

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.
@Khushiyant
Copy link
Contributor

@milas I was thinking implementing a class called ContainerInfo with support for properties such as running, ports etc.
What do you recommend for required tests and documentation while implementing that?

@Khushiyant Khushiyant linked a pull request Sep 16, 2024 that will close this issue
Draft
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
kind/feature-request
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat: add ContainerInfo class to inspect_container return type Khushiyant/docker-py
3 participants
@milas @akhildevelops @Khushiyant