Fix pod log stream follow detection

Author: goutamadwant

kubernetes/base/watch/watch.py

@@ -19,7 +19,7 @@
 from kubernetes import client
 
 PYDOC_RETURN_LABEL = ":rtype:"
-PYDOC_FOLLOW_PARAM = ":param bool follow:"
+PYDOC_FOLLOW_PARAMS = (":param bool follow:", ":param follow:")
 
 # Removing this suffix from return type name should give us event's object
 # type. e.g., if list_namespaces() returns "NamespaceList" type,
@@ -111,7 +111,8 @@ def get_return_type(self, func):
         return return_type
 
     def get_watch_argument_name(self, func):
-        if PYDOC_FOLLOW_PARAM in pydoc.getdoc(func):
+        doc = pydoc.getdoc(func)
+        if any(param in doc for param in PYDOC_FOLLOW_PARAMS):
             return 'follow'
         else:
             return 'watch'

kubernetes/base/watch/watch_test.py

@@ -19,6 +19,7 @@
 
 from kubernetes import client, config
 from kubernetes.client import ApiException
+from kubernetes.client.exceptions import ApiTypeError
 
 from .watch import Watch
 
@@ -223,6 +224,44 @@ def test_watch_for_follow(self):
         fake_resp.close.assert_called_once()
         fake_resp.release_conn.assert_called_once()
 
+    def test_watch_for_follow_with_split_param_type_docstring(self):
+        fake_resp = Mock()
+        fake_resp.close = Mock()
+        fake_resp.release_conn = Mock()
+        fake_resp.stream = Mock(
+            return_value=[
+                'log_line_1\n',
+                'log_line_2\n'])
+
+        def read_pod_log(*args, **kwargs):
+            if 'watch' in kwargs:
+                raise ApiTypeError(
+                    "Got an unexpected keyword argument 'watch'"
+                    " to method read_namespaced_pod_log")
+            return fake_resp
+
+        fake_api = Mock()
+        fake_api.read_namespaced_pod_log = Mock(side_effect=read_pod_log)
+        fake_api.read_namespaced_pod_log.__doc__ = (
+            ':param follow: Follow the log stream of the pod. Defaults to false.\n'
+            ':type follow: bool\n'
+            ':rtype: str')
+
+        w = Watch()
+        count = 1
+        for e in w.stream(fake_api.read_namespaced_pod_log):
+            self.assertEqual("log_line_1", e)
+            count += 1
+            if count == 2:
+                w.stop()
+
+        fake_api.read_namespaced_pod_log.assert_called_once_with(
+            _preload_content=False, follow=True)
+        fake_resp.stream.assert_called_once_with(
+            amt=None, decode_content=False)
+        fake_resp.close.assert_called_once()
+        fake_resp.release_conn.assert_called_once()
+
     def test_watch_resource_version_set(self):
         # https://github.com/kubernetes-client/python/issues/700
         # ensure watching from a resource version does reset to resource