Merge pull request #76 from wj-Mcat/main

Make the __doc__ the description for a Tap object by default.

Author: martinjm97

tap/_version.py

@@ -1,7 +1,7 @@
 __all__ = ['__version__']
 
 # major, minor, patch
-version_info = 1, 7, 2
+version_info = 1, 7, 3
 
 # Nice string for the version
 __version__ = '.'.join(map(str, version_info))

tap/tap.py

@@ -110,6 +110,8 @@ def __init__(self,
         # Indicate that initialization is complete
         self._initialized = True
 
+        self.description = self.__doc__ or ''
+
     def _add_argument(self, *name_or_flags, **kwargs) -> None:
         """Adds an argument to self (i.e. the super class ArgumentParser).
 
@@ -311,6 +313,9 @@ def process_args(self) -> None:
 
     def add_subparser(self, flag: str, subparser_type: type, **kwargs) -> None:
         """Add a subparser to the collection of subparsers"""
+        help_desc = kwargs.get('help', subparser_type.__doc__)
+        kwargs['help'] = help_desc
+        
         self._subparser_buffer.append((flag, subparser_type, kwargs))
 
     def _add_subparsers(self) -> None:

tests/test_integration.py

@@ -3,6 +3,7 @@
 import os
 from pathlib import Path
 import pickle
+from re import L
 import sys
 from tempfile import TemporaryDirectory
 from typing import Any, Iterable, List, Optional, Set, Tuple, Union
@@ -1561,5 +1562,33 @@ def test_pickle(self):
         self.assertEqual(loaded_args.as_dict(), args.as_dict())
 
 
+class TestParserDescription(TestCase):
+    def test_root_parser_description(self):
+        class RootParser(Tap):
+            """<Root Parser>"""
+            field: str = '1'
+        
+        root_parser = RootParser()
+        help_info = root_parser.format_help()
+        self.assertIn('<Root Parser>', help_info)
+
+    def test_sub_parser_description(self):
+
+        class SubParser(Tap):
+            """<Sub Parser>"""
+            sub_field: str = '2'
+        
+        class RootParser(Tap):
+            """<Root Parser>"""
+            field: str = '1'
+
+            def configure(self):
+                self.add_subparsers(help='All sub parser')
+                self.add_subparser('sub', SubParser)
+        
+        help_desc = RootParser().format_help()
+        self.assertIn('<Sub Parser>', help_desc)
+        self.assertIn('<Root Parser>', help_desc)
+
 if __name__ == '__main__':
     unittest.main()