types-docker 7.0.0.20240413__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- types-docker-7.0.0.20240413/CHANGELOG.md +4 -0
- types-docker-7.0.0.20240413/MANIFEST.in +1 -0
- types-docker-7.0.0.20240413/PKG-INFO +37 -0
- types-docker-7.0.0.20240413/docker-stubs/METADATA.toml +3 -0
- types-docker-7.0.0.20240413/docker-stubs/__init__.pyi +7 -0
- types-docker-7.0.0.20240413/docker-stubs/api/__init__.pyi +1 -0
- types-docker-7.0.0.20240413/docker-stubs/api/build.pyi +39 -0
- types-docker-7.0.0.20240413/docker-stubs/api/client.pyi +55 -0
- types-docker-7.0.0.20240413/docker-stubs/api/config.pyi +7 -0
- types-docker-7.0.0.20240413/docker-stubs/api/container.pyi +109 -0
- types-docker-7.0.0.20240413/docker-stubs/api/daemon.pyi +23 -0
- types-docker-7.0.0.20240413/docker-stubs/api/exec_api.pyi +22 -0
- types-docker-7.0.0.20240413/docker-stubs/api/image.pyi +59 -0
- types-docker-7.0.0.20240413/docker-stubs/api/network.pyi +34 -0
- types-docker-7.0.0.20240413/docker-stubs/api/plugin.pyi +14 -0
- types-docker-7.0.0.20240413/docker-stubs/api/secret.pyi +7 -0
- types-docker-7.0.0.20240413/docker-stubs/api/service.pyi +47 -0
- types-docker-7.0.0.20240413/docker-stubs/api/swarm.pyi +41 -0
- types-docker-7.0.0.20240413/docker-stubs/api/volume.pyi +14 -0
- types-docker-7.0.0.20240413/docker-stubs/auth.pyi +40 -0
- types-docker-7.0.0.20240413/docker-stubs/client.pyi +49 -0
- types-docker-7.0.0.20240413/docker-stubs/constants.pyi +22 -0
- types-docker-7.0.0.20240413/docker-stubs/context/__init__.pyi +2 -0
- types-docker-7.0.0.20240413/docker-stubs/context/api.pyi +30 -0
- types-docker-7.0.0.20240413/docker-stubs/context/config.pyi +10 -0
- types-docker-7.0.0.20240413/docker-stubs/context/context.pyi +47 -0
- types-docker-7.0.0.20240413/docker-stubs/credentials/__init__.pyi +8 -0
- types-docker-7.0.0.20240413/docker-stubs/credentials/constants.pyi +4 -0
- types-docker-7.0.0.20240413/docker-stubs/credentials/errors.pyi +7 -0
- types-docker-7.0.0.20240413/docker-stubs/credentials/store.pyi +11 -0
- types-docker-7.0.0.20240413/docker-stubs/credentials/utils.pyi +1 -0
- types-docker-7.0.0.20240413/docker-stubs/errors.pyi +71 -0
- types-docker-7.0.0.20240413/docker-stubs/models/__init__.pyi +0 -0
- types-docker-7.0.0.20240413/docker-stubs/models/configs.pyi +13 -0
- types-docker-7.0.0.20240413/docker-stubs/models/containers.pyi +81 -0
- types-docker-7.0.0.20240413/docker-stubs/models/images.pyi +43 -0
- types-docker-7.0.0.20240413/docker-stubs/models/networks.pyi +19 -0
- types-docker-7.0.0.20240413/docker-stubs/models/nodes.pyi +13 -0
- types-docker-7.0.0.20240413/docker-stubs/models/plugins.pyi +25 -0
- types-docker-7.0.0.20240413/docker-stubs/models/resource.pyi +27 -0
- types-docker-7.0.0.20240413/docker-stubs/models/secrets.pyi +13 -0
- types-docker-7.0.0.20240413/docker-stubs/models/services.pyi +27 -0
- types-docker-7.0.0.20240413/docker-stubs/models/swarm.pyi +33 -0
- types-docker-7.0.0.20240413/docker-stubs/models/volumes.pyi +16 -0
- types-docker-7.0.0.20240413/docker-stubs/py.typed +0 -0
- types-docker-7.0.0.20240413/docker-stubs/tls.pyi +10 -0
- types-docker-7.0.0.20240413/docker-stubs/transport/__init__.pyi +4 -0
- types-docker-7.0.0.20240413/docker-stubs/transport/basehttpadapter.pyi +4 -0
- types-docker-7.0.0.20240413/docker-stubs/transport/npipeconn.pyi +29 -0
- types-docker-7.0.0.20240413/docker-stubs/transport/npipesocket.pyi +49 -0
- types-docker-7.0.0.20240413/docker-stubs/transport/sshconn.pyi +49 -0
- types-docker-7.0.0.20240413/docker-stubs/transport/unixconn.pyi +31 -0
- types-docker-7.0.0.20240413/docker-stubs/types/__init__.pyi +35 -0
- types-docker-7.0.0.20240413/docker-stubs/types/base.pyi +5 -0
- types-docker-7.0.0.20240413/docker-stubs/types/containers.pyi +164 -0
- types-docker-7.0.0.20240413/docker-stubs/types/daemon.pyi +6 -0
- types-docker-7.0.0.20240413/docker-stubs/types/healthcheck.pyi +24 -0
- types-docker-7.0.0.20240413/docker-stubs/types/networks.pyi +31 -0
- types-docker-7.0.0.20240413/docker-stubs/types/services.pyi +170 -0
- types-docker-7.0.0.20240413/docker-stubs/types/swarm.pyi +29 -0
- types-docker-7.0.0.20240413/docker-stubs/utils/__init__.pyi +32 -0
- types-docker-7.0.0.20240413/docker-stubs/utils/build.pyi +38 -0
- types-docker-7.0.0.20240413/docker-stubs/utils/config.pyi +10 -0
- types-docker-7.0.0.20240413/docker-stubs/utils/decorators.pyi +3 -0
- types-docker-7.0.0.20240413/docker-stubs/utils/fnmatch.pyi +5 -0
- types-docker-7.0.0.20240413/docker-stubs/utils/json_stream.pyi +10 -0
- types-docker-7.0.0.20240413/docker-stubs/utils/ports.pyi +9 -0
- types-docker-7.0.0.20240413/docker-stubs/utils/proxy.pyi +33 -0
- types-docker-7.0.0.20240413/docker-stubs/utils/socket.pyi +18 -0
- types-docker-7.0.0.20240413/docker-stubs/utils/utils.pyi +34 -0
- types-docker-7.0.0.20240413/docker-stubs/version.pyi +1 -0
- types-docker-7.0.0.20240413/setup.cfg +4 -0
- types-docker-7.0.0.20240413/setup.py +51 -0
- types-docker-7.0.0.20240413/types_docker.egg-info/PKG-INFO +37 -0
- types-docker-7.0.0.20240413/types_docker.egg-info/SOURCES.txt +76 -0
- types-docker-7.0.0.20240413/types_docker.egg-info/dependency_links.txt +1 -0
- types-docker-7.0.0.20240413/types_docker.egg-info/requires.txt +2 -0
- types-docker-7.0.0.20240413/types_docker.egg-info/top_level.txt +1 -0
|
@@ -0,0 +1 @@
|
|
|
1
|
+
include CHANGELOG.md
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
Metadata-Version: 2.1
|
|
2
|
+
Name: types-docker
|
|
3
|
+
Version: 7.0.0.20240413
|
|
4
|
+
Summary: Typing stubs for docker
|
|
5
|
+
Home-page: https://github.com/python/typeshed
|
|
6
|
+
License: Apache-2.0 license
|
|
7
|
+
Project-URL: GitHub, https://github.com/python/typeshed
|
|
8
|
+
Project-URL: Changes, https://github.com/typeshed-internal/stub_uploader/blob/main/data/changelogs/docker.md
|
|
9
|
+
Project-URL: Issue tracker, https://github.com/python/typeshed/issues
|
|
10
|
+
Project-URL: Chat, https://gitter.im/python/typing
|
|
11
|
+
Classifier: License :: OSI Approved :: Apache Software License
|
|
12
|
+
Classifier: Programming Language :: Python :: 3
|
|
13
|
+
Classifier: Typing :: Stubs Only
|
|
14
|
+
Requires-Python: >=3.8
|
|
15
|
+
Description-Content-Type: text/markdown
|
|
16
|
+
|
|
17
|
+
## Typing stubs for docker
|
|
18
|
+
|
|
19
|
+
This is a [PEP 561](https://peps.python.org/pep-0561/)
|
|
20
|
+
type stub package for the [`docker`](https://github.com/docker/docker-py) package.
|
|
21
|
+
It can be used by type-checking tools like
|
|
22
|
+
[mypy](https://github.com/python/mypy/),
|
|
23
|
+
[pyright](https://github.com/microsoft/pyright),
|
|
24
|
+
[pytype](https://github.com/google/pytype/),
|
|
25
|
+
PyCharm, etc. to check code that uses
|
|
26
|
+
`docker`.
|
|
27
|
+
|
|
28
|
+
This version of `types-docker` aims to provide accurate annotations
|
|
29
|
+
for `docker==7.0.*`.
|
|
30
|
+
The source for this package can be found at
|
|
31
|
+
https://github.com/python/typeshed/tree/main/stubs/docker. All fixes for
|
|
32
|
+
types and metadata should be contributed there.
|
|
33
|
+
|
|
34
|
+
See https://github.com/python/typeshed/blob/main/README.md for more details.
|
|
35
|
+
This package was generated from typeshed commit `b61d90c6f5dc4600055916f98c0e63deec0546e9` and was tested
|
|
36
|
+
with mypy 1.9.0, pyright 1.1.358, and
|
|
37
|
+
pytype 2024.4.11.
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
from .api import APIClient as APIClient
|
|
2
|
+
from .client import DockerClient as DockerClient, from_env as from_env
|
|
3
|
+
from .context import Context as Context, ContextAPI as ContextAPI
|
|
4
|
+
from .tls import TLSConfig as TLSConfig
|
|
5
|
+
from .version import __version__ as __version__
|
|
6
|
+
|
|
7
|
+
__title__: str
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
from .client import APIClient as APIClient
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
from _typeshed import Incomplete
|
|
2
|
+
|
|
3
|
+
log: Incomplete
|
|
4
|
+
|
|
5
|
+
class BuildApiMixin:
|
|
6
|
+
def build(
|
|
7
|
+
self,
|
|
8
|
+
path: Incomplete | None = None,
|
|
9
|
+
tag: str | None = None,
|
|
10
|
+
quiet: bool = False,
|
|
11
|
+
fileobj: Incomplete | None = None,
|
|
12
|
+
nocache: bool = False,
|
|
13
|
+
rm: bool = False,
|
|
14
|
+
timeout: Incomplete | None = None,
|
|
15
|
+
custom_context: bool = False,
|
|
16
|
+
encoding: Incomplete | None = None,
|
|
17
|
+
pull: bool = False,
|
|
18
|
+
forcerm: bool = False,
|
|
19
|
+
dockerfile: Incomplete | None = None,
|
|
20
|
+
container_limits: Incomplete | None = None,
|
|
21
|
+
decode: bool = False,
|
|
22
|
+
buildargs: Incomplete | None = None,
|
|
23
|
+
gzip: bool = False,
|
|
24
|
+
shmsize: Incomplete | None = None,
|
|
25
|
+
labels: Incomplete | None = None,
|
|
26
|
+
cache_from: Incomplete | None = None,
|
|
27
|
+
target: Incomplete | None = None,
|
|
28
|
+
network_mode: Incomplete | None = None,
|
|
29
|
+
squash: Incomplete | None = None,
|
|
30
|
+
extra_hosts: Incomplete | None = None,
|
|
31
|
+
platform: Incomplete | None = None,
|
|
32
|
+
isolation: Incomplete | None = None,
|
|
33
|
+
use_config_proxy: bool = True,
|
|
34
|
+
): ...
|
|
35
|
+
def prune_builds(
|
|
36
|
+
self, filters: Incomplete | None = None, keep_storage: Incomplete | None = None, all: Incomplete | None = None
|
|
37
|
+
): ...
|
|
38
|
+
|
|
39
|
+
def process_dockerfile(dockerfile, path): ...
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
from _typeshed import Incomplete
|
|
2
|
+
from collections.abc import Mapping, Sequence
|
|
3
|
+
|
|
4
|
+
import requests
|
|
5
|
+
from docker.tls import TLSConfig
|
|
6
|
+
from requests.adapters import BaseAdapter
|
|
7
|
+
|
|
8
|
+
from .build import BuildApiMixin
|
|
9
|
+
from .config import ConfigApiMixin
|
|
10
|
+
from .container import ContainerApiMixin
|
|
11
|
+
from .daemon import DaemonApiMixin
|
|
12
|
+
from .exec_api import ExecApiMixin
|
|
13
|
+
from .image import ImageApiMixin
|
|
14
|
+
from .network import NetworkApiMixin
|
|
15
|
+
from .plugin import PluginApiMixin
|
|
16
|
+
from .secret import SecretApiMixin
|
|
17
|
+
from .service import ServiceApiMixin
|
|
18
|
+
from .swarm import SwarmApiMixin
|
|
19
|
+
from .volume import VolumeApiMixin
|
|
20
|
+
|
|
21
|
+
class APIClient(
|
|
22
|
+
requests.Session,
|
|
23
|
+
BuildApiMixin,
|
|
24
|
+
ConfigApiMixin,
|
|
25
|
+
ContainerApiMixin,
|
|
26
|
+
DaemonApiMixin,
|
|
27
|
+
ExecApiMixin,
|
|
28
|
+
ImageApiMixin,
|
|
29
|
+
NetworkApiMixin,
|
|
30
|
+
PluginApiMixin,
|
|
31
|
+
SecretApiMixin,
|
|
32
|
+
ServiceApiMixin,
|
|
33
|
+
SwarmApiMixin,
|
|
34
|
+
VolumeApiMixin,
|
|
35
|
+
):
|
|
36
|
+
__attrs__: Sequence[str]
|
|
37
|
+
base_url: str
|
|
38
|
+
timeout: int
|
|
39
|
+
credstore_env: Mapping[Incomplete, Incomplete] | None
|
|
40
|
+
def __init__(
|
|
41
|
+
self,
|
|
42
|
+
base_url: str | None = None,
|
|
43
|
+
version: str | None = None,
|
|
44
|
+
timeout: int = 60,
|
|
45
|
+
tls: bool | TLSConfig = False,
|
|
46
|
+
user_agent: str = "docker-sdk-python/7.0.0",
|
|
47
|
+
num_pools: int | None = None,
|
|
48
|
+
credstore_env: Mapping[Incomplete, Incomplete] | None = None,
|
|
49
|
+
use_ssh_client: bool = False,
|
|
50
|
+
max_pool_size: int = 10,
|
|
51
|
+
) -> None: ...
|
|
52
|
+
def get_adapter(self, url: str) -> BaseAdapter: ...
|
|
53
|
+
@property
|
|
54
|
+
def api_version(self) -> str: ...
|
|
55
|
+
def reload_config(self, dockercfg_path: str | None = None) -> None: ...
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
from _typeshed import Incomplete
|
|
2
|
+
|
|
3
|
+
class ConfigApiMixin:
|
|
4
|
+
def create_config(self, name, data, labels: Incomplete | None = None, templating: Incomplete | None = None): ...
|
|
5
|
+
def inspect_config(self, id): ...
|
|
6
|
+
def remove_config(self, id): ...
|
|
7
|
+
def configs(self, filters: Incomplete | None = None): ...
|
|
@@ -0,0 +1,109 @@
|
|
|
1
|
+
from _typeshed import Incomplete
|
|
2
|
+
|
|
3
|
+
class ContainerApiMixin:
|
|
4
|
+
def attach(
|
|
5
|
+
self, container, stdout: bool = True, stderr: bool = True, stream: bool = False, logs: bool = False, demux: bool = False
|
|
6
|
+
): ...
|
|
7
|
+
def attach_socket(self, container, params: Incomplete | None = None, ws: bool = False): ...
|
|
8
|
+
def commit(
|
|
9
|
+
self,
|
|
10
|
+
container,
|
|
11
|
+
repository: str | None = None,
|
|
12
|
+
tag: str | None = None,
|
|
13
|
+
message: Incomplete | None = None,
|
|
14
|
+
author: Incomplete | None = None,
|
|
15
|
+
pause: bool = True,
|
|
16
|
+
changes: Incomplete | None = None,
|
|
17
|
+
conf: Incomplete | None = None,
|
|
18
|
+
): ...
|
|
19
|
+
def containers(
|
|
20
|
+
self,
|
|
21
|
+
quiet: bool = False,
|
|
22
|
+
all: bool = False,
|
|
23
|
+
trunc: bool = False,
|
|
24
|
+
latest: bool = False,
|
|
25
|
+
since: Incomplete | None = None,
|
|
26
|
+
before: Incomplete | None = None,
|
|
27
|
+
limit: int = -1,
|
|
28
|
+
size: bool = False,
|
|
29
|
+
filters: Incomplete | None = None,
|
|
30
|
+
): ...
|
|
31
|
+
def create_container(
|
|
32
|
+
self,
|
|
33
|
+
image,
|
|
34
|
+
command: Incomplete | None = None,
|
|
35
|
+
hostname: Incomplete | None = None,
|
|
36
|
+
user: Incomplete | None = None,
|
|
37
|
+
detach: bool = False,
|
|
38
|
+
stdin_open: bool = False,
|
|
39
|
+
tty: bool = False,
|
|
40
|
+
ports: Incomplete | None = None,
|
|
41
|
+
environment: Incomplete | None = None,
|
|
42
|
+
volumes: Incomplete | None = None,
|
|
43
|
+
network_disabled: bool = False,
|
|
44
|
+
name: Incomplete | None = None,
|
|
45
|
+
entrypoint: Incomplete | None = None,
|
|
46
|
+
working_dir: Incomplete | None = None,
|
|
47
|
+
domainname: Incomplete | None = None,
|
|
48
|
+
host_config: Incomplete | None = None,
|
|
49
|
+
mac_address: Incomplete | None = None,
|
|
50
|
+
labels: Incomplete | None = None,
|
|
51
|
+
stop_signal: Incomplete | None = None,
|
|
52
|
+
networking_config: Incomplete | None = None,
|
|
53
|
+
healthcheck: Incomplete | None = None,
|
|
54
|
+
stop_timeout: Incomplete | None = None,
|
|
55
|
+
runtime: Incomplete | None = None,
|
|
56
|
+
use_config_proxy: bool = True,
|
|
57
|
+
platform: Incomplete | None = None,
|
|
58
|
+
): ...
|
|
59
|
+
def create_container_config(self, *args, **kwargs): ...
|
|
60
|
+
def create_container_from_config(self, config, name: Incomplete | None = None, platform: Incomplete | None = None): ...
|
|
61
|
+
def create_host_config(self, *args, **kwargs): ...
|
|
62
|
+
def create_networking_config(self, *args, **kwargs): ...
|
|
63
|
+
def create_endpoint_config(self, *args, **kwargs): ...
|
|
64
|
+
def diff(self, container): ...
|
|
65
|
+
def export(self, container, chunk_size=2097152): ...
|
|
66
|
+
def get_archive(self, container, path, chunk_size=2097152, encode_stream: bool = False): ...
|
|
67
|
+
def inspect_container(self, container): ...
|
|
68
|
+
def kill(self, container, signal: Incomplete | None = None) -> None: ...
|
|
69
|
+
def logs(
|
|
70
|
+
self,
|
|
71
|
+
container,
|
|
72
|
+
stdout: bool = True,
|
|
73
|
+
stderr: bool = True,
|
|
74
|
+
stream: bool = False,
|
|
75
|
+
timestamps: bool = False,
|
|
76
|
+
tail: str = "all",
|
|
77
|
+
since: Incomplete | None = None,
|
|
78
|
+
follow: Incomplete | None = None,
|
|
79
|
+
until: Incomplete | None = None,
|
|
80
|
+
): ...
|
|
81
|
+
def pause(self, container) -> None: ...
|
|
82
|
+
def port(self, container, private_port): ...
|
|
83
|
+
def put_archive(self, container, path, data): ...
|
|
84
|
+
def prune_containers(self, filters: Incomplete | None = None): ...
|
|
85
|
+
def remove_container(self, container, v: bool = False, link: bool = False, force: bool = False) -> None: ...
|
|
86
|
+
def rename(self, container, name) -> None: ...
|
|
87
|
+
def resize(self, container, height, width) -> None: ...
|
|
88
|
+
def restart(self, container, timeout: int = 10) -> None: ...
|
|
89
|
+
def start(self, container, *args, **kwargs) -> None: ...
|
|
90
|
+
def stats(self, container, decode: Incomplete | None = None, stream: bool = True, one_shot: Incomplete | None = None): ...
|
|
91
|
+
def stop(self, container, timeout: Incomplete | None = None) -> None: ...
|
|
92
|
+
def top(self, container, ps_args: Incomplete | None = None): ...
|
|
93
|
+
def unpause(self, container) -> None: ...
|
|
94
|
+
def update_container(
|
|
95
|
+
self,
|
|
96
|
+
container,
|
|
97
|
+
blkio_weight: Incomplete | None = None,
|
|
98
|
+
cpu_period: Incomplete | None = None,
|
|
99
|
+
cpu_quota: Incomplete | None = None,
|
|
100
|
+
cpu_shares: Incomplete | None = None,
|
|
101
|
+
cpuset_cpus: Incomplete | None = None,
|
|
102
|
+
cpuset_mems: Incomplete | None = None,
|
|
103
|
+
mem_limit: Incomplete | None = None,
|
|
104
|
+
mem_reservation: Incomplete | None = None,
|
|
105
|
+
memswap_limit: Incomplete | None = None,
|
|
106
|
+
kernel_memory: Incomplete | None = None,
|
|
107
|
+
restart_policy: Incomplete | None = None,
|
|
108
|
+
): ...
|
|
109
|
+
def wait(self, container, timeout: Incomplete | None = None, condition: Incomplete | None = None): ...
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
from _typeshed import Incomplete
|
|
2
|
+
|
|
3
|
+
class DaemonApiMixin:
|
|
4
|
+
def df(self): ...
|
|
5
|
+
def events(
|
|
6
|
+
self,
|
|
7
|
+
since: Incomplete | None = None,
|
|
8
|
+
until: Incomplete | None = None,
|
|
9
|
+
filters: Incomplete | None = None,
|
|
10
|
+
decode: Incomplete | None = None,
|
|
11
|
+
): ...
|
|
12
|
+
def info(self): ...
|
|
13
|
+
def login(
|
|
14
|
+
self,
|
|
15
|
+
username,
|
|
16
|
+
password: Incomplete | None = None,
|
|
17
|
+
email: Incomplete | None = None,
|
|
18
|
+
registry: Incomplete | None = None,
|
|
19
|
+
reauth: bool = False,
|
|
20
|
+
dockercfg_path: Incomplete | None = None,
|
|
21
|
+
): ...
|
|
22
|
+
def ping(self): ...
|
|
23
|
+
def version(self, api_version: bool = True): ...
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
from _typeshed import Incomplete
|
|
2
|
+
|
|
3
|
+
class ExecApiMixin:
|
|
4
|
+
def exec_create(
|
|
5
|
+
self,
|
|
6
|
+
container,
|
|
7
|
+
cmd,
|
|
8
|
+
stdout: bool = True,
|
|
9
|
+
stderr: bool = True,
|
|
10
|
+
stdin: bool = False,
|
|
11
|
+
tty: bool = False,
|
|
12
|
+
privileged: bool = False,
|
|
13
|
+
user: str = "",
|
|
14
|
+
environment: Incomplete | None = None,
|
|
15
|
+
workdir: Incomplete | None = None,
|
|
16
|
+
detach_keys: Incomplete | None = None,
|
|
17
|
+
): ...
|
|
18
|
+
def exec_inspect(self, exec_id): ...
|
|
19
|
+
def exec_resize(self, exec_id, height: Incomplete | None = None, width: Incomplete | None = None) -> None: ...
|
|
20
|
+
def exec_start(
|
|
21
|
+
self, exec_id, detach: bool = False, tty: bool = False, stream: bool = False, socket: bool = False, demux: bool = False
|
|
22
|
+
): ...
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
from _typeshed import Incomplete
|
|
2
|
+
|
|
3
|
+
log: Incomplete
|
|
4
|
+
|
|
5
|
+
class ImageApiMixin:
|
|
6
|
+
def get_image(self, image: str, chunk_size: int = 2097152): ...
|
|
7
|
+
def history(self, image): ...
|
|
8
|
+
def images(self, name: str | None = None, quiet: bool = False, all: bool = False, filters: Incomplete | None = None): ...
|
|
9
|
+
def import_image(
|
|
10
|
+
self,
|
|
11
|
+
src: Incomplete | None = None,
|
|
12
|
+
repository: str | None = None,
|
|
13
|
+
tag: str | None = None,
|
|
14
|
+
image: str | None = None,
|
|
15
|
+
changes: Incomplete | None = None,
|
|
16
|
+
stream_src: bool = False,
|
|
17
|
+
): ...
|
|
18
|
+
def import_image_from_data(
|
|
19
|
+
self, data, repository: str | None = None, tag: str | None = None, changes: Incomplete | None = None
|
|
20
|
+
): ...
|
|
21
|
+
def import_image_from_file(
|
|
22
|
+
self, filename: str, repository: str | None = None, tag: str | None = None, changes: Incomplete | None = None
|
|
23
|
+
): ...
|
|
24
|
+
def import_image_from_stream(
|
|
25
|
+
self, stream, repository: str | None = None, tag: str | None = None, changes: Incomplete | None = None
|
|
26
|
+
): ...
|
|
27
|
+
def import_image_from_url(
|
|
28
|
+
self, url, repository: str | None = None, tag: str | None = None, changes: Incomplete | None = None
|
|
29
|
+
): ...
|
|
30
|
+
def import_image_from_image(
|
|
31
|
+
self, image, repository: str | None = None, tag: str | None = None, changes: Incomplete | None = None
|
|
32
|
+
): ...
|
|
33
|
+
def inspect_image(self, image): ...
|
|
34
|
+
def inspect_distribution(self, image, auth_config: Incomplete | None = None): ...
|
|
35
|
+
def load_image(self, data, quiet: Incomplete | None = None): ...
|
|
36
|
+
def prune_images(self, filters: Incomplete | None = None): ...
|
|
37
|
+
def pull(
|
|
38
|
+
self,
|
|
39
|
+
repository: str,
|
|
40
|
+
tag: str | None = None,
|
|
41
|
+
stream: bool = False,
|
|
42
|
+
auth_config: Incomplete | None = None,
|
|
43
|
+
decode: bool = False,
|
|
44
|
+
platform: Incomplete | None = None,
|
|
45
|
+
all_tags: bool = False,
|
|
46
|
+
): ...
|
|
47
|
+
def push(
|
|
48
|
+
self,
|
|
49
|
+
repository: str,
|
|
50
|
+
tag: str | None = None,
|
|
51
|
+
stream: bool = False,
|
|
52
|
+
auth_config: Incomplete | None = None,
|
|
53
|
+
decode: bool = False,
|
|
54
|
+
): ...
|
|
55
|
+
def remove_image(self, image: str, force: bool = False, noprune: bool = False): ...
|
|
56
|
+
def search(self, term: str, limit: int | None = None): ...
|
|
57
|
+
def tag(self, image, repository, tag: str | None = None, force: bool = False): ...
|
|
58
|
+
|
|
59
|
+
def is_file(src: str) -> bool: ...
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
from _typeshed import Incomplete
|
|
2
|
+
|
|
3
|
+
class NetworkApiMixin:
|
|
4
|
+
def networks(self, names: Incomplete | None = None, ids: Incomplete | None = None, filters: Incomplete | None = None): ...
|
|
5
|
+
def create_network(
|
|
6
|
+
self,
|
|
7
|
+
name,
|
|
8
|
+
driver: Incomplete | None = None,
|
|
9
|
+
options: Incomplete | None = None,
|
|
10
|
+
ipam: Incomplete | None = None,
|
|
11
|
+
check_duplicate: Incomplete | None = None,
|
|
12
|
+
internal: bool = False,
|
|
13
|
+
labels: Incomplete | None = None,
|
|
14
|
+
enable_ipv6: bool = False,
|
|
15
|
+
attachable: Incomplete | None = None,
|
|
16
|
+
scope: Incomplete | None = None,
|
|
17
|
+
ingress: Incomplete | None = None,
|
|
18
|
+
): ...
|
|
19
|
+
def prune_networks(self, filters: Incomplete | None = None): ...
|
|
20
|
+
def remove_network(self, net_id) -> None: ...
|
|
21
|
+
def inspect_network(self, net_id, verbose: Incomplete | None = None, scope: Incomplete | None = None): ...
|
|
22
|
+
def connect_container_to_network(
|
|
23
|
+
self,
|
|
24
|
+
container,
|
|
25
|
+
net_id,
|
|
26
|
+
ipv4_address: Incomplete | None = None,
|
|
27
|
+
ipv6_address: Incomplete | None = None,
|
|
28
|
+
aliases: Incomplete | None = None,
|
|
29
|
+
links: Incomplete | None = None,
|
|
30
|
+
link_local_ips: Incomplete | None = None,
|
|
31
|
+
driver_opt: Incomplete | None = None,
|
|
32
|
+
mac_address: Incomplete | None = None,
|
|
33
|
+
) -> None: ...
|
|
34
|
+
def disconnect_container_from_network(self, container, net_id, force: bool = False) -> None: ...
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
from _typeshed import Incomplete
|
|
2
|
+
|
|
3
|
+
class PluginApiMixin:
|
|
4
|
+
def configure_plugin(self, name, options): ...
|
|
5
|
+
def create_plugin(self, name, plugin_data_dir, gzip: bool = False): ...
|
|
6
|
+
def disable_plugin(self, name, force: bool = False): ...
|
|
7
|
+
def enable_plugin(self, name, timeout: int = 0): ...
|
|
8
|
+
def inspect_plugin(self, name): ...
|
|
9
|
+
def pull_plugin(self, remote, privileges, name: Incomplete | None = None): ...
|
|
10
|
+
def plugins(self): ...
|
|
11
|
+
def plugin_privileges(self, name): ...
|
|
12
|
+
def push_plugin(self, name): ...
|
|
13
|
+
def remove_plugin(self, name, force: bool = False): ...
|
|
14
|
+
def upgrade_plugin(self, name, remote, privileges): ...
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
from _typeshed import Incomplete
|
|
2
|
+
|
|
3
|
+
class SecretApiMixin:
|
|
4
|
+
def create_secret(self, name, data, labels: Incomplete | None = None, driver: Incomplete | None = None): ...
|
|
5
|
+
def inspect_secret(self, id): ...
|
|
6
|
+
def remove_secret(self, id): ...
|
|
7
|
+
def secrets(self, filters: Incomplete | None = None): ...
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
from _typeshed import Incomplete
|
|
2
|
+
|
|
3
|
+
class ServiceApiMixin:
|
|
4
|
+
def create_service(
|
|
5
|
+
self,
|
|
6
|
+
task_template,
|
|
7
|
+
name: Incomplete | None = None,
|
|
8
|
+
labels: Incomplete | None = None,
|
|
9
|
+
mode: Incomplete | None = None,
|
|
10
|
+
update_config: Incomplete | None = None,
|
|
11
|
+
networks: Incomplete | None = None,
|
|
12
|
+
endpoint_config: Incomplete | None = None,
|
|
13
|
+
endpoint_spec: Incomplete | None = None,
|
|
14
|
+
rollback_config: Incomplete | None = None,
|
|
15
|
+
): ...
|
|
16
|
+
def inspect_service(self, service, insert_defaults: Incomplete | None = None): ...
|
|
17
|
+
def inspect_task(self, task): ...
|
|
18
|
+
def remove_service(self, service): ...
|
|
19
|
+
def services(self, filters: Incomplete | None = None, status: Incomplete | None = None): ...
|
|
20
|
+
def service_logs(
|
|
21
|
+
self,
|
|
22
|
+
service,
|
|
23
|
+
details: bool = False,
|
|
24
|
+
follow: bool = False,
|
|
25
|
+
stdout: bool = False,
|
|
26
|
+
stderr: bool = False,
|
|
27
|
+
since: int = 0,
|
|
28
|
+
timestamps: bool = False,
|
|
29
|
+
tail: str = "all",
|
|
30
|
+
is_tty: Incomplete | None = None,
|
|
31
|
+
): ...
|
|
32
|
+
def tasks(self, filters: Incomplete | None = None): ...
|
|
33
|
+
def update_service(
|
|
34
|
+
self,
|
|
35
|
+
service,
|
|
36
|
+
version,
|
|
37
|
+
task_template: Incomplete | None = None,
|
|
38
|
+
name: Incomplete | None = None,
|
|
39
|
+
labels: Incomplete | None = None,
|
|
40
|
+
mode: Incomplete | None = None,
|
|
41
|
+
update_config: Incomplete | None = None,
|
|
42
|
+
networks: Incomplete | None = None,
|
|
43
|
+
endpoint_config: Incomplete | None = None,
|
|
44
|
+
endpoint_spec: Incomplete | None = None,
|
|
45
|
+
fetch_current_spec: bool = False,
|
|
46
|
+
rollback_config: Incomplete | None = None,
|
|
47
|
+
): ...
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
from _typeshed import Incomplete
|
|
2
|
+
|
|
3
|
+
log: Incomplete
|
|
4
|
+
|
|
5
|
+
class SwarmApiMixin:
|
|
6
|
+
def create_swarm_spec(self, *args, **kwargs): ...
|
|
7
|
+
def get_unlock_key(self): ...
|
|
8
|
+
def init_swarm(
|
|
9
|
+
self,
|
|
10
|
+
advertise_addr: Incomplete | None = None,
|
|
11
|
+
listen_addr: str = "0.0.0.0:2377",
|
|
12
|
+
force_new_cluster: bool = False,
|
|
13
|
+
swarm_spec: Incomplete | None = None,
|
|
14
|
+
default_addr_pool: Incomplete | None = None,
|
|
15
|
+
subnet_size: Incomplete | None = None,
|
|
16
|
+
data_path_addr: Incomplete | None = None,
|
|
17
|
+
data_path_port: Incomplete | None = None,
|
|
18
|
+
): ...
|
|
19
|
+
def inspect_swarm(self): ...
|
|
20
|
+
def inspect_node(self, node_id): ...
|
|
21
|
+
def join_swarm(
|
|
22
|
+
self,
|
|
23
|
+
remote_addrs,
|
|
24
|
+
join_token,
|
|
25
|
+
listen_addr: str = "0.0.0.0:2377",
|
|
26
|
+
advertise_addr: Incomplete | None = None,
|
|
27
|
+
data_path_addr: Incomplete | None = None,
|
|
28
|
+
): ...
|
|
29
|
+
def leave_swarm(self, force: bool = False): ...
|
|
30
|
+
def nodes(self, filters: Incomplete | None = None): ...
|
|
31
|
+
def remove_node(self, node_id, force: bool = False): ...
|
|
32
|
+
def unlock_swarm(self, key): ...
|
|
33
|
+
def update_node(self, node_id, version, node_spec: Incomplete | None = None): ...
|
|
34
|
+
def update_swarm(
|
|
35
|
+
self,
|
|
36
|
+
version,
|
|
37
|
+
swarm_spec: Incomplete | None = None,
|
|
38
|
+
rotate_worker_token: bool = False,
|
|
39
|
+
rotate_manager_token: bool = False,
|
|
40
|
+
rotate_manager_unlock_key: bool = False,
|
|
41
|
+
): ...
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
from _typeshed import Incomplete
|
|
2
|
+
|
|
3
|
+
class VolumeApiMixin:
|
|
4
|
+
def volumes(self, filters: Incomplete | None = None): ...
|
|
5
|
+
def create_volume(
|
|
6
|
+
self,
|
|
7
|
+
name: Incomplete | None = None,
|
|
8
|
+
driver: Incomplete | None = None,
|
|
9
|
+
driver_opts: Incomplete | None = None,
|
|
10
|
+
labels: Incomplete | None = None,
|
|
11
|
+
): ...
|
|
12
|
+
def inspect_volume(self, name): ...
|
|
13
|
+
def prune_volumes(self, filters: Incomplete | None = None): ...
|
|
14
|
+
def remove_volume(self, name, force: bool = False) -> None: ...
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
from _typeshed import Incomplete
|
|
2
|
+
|
|
3
|
+
INDEX_NAME: str
|
|
4
|
+
INDEX_URL: Incomplete
|
|
5
|
+
TOKEN_USERNAME: str
|
|
6
|
+
log: Incomplete
|
|
7
|
+
|
|
8
|
+
def resolve_repository_name(repo_name): ...
|
|
9
|
+
def resolve_index_name(index_name): ...
|
|
10
|
+
def get_config_header(client, registry): ...
|
|
11
|
+
def split_repo_name(repo_name): ...
|
|
12
|
+
def get_credential_store(authconfig, registry): ...
|
|
13
|
+
|
|
14
|
+
class AuthConfig(dict[str, Incomplete]):
|
|
15
|
+
def __init__(self, dct, credstore_env: Incomplete | None = None) -> None: ...
|
|
16
|
+
@classmethod
|
|
17
|
+
def parse_auth(cls, entries, raise_on_error: bool = False): ...
|
|
18
|
+
@classmethod
|
|
19
|
+
def load_config(cls, config_path, config_dict, credstore_env: Incomplete | None = None): ...
|
|
20
|
+
@property
|
|
21
|
+
def auths(self): ...
|
|
22
|
+
@property
|
|
23
|
+
def creds_store(self): ...
|
|
24
|
+
@property
|
|
25
|
+
def cred_helpers(self): ...
|
|
26
|
+
@property
|
|
27
|
+
def is_empty(self): ...
|
|
28
|
+
def resolve_authconfig(self, registry: Incomplete | None = None): ...
|
|
29
|
+
def get_credential_store(self, registry): ...
|
|
30
|
+
def get_all_credentials(self): ...
|
|
31
|
+
def add_auth(self, reg, data) -> None: ...
|
|
32
|
+
|
|
33
|
+
def resolve_authconfig(authconfig, registry: Incomplete | None = None, credstore_env: Incomplete | None = None): ...
|
|
34
|
+
def convert_to_hostname(url): ...
|
|
35
|
+
def decode_auth(auth): ...
|
|
36
|
+
def encode_header(auth): ...
|
|
37
|
+
def parse_auth(entries, raise_on_error: bool = False): ...
|
|
38
|
+
def load_config(
|
|
39
|
+
config_path: Incomplete | None = None, config_dict: Incomplete | None = None, credstore_env: Incomplete | None = None
|
|
40
|
+
): ...
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
from typing import NoReturn
|
|
2
|
+
|
|
3
|
+
from docker import APIClient
|
|
4
|
+
from docker.models.configs import ConfigCollection
|
|
5
|
+
from docker.models.containers import ContainerCollection
|
|
6
|
+
from docker.models.images import ImageCollection
|
|
7
|
+
from docker.models.networks import NetworkCollection
|
|
8
|
+
from docker.models.nodes import NodeCollection
|
|
9
|
+
from docker.models.plugins import PluginCollection
|
|
10
|
+
from docker.models.secrets import SecretCollection
|
|
11
|
+
from docker.models.services import ServiceCollection
|
|
12
|
+
from docker.models.swarm import Swarm
|
|
13
|
+
from docker.models.volumes import VolumeCollection
|
|
14
|
+
|
|
15
|
+
class DockerClient:
|
|
16
|
+
api: APIClient
|
|
17
|
+
def __init__(self, *args, **kwargs) -> None: ...
|
|
18
|
+
@classmethod
|
|
19
|
+
def from_env(cls, **kwargs) -> DockerClient: ...
|
|
20
|
+
@property
|
|
21
|
+
def configs(self) -> ConfigCollection: ...
|
|
22
|
+
@property
|
|
23
|
+
def containers(self) -> ContainerCollection: ...
|
|
24
|
+
@property
|
|
25
|
+
def images(self) -> ImageCollection: ...
|
|
26
|
+
@property
|
|
27
|
+
def networks(self) -> NetworkCollection: ...
|
|
28
|
+
@property
|
|
29
|
+
def nodes(self) -> NodeCollection: ...
|
|
30
|
+
@property
|
|
31
|
+
def plugins(self) -> PluginCollection: ...
|
|
32
|
+
@property
|
|
33
|
+
def secrets(self) -> SecretCollection: ...
|
|
34
|
+
@property
|
|
35
|
+
def services(self) -> ServiceCollection: ...
|
|
36
|
+
@property
|
|
37
|
+
def swarm(self) -> Swarm: ...
|
|
38
|
+
@property
|
|
39
|
+
def volumes(self) -> VolumeCollection: ...
|
|
40
|
+
def events(self, *args, **kwargs): ...
|
|
41
|
+
def df(self): ...
|
|
42
|
+
def info(self, *args, **kwargs): ...
|
|
43
|
+
def login(self, *args, **kwargs): ...
|
|
44
|
+
def ping(self, *args, **kwargs): ...
|
|
45
|
+
def version(self, *args, **kwargs): ...
|
|
46
|
+
def close(self): ...
|
|
47
|
+
def __getattr__(self, name: str) -> NoReturn: ...
|
|
48
|
+
|
|
49
|
+
from_env = DockerClient.from_env
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
from collections.abc import Mapping, Sequence
|
|
2
|
+
from typing import Final
|
|
3
|
+
|
|
4
|
+
DEFAULT_DOCKER_API_VERSION: Final[str]
|
|
5
|
+
MINIMUM_DOCKER_API_VERSION: Final[str]
|
|
6
|
+
DEFAULT_TIMEOUT_SECONDS: Final[int]
|
|
7
|
+
STREAM_HEADER_SIZE_BYTES: Final[int]
|
|
8
|
+
CONTAINER_LIMITS_KEYS: Final[Sequence[str]]
|
|
9
|
+
DEFAULT_HTTP_HOST: Final[str]
|
|
10
|
+
DEFAULT_UNIX_SOCKET: Final[str]
|
|
11
|
+
DEFAULT_NPIPE: Final[str]
|
|
12
|
+
BYTE_UNITS: Final[Mapping[str, int]]
|
|
13
|
+
INSECURE_REGISTRY_DEPRECATION_WARNING: Final[str]
|
|
14
|
+
IS_WINDOWS_PLATFORM: Final[bool]
|
|
15
|
+
WINDOWS_LONGPATH_PREFIX: Final[str]
|
|
16
|
+
DEFAULT_USER_AGENT: Final[str]
|
|
17
|
+
DEFAULT_NUM_POOLS: Final[int]
|
|
18
|
+
DEFAULT_NUM_POOLS_SSH: Final[int]
|
|
19
|
+
DEFAULT_MAX_POOL_SIZE: Final[int]
|
|
20
|
+
DEFAULT_DATA_CHUNK_SIZE: Final[int]
|
|
21
|
+
DEFAULT_SWARM_ADDR_POOL: Final[Sequence[str]]
|
|
22
|
+
DEFAULT_SWARM_SUBNET_SIZE: Final[int]
|