docs: docstrings for parsers

jina/parsers/base.py

@@ -1,3 +1,4 @@
+"""Module containing the base parser for arguments of Jina."""
 import argparse
 
 from .helper import _chf

jina/parsers/check.py

@@ -1,3 +1,4 @@
+"""Argparser module for the check functions"""
 from .base import set_base_parser
 
 

jina/parsers/client.py

@@ -1,3 +1,4 @@
+"""Module for argparse for Client"""
 from .helper import add_arg_group
 from ..enums import RequestType
 

jina/parsers/export_api.py

@@ -1,3 +1,4 @@
+"""Argparser module for the export API"""
 from .base import set_base_parser
 
 

jina/parsers/flow.py

@@ -1,3 +1,4 @@
+"""Argparser module for Flow"""
 import argparse
 
 from .base import set_base_parser

jina/parsers/helloworld.py

@@ -1,3 +1,4 @@
+"""Module for hello world argparser"""
 import argparse
 
 from pkg_resources import resource_filename

jina/parsers/helper.py

@@ -1,6 +1,8 @@
+"""Module for helper functions in the parser"""
 import argparse
 import os
 import uuid
+from typing import Tuple
 
 _SHOW_ALL_ARGS = 'JINA_FULL_CLI' in os.environ
 if _SHOW_ALL_ARGS:
@@ -12,8 +14,12 @@ def add_arg_group(parser, title):
     return parser.add_argument_group(f'{title} arguments')
 
 
-def UUIDString(astring):
-    """argparse type to check if a string is a valid UUID string"""
+def UUIDString(astring) -> str:
+    """argparse type to check if a string is a valid UUID string
+
+    :param astring: the string to check
+    :return: the string
+    """
     uuid.UUID(astring)
     return astring
 
@@ -179,8 +185,12 @@ def _fill_text(self, text, width, indent):
         lines = self._para_reformat(text, width)
         return '\n'.join(lines)
 
-    def _indents(self, line):
-        """Return line indent level and "sub_indent" for bullet list text."""
+    def _indents(self, line) -> Tuple[int, int]:
+        """Return line indent level and "sub_indent" for bullet list text.
+
+        :param line: the line to check
+        :return: indentation of line and indentation of sub-items
+        """
         import re
         indent = len(re.match(r'( *)', line).group(1))
         list_match = re.match(r'( *)(([*\-+>]+|\w+\)|\w+\.) +)', line)
@@ -192,7 +202,11 @@ def _indents(self, line):
         return (indent, sub_indent)
 
     def _split_paragraphs(self, text):
-        """Split text in to paragraphs of like-indented lines."""
+        """Split text into paragraphs of like-indented lines.
+
+        :param text: the text input
+        :return: list of paragraphs
+        """
 
         import textwrap, re
 
@@ -218,7 +232,12 @@ def _split_paragraphs(self, text):
         return paragraphs
 
     def _para_reformat(self, text, width):
-        """Reformat text, by paragraph."""
+        """Format text, by paragraph.
+
+        :param text: the text to format
+        :param width: the width to apply
+        :return: the new text
+        """
 
         import textwrap
 

jina/parsers/hub/build.py

@@ -1,3 +1,4 @@
+"""Argparser module for hub build"""
 from ..helper import add_arg_group
 from ...enums import BuildTestLevel
 

jina/parsers/hub/list.py

@@ -1,3 +1,4 @@
+"""Argparser module for hub list"""
 from ..helper import add_arg_group
 
 

jina/parsers/hub/login.py

@@ -1,3 +1,4 @@
+"""Argparser module for hub login"""
 import os
 
 from ..helper import add_arg_group

jina/parsers/hub/new.py

@@ -1,3 +1,4 @@
+"""Argparser module for hub new"""
 from ..helper import add_arg_group
 
 

jina/parsers/hub/pushpull.py

@@ -1,3 +1,4 @@
+"""Argparser module for hub push & pull"""
 from ..helper import add_arg_group
 
 

jina/parsers/logger.py

@@ -1,7 +1,12 @@
+"""Argparser module Loggers"""
 from .base import set_base_parser
 
 
 def set_logger_parser(parser=None):
+    """
+    :param parser: the parser instance to which we add arguments
+    :return: the parser instance
+    """
     if not parser:
         parser = set_base_parser()
 

jina/parsers/optimizer.py

@@ -1,3 +1,4 @@
+"""Argparser module for Optimizer"""
 from .base import set_base_parser
 from .peapods.base import mixin_base_ppr_parser
 

jina/parsers/peapods/base.py

@@ -1,3 +1,4 @@
+"""Base argparser module for Pea and Pod runtime"""
 import argparse
 
 from pkg_resources import resource_filename
@@ -8,6 +9,7 @@
 
 def mixin_base_ppr_parser(parser):
     """Mixing in arguments required by pea/pod/runtime module into the given parser.
+    :param parser: the parser instance to which we add arguments
     """
 
     gp = add_arg_group(parser, title='Essential')

jina/parsers/peapods/pea.py

@@ -1,3 +1,4 @@
+"""Argparser module for Pea runtimes"""
 import argparse
 
 from ..helper import add_arg_group, _SHOW_ALL_ARGS, KVAppendAction
@@ -7,6 +8,7 @@
 
 def mixin_pea_parser(parser):
     """Mixing in arguments required by :class:`BasePea` into the given parser.
+    :param parser: the parser instance to which we add arguments
     """
 
     gp = add_arg_group(parser, title='Pea')

jina/parsers/peapods/pod.py

@@ -1,11 +1,14 @@
+"""Argparser module for Pod runtimes"""
 import argparse
 
 from jina.enums import PollingType, SchedulerType, PodRoleType
 from jina.parsers.helper import add_arg_group, _SHOW_ALL_ARGS
 
 
 def mixin_base_pod_parser(parser):
-    """Mixing in arguments required by :class:`BasePod` into the given parser. """
+    """Mixing in arguments required by :class:`BasePod` into the given parser.
+    :param parser: the parser instance to which we add arguments
+    """
     gp = add_arg_group(parser, title='Pod')
 
     gp.add_argument('--uses-before', type=str,

jina/parsers/peapods/runtimes/container.py

@@ -1,8 +1,11 @@
+"""Argparser module for container runtimes"""
 from ...helper import add_arg_group, DockerKwargsAppendAction
 
 
 def mixin_container_runtime_parser(parser):
-    """Mixing in arguments required by :class:`ContainerRuntime` into the given parser."""
+    """Mixing in arguments required by :class:`ContainerRuntime` into the given parser.
+    :param parser: the parser instance to which we add arguments
+    """
     gp = add_arg_group(parser, title='ContainerRuntime')
 
     gp.add_argument('--uses-internal', type=str, default='BaseExecutor',

jina/parsers/peapods/runtimes/distributed.py

@@ -1,15 +1,20 @@
+"""Argparser module for distributed runtimes"""
 from jina.helper import random_identity
 from jina.parsers.helper import add_arg_group
 
 
 def mixin_distributed_feature_parser(parser):
-    """Mixing in arguments required by :class:`BasePod` into the given parser. """
+    """Mixing in arguments required by :class:`BasePod` into the given parser.
+    :param parser: the parser instance to which we add arguments
+    """
+
     gp = add_arg_group(parser, title='Distributed')
 
     gp.add_argument('--silent-remote-logs', action='store_true', default=False,
                     help='Do not display the streaming of remote logs on local console')
 
     gp.add_argument('--upload-files', type=str, nargs='*', metavar='FILE',
+
                     help='''
 The files on the host to be uploaded to the remote
 workspace. This can be useful when your Pod has more

jina/parsers/peapods/runtimes/remote.py

@@ -1,3 +1,4 @@
+"""Argparser module for remote runtime"""
 from ...helper import add_arg_group
 from .... import __default_host__
 from ....enums import CompressAlgo

jina/parsers/peapods/runtimes/zed.py

@@ -1,3 +1,4 @@
+"""Argparser module for ZED runtime"""
 import argparse
 
 from ...helper import add_arg_group, _SHOW_ALL_ARGS
@@ -7,7 +8,9 @@
 
 
 def mixin_zed_runtime_parser(parser):
-    """Mixing in arguments required by :class:`ZEDRuntime` into the given parser."""
+    """Mixing in arguments required by :class:`ZEDRuntime` into the given parser.
+    :param parser: the parser instance to which we add arguments
+    """
 
     gp = add_arg_group(parser, title='ZEDRuntime')
 
@@ -80,4 +83,3 @@ def mixin_zed_runtime_parser(parser):
     gp.add_argument('--num-part', type=int, default=0,
                     help='the number of messages expected from upstream, 0 and 1 means single part'
                     if _SHOW_ALL_ARGS else argparse.SUPPRESS)
-

jina/parsers/peapods/runtimes/zmq.py

@@ -1,11 +1,14 @@
+"""Argparser module for ZMQ runtimes"""
 import os
 
 from ...helper import add_arg_group
 from ....helper import random_port
 
 
 def mixin_zmq_runtime_parser(parser):
-    """Mixing in arguments required by :class:`ZMQRuntime` into the given parser."""
+    """Mixing in arguments required by :class:`ZMQRuntime` into the given parser.
+    :param parser: the parser instance to which we add arguments
+    """
 
     gp = add_arg_group(parser, title='ZMQRuntime')
     gp.add_argument('--port-ctrl', type=int, default=os.environ.get('JINA_CONTROL_PORT', random_port()),

jina/parsers/ping.py

@@ -1,3 +1,4 @@
+"""Argparser module for pinging"""
 from .base import set_base_parser