q_a0ddlmZddlmZGddZy))errors)utilsc`eZdZddZ d dZdZejdddZd dZ y) VolumeApiMixinNcd|rtj|ndi}|jd}|j|j ||dS)a List volumes currently registered by the docker daemon. Similar to the ``docker volume ls`` command. Args: filters (dict): Server-side list filtering options. Returns: (dict): Dictionary with list of volume objects as value of the ``Volumes`` key. Raises: :py:class:`docker.errors.APIError` If the server returns an error. Example: >>> client.api.volumes() {u'Volumes': [{u'Driver': u'local', u'Mountpoint': u'/var/lib/docker/volumes/foobar/_data', u'Name': u'foobar'}, {u'Driver': u'local', u'Mountpoint': u'/var/lib/docker/volumes/baz/_data', u'Name': u'baz'}]} filtersNz/volumesparamsT)rconvert_filters_url_result_getselfrr urls 3/usr/lib/python3/dist-packages/docker/api/volume.pyvolumeszVolumeApiMixin.volumessM8 u,,W5d ii #||DIIc&I94@@cd|jd}|t|ts td|||d}|Xt j d|j dkrtjdt|ts td||d<|j|j|| d S) a Create and register a named volume Args: name (str): Name of the volume 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: (dict): The created volume reference object Raises: :py:class:`docker.errors.APIError` If the server returns an error. Example: >>> volume = client.api.create_volume(name='foobar', driver='local', driver_opts={'foo': 'bar', 'baz': 'false'}, labels={"key": "value"}) >>> print(volume) {u'Driver': u'local', u'Labels': {u'key': u'value'}, u'Mountpoint': u'/var/lib/docker/volumes/foobar/_data', u'Name': u'foobar', u'Scope': u'local'} z/volumes/createz driver_opts must be a dictionary)NameDriver DriverOptsz1.23z)volume labels were introduced in API 1.23zlabels must be a dictionaryLabels)dataT) r isinstancedict TypeErrorrcompare_version_versionrInvalidVersionr _post_json)rnamedriver driver_optslabelsrrs r create_volumezVolumeApiMixin.create_volume's>ii)*  ":k4+H>? ?%   $$VT]];a?++?fd+ =>>#DN||DOOCdO;TBBrch|jd|}|j|j|dS)a Retrieve volume info by name. Args: name (str): volume name Returns: (dict): Volume information dictionary Raises: :py:class:`docker.errors.APIError` If the server returns an error. Example: >>> client.api.inspect_volume('foobar') {u'Driver': u'local', u'Mountpoint': u'/var/lib/docker/volumes/foobar/_data', u'Name': u'foobar'} /volumes/{0}T)r r r)rr#rs rinspect_volumezVolumeApiMixin.inspect_volume[s-,ii-||DIIcND11r1.25ci}|rtj||d<|jd}|j|j ||dS)a Delete unused volumes Args: filters (dict): Filters to process on the prune list. Returns: (dict): A dict containing a list of deleted volume names and the amount of disk space reclaimed in bytes. Raises: :py:class:`docker.errors.APIError` If the server returns an error. rz/volumes/pruner T)rr r r _postrs r prune_volumeszVolumeApiMixin.prune_volumestsN   % 5 5g >F9 ii()||DJJs6J:DAArci}|r9tj|jdrtjdd|i}|j d||}|j |}|j|y)az Remove a volume. Similar to the ``docker volume rm`` command. Args: name (str): The volume's name 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. r+z(force removal was introduced in API 1.25forcer)r N)r version_ltr rr!r _delete_raise_for_status)rr#r0r rresps r remove_volumezVolumeApiMixin.remove_volumesr  v6++>u%FiiVi<||C  t$r)N)NNNN)F) __name__ __module__ __qualname__rr'r*rminimum_versionr.r5rrrrsGABAE!2Ch22U6"B#B*%rrN)rrrr:rrr<s\%\%r