Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion docker/api/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,7 @@ def _attach_params(self, override=None):
'stream': 1
}

@check_resource
@check_resource('container')
def _attach_websocket(self, container, params=None):
url = self._url("/containers/{0}/attach/ws", container)
req = requests.Request("POST", url, params=self._attach_params(params))
Expand Down
48 changes: 24 additions & 24 deletions docker/api/container.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@


class ContainerApiMixin(object):
@utils.check_resource
@utils.check_resource('container')
def attach(self, container, stdout=True, stderr=True,
stream=False, logs=False):
"""
Expand Down Expand Up @@ -54,7 +54,7 @@ def attach(self, container, stdout=True, stderr=True,

return self._read_from_socket(response, stream)

@utils.check_resource
@utils.check_resource('container')
def attach_socket(self, container, params=None, ws=False):
"""
Like ``attach``, but returns the underlying socket-like object for the
Expand Down Expand Up @@ -93,7 +93,7 @@ def attach_socket(self, container, params=None, ws=False):
)
)

@utils.check_resource
@utils.check_resource('container')
def commit(self, container, repository=None, tag=None, message=None,
author=None, changes=None, conf=None):
"""
Expand Down Expand Up @@ -195,7 +195,7 @@ def containers(self, quiet=False, all=False, trunc=False, latest=False,
x['Id'] = x['Id'][:12]
return res

@utils.check_resource
@utils.check_resource('container')
def copy(self, container, resource):
"""
Identical to the ``docker cp`` command. Get files/folders from the
Expand Down Expand Up @@ -659,7 +659,7 @@ def create_endpoint_config(self, *args, **kwargs):
"""
return EndpointConfig(self._version, *args, **kwargs)

@utils.check_resource
@utils.check_resource('container')
def diff(self, container):
"""
Inspect changes on a container's filesystem.
Expand All @@ -678,7 +678,7 @@ def diff(self, container):
self._get(self._url("/containers/{0}/changes", container)), True
)

@utils.check_resource
@utils.check_resource('container')
def export(self, container):
"""
Export the contents of a filesystem as a tar archive.
Expand All @@ -699,7 +699,7 @@ def export(self, container):
self._raise_for_status(res)
return res.raw

@utils.check_resource
@utils.check_resource('container')
@utils.minimum_version('1.20')
def get_archive(self, container, path):
"""
Expand Down Expand Up @@ -730,7 +730,7 @@ def get_archive(self, container, path):
utils.decode_json_header(encoded_stat) if encoded_stat else None
)

@utils.check_resource
@utils.check_resource('container')
def inspect_container(self, container):
"""
Identical to the `docker inspect` command, but only for containers.
Expand All @@ -750,7 +750,7 @@ def inspect_container(self, container):
self._get(self._url("/containers/{0}/json", container)), True
)

@utils.check_resource
@utils.check_resource('container')
def kill(self, container, signal=None):
"""
Kill a container or send a signal to a container.
Expand All @@ -773,7 +773,7 @@ def kill(self, container, signal=None):

self._raise_for_status(res)

@utils.check_resource
@utils.check_resource('container')
def logs(self, container, stdout=True, stderr=True, stream=False,
timestamps=False, tail='all', since=None, follow=None):
"""
Expand Down Expand Up @@ -836,7 +836,7 @@ def logs(self, container, stdout=True, stderr=True, stream=False,
logs=True
)

@utils.check_resource
@utils.check_resource('container')
def pause(self, container):
"""
Pauses all processes within a container.
Expand All @@ -852,7 +852,7 @@ def pause(self, container):
res = self._post(url)
self._raise_for_status(res)

@utils.check_resource
@utils.check_resource('container')
def port(self, container, private_port):
"""
Lookup the public-facing port that is NAT-ed to ``private_port``.
Expand Down Expand Up @@ -901,7 +901,7 @@ def port(self, container, private_port):

return h_ports

@utils.check_resource
@utils.check_resource('container')
@utils.minimum_version('1.20')
def put_archive(self, container, path, data):
"""
Expand Down Expand Up @@ -949,7 +949,7 @@ def prune_containers(self, filters=None):
url = self._url('/containers/prune')
return self._result(self._post(url, params=params), True)

@utils.check_resource
@utils.check_resource('container')
def remove_container(self, container, v=False, link=False, force=False):
"""
Remove a container. Similar to the ``docker rm`` command.
Expand All @@ -973,7 +973,7 @@ def remove_container(self, container, v=False, link=False, force=False):
self._raise_for_status(res)

@utils.minimum_version('1.17')
@utils.check_resource
@utils.check_resource('container')
def rename(self, container, name):
"""
Rename a container. Similar to the ``docker rename`` command.
Expand All @@ -991,7 +991,7 @@ def rename(self, container, name):
res = self._post(url, params=params)
self._raise_for_status(res)

@utils.check_resource
@utils.check_resource('container')
def resize(self, container, height, width):
"""
Resize the tty session.
Expand All @@ -1010,7 +1010,7 @@ def resize(self, container, height, width):
res = self._post(url, params=params)
self._raise_for_status(res)

@utils.check_resource
@utils.check_resource('container')
def restart(self, container, timeout=10):
"""
Restart a container. Similar to the ``docker restart`` command.
Expand All @@ -1031,7 +1031,7 @@ def restart(self, container, timeout=10):
res = self._post(url, params=params)
self._raise_for_status(res)

@utils.check_resource
@utils.check_resource('container')
def start(self, container, *args, **kwargs):
"""
Start a container. Similar to the ``docker start`` command, but
Expand Down Expand Up @@ -1070,7 +1070,7 @@ def start(self, container, *args, **kwargs):
self._raise_for_status(res)

@utils.minimum_version('1.17')
@utils.check_resource
@utils.check_resource('container')
def stats(self, container, decode=None, stream=True):
"""
Stream statistics for a specific container. Similar to the
Expand All @@ -1096,7 +1096,7 @@ def stats(self, container, decode=None, stream=True):
return self._result(self._get(url, params={'stream': False}),
json=True)

@utils.check_resource
@utils.check_resource('container')
def stop(self, container, timeout=10):
"""
Stops a container. Similar to the ``docker stop`` command.
Expand All @@ -1117,7 +1117,7 @@ def stop(self, container, timeout=10):
timeout=(timeout + (self.timeout or 0)))
self._raise_for_status(res)

@utils.check_resource
@utils.check_resource('container')
def top(self, container, ps_args=None):
"""
Display the running processes of a container.
Expand All @@ -1139,7 +1139,7 @@ def top(self, container, ps_args=None):
params['ps_args'] = ps_args
return self._result(self._get(u, params=params), True)

@utils.check_resource
@utils.check_resource('container')
def unpause(self, container):
"""
Unpause all processes within a container.
Expand All @@ -1152,7 +1152,7 @@ def unpause(self, container):
self._raise_for_status(res)

@utils.minimum_version('1.22')
@utils.check_resource
@utils.check_resource('container')
def update_container(
self, container, blkio_weight=None, cpu_period=None, cpu_quota=None,
cpu_shares=None, cpuset_cpus=None, cpuset_mems=None, mem_limit=None,
Expand Down Expand Up @@ -1217,7 +1217,7 @@ def update_container(
res = self._post_json(url, data=data)
return self._result(res, True)

@utils.check_resource
@utils.check_resource('container')
def wait(self, container, timeout=None):
"""
Block until a container stops, then return its exit code. Similar to
Expand Down
4 changes: 2 additions & 2 deletions docker/api/exec_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

class ExecApiMixin(object):
@utils.minimum_version('1.15')
@utils.check_resource
@utils.check_resource('container')
def exec_create(self, container, cmd, stdout=True, stderr=True,
stdin=False, tty=False, privileged=False, user='',
environment=None):
Expand Down Expand Up @@ -110,7 +110,7 @@ def exec_resize(self, exec_id, height=None, width=None):
self._raise_for_status(res)

@utils.minimum_version('1.15')
@utils.check_resource
@utils.check_resource('exec_id')
def exec_start(self, exec_id, detach=False, tty=False, stream=False,
socket=False):
"""
Expand Down
12 changes: 6 additions & 6 deletions docker/api/image.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

class ImageApiMixin(object):

@utils.check_resource
@utils.check_resource('image')
def get_image(self, image):
"""
Get a tarball of an image. Similar to the ``docker save`` command.
Expand All @@ -39,7 +39,7 @@ def get_image(self, image):
self._raise_for_status(res)
return res.raw

@utils.check_resource
@utils.check_resource('image')
def history(self, image):
"""
Show the history of an image.
Expand Down Expand Up @@ -228,7 +228,7 @@ def import_image_from_image(self, image, repository=None, tag=None,
image=image, repository=repository, tag=tag, changes=changes
)

@utils.check_resource
@utils.check_resource('image')
def insert(self, image, url, path):
if utils.compare_version('1.12', self._version) >= 0:
raise errors.DeprecatedMethod(
Expand All @@ -241,7 +241,7 @@ def insert(self, image, url, path):
}
return self._result(self._post(api_url, params=params))

@utils.check_resource
@utils.check_resource('image')
def inspect_image(self, image):
"""
Get detailed information about an image. Similar to the ``docker
Expand Down Expand Up @@ -443,7 +443,7 @@ def push(self, repository, tag=None, stream=False,

return self._result(response)

@utils.check_resource
@utils.check_resource('image')
def remove_image(self, image, force=False, noprune=False):
"""
Remove an image. Similar to the ``docker rmi`` command.
Expand Down Expand Up @@ -477,7 +477,7 @@ def search(self, term):
True
)

@utils.check_resource
@utils.check_resource('image')
def tag(self, image, repository, tag=None, force=False):
"""
Tag an image into a repository. Similar to the ``docker tag`` command.
Expand Down
6 changes: 4 additions & 2 deletions docker/api/network.py
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,7 @@ def prune_networks(self, filters=None):
return self._result(self._post(url, params=params), True)

@minimum_version('1.21')
@check_resource('net_id')
def remove_network(self, net_id):
"""
Remove a network. Similar to the ``docker network rm`` command.
Expand All @@ -168,6 +169,7 @@ def remove_network(self, net_id):
self._raise_for_status(res)

@minimum_version('1.21')
@check_resource('net_id')
def inspect_network(self, net_id, verbose=None):
"""
Get detailed information about a network.
Expand All @@ -187,7 +189,7 @@ def inspect_network(self, net_id, verbose=None):
res = self._get(url, params=params)
return self._result(res, json=True)

@check_resource
@check_resource('image')
@minimum_version('1.21')
def connect_container_to_network(self, container, net_id,
ipv4_address=None, ipv6_address=None,
Expand Down Expand Up @@ -224,7 +226,7 @@ def connect_container_to_network(self, container, net_id,
res = self._post_json(url, data=data)
self._raise_for_status(res)

@check_resource
@check_resource('image')
@minimum_version('1.21')
def disconnect_container_from_network(self, container, net_id,
force=False):
Expand Down
8 changes: 4 additions & 4 deletions docker/api/plugin.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

class PluginApiMixin(object):
@utils.minimum_version('1.25')
@utils.check_resource
@utils.check_resource('name')
def configure_plugin(self, name, options):
"""
Configure a plugin.
Expand Down Expand Up @@ -171,7 +171,7 @@ def plugin_privileges(self, name):
return self._result(self._get(url, params=params), True)

@utils.minimum_version('1.25')
@utils.check_resource
@utils.check_resource('name')
def push_plugin(self, name):
"""
Push a plugin to the registry.
Expand All @@ -195,7 +195,7 @@ def push_plugin(self, name):
return self._stream_helper(res, decode=True)

@utils.minimum_version('1.25')
@utils.check_resource
@utils.check_resource('name')
def remove_plugin(self, name, force=False):
"""
Remove an installed plugin.
Expand All @@ -215,7 +215,7 @@ def remove_plugin(self, name, force=False):
return True

@utils.minimum_version('1.26')
@utils.check_resource
@utils.check_resource('name')
def upgrade_plugin(self, name, remote, privileges):
"""
Upgrade an installed plugin.
Expand Down
4 changes: 2 additions & 2 deletions docker/api/secret.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ def create_secret(self, name, data, labels=None):
)

@utils.minimum_version('1.25')
@utils.check_resource
@utils.check_resource('id')
def inspect_secret(self, id):
"""
Retrieve secret metadata
Expand All @@ -54,7 +54,7 @@ def inspect_secret(self, id):
return self._result(self._get(url), True)

@utils.minimum_version('1.25')
@utils.check_resource
@utils.check_resource('id')
def remove_secret(self, id):
"""
Remove a secret
Expand Down
Loading