o Nrf O@sbddlZddlZddlmZmZmZddlmZee Z GdddZ ddZ  d d d Z dS) N)autherrorsutils)DEFAULT_DATA_CHUNK_SIZEc@s.eZdZedefddZedddZd*dd Z  d+d d Z  d,d d Z  d,ddZ  d,ddZ  d,ddZ  d,ddZedddZededd-ddZd-ddZedd-ddZ  d.d d!Z  d/d"d#Zedd0d$d%Zd-d&d'Zedd1d(d)ZdS)2 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 = 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_urlZ_stream_raw_result)selfr chunk_sizeresrY/var/www/html/software/conda/envs/catlas/lib/python3.10/site-packages/docker/api/image.py get_image szImageApiMixin.get_imagecCs||d|}||dS)a$ Show the history of an image. Args: image (str): The image to show history for Returns: (list): 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 rrrrrhistory)s zImageApiMixin.historyNFcCs|rdnd|r dndd}|r&t|jdr||d<n |r"||d<nd|i}|r/t||d<||j|d|d d }|rFd d |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)Zonly_idsall1.25filter referencefiltersz /images/jsonparamsTcSsg|]}|dqS)ZIdr).0xrrr csz(ImageApiMixin.images..)r version_lt_versionconvert_filtersrr r )r namequietrrrrrrrimages;s"    zImageApiMixin.imagesc Cs|s |s td|d}t|||t|tr|nd|d}ddi} |s+|ddkr6||j|d|d St|tr_t |d } ||j|| || dd WdS1sXwYdS|red | d <||j|||| dS)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-rheaderstimeoutchunkedzTransfer-Encoding)r-rr0) rZDockerExceptionr _import_image_params isinstancestrgetr_postopen) r r' repositorytagrr( stream_srcurr0frrr import_imagefs8    $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 r3rr7)r r-r9r:r(r<rr0rrrimport_image_from_datas  z$ImageApiMixin.import_image_from_datacC|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'r9r:r(r>)r filenamer9r:r(rrrimport_image_from_filesz$ImageApiMixin.import_image_from_filecCs|j|d|||dS)NT)r'r;r9r:r(rB)r r r9r:r(rrrimport_image_from_streamsz&ImageApiMixin.import_image_from_streamcCr@)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 rArB)r urlr9r:r(rrrimport_image_from_urls z#ImageApiMixin.import_image_from_urlcCr@)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 )rr9r:r(rB)r rr9r:r(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}|durt||}|r||d<n tdt||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)r0T) rresolve_repository_nameget_config_headerlogdebug encode_headerr rr )r r auth_configregistry_r0headerrFrrrinspect_distributions   z"ImageApiMixin.inspect_distributioncCsni}|durt|jdrtd||d<|j|d||dd}t|jdr0|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.23r#z /images/loadT)r-rr decode) rrr rInvalidVersionr7r Z version_gte_stream_helper_raise_for_status)r r-r#rrrrr load_image#szImageApiMixin.load_imagercCs:|d}i}|durt||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 rr!rr7)r rrFrrrr prune_imagesFs zImageApiMixin.prune_imagescCst|\}}|p |p d}|rd}t|\} } ||d} i} |dur0t|| } | r/| | d<n tdt|| d<|durPt|j drLt d|| d<|j | d | | |dd }|||rk|j||d S||S) aa 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: >>> resp = client.api.pull('busybox', stream=True, decode=True) ... for line in resp: ... 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" } ZlatestN)r: fromImagerKrLz1.32z0platform was only introduced in API version 1.32platformr%)rr0r r1rW)rparse_repository_tagrrMrNrOrPrQrr rrYr7r r[rZr)r r9r:r rRrXr_Zall_tagsZ image_tagrS repo_namerr0rUresponserrrpull_s<,      zImageApiMixin.pullc Cs|s t|\}}t|\}}|d|}d|i} i} |dur-t||} | r,| | d<n tdt|| d<|j |d| || d} | | |rQ|j | |dS| | S)aG 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: >>> resp = client.api.push( ... 'yourname/app', ... stream=True, ... decode=True, ... ) ... for line in resp: ... 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}/pushr:NrKrL)r0r rrW) rr`rrMr rNrOrPrQZ _post_jsonr[rZr) r r9r:r rRrXrSrar<rr0rUrbrrrpushs*&      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)_deleter r)r rrerfrrrrr remove_images  zImageApiMixin.remove_imagecCs4d|i}|dur ||d<||j|d|ddS)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. termNlimitz/images/searchrTrI)r rirjrrrrsearchszImageApiMixin.searchcCsB|||rdndd}|d|}|j||d}|||jdkS)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)r:reporez/images/{0}/tagr)r r7r[ status_code)r rr9r:rerrFrrrrr:s    zImageApiMixin.tag)NFFN)NNNNNFNNN)N)NFNFNF)NFNF)FFNF)__name__ __module__ __qualname__rZcheck_resourcerrrr$r>r?rDrErGrHrJminimum_versionrVr\r]rcrdrhrkr:rrrrr sV  + 4       "#  U B  rcCs.z t|to tj|WStyYdSwrp)r4r5ospathisfile TypeError)r'rrris_file?s   rycCsF||d}|r ||d<n|rt|s||d<nd|d<|r!||d<|S)N)rlr:r^r+r,r()ry)rlr:rr'r(rrrrr3Is   r3ro)loggingrurrr constantsr getLoggerrqrOrryr3rrrrs  9