o q_a@s*ddlmZddlmZGdddZdS))errors)utilsc@sJeZdZdddZ  dddZddZeddd d Zdd d Z dS)VolumeApiMixinNcCs6d|rt|ndi}|d}||j||ddS)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_getselfrrurlr3/usr/lib/python3/dist-packages/docker/api/volume.pyvolumess zVolumeApiMixin.volumescCs|d}|durt|tstd|||d}|dur7td|jdkr*tdt|ts3td||d <| |j ||d 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/createNz 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)r namedriver driver_optslabelsrrrrr create_volume's  zVolumeApiMixin.create_volumecCs|d|}|||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 )r rrrrrinspect_volume[s zVolumeApiMixin.inspect_volume1.25cCs6i}|r t||d<|d}||j||ddS)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/prunerT)rrr r _postr rrr prune_volumests  zVolumeApiMixin.prune_volumesFcCsPi}|rt|jdrtdd|i}|jd||d}||}||dS)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$rN)r version_ltrrrr _delete_raise_for_status)r rr)rrresprrr remove_volumes  zVolumeApiMixin.remove_volume)N)NNNN)F) __name__ __module__ __qualname__rr#r%rminimum_versionr(r.rrrrrs ! 4 rN)rrrrrrrs