HEX

File: //lib/python3/dist-packages/docker/models/__pycache__/networks.cpython-310.pyc
o

�h�_�@sXddlmZddlmZddlmZddlmZmZGdd�de�Z	Gdd	�d	e�Z
d
S)�)�	APIClient)�version_gte�)�	Container)�Model�
Collectionc@s@eZdZdZedd��Zedd��Zdd�Zdd	�Zd
d�Z	dS)
�Networkz
    A Docker network.
    cCs|j�d�S)z*
        The name of the network.
        �Name)�attrs�get��self�r�8/usr/lib/python3/dist-packages/docker/models/networks.py�nameszNetwork.namecs"�fdd��j�d�pi��D�S)z�
        The containers that are connected to the network, as a list of
        :py:class:`~docker.models.containers.Container` objects.
        csg|]	}�jj�|��qSr)�client�
containersr)�.0�cidrrr�
<listcomp>s�z&Network.containers.<locals>.<listcomp>�
Containers)r
r�keysrrrrrs
�zNetwork.containerscO�0t|t�r|j}|jjj||jg|�Ri|��S)a
        Connect a container to this network.

        Args:
            container (str): Container to connect to this network, as either
                an ID, name, or :py:class:`~docker.models.containers.Container`
                object.
            aliases (:py:class:`list`): A list of aliases for this endpoint.
                Names in that list can be used within the network to reach the
                container. Defaults to ``None``.
            links (:py:class:`list`): A list of links for this endpoint.
                Containers declared in this list will be linkedto this
                container. Defaults to ``None``.
            ipv4_address (str): The IP address of this container on the
                network, using the IPv4 protocol. Defaults to ``None``.
            ipv6_address (str): The IP address of this container on the
                network, using the IPv6 protocol. Defaults to ``None``.
            link_local_ips (:py:class:`list`): A list of link-local (IPv4/IPv6)
                addresses.
            driver_opt (dict): A dictionary of options to provide to the
                network driver. Defaults to ``None``.

        Raises:
            :py:class:`docker.errors.APIError`
                If the server returns an error.
        )�
isinstancer�idr�api�connect_container_to_network�r
�	container�args�kwargsrrr�connects
���zNetwork.connectcOr)a�
        Disconnect a container from this network.

        Args:
            container (str): Container to disconnect from this network, as
                either an ID, name, or
                :py:class:`~docker.models.containers.Container` object.
            force (bool): Force the container to disconnect from a network.
                Default: ``False``

        Raises:
            :py:class:`docker.errors.APIError`
                If the server returns an error.
        )rrrrr�!disconnect_container_from_networkrrrr�
disconnect>s
���zNetwork.disconnectcCs|jj�|j�S)z�
        Remove this network.

        Raises:
            :py:class:`docker.errors.APIError`
                If the server returns an error.
        )rr�remove_networkrrrrr�removeSszNetwork.removeN)
�__name__�
__module__�__qualname__�__doc__�propertyrrr!r#r%rrrrrs


!rc@s@eZdZdZeZdd�Zdd�Zdd�Zdd	d
�Z	e
jje	_dS)�NetworkCollectionz(
    Networks on the Docker server.
    cOs*|jjj|g|�Ri|��}|�|d�S)a�
        Create a network. Similar to the ``docker network create``.

        Args:
            name (str): Name of the network
            driver (str): Name of the driver used to create the network
            options (dict): Driver options as a key-value dictionary
            ipam (IPAMConfig): Optional custom IP scheme for the network.
            check_duplicate (bool): Request daemon to check for networks with
                same name. Default: ``None``.
            internal (bool): Restrict external access to the network. Default
                ``False``.
            labels (dict): Map of labels to set on the network. Default
                ``None``.
            enable_ipv6 (bool): Enable IPv6 on the network. Default ``False``.
            attachable (bool): If enabled, and the network is in the global
                scope,  non-service containers on worker nodes will be able to
                connect to the network.
            scope (str): Specify the network's scope (``local``, ``global`` or
                ``swarm``)
            ingress (bool): If set, create an ingress network which provides
                the routing-mesh in swarm mode.

        Returns:
            (:py:class:`Network`): The network that was created.

        Raises:
            :py:class:`docker.errors.APIError`
                If the server returns an error.

        Example:
            A network using the bridge driver:

                >>> client.networks.create("network1", driver="bridge")

            You can also create more advanced networks with custom IPAM
            configurations. For example, setting the subnet to
            ``192.168.52.0/24`` and gateway address to ``192.168.52.254``.

            .. code-block:: python

                >>> ipam_pool = docker.types.IPAMPool(
                    subnet='192.168.52.0/24',
                    gateway='192.168.52.254'
                )
                >>> ipam_config = docker.types.IPAMConfig(
                    pool_configs=[ipam_pool]
                )
                >>> client.networks.create(
                    "network1",
                    driver="bridge",
                    ipam=ipam_config
                )

        �Id)rr�create_networkr)r
rrr �resprrr�createds8zNetworkCollection.createcOs"|�|jjj|g|�Ri|���S)aU
        Get a network by its ID.

        Args:
            network_id (str): The ID of the network.
            verbose (bool): Retrieve the service details across the cluster in
                swarm mode.
            scope (str): Filter the network by scope (``swarm``, ``global``
                or ``local``).

        Returns:
            (:py:class:`Network`) The network.

        Raises:
            :py:class:`docker.errors.NotFound`
                If the network does not exist.

            :py:class:`docker.errors.APIError`
                If the server returns an error.

        )�
prepare_modelrr�inspect_network)r
�
network_idrr rrrr�s�zNetworkCollection.getcs\|�dd�}�jjj|i|��}�fdd�|D�}|r,t�jjjd�r,|D]}|��q%|S)a�
        List networks. Similar to the ``docker networks ls`` command.

        Args:
            names (:py:class:`list`): List of names to filter by.
            ids (:py:class:`list`): List of ids to filter by.
            filters (dict): Filters to be processed on the network list.
                Available filters:
                - ``driver=[<driver-name>]`` Matches a network's driver.
                - `label` (str|list): format either ``"key"``, ``"key=value"``
                    or a list of such.
                - ``type=["custom"|"builtin"]`` Filters networks by type.
            greedy (bool): Fetch more details for each network individually.
                You might want this to get the containers attached to them.

        Returns:
            (list of :py:class:`Network`) The networks on the server.

        Raises:
            :py:class:`docker.errors.APIError`
                If the server returns an error.
        �greedyFcsg|]}��|��qSr)r0)r�itemrrrr�sz*NetworkCollection.list.<locals>.<listcomp>z1.28)�poprr�networksr�_version�reload)r
rr r3r.r6�netrrr�list�s
zNetworkCollection.listNcCs|jjj|d�S)N)�filters)rr�prune_networks)r
r;rrr�prune�szNetworkCollection.prune)N)r&r'r(r)r�modelr/rr:r=rr<rrrrr+^s;
r+N)rr�utilsrrr�resourcerrrr+rrrr�<module>sW