mirror of https://github.com/docker/docker-py.git
100 lines
2.8 KiB
Python
100 lines
2.8 KiB
Python
from ..api import APIClient
|
|
from .resource import Collection, Model
|
|
|
|
|
|
class Volume(Model):
|
|
"""A volume."""
|
|
id_attribute = 'Name'
|
|
|
|
@property
|
|
def name(self):
|
|
"""The name of the volume."""
|
|
return self.attrs['Name']
|
|
|
|
def remove(self, force=False):
|
|
"""
|
|
Remove this volume.
|
|
|
|
Args:
|
|
force (bool): Force removal of volumes that were already removed
|
|
out of band by the volume driver plugin.
|
|
Raises:
|
|
:py:class:`docker.errors.APIError`
|
|
If volume failed to remove.
|
|
"""
|
|
return self.client.api.remove_volume(self.id, force=force)
|
|
|
|
|
|
class VolumeCollection(Collection):
|
|
"""Volumes on the Docker server."""
|
|
model = Volume
|
|
|
|
def create(self, name=None, **kwargs):
|
|
"""
|
|
Create a volume.
|
|
|
|
Args:
|
|
name (str): Name of the volume. If not specified, the engine
|
|
generates a name.
|
|
driver (str): Name of the driver used to create the volume
|
|
driver_opts (dict): Driver options as a key-value dictionary
|
|
labels (dict): Labels to set on the volume
|
|
|
|
Returns:
|
|
(:py:class:`Volume`): The volume created.
|
|
|
|
Raises:
|
|
:py:class:`docker.errors.APIError`
|
|
If the server returns an error.
|
|
|
|
Example:
|
|
|
|
>>> volume = client.volumes.create(name='foobar', driver='local',
|
|
driver_opts={'foo': 'bar', 'baz': 'false'},
|
|
labels={"key": "value"})
|
|
|
|
"""
|
|
obj = self.client.api.create_volume(name, **kwargs)
|
|
return self.prepare_model(obj)
|
|
|
|
def get(self, volume_id):
|
|
"""
|
|
Get a volume.
|
|
|
|
Args:
|
|
volume_id (str): Volume name.
|
|
|
|
Returns:
|
|
(:py:class:`Volume`): The volume.
|
|
|
|
Raises:
|
|
:py:class:`docker.errors.NotFound`
|
|
If the volume does not exist.
|
|
:py:class:`docker.errors.APIError`
|
|
If the server returns an error.
|
|
"""
|
|
return self.prepare_model(self.client.api.inspect_volume(volume_id))
|
|
|
|
def list(self, **kwargs):
|
|
"""
|
|
List volumes. Similar to the ``docker volume ls`` command.
|
|
|
|
Args:
|
|
filters (dict): Server-side list filtering options.
|
|
|
|
Returns:
|
|
(list of :py:class:`Volume`): The volumes.
|
|
|
|
Raises:
|
|
:py:class:`docker.errors.APIError`
|
|
If the server returns an error.
|
|
"""
|
|
resp = self.client.api.volumes(**kwargs)
|
|
if not resp.get('Volumes'):
|
|
return []
|
|
return [self.prepare_model(obj) for obj in resp['Volumes']]
|
|
|
|
def prune(self, filters=None):
|
|
return self.client.api.prune_volumes(filters=filters)
|
|
prune.__doc__ = APIClient.prune_volumes.__doc__
|