
    h_                     d    d dl mZ d dlmZ ddlmZ ddlmZmZ  G d de      Z	 G d d	e      Z
y
)   )	APIClient)version_gte   )	Container)Model
Collectionc                   B    e Zd ZdZed        Zed        Zd Zd Zd Z	y)Networkz
    A Docker network.
    c                 8    | j                   j                  d      S )z*
        The name of the network.
        Name)attrsgetselfs    8/usr/lib/python3/dist-packages/docker/models/networks.pynamezNetwork.name   s    
 zz~~f%%    c                     | j                   j                  d      xs i j                         D cg c]'  }| j                  j                  j                  |      ) c}S c c}w )z
        The containers that are connected to the network, as a list of
        :py:class:`~docker.models.containers.Container` objects.
        
Containers)r   r   keysclient
containers)r   cids     r   r   zNetwork.containers   sQ     ZZ^^L)/R557
03DKK""&&s+
 	
 
s   ,Ac                     t        |t              r|j                  } | j                  j                  j
                  || j                  g|i |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kwargss       r   connectzNetwork.connect   sM    6 i+!I;t{{;;tww
!%
)/
 	
r   c                     t        |t              r|j                  } | j                  j                  j
                  || j                  g|i |S )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.
        )r   r   r   r   r   !disconnect_container_from_networkr   s       r   
disconnectzNetwork.disconnect>   sM     i+!I@t{{@@tww
!%
)/
 	
r   c                 `    | j                   j                  j                  | j                        S )z
        Remove this network.

        Raises:
            :py:class:`docker.errors.APIError`
                If the server returns an error.
        )r   r   remove_networkr   r   s    r   removezNetwork.removeS   s!     {{--dgg66r   N)
__name__
__module____qualname____doc__propertyr   r   r#   r&   r)    r   r   r
   r
      s?     & & 
 

B
*7r   r
   c                   d    e Zd ZdZeZd Zd Zd ZddZ	e
j                  j                  e	_        y)NetworkCollectionz(
    Networks on the Docker server.
    c                 ~     | j                   j                  j                  |g|i |}| j                  |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)r   r   create_networkr   )r   r   r!   r"   resps        r   createzNetworkCollection.created   s<    p .t{{--dDTDVDxxT
##r   c                 t    | j                   | j                  j                  j                  |g|i |      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_modelr   r   inspect_network)r   
network_idr!   r"   s       r   r   zNetworkCollection.get   s9    , !!+DKKOO++JHHH
 	
r   c                 B   |j                  dd      } | j                  j                  j                  |i |}|D cg c]  }| j	                  |       }}|rAt        | j                  j                  j                  d      r|D ]  }|j                           |S c c}w )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.
        greedyFz1.28)popr   r   networksr8   r   _versionreload)r   r!   r"   r<   r5   itemr>   nets           r   listzNetworkCollection.list   s    . He,'t{{''889=>D&&t,>>k$++//":":FC 

	 ?s   BNc                 N    | j                   j                  j                  |      S )N)filters)r   r   prune_networks)r   rE   s     r   prunezNetworkCollection.prune   s    {{--g->>r   )N)r*   r+   r,   r-   r
   modelr6   r   rC   rG   r   rF   r/   r   r   r1   r1   ^   s6     E9$v
4>?,,44EMr   r1   N)r   r   utilsr   r   r   resourcer   r   r
   r1   r/   r   r   <module>rK      s.      ! 'T7e T7n|5
 |5r   