summaryrefslogtreecommitdiff
path: root/docker/api/volume.py
blob: 708cbe52dd808c40a3572e75b797262b5ba98cd6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
import functools

from .. import errors
from ..utils import utils


def check_api_version(f):
    @functools.wraps(f)
    def wrapped(self, *args, **kwargs):
        if utils.compare_version('1.21', self._version) < 0:
            raise errors.InvalidVersion(
                'The volume API is not available for API version < 1.21'
            )
        return f(self, *args, **kwargs)
    return wrapped


class VolumeApiMixin(object):
    @check_api_version
    def volumes(self, filters=None):
        params = {
            'filter': utils.convert_filters(filters) if filters else None
        }
        url = self._url('/volumes')
        return self._result(self._get(url, params=params), True)

    @check_api_version
    def create_volume(self, name, driver=None, driver_opts=None):
        url = self._url('/volumes')
        if driver_opts is not None and not isinstance(driver_opts, dict):
            raise TypeError('driver_opts must be a dictionary')

        data = {
            'Name': name,
            'Driver': driver,
            'DriverOpts': driver_opts,
        }
        return self._result(self._post_json(url, data=data), True)

    @check_api_version
    def inspect_volume(self, name):
        url = self._url('/volumes/{0}', name)
        return self._result(self._get(url), True)

    @check_api_version
    def remove_volume(self, name):
        url = self._url('/volumes/{0}', name)
        resp = self._delete(url)
        self._raise_for_status(resp)
        return True