2.aN~ddlZddlZddlmZmZmZddlmZeje Z GddZ dZ d dZ y) N)autherrorsutils)DEFAULT_DATA_CHUNK_SIZEc eZdZejdefdZejddZddZ ddZ ddZ ddZ dd Z dd Z dd Zejdd Zej d ejdddZddZej dddZ ddZ ddZejdddZddZejdddZy) ImageApiMixinimagecn|j|jd|d}|j||dS)a Get a tarball of an image. Similar to the ``docker save`` command. Args: image (str): Image name to get chunk_size (int): The number of bytes returned by each iteration of the generator. If ``None``, data will be streamed as it is received. Default: 2 MB Returns: (generator): A stream of raw archive data. Raises: :py:class:`docker.errors.APIError` If the server returns an error. Example: >>> image = client.api.get_image("busybox:latest") >>> f = open('/tmp/busybox-latest.tar', 'wb') >>> for chunk in image: >>> f.write(chunk) >>> f.close() z/images/{0}/getT)streamF)_get_url_stream_raw_result)selfr chunk_sizeress 2/usr/lib/python3/dist-packages/docker/api/image.py get_imagezImageApiMixin.get_image s74ii "3U;DiI&&sJ>>ch|j|jd|}|j|dS)a# Show the history of an image. Args: image (str): The image to show history for Returns: (str): The history of the image Raises: :py:class:`docker.errors.APIError` If the server returns an error. z/images/{0}/historyT)r r_result)rr rs rhistoryzImageApiMixin.history)s/ii "7?@||C&&rNcT|rdnd|rdndd}|r2tj|jdr||d<n |r||d<nd|i}|rtj||d<|j |j |j d| d }|r|Dcgc]}|d  c}S|Scc}w) a List images. Similar to the ``docker images`` command. Args: name (str): Only show images belonging to the repository ``name`` quiet (bool): Only return numeric IDs as a list. all (bool): Show intermediate image layers. By default, these are filtered out. filters (dict): Filters to be processed on the image list. Available filters: - ``dangling`` (bool) - `label` (str|list): format either ``"key"``, ``"key=value"`` or a list of such. Returns: (dict or list): A list if ``quiet=True``, otherwise a dict. Raises: :py:class:`docker.errors.APIError` If the server returns an error. r)only_idsall1.25filter referencefiltersz /images/jsonparamsTId)r version_lt_versionconvert_filtersrr r)rnamequietrr r"rxs rimageszImageApiMixin.images;s.#1   v6#'x +/GK(*D1G  % 5 5g >F9 ll499TYY~%>v9N! %()AdG) ) *s B%c |s|stjd|jd}t|||t |t r|nd|}ddi} |s|j ddk7r#|j|j|d| St |t r;t|d 5} |j|j|| || d cdddS|rd | d <|j|j|||| S#1swYyxYw)ad Import an image. Similar to the ``docker import`` command. If ``src`` is a string or unicode string, it will first be treated as a path to a tarball on the local system. If there is an error reading from that file, ``src`` will be treated as a URL instead to fetch the image from. You can also pass an open file handle as ``src``, in which case the data will be read from that file. If ``src`` is unset but ``image`` is set, the ``image`` parameter will be taken as the name of an existing image to import from. Args: src (str or file): Path to tarfile, URL, or file-like object repository (str): The repository to create tag (str): The tag to apply image (str): Use another image like the ``FROM`` Dockerfile parameter z(Must specify src or image to import from/images/createNsrcchanges Content-Typeapplication/tarfromSrc-)datar"rbr4r"headerstimeoutchunkedzTransfer-Encoding)r4r"r7) rDockerExceptionr_import_image_params isinstancestrgetr_postopen) rr. repositorytagr r/ stream_srcur"r7fs r import_imagezImageApiMixin.import_imagefs#*u((:  II& '% U"3,$  "#45 FJJy)S0<< 14 7 S !c4 A||JJ&'4  /8+,<< 13vw G   s &%DD c |jd}t||d|}ddi}|j|j||||dS)a@ Like :py:meth:`~docker.api.image.ImageApiMixin.import_image`, but allows importing in-memory bytes data. Args: data (bytes collection): Bytes collection containing valid tar data repository (str): The repository to create tag (str): The tag to apply r,r3r-r0r1Nr6)rr;rr?)rr4rArBr/rDr"r7s rimport_image_from_dataz$ImageApiMixin.import_image_from_datas` II& '% g "#45|| JJVWd    rc,|j||||S)aj Like :py:meth:`~docker.api.image.ImageApiMixin.import_image`, but only supports importing from a tar file on disk. Args: filename (str): Full path to a tar file. repository (str): The repository to create tag (str): The tag to apply Raises: IOError: File does not exist. r.rArBr/rF)rfilenamerArBr/s rimport_image_from_filez$ImageApiMixin.import_image_from_files%  ZS'!  rc.|j|d|||S)NT)r.rCrArBr/rK)rr rArBr/s rimport_image_from_streamz&ImageApiMixin.import_image_from_streams&  4JC!  rc,|j||||S)a" Like :py:meth:`~docker.api.image.ImageApiMixin.import_image`, but only supports importing from a URL. Args: url (str): A URL pointing to a tar file. repository (str): The repository to create tag (str): The tag to apply rJrK)rurlrArBr/s rimport_image_from_urlz#ImageApiMixin.import_image_from_urls%   W!  rc,|j||||S)aX Like :py:meth:`~docker.api.image.ImageApiMixin.import_image`, but only supports importing from another image, like the ``FROM`` Dockerfile parameter. Args: image (str): Image name to import from repository (str): The repository to create tag (str): The tag to apply )r rArBr/rK)rr rArBr/s rimport_image_from_imagez%ImageApiMixin.import_image_from_images%  JC!  rcd|j|j|jd|dS)a Get detailed information about an image. Similar to the ``docker inspect`` command, but only for images. Args: image (str): The image to inspect Returns: (dict): Similar to the output of ``docker inspect``, but as a single dict Raises: :py:class:`docker.errors.APIError` If the server returns an error. z/images/{0}/jsonTrr r)rr s r inspect_imagezImageApiMixin.inspect_images/"|| IIdii 2E: ;T  rz1.30c:tj|\}}i}|tj||}|r3||d<n-tj dtj ||d<|j d|}|j|j||dS)a/ Get image digest and platform information by contacting the registry. Args: image (str): The image name to inspect auth_config (dict): Override the credentials that are found in the config for this request. ``auth_config`` should contain the ``username`` and ``password`` keys to be valid. Returns: (dict): A dict containing distribution data Raises: :py:class:`docker.errors.APIError` If the server returns an error. X-Registry-AuthSending supplied auth configz/distribution/{0}/json)r7T) rresolve_repository_nameget_config_headerlogdebug encode_headerrrr )rr auth_configregistry_r7headerrQs rinspect_distributionz"ImageApiMixin.inspect_distributions&2259 !  ++D(;F-3)* II4 5)-););K)HG% &ii0%8|| IIc7I +T  rcPi}|:tj|jdrtjd||d<|j |j d||d}tj|jdr|j|dS|j|y) a9 Load an image that was previously saved using :py:meth:`~docker.api.image.ImageApiMixin.get_image` (or ``docker save``). Similar to ``docker load``. Args: data (binary): Image data to be loaded. quiet (boolean): Suppress progress details in response. Returns: (generator): Progress output as JSON objects. Only available for API version >= 1.23 Raises: :py:class:`docker.errors.APIError` If the server returns an error. Nz1.23z,quiet is not supported in API version < 1.23r(z /images/loadT)r4r"r decode) rr$r%rInvalidVersionr?r version_gte_stream_helper_raise_for_status)rr4r(r"rs r load_imagezImageApiMixin.load_image#s$   v6++B$F7Ojj IIn %D    T]]F 3&&s4&8 8 s#rrc|jd}i}|tj||d<|j|j ||dS)a Delete unused images Args: filters (dict): Filters to process on the prune list. Available filters: - dangling (bool): When set to true (or 1), prune only unused and untagged images. Returns: (dict): A dict containing a list of deleted image IDs and the amount of disk space reclaimed in bytes. Raises: :py:class:`docker.errors.APIError` If the server returns an error. z /images/pruner r!T)rrr&rr?)rr rQr"s r prune_imageszImageApiMixin.prune_imagesFsP&ii(   % 5 5g >F9 ||DJJs6J:DAArcVtj|\}}|xs|xsd}|rd}tj|\} } ||d} i} |tj|| } | r3| | d<n-t j dtj|| d<|:tj|jdrtjd|| d<|j|jd | | |d }|j||r|j|| S|j!|S) aE Pulls an image. Similar to the ``docker pull`` command. Args: repository (str): The repository to pull tag (str): The tag to pull. If ``tag`` is ``None`` or empty, it is set to ``latest``. stream (bool): Stream the output as a generator. Make sure to consume the generator, otherwise pull might get cancelled. auth_config (dict): Override the credentials that are found in the config for this request. ``auth_config`` should contain the ``username`` and ``password`` keys to be valid. decode (bool): Decode the JSON data from the server into dicts. Only applies with ``stream=True`` platform (str): Platform in the format ``os[/arch[/variant]]`` all_tags (bool): Pull all image tags, the ``tag`` parameter is ignored. Returns: (generator or str): The output Raises: :py:class:`docker.errors.APIError` If the server returns an error. Example: >>> for line in client.api.pull('busybox', stream=True, decode=True): ... print(json.dumps(line, indent=4)) { "status": "Pulling image (latest) from busybox", "progressDetail": {}, "id": "e72ac664f4f0" } { "status": "Pulling image (latest) from busybox, endpoint: ...", "progressDetail": {}, "id": "e72ac664f4f0" } latestN)rB fromImagerYrZz1.32z0platform was only introduced in API version 1.32platformr,)r"r7r r8rf)rparse_repository_tagrr[r\r]r^r_r$r%rrhr?rrkrjr)rrArBr r`rgrrall_tags image_tagra repo_namer"r7rcresponses rpullzImageApiMixin.pull_sBV!& : :: F I*Y*( C":::F)#   ++D(;F-3)* II4 5)-););K)HG% &   v6++F"*F: :: II& '4  x( &&x&? ?||H%%rc|stj|\}}tj|\}}|j d|}d|i} i} |tj ||} | r3| | d<n-t jdtj|| d<|j|d| || } |j| |r|j| |S|j| S)a Push an image or a repository to the registry. Similar to the ``docker push`` command. Args: repository (str): The repository to push to tag (str): An optional tag to push stream (bool): Stream the output as a blocking generator auth_config (dict): Override the credentials that are found in the config for this request. ``auth_config`` should contain the ``username`` and ``password`` keys to be valid. decode (bool): Decode the JSON data from the server into dicts. Only applies with ``stream=True`` Returns: (generator or str): The output from the server. Raises: :py:class:`docker.errors.APIError` If the server returns an error. Example: >>> for line in client.api.push('yourname/app', stream=True, decode=True): ... print(line) {'status': 'Pushing repository yourname/app (1 tags)'} {'status': 'Pushing','progressDetail': {}, 'id': '511136ea3c5a'} {'status': 'Image already pushed, skipping', 'progressDetail':{}, 'id': '511136ea3c5a'} ... z/images/{0}/pushrBNrYrZ)r7r r"rf) rrsrr[rr\r]r^r_ _post_jsonrkrjr) rrArBr r`rgrarvrDr"r7rcrws rpushzImageApiMixin.pushsB#88DOJ":::F) II(* 5 3   ++D(;F-3)* II4 5)-););K)HG% &?? tWVF#  x( &&x&? ?||H%%rcv||d}|j|jd||}|j|dS)z Remove an image. Similar to the ``docker rmi`` command. Args: image (str): The image to remove force (bool): Force removal of the image noprune (bool): Do not delete untagged parents )forcenoprunez /images/{0}r!T)_deleterr)rr r}r~r"rs r remove_imagezImageApiMixin.remove_images<!W5ll499]E:6lJ||C&&rc|d|i}|||d<|j|j|jd|dS)a Search for images on Docker Hub. Similar to the ``docker search`` command. Args: term (str): A term to search for. limit (int): The maximum number of results to return. Returns: (list of dicts): The response of the search. Raises: :py:class:`docker.errors.APIError` If the server returns an error. termlimitz/images/searchr!TrV)rrrr"s rsearchzImageApiMixin.searchsJ $  #F7O|| IIdii 01&I A   rc|||rdndd}|jd|}|j||}|j||jdk(S)aH Tag an image into a repository. Similar to the ``docker tag`` command. Args: image (str): The image to tag repository (str): The repository to set for the tag tag (str): The tag name force (bool): Force Returns: (bool): ``True`` if successful Raises: :py:class:`docker.errors.APIError` If the server returns an error. Example: >>> client.api.tag('ubuntu', 'localhost:5000/ubuntu', 'latest', force=True) rr)rBrepor}z/images/{0}/tagr!)rr?rk status_code)rr rArBr}r"rQrs rrBzImageApiMixin.tagsZ0QQ  ii)51jjVj, s##%%r)NFFN)NNNNNFNNN)N)NFNFNF)NFNF)FFNF)__name__ __module__ __qualname__rcheck_resourcerrrr*rFrHrMrOrRrTrWminimum_versionrdrlrnrxr{rrrBrrr r sU'"*A?#?8U'"'#'")VGK.32hAE'+ .EI'+ &EI)- ?C&*  CG(, U'" # (U6"U'"  ##  D!$FU6"B#B0DH38R&hDH;&zU'" '# ' 2U'"&#&rr c t|txrtjj |S#t $rYywxYwr)r<r=ospathisfile TypeError)r.s ris_filer9s? sC  GGNN3   s 03 ??c^||d}|r||d<n|rt|s||d<nd|d<|r||d<|S)N)rrBrqr2r3r/)r)rrBr r.r/r"s rr;r;CsOF #{ WS\yy#y Mrr)loggingrrrr constantsr getLoggerrr]r rr;rrrrsE ""/g!l&l&^59!%r