U ]K@shddlZddlZddlZddlmZmZmZddlmZe e Z Gddde Z ddZd d d ZdS) N)autherrorsutils)DEFAULT_DATA_CHUNK_SIZEc@s eZdZedefddZedddZd*dd Zd+d d Z d,d d Z d-ddZ d.ddZ d/ddZ d0ddZedddZededd1ddZd2ddZedd3ddZd4d d!Zd5d"d#Zedd6d$d%Zd&d'Zedd7d(d)ZdS)8 ImageApiMixinimagecCs$|j|d|dd}|||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 = cli.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_urlZ_stream_raw_result)selfrZ chunk_sizeresr2/usr/lib/python3/dist-packages/docker/api/image.py get_imageszImageApiMixin.get_imagecCs||d|}||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)r rr rrrhistory+szImageApiMixin.historyNFcCs`||r dnd|rdndd}|r.t||d<||j|d|dd}|r\dd |DS|S) 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)filterZonly_idsallfiltersz /images/jsonparamsTcSsg|] }|dqS)ZIdr).0xrrr ]sz(ImageApiMixin.images..)rconvert_filtersrr r )r namequietrrrr rrrimages=s  zImageApiMixin.imagesc Cs|s|std|d}t|||t|tjr4|nd|d}ddi} |sX|ddkrn||j |d|d St|tjrt |d (} ||j || || dd W5QRSQRXn$|rd | d <||j |||| dSdS)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-)datarrbr(rheaderstimeoutZchunkedzTransfer-Encoding)r(rr+) rZDockerExceptionr _import_image_params isinstancesix string_typesgetr_postopen) r r" repositorytagrr# stream_srcurr+frrr import_image`sB   zImageApiMixin.import_imagec Cs<|d}t||d|d}ddi}||j||||ddS)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 r'r!r$r%Nr*)r r-rr2)r r(r4r5r#r7rr+rrrimport_image_from_datas" z$ImageApiMixin.import_image_from_datacCs|j||||dS)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"r4r5r#r9)r filenamer4r5r#rrrimport_image_from_files z$ImageApiMixin.import_image_from_filecCs|j|d|||dS)NT)r"r6r4r5r#r<)r r r4r5r#rrrimport_image_from_streamsz&ImageApiMixin.import_image_from_streamcCs|j||||dS)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 r;r<)r urlr4r5r#rrrimport_image_from_urls z#ImageApiMixin.import_image_from_urlcCs|j||||dS)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 )rr4r5r#r<)r rr4r5r#rrrimport_image_from_images z%ImageApiMixin.import_image_from_imagecCs|||d|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 )r rrrr inspect_imageszImageApiMixin.inspect_imagez1.30cCsnt|\}}i}|dkr4t||}|rL||d<ntdt||d<|d|}||j||ddS)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. NX-Registry-AuthSending supplied auth configz/distribution/{0}/json)r+T) rresolve_repository_nameget_config_headerlogdebug encode_headerr rr )r r auth_configregistry_r+headerr@rrrinspect_distributions     z"ImageApiMixin.inspect_distributioncCsni}|dk r,t|jdr$td||d<|j|d||dd}t|jdr`|j|ddS| |dS) 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.23rz /images/loadT)r(rr decode) r version_lt_versionrInvalidVersionr2r Z version_gte_stream_helper_raise_for_status)r r(rrr rrr load_images zImageApiMixin.load_imagez1.25cCs:|d}i}|dk r$t||d<||j||ddS)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/pruneNrrT)r rrrr2)r rr@rrrr prune_images@s  zImageApiMixin.prune_imagesc Cs|st|\}}t|\}}||d} i} |dkrPt||} | rh| | d<ntdt|| d<|dk rt|j drt d|| d<|j | d| | |dd } || |r|j| |d S|| S) a Pulls an image. Similar to the ``docker pull`` command. Args: repository (str): The repository to pull tag (str): The tag to pull 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]]`` Returns: (generator or str): The output Raises: :py:class:`docker.errors.APIError` If the server returns an error. Example: >>> for line in cli.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" } )r5 fromImageNrErFz1.32z0platform was only introduced in API version 1.32platformr )rr+r r,rQ)rparse_repository_tagrrGrHrIrJrKrSrTrrUr2r rWrVr) r r4r5r rLrRr[rM repo_namerr+rOresponserrrpullYs<(    zImageApiMixin.pullc Cs|st|\}}t|\}}|d|}d|i} i} |dkrZt||} | rr| | d<ntdt|| d<|j |d| || d} | | |r|j | |dS| | 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 cli.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}/pushr5NrErF)r+r rrQ) rr\rrGr rHrIrJrKZ _post_jsonrWrVr) r r4r5r rLrRrMr]r7rr+rOr^rrrpushs2!     zImageApiMixin.pushcCs,||d}|j|d||d}||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}rT)Z_deleter r)r rrarbrr rrr remove_images zImageApiMixin.remove_imagecCs ||j|dd|iddS)a\ Search for images on Docker Hub. Similar to the ``docker search`` command. Args: term (str): A term to search for. Returns: (list of dicts): The response of the search. Raises: :py:class:`docker.errors.APIError` If the server returns an error. z/images/searchtermrTrC)r rdrrrsearchszImageApiMixin.searchcCsB|||r dndd}|d|}|j||d}|||jdkS)aD 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.tag('ubuntu', 'localhost:5000/ubuntu', 'latest', force=True) rr)r5reporaz/images/{0}/tagr)r r2rWZ status_code)r rr4r5rarr@r rrrr5s   zImageApiMixin.tag)NFFN)NNNNNF)NNN)NNN)NNN)NNN)NNN)N)N)N)NFNFN)NFNF)FF)NF)__name__ __module__ __qualname__rZcheck_resourcerrrrr9r:r>r?rArBrDZminimum_versionrPrXrYr_r`rcrer5rrrrr sX  # 4      " #  M = rcCs6zt|tjotj|WStk r0YdSXdS)NF)r.r/r0ospathisfile TypeError)r"rrris_file's   rocCsF||d}|r||d<n|r.t|s.||d<nd|d<|rB||d<|S)N)rfr5rZr&r'r#)ro)rfr5rr"r#rrrrr-1s   r-)NNN)Zloggingrkr/rrrZ constantsrZ getLoggerrhrIobjectrror-rrrrs