U ]C@sddlZddlZddlZddlZddlmZddlmZddlm Z m Z m Z ddl m Z ddlmZdd lmZmZGd d d eZGd d d eZGdddeZddZdS)N) APIClient)DEFAULT_DATA_CHUNK_SIZE) BuildErrorImageLoadErrorInvalidArgument)parse_repository_tag) json_stream) CollectionModelc@s\eZdZdZddZeddZeddZedd Zd d Z e d fd dZ dddZ dS)Imagez! An image on the server. cCsd|jjd|jfS)Nz <%s: '%s'>z', ') __class____name__jointagsselfr6/usr/lib/python3/dist-packages/docker/models/images.py__repr__szImage.__repr__cCs|jdd}|piS)z7 The labels of an image as dictionary. ZConfigZLabelsattrsget)rresultrrrlabelssz Image.labelscCs(|jdr|jddS|jddS)f The ID of the image truncated to 10 characters, plus the ``sha256:`` prefix. sha256:N )id startswithrrrrshort_ids zImage.short_idcCs&|jd}|dkrg}dd|DS)z# The image's tags. ZRepoTagsNcSsg|]}|dkr|qS)z :r).0tagrrr 0szImage.tags..r)rrrrrr(s z Image.tagscCs|jj|jS)z Show the history of an image. Returns: (str): The history of the image. Raises: :py:class:`docker.errors.APIError` If the server returns an error. )clientapihistoryr rrrrr(2s z Image.historyFcCsV|j}|rF|jr|jdn|}t|tjrF||jkrBtd||}|jj ||S)a Get a tarball of an image. Similar to the ``docker save`` command. Args: chunk_size (int): The generator will return up to that much data per iteration, but may return less. If ``None``, data will be streamed as it is received. Default: 2 MB named (str or bool): If ``False`` (default), the tarball will not retain repository and tag information for this image. If set to ``True``, the first tag in the :py:attr:`~tags` list will be used to identify the image. Alternatively, any element of the :py:attr:`~tags` list can be used as an argument to use that specific tag as the saved identifier. 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() rz${} is not a valid tag for this image) r r isinstancesix string_typesrformatr&r'Z get_image)rZ chunk_sizeZnamedZimgrrrsave?s  z Image.saveNcKs|jjj|j|fd|i|S)a Tag this image into a repository. Similar to the ``docker tag`` command. Args: repository (str): The repository to set for the tag tag (str): The tag name force (bool): Force Raises: :py:class:`docker.errors.APIError` If the server returns an error. Returns: (bool): ``True`` if successful r$)r&r'r$r r repositoryr$kwargsrrrr$isz Image.tag)N) r __module__ __qualname____doc__rpropertyrr"rr(rr-r$rrrrr s    *r cs\eZdZdZfddZeddZeddZdd d Zd d Z d dZ e j je _Z S) RegistryDatazO Image metadata stored on the registry, including available platforms. cstt|j||||_dSN)superr5__init__ image_name)rr9argsr0rrrr8szRegistryData.__init__cCs|jddS)z' The ID of the object. Z DescriptorZdigest)rrrrrr szRegistryData.idcCs|jddS)rNr)r rrrrr"szRegistryData.short_idNcCs"t|j\}}|jj||j|dS)z Pull the image digest. Args: platform (str): The platform to pull the image for. Default: ``None`` Returns: (:py:class:`Image`): A reference to the pulled image. )r$platform)rr9 collectionpullr )rr<r/_rrrr>s zRegistryData.pullcCs|rzt|tsz|d}t|dks0t|dkr>td|d|di}t|dkrb|d|d<t|dkrz|d|d <t||j|j d kS) a Check whether the given platform identifier is available for this digest. Args: platform (str or dict): A string using the ``os[/arch[/variant]]`` format, or a platform dictionary. Returns: (bool): ``True`` if the platform is recognized as available, ``False`` otherwise. Raises: :py:class:`docker.errors.InvalidArgument` If the platform argument is not a valid descriptor. /r z("{0}" is not a valid platform descriptorosrrZvariant architectureZ Platforms) r)dictsplitlenrr,normalize_platformr&versionr)rr<partsrrr has_platforms"      zRegistryData.has_platformcCs|jj|j|_dSr6)r&r'inspect_distributionr9rrrrrreloadszRegistryData.reload)N) rr1r2r3r8r4r r"r>rJrLr __classcell__rrr;rr5}s     r5c@seZdZeZddZddZdddZdd d Zd d Z dd dZ dddZ e j j e _ ddZe jj e_ ddZe jj e_ dddZe jj e_ ddZe jj e_ dS)ImageCollectionc Ks|jjjf|}t|tjr&||Sd}d}tt |\}}|D]D}d|kr^t |d|d|krt d|d}|r| d}|}qD|r|||fSt |pd|dS)a Build an image and return it. Similar to the ``docker build`` command. Either ``path`` or ``fileobj`` must be set. If you have a tar file for the Docker build context (including a Dockerfile) already, pass a readable file-like object to ``fileobj`` and also pass ``custom_context=True``. If the stream is compressed also, set ``encoding`` to the correct value (e.g ``gzip``). If you want to get the raw output of the build, use the :py:meth:`~docker.api.build.BuildApiMixin.build` method in the low-level API. Args: path (str): Path to the directory containing the Dockerfile fileobj: A file object to use as the Dockerfile. (Or a file-like object) tag (str): A tag to add to the final image quiet (bool): Whether to return the status nocache (bool): Don't use the cache when set to ``True`` rm (bool): Remove intermediate containers. The ``docker build`` command now defaults to ``--rm=true``, but we have kept the old default of `False` to preserve backward compatibility timeout (int): HTTP timeout custom_context (bool): Optional if using ``fileobj`` encoding (str): The encoding for a stream. Set to ``gzip`` for compressing pull (bool): Downloads any updates to the FROM image in Dockerfiles forcerm (bool): Always remove intermediate containers, even after unsuccessful builds dockerfile (str): path within the build context to the Dockerfile buildargs (dict): A dictionary of build arguments container_limits (dict): A dictionary of limits applied to each container created by the build process. Valid keys: - memory (int): set memory limit for build - memswap (int): Total memory (memory + swap), -1 to disable swap - cpushares (int): CPU shares (relative weight) - cpusetcpus (str): CPUs in which to allow execution, e.g., ``"0-3"``, ``"0,1"`` shmsize (int): Size of `/dev/shm` in bytes. The size must be greater than 0. If omitted the system uses 64MB labels (dict): A dictionary of labels to set on the image cache_from (list): A list of images used for build cache resolution target (str): Name of the build-stage to build in a multi-stage Dockerfile network_mode (str): networking mode for the run commands during build squash (bool): Squash the resulting images layers into a single layer. extra_hosts (dict): Extra hosts to add to /etc/hosts in building containers, as a mapping of hostname to IP address. platform (str): Platform in the format ``os[/arch[/variant]]``. isolation (str): Isolation technology used during build. Default: `None`. use_config_proxy (bool): If ``True``, and if the docker client configuration file (``~/.docker/config.json`` by default) contains a proxy configuration, the corresponding environment variables will be set in the container being built. Returns: (tuple): The first item is the :py:class:`Image` object for the image that was build. The second item is a generator of the build logs as JSON-decoded objects. Raises: :py:class:`docker.errors.BuildError` If there is an error during the build. :py:class:`docker.errors.APIError` If the server returns any other error. ``TypeError`` If neither ``path`` nor ``fileobj`` is specified. Nerrorstreamz*(^Successfully built |sha256:)([0-9a-f]+)$rZUnknown)r&r'buildr)r*r+r itertoolsteer rresearchgroup) rr0respZ last_eventimage_idZ result_streamZinternal_streamchunkmatchrrrrQs(L   zImageCollection.buildcCs||jj|S)am Gets an image. Args: name (str): The name of the image. Returns: (:py:class:`Image`): The image. Raises: :py:class:`docker.errors.ImageNotFound` If the image does not exist. :py:class:`docker.errors.APIError` If the server returns an error. )Z prepare_modelr&r'Z inspect_image)rnamerrrr,szImageCollection.getNcCst||jj|||j|dS)a  Gets the registry data for an image. Args: name (str): The name of the image. 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: (:py:class:`RegistryData`): The data object. Raises: :py:class:`docker.errors.APIError` If the server returns an error. )r9rr&r=)r5r&r'rK)rr[Z auth_configrrrget_registry_data>s z!ImageCollection.get_registry_dataFcs&jjj|||d}fdd|DS)a List images on the server. Args: name (str): Only show images belonging to the repository ``name`` 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: (list of :py:class:`Image`): The images. Raises: :py:class:`docker.errors.APIError` If the server returns an error. )r[allfilterscsg|]}|dqS)ZIdr)r#rrrrr%lsz(ImageCollection.list..)r&r'images)rr[r]r^rWrrrlistVszImageCollection.listcsrjj|}g}|D]H}d|krJtd|d}|rJ|d}||d|krt|dqfdd|DS)a Load an image that was previously saved using :py:meth:`~docker.models.images.Image.save` (or ``docker save``). Similar to ``docker load``. Args: data (binary): Image data to be loaded. Returns: (list of :py:class:`Image`): The images. Raises: :py:class:`docker.errors.APIError` If the server returns an error. rPz)(^Loaded image ID: |^Loaded image: )(.+)$rrOcsg|]}|qSrr_)r#irrrr%sz(ImageCollection.load..)r&r'Z load_imagerTrUrVappendr)rdatarWrarYrZrXrrrloadns  zImageCollection.loadc Ks~|st|\}}d|kr(td|d=|jjj|f|dd|}|D]}qH|rt|d|||drldndS| |S) aP Pull an image of the given name and return it. Similar to the ``docker pull`` command. If no tag is specified, all tags from that repository will be pulled. If you want to get the raw pull output, use the :py:meth:`~docker.api.image.ImageApiMixin.pull` method in the low-level API. Args: repository (str): The repository to pull tag (str): The tag to pull 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. platform (str): Platform in the format ``os[/arch[/variant]]`` Returns: (:py:class:`Image` or list): The image that has been pulled. If no ``tag`` was specified, the method will return a list of :py:class:`Image` objects belonging to this repository. Raises: :py:class:`docker.errors.APIError` If the server returns an error. Example: >>> # Pull the image tagged `latest` in the busybox repo >>> image = client.images.pull('busybox:latest') >>> # Pull all tags in the busybox repo >>> images = client.images.pull('busybox') rPzH`stream` is not a valid parameter for this method and will be overriddenT)r$rPz {0}{2}{1}r@:) rwarningswarnr&r'r>rr,r!rb)rr/r$r0Zpull_logr?rrrr>s0$ zImageCollection.pullcKs|jjj|fd|i|S)Nr$)r&r'pushr.rrrrkszImageCollection.pushcOs|jjj||dSr6)r&r' remove_imagerr:r0rrrremoveszImageCollection.removecOs|jjj||Sr6)r&r'rUrmrrrrUszImageCollection.searchcCs|jjj|dS)N)r^)r&r' prune_images)rr^rrrpruneszImageCollection.prunecOs|jjj||Sr6)r&r' prune_buildsrmrrrrqszImageCollection.prune_builds)N)NFN)N)N)N)rr1r2r ZmodelrQrr\rbrfr>rkrr3rnrlrUrprorqrrrrrNs"a   <      rNcCs8|dkr i}d|kr |d|d<d|kr4|d|d<|S)NrBZOsrCZArchr)r<Z engine_inforrrrGs  rG)rRrTrir*r'rZ constantsrerrorsrrrZutilsrZutils.json_streamr resourcer r r r5rNrGrrrrs    nK