cpus renamed to nano_cpus. Type and scale of nano_cpus are changed. Comments for new parameters are changed.

Signed-off-by: Alexey Rokhin <[email protected]>

Author: AlexeyRokhin

docker/models/containers.py

@@ -456,13 +456,13 @@ def run(self, image, command=None, stdout=True, stderr=False,
             cap_add (list of str): Add kernel capabilities. For example,
                 ``["SYS_ADMIN", "MKNOD"]``.
             cap_drop (list of str): Drop kernel capabilities.
-            cpu_count (int): CPU count (Windows only).
-            cpu_percent (int): CPU percent (Windows only).
+            cpu_count (int): Number of usable CPUs (Windows only).
+            cpu_percent (int): Usable percentage of the available CPUs
+                (Windows only).
             cpu_period (int): The length of a CPU period in microseconds.
             cpu_quota (int): Microseconds of CPU time that the container can
                 get in a CPU period.
             cpu_shares (int): CPU shares (relative weight).
-            cpus (float): Number of CPUs.
             cpuset_cpus (str): CPUs in which to allow execution (``0-3``,
                 ``0,1``).
             detach (bool): Run container in the background and return a
@@ -526,6 +526,7 @@ def run(self, image, command=None, stdout=True, stderr=False,
             networks (:py:class:`list`): A list of network names to connect
                 this container to.
             name (str): The name for this container.
+            nano_cpus (int):  CPU quota in units of 10-9 CPUs.
             network_disabled (bool): Disable networking.
             network_mode (str): One of:
 
@@ -809,7 +810,6 @@ def prune(self, filters=None):
     'cpu_period',
     'cpu_quota',
     'cpu_shares',
-    'cpus',
     'cpuset_cpus',
     'device_read_bps',
     'device_read_iops',
@@ -833,6 +833,7 @@ def prune(self, filters=None):
     'mem_reservation',
     'mem_swappiness',
     'memswap_limit',
+    'nano_cpus',
     'network_mode',
     'oom_kill_disable',
     'oom_score_adj',

docker/types/containers.py

@@ -119,7 +119,7 @@ def __init__(self, version, binds=None, port_bindings=None,
                  cpuset_cpus=None, userns_mode=None, pids_limit=None,
                  isolation=None, auto_remove=False, storage_opt=None,
                  init=None, init_path=None, volume_driver=None,
-                 cpu_count=None, cpu_percent=None, cpus=None):
+                 cpu_count=None, cpu_percent=None, nano_cpus=None):
 
         if mem_limit is not None:
             self['Memory'] = parse_bytes(mem_limit)
@@ -450,13 +450,13 @@ def __init__(self, version, binds=None, port_bindings=None,
 
             self['CpuPercent'] = cpu_percent
 
-        if cpus:
-            if not isinstance(cpus, (float, int)):
-                raise host_config_type_error('cpus', cpus, 'float')
+        if nano_cpus:
+            if not isinstance(nano_cpus, int):
+                raise host_config_type_error('nano_cpus', nano_cpus, 'int')
             if version_lt(version, '1.25'):
-                raise host_config_version_error('cpus', '1.25')
+                raise host_config_version_error('nano_cpus', '1.25')
 
-            self['NanoCpus'] = int(1000000000 * cpus)
+            self['NanoCpus'] = nano_cpus
 
 
 def host_config_type_error(param, param_value, expected):

tests/unit/api_container_test.py

@@ -1158,7 +1158,7 @@ def test_create_container_with_host_config_cpus(self):
             'busybox', 'ls', host_config=self.client.create_host_config(
                 cpu_count=1,
                 cpu_percent=20,
-                cpus=10
+                nano_cpus=1000
             )
         )
 
@@ -1177,10 +1177,12 @@ def test_create_container_with_host_config_cpus(self):
                              "HostConfig": {
                                 "CpuCount": 1,
                                 "CpuPercent": 20,
-                                "NanoCpus": 10000000000,
+                                "NanoCpus": 1000,
                                 "NetworkMode": "default"
                              }}'''))
-        self.assertEqual(args[1]['headers'], {'Content-Type': 'application/json'})
+        self.assertEqual(
+            args[1]['headers'], {'Content-Type': 'application/json'}
+        )
 
 
 class ContainerTest(BaseAPIClientTest):

tests/unit/dockertypes_test.py

@@ -172,7 +172,7 @@ def test_create_host_config_with_volume_driver(self):
 
         config = create_host_config(version='1.21', volume_driver='local')
         assert config.get('VolumeDriver') == 'local'
-    
+
     def test_create_host_config_invalid_cpu_count_types(self):
         with pytest.raises(TypeError):
             create_host_config(version='1.25', cpu_count='1')
@@ -195,16 +195,16 @@ def test_create_host_config_with_cpu_percent(self):
             InvalidVersion, lambda: create_host_config(
                 version='1.24', cpu_percent=10))
 
-    def test_create_host_config_invalid_cpus_types(self):
+    def test_create_host_config_invalid_nano_cpus_types(self):
         with pytest.raises(TypeError):
-            create_host_config(version='1.25', cpus='0')
+            create_host_config(version='1.25', nano_cpus='0')
 
-    def test_create_host_config_with_cpus(self):
-        config = create_host_config(version='1.25', cpus=100)
-        self.assertEqual(config.get('NanoCpus'), 100000000000)
+    def test_create_host_config_with_nano_cpus(self):
+        config = create_host_config(version='1.25', nano_cpus=1000)
+        self.assertEqual(config.get('NanoCpus'), 1000)
         self.assertRaises(
             InvalidVersion, lambda: create_host_config(
-                version='1.24', cpus=1))
+                version='1.24', nano_cpus=1))
 
 
 class ContainerConfigTest(unittest.TestCase):