Skip to content

[docker-py] Fix Container.top() return type #15067

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

Merged
merged 2 commits into from
Nov 24, 2025
Merged

[docker-py] Fix Container.top() return type #15067

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2ceca4c
[docker-py] Fix `Container.top()` return type
roberfi Nov 22, 2025
8da2540
[docker-py] Make _TopResult typed dict local
roberfi Nov 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion stubs/docker/docker/api/container.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,11 @@ class _HasId(TypedDict):
class _HasID(TypedDict):
ID: str

@type_check_only
class _TopResult(TypedDict):
Titles: list[str]
Processes: list[list[str]]

_Container: TypeAlias = _HasId | _HasID | str

class ContainerApiMixin:
Expand Down Expand Up @@ -145,7 +150,7 @@ class ContainerApiMixin:
def start(self, container: _Container) -> None: ...
def stats(self, container: _Container, decode: bool | None = None, stream: bool = True, one_shot: bool | None = None): ...
def stop(self, container: _Container, timeout: int | None = None) -> None: ...
def top(self, container: _Container, ps_args: str | None = None) -> str: ...
def top(self, container: _Container, ps_args: str | None = None) -> _TopResult: ...
def unpause(self, container: _Container) -> None: ...
def update_container(
self,
Expand Down
7 changes: 6 additions & 1 deletion stubs/docker/docker/models/containers.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,11 @@ class _RestartPolicy(TypedDict):
MaximumRetryCount: NotRequired[int]
Name: NotRequired[Literal["always", "on-failure"]]

@type_check_only
class _TopResult(TypedDict):
Titles: list[str]
Processes: list[list[str]]

class Container(Model):
@property
def name(self) -> str | None: ...
Expand Down Expand Up @@ -91,7 +96,7 @@ class Container(Model):
def start(self) -> None: ...
def stats(self, **kwargs): ...
def stop(self, *, timeout: float | None = None) -> None: ...
def top(self, *, ps_args: str | None = None) -> str: ...
def top(self, *, ps_args: str | None = None) -> _TopResult: ...
def unpause(self): ...
def update(
self,
Expand Down