Добавление примеров использования и описания в argparse

Author: YariKartoshe4ka

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.2.0
+    rev: v4.3.0
     hooks:
       - id: check-builtin-literals
       - id: check-docstring-first
@@ -17,7 +17,7 @@ repos:
       - id: isort
 
   - repo: https://github.com/PyCQA/flake8
-    rev: 4.0.1
+    rev: 5.0.4
     hooks:
       - id: flake8
         additional_dependencies:

vkms/argparser.py

@@ -13,14 +13,26 @@ def _format_action_invocation(self, action):
         return '/'.join(action.option_strings) + ' ' + args_string
 
 
+description = 'Utility for saving VKontakte conversations'
+epilog = '''examples:
+  %(prog)s -vv -i c45,558891166 dump --export-json
+  %(prog)s -e 100,-22822305 parse -f html
+  %(prog)s atch --ts photos,audios
+'''
+
+
 def parse_args():
     """
     Создает объект парсера и парсит аргументы
 
     Returns:
         argparse.Namespace: Набор аргументов парсера
     """
-    parser = ArgumentParser(formatter_class=CustomHelpFormatter)
+    parser = ArgumentParser(
+        formatter_class=CustomHelpFormatter,
+        description=description,
+        epilog=epilog
+    )
 
     parser.add_argument(
         '-o',
@@ -66,7 +78,9 @@ def parse_args():
         'dump',
         help='Save only the necessary information (VK API method outputs) '
              'in a machine-friendly format (SQLite + JSON) for further processing',
-        formatter_class=CustomHelpFormatter
+        formatter_class=CustomHelpFormatter,
+        description=description,
+        epilog=epilog
     )
 
     parser_dump.add_argument(
@@ -105,7 +119,9 @@ def parse_args():
     parser_parse = subparsers.add_parser(
         'parse',
         help='Convert machine-friendly JSON format to human-readable',
-        formatter_class=CustomHelpFormatter
+        formatter_class=CustomHelpFormatter,
+        description=description,
+        epilog=epilog
     )
 
     parser_parse.add_argument(
@@ -121,7 +137,9 @@ def parse_args():
     parser_atch = subparsers.add_parser(
         'atch',
         help='Download messages attachments (photos, audio, etc.)',
-        formatter_class=CustomHelpFormatter
+        formatter_class=CustomHelpFormatter,
+        description=description,
+        epilog=epilog
     )
 
     parser_atch.add_argument(