docker
/
docker-py
mirror of https://github.com/docker/docker-py.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix for #1815: make APIClient.stop honor container StopTimeout value 

Signed-off-by: Damien Nadé <anvil.github@livna.org>
This commit is contained in:
Damien Nadé 2017-11-20 16:47:36 +01:00 committed by Damien Nadé
parent 1d6b5b2032
commit f3dbd017f8
1 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docker/api/container.py
View File

@ -1112,19 +1112,25 @@ class ContainerApiMixin(object):
json=True) json=True)
@utils.check_resource('container') @utils.check_resource('container')
def stop(self, container, timeout=10): def stop(self, container, timeout=None):
""" """
Stops a container. Similar to the ``docker stop`` command. Stops a container. Similar to the ``docker stop`` command.
Args: Args:
container (str): The container to stop container (str): The container to stop
timeout (int): Timeout in seconds to wait for the container to timeout (int): Timeout in seconds to wait for the container to
stop before sending a ``SIGKILL``. Default: 10 stop before sending a ``SIGKILL``. If None, then the
StopTimeout value of the container will be used.
Default: None
Raises: Raises:
:py:class:`docker.errors.APIError` :py:class:`docker.errors.APIError`
If the server returns an error. If the server returns an error.
""" """
if timeout is None:
params = {}
timeout = 10
else:
params = {'t': timeout} params = {'t': timeout}
url = self._url("/containers/{0}/stop", container) url = self._url("/containers/{0}/stop", container)