add tcp_keepalive to Config object

botocore/args.py

@@ -234,7 +234,9 @@ def compute_client_args(
             'protocol': protocol,
             'config_kwargs': config_kwargs,
             's3_config': s3_config,
-            'socket_options': self._compute_socket_options(scoped_config),
+            'socket_options': self._compute_socket_options(
+                scoped_config, client_config
+            ),
         }
 
     def compute_s3_config(self, client_config):
@@ -387,16 +389,17 @@ def _resolve_endpoint(
             service_name, region_name, endpoint_url, is_secure
         )
 
-    def _compute_socket_options(self, scoped_config):
+    def _compute_socket_options(self, scoped_config, client_config=None):
         # This disables Nagle's algorithm and is the default socket options
         # in urllib3.
         socket_options = [(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)]
-        if scoped_config:
-            # Enables TCP Keepalive if specified in shared config file.
-            if self._ensure_boolean(scoped_config.get('tcp_keepalive', False)):
-                socket_options.append(
-                    (socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1)
-                )
+        client_keepalive = client_config and client_config.tcp_keepalive
+        scoped_keepalive = scoped_config and self._ensure_boolean(
+            scoped_config.get("tcp_keepalive", False)
+        )
+        # Enables TCP Keepalive if specified in client config object or shared config file.
+        if client_keepalive or scoped_keepalive:
+            socket_options.append((socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1))
         return socket_options
 
     def _compute_retry_config(self, config_kwargs):

botocore/config.py

@@ -183,6 +183,12 @@ class Config:
         endpoint resolution.
 
         Defaults to None.
+
+    :type tcp_keepalive: bool
+    :param tcp_keepalive: Enables the TCP Keep-Alive socket option used when
+        creating new connections if set to True.
+
+        Defaults to False.
     """
 
     OPTION_DEFAULTS = OrderedDict(
@@ -205,6 +211,7 @@ class Config:
             ('use_dualstack_endpoint', None),
             ('use_fips_endpoint', None),
             ('defaults_mode', None),
+            ('tcp_keepalive', None),
         ]
     )
 

tests/unit/test_args.py

@@ -189,7 +189,7 @@ def test_region_does_not_resolve_if_not_s3_and_endpoint_url_provided(self):
         )
         self.assertEqual(client_args['client_config'].region_name, None)
 
-    def test_tcp_keepalive_enabled(self):
+    def test_tcp_keepalive_enabled_scoped_config(self):
         scoped_config = {'tcp_keepalive': 'true'}
         with mock.patch('botocore.args.EndpointCreator') as m:
             self.call_get_client_args(scoped_config=scoped_config)
@@ -200,13 +200,39 @@ def test_tcp_keepalive_enabled(self):
             )
 
     def test_tcp_keepalive_not_specified(self):
-        scoped_config = {}
         with mock.patch('botocore.args.EndpointCreator') as m:
-            self.call_get_client_args(scoped_config=scoped_config)
+            self.call_get_client_args(scoped_config={}, client_config=None)
+            self.assert_create_endpoint_call(
+                m, socket_options=self.default_socket_options
+            )
+            self.call_get_client_args(
+                scoped_config=None, client_config=Config()
+            )
             self.assert_create_endpoint_call(
                 m, socket_options=self.default_socket_options
             )
 
+    def test_tcp_keepalive_enabled_if_set_anywhere(self):
+        with mock.patch('botocore.args.EndpointCreator') as m:
+            self.call_get_client_args(
+                scoped_config={'tcp_keepalive': 'true'},
+                client_config=Config(tcp_keepalive=False),
+            )
+            self.assert_create_endpoint_call(
+                m,
+                socket_options=self.default_socket_options
+                + [(socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1)],
+            )
+            self.call_get_client_args(
+                scoped_config={'tcp_keepalive': 'false'},
+                client_config=Config(tcp_keepalive=True),
+            )
+            self.assert_create_endpoint_call(
+                m,
+                socket_options=self.default_socket_options
+                + [(socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1)],
+            )
+
     def test_tcp_keepalive_explicitly_disabled(self):
         scoped_config = {'tcp_keepalive': 'false'}
         with mock.patch('botocore.args.EndpointCreator') as m: