Move config type creation from docker.utils functions to classes in

docker.types

Signed-off-by: Joffrey F <[email protected]>

Author: shin-

docker/api/container.py

@@ -4,7 +4,9 @@
 
 from .. import errors
 from .. import utils
-from ..utils.utils import create_networking_config, create_endpoint_config
+from ..types import (
+    ContainerConfig, EndpointConfig, HostConfig, NetworkingConfig
+)
 
 
 class ContainerApiMixin(object):
@@ -430,16 +432,16 @@ def create_container(self, image, command=None, hostname=None, user=None,
             )
 
         config = self.create_container_config(
-            image, command, hostname, user, detach, stdin_open,
-            tty, mem_limit, ports, environment, dns, volumes, volumes_from,
+            image, command, hostname, user, detach, stdin_open, tty, mem_limit,
+            ports, dns, environment, volumes, volumes_from,
             network_disabled, entrypoint, cpu_shares, working_dir, domainname,
             memswap_limit, cpuset, host_config, mac_address, labels,
             volume_driver, stop_signal, networking_config, healthcheck,
         )
         return self.create_container_from_config(config, name)
 
     def create_container_config(self, *args, **kwargs):
-        return utils.create_container_config(self._version, *args, **kwargs)
+        return ContainerConfig(self._version, *args, **kwargs)
 
     def create_container_from_config(self, config, name=None):
         u = self._url("/containers/create")
@@ -582,7 +584,7 @@ def create_host_config(self, *args, **kwargs):
                 "keyword argument 'version'"
             )
         kwargs['version'] = self._version
-        return utils.create_host_config(*args, **kwargs)
+        return HostConfig(*args, **kwargs)
 
     def create_networking_config(self, *args, **kwargs):
         """
@@ -608,7 +610,7 @@ def create_networking_config(self, *args, **kwargs):
             )
 
         """
-        return create_networking_config(*args, **kwargs)
+        return NetworkingConfig(*args, **kwargs)
 
     def create_endpoint_config(self, *args, **kwargs):
         """
@@ -641,7 +643,7 @@ def create_endpoint_config(self, *args, **kwargs):
             )
 
         """
-        return create_endpoint_config(self._version, *args, **kwargs)
+        return EndpointConfig(self._version, *args, **kwargs)
 
     @utils.check_resource
     def diff(self, container):

docker/api/network.py

@@ -46,8 +46,7 @@ def create_network(self, name, driver=None, options=None, ipam=None,
             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 (dict): Optional custom IP scheme for the network.
-                Created with :py:meth:`~docker.utils.create_ipam_config`.
+            ipam (IPAMConfig): Optional custom IP scheme for the network.
             check_duplicate (bool): Request daemon to check for networks with
                 same name. Default: ``True``.
             internal (bool): Restrict external access to the network. Default
@@ -74,11 +73,11 @@ def create_network(self, name, driver=None, options=None, ipam=None,
 
             .. code-block:: python
 
-                >>> ipam_pool = docker.utils.create_ipam_pool(
+                >>> ipam_pool = docker.types.IPAMPool(
                     subnet='192.168.52.0/24',
                     gateway='192.168.52.254'
                 )
-                >>> ipam_config = docker.utils.create_ipam_config(
+                >>> ipam_config = docker.types.IPAMConfig(
                     pool_configs=[ipam_pool]
                 )
                 >>> docker_client.create_network("network1", driver="bridge",

docker/api/swarm.py

@@ -1,5 +1,6 @@
 import logging
 from six.moves import http_client
+from .. import types
 from .. import utils
 log = logging.getLogger(__name__)
 
@@ -50,7 +51,7 @@ def create_swarm_spec(self, *args, **kwargs):
               force_new_cluster=False, swarm_spec=spec
             )
         """
-        return utils.SwarmSpec(*args, **kwargs)
+        return types.SwarmSpec(*args, **kwargs)
 
     @utils.minimum_version('1.24')
     def init_swarm(self, advertise_addr=None, listen_addr='0.0.0.0:2377',

docker/models/containers.py

@@ -2,7 +2,7 @@
 
 from ..errors import (ContainerError, ImageNotFound,
                       create_unexpected_kwargs_error)
-from ..utils import create_host_config
+from ..types import HostConfig
 from .images import Image
 from .resource import Collection, Model
 
@@ -869,7 +869,7 @@ def _create_container_args(kwargs):
     if kwargs:
         raise create_unexpected_kwargs_error('run', kwargs)
 
-    create_kwargs['host_config'] = create_host_config(**host_config_kwargs)
+    create_kwargs['host_config'] = HostConfig(**host_config_kwargs)
 
     # Fill in any kwargs which need processing by create_host_config first
     port_bindings = create_kwargs['host_config'].get('PortBindings')

docker/models/networks.py

@@ -98,7 +98,7 @@ def create(self, name, *args, **kwargs):
             driver (str): Name of the driver used to create the network
             options (dict): Driver options as a key-value dictionary
             ipam (dict): Optional custom IP scheme for the network.
-                Created with :py:meth:`~docker.utils.create_ipam_config`.
+                Created with :py:class:`~docker.types.IPAMConfig`.
             check_duplicate (bool): Request daemon to check for networks with
                 same name. Default: ``True``.
             internal (bool): Restrict external access to the network. Default
@@ -125,11 +125,11 @@ def create(self, name, *args, **kwargs):
 
             .. code-block:: python
 
-                >>> ipam_pool = docker.utils.create_ipam_pool(
+                >>> ipam_pool = docker.types.IPAMPool(
                     subnet='192.168.52.0/24',
                     gateway='192.168.52.254'
                 )
-                >>> ipam_config = docker.utils.create_ipam_config(
+                >>> ipam_config = docker.types.IPAMConfig(
                     pool_configs=[ipam_pool]
                 )
                 >>> client.networks.create(

docker/types/__init__.py

@@ -1,8 +1,9 @@
 # flake8: noqa
-from .containers import LogConfig, Ulimit
+from .containers import ContainerConfig, HostConfig, LogConfig, Ulimit
+from .healthcheck import Healthcheck
+from .networks import EndpointConfig, IPAMConfig, IPAMPool, NetworkingConfig
 from .services import (
     ContainerSpec, DriverConfig, EndpointSpec, Mount, Resources, RestartPolicy,
     TaskTemplate, UpdateConfig
 )
-from .healthcheck import Healthcheck
 from .swarm import SwarmSpec, SwarmExternalCA