Skip to content

Improve docker.types #13809

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
Avasam merged 5 commits into from
May 2, 2025
Merged

Improve docker.types #13809

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d343fde
Improve `docker.types`
donbarbos Apr 9, 2025
146af75
Accept existing suggestions
donbarbos Apr 12, 2025
699078b
Use more covariant types
donbarbos Apr 13, 2025
e91cddd
Finish fixing invariance issues
Avasam Apr 14, 2025
d35ec17
Merge branch 'main' into improve-docker-types
donbarbos Apr 15, 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
55 changes: 29 additions & 26 deletions stubs/docker/docker/types/containers.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,19 @@ from typing import Literal

from docker._types import ContainerWeightDevice

from .. import errors
from .base import DictType
from .healthcheck import Healthcheck
from .networks import NetworkingConfig
from .services import Mount

class LogConfigTypesEnum:
JSON: Incomplete
SYSLOG: Incomplete
JOURNALD: Incomplete
GELF: Incomplete
FLUENTD: Incomplete
NONE: Incomplete
JSON: str
SYSLOG: str
JOURNALD: str
GELF: str
FLUENTD: str
NONE: str
Comment thread
donbarbos marked this conversation as resolved.
Outdated

class LogConfig(DictType):
types: type[LogConfigTypesEnum]
Expand Down Expand Up @@ -68,21 +71,21 @@ class HostConfig(dict[str, Incomplete]):
def __init__(
self,
version: str,
binds: Incomplete | None = None,
port_bindings: Incomplete | None = None,
lxc_conf: dict[Incomplete, Incomplete] | None = None,
binds: dict[str, dict[str, str]] | list[str] | None = None,
Comment thread
donbarbos marked this conversation as resolved.
Outdated
port_bindings: dict[int | str, Incomplete] | None = None,
Comment thread
donbarbos marked this conversation as resolved.
Outdated
lxc_conf: dict[str, Incomplete] | list[dict[str, Incomplete]] | None = None,
publish_all_ports: bool = False,
links: dict[str, str | None] | None = None,
privileged: bool = False,
dns: list[Incomplete] | None = None,
dns_search: list[Incomplete] | None = None,
dns: list[str] | None = None,
dns_search: list[str] | None = None,
volumes_from: list[str] | None = None,
network_mode: str | None = None,
restart_policy: dict[Incomplete, Incomplete] | None = None,
restart_policy: dict[str, str | int] | None = None,
cap_add: list[str] | None = None,
cap_drop: list[str] | None = None,
devices: list[str] | None = None,
extra_hosts: dict[Incomplete, Incomplete] | None = None,
extra_hosts: dict[str, Incomplete] | None = None,
Comment thread
donbarbos marked this conversation as resolved.
Outdated
read_only: bool | None = None,
pid_mode: str | None = None,
ipc_mode: str | None = None,
Expand All @@ -100,13 +103,13 @@ class HostConfig(dict[str, Incomplete]):
cpu_period: int | None = None,
blkio_weight: int | None = None,
blkio_weight_device: list[ContainerWeightDevice] | None = None,
device_read_bps: Incomplete | None = None,
device_write_bps: Incomplete | None = None,
device_read_iops: Incomplete | None = None,
device_write_iops: Incomplete | None = None,
device_read_bps: list[dict[str, str | int]] | None = None,
device_write_bps: list[dict[str, str | int]] | None = None,
device_read_iops: list[dict[str, str | int]] | None = None,
device_write_iops: list[dict[str, str | int]] | None = None,
oom_kill_disable: bool = False,
shm_size: str | int | None = None,
sysctls: dict[Incomplete, Incomplete] | None = None,
sysctls: dict[str, str] | None = None,
tmpfs: dict[str, str] | None = None,
oom_score_adj: int | None = None,
dns_opt: list[Incomplete] | None = None,
Expand Down Expand Up @@ -134,16 +137,16 @@ class HostConfig(dict[str, Incomplete]):
cgroupns: Literal["private", "host"] | None = None,
) -> None: ...

def host_config_type_error(param, param_value, expected): ...
def host_config_version_error(param, version, less_than: bool = True): ...
def host_config_value_error(param, param_value): ...
def host_config_incompatible_error(param, param_value, incompatible_param): ...
def host_config_type_error(param: str, param_value, expected: str) -> TypeError: ...
Comment thread
donbarbos marked this conversation as resolved.
Outdated
def host_config_version_error(param: str, version: str, less_than: bool = True) -> errors.InvalidVersion: ...
def host_config_value_error(param: str, param_value) -> ValueError: ...
Comment thread
donbarbos marked this conversation as resolved.
Outdated
def host_config_incompatible_error(param: str, param_value: str, incompatible_param: str) -> errors.InvalidArgument: ...

class ContainerConfig(dict[str, Incomplete]):
def __init__(
self,
version: str,
image,
image: str,
command: str | list[str],
hostname: str | None = None,
user: str | int | None = None,
Expand All @@ -157,12 +160,12 @@ class ContainerConfig(dict[str, Incomplete]):
entrypoint: str | list[str] | None = None,
working_dir: str | None = None,
domainname: str | None = None,
host_config: Incomplete | None = None,
host_config: HostConfig | None = None,
mac_address: str | None = None,
labels: dict[str, str] | list[str] | None = None,
stop_signal: str | None = None,
networking_config: Incomplete | None = None,
healthcheck: Incomplete | None = None,
networking_config: NetworkingConfig | None = None,
healthcheck: Healthcheck | None = None,
stop_timeout: int | None = None,
runtime: str | None = None,
) -> None: ...
29 changes: 16 additions & 13 deletions stubs/docker/docker/types/networks.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,29 +3,32 @@ from _typeshed import Incomplete
class EndpointConfig(dict[str, Incomplete]):
def __init__(
self,
version,
aliases: Incomplete | None = None,
links: Incomplete | None = None,
ipv4_address: Incomplete | None = None,
ipv6_address: Incomplete | None = None,
link_local_ips: Incomplete | None = None,
version: str,
aliases: list[Incomplete] | None = None,
links: list[Incomplete] | None = None,
Comment thread
donbarbos marked this conversation as resolved.
Outdated
ipv4_address: str | None = None,
ipv6_address: str | None = None,
link_local_ips: list[str] | None = None,
driver_opt: Incomplete | None = None,
mac_address: Incomplete | None = None,
mac_address: str | None = None,
) -> None: ...

class NetworkingConfig(dict[str, Incomplete]):
def __init__(self, endpoints_config: Incomplete | None = None) -> None: ...
def __init__(self, endpoints_config: EndpointConfig | None = None) -> None: ...

class IPAMConfig(dict[str, Incomplete]):
def __init__(
self, driver: str = "default", pool_configs: Incomplete | None = None, options: Incomplete | None = None
self,
driver: str = "default",
pool_configs: list[IPAMPool] | None = None,
options: dict[Incomplete, Incomplete] | None = None,
) -> None: ...

class IPAMPool(dict[str, Incomplete]):
def __init__(
self,
subnet: Incomplete | None = None,
iprange: Incomplete | None = None,
gateway: Incomplete | None = None,
aux_addresses: Incomplete | None = None,
subnet: str | None = None,
iprange: str | None = None,
gateway: str | None = None,
aux_addresses: dict[str, str] | None = None,
) -> None: ...
Loading