Add support for 3.10 (#13)

Author: gaborbernat

.github/workflows/check.yml

@@ -22,14 +22,15 @@ jobs:
         os:
           - Ubuntu
         py:
+          - 3.10.0-rc.2
           - 3.9
           - 3.8
           - 3.7
     steps:
       - name: setup python for tox
         uses: actions/setup-python@v2
         with:
-          python-version: 3.9
+          python-version: 3.10.0-rc.2
       - name: install tox
         run: python -m pip install tox
       - uses: actions/checkout@v2
@@ -67,10 +68,10 @@ jobs:
           - pkg_check
     steps:
       - uses: actions/checkout@v2
-      - name: setup Python 3.9
+      - name: setup Python 3.10.0-rc.2
         uses: actions/setup-python@v2
         with:
-          python-version: 3.9
+          python-version: 3.10.0-rc.2
       - name: install tox
         run: python -m pip install tox
       - name: run check for ${{ matrix.tox_env }}
@@ -86,7 +87,7 @@ jobs:
       - name: setup python to build package
         uses: actions/setup-python@v2
         with:
-          python-version: 3.9
+          python-version: 3.10.0-rc.2
       - name: install build
         run: python -m pip install build
       - uses: actions/checkout@v2

.pre-commit-config.yaml

@@ -10,7 +10,7 @@ repos:
       - id: end-of-file-fixer
       - id: trailing-whitespace
   - repo: https://github.com/asottile/pyupgrade
-    rev: v2.28.0
+    rev: v2.29.0
     hooks:
       - id: pyupgrade
   - repo: https://github.com/PyCQA/isort
@@ -27,7 +27,7 @@ repos:
     rev: v1.17.0
     hooks:
       - id: setup-cfg-fmt
-        args: ["--max-py-version", "3.9"]
+        args: ["--max-py-version", "3.10"]
   - repo: https://github.com/tox-dev/tox-ini-fmt
     rev: "0.5.1"
     hooks:
@@ -36,10 +36,12 @@ repos:
     rev: "3.9.2"
     hooks:
       - id: flake8
-        additional_dependencies: [
-            "flake8-bugbear == 21.4.3",
-            "flake8-unused-arguments == 0.0.6",
-            "flake8-comprehensions == 3.5.0",
-            "flake8-spellcheck == 0.24.0",
-            "flake8-pytest-style == 1.4.2",
-        ]
+        additional_dependencies:
+        - flake8-bugbear==21.9.2
+        - flake8-comprehensions==3.6.1
+        - flake8-pytest-style==1.5
+        - flake8-spellcheck==0.24
+        - flake8-unused-arguments==0.0.6
+        - flake8-noqa==1.1.0
+        - flake8-eradicate==1.1.0
+        - pep8-naming==0.12.1

setup.cfg

@@ -24,6 +24,7 @@ classifiers =
     Programming Language :: Python :: 3.7
     Programming Language :: Python :: 3.8
     Programming Language :: Python :: 3.9
+    Programming Language :: Python :: 3.10
     Programming Language :: Python :: Implementation :: CPython
     Topic :: Documentation
     Topic :: Documentation :: Sphinx
@@ -55,9 +56,13 @@ test =
 sphinx_argparse_cli = py.typed
 
 [flake8]
+max-complexity = 22
 max-line-length = 120
-ignore = F401, H301, E203
+unused-arguments-ignore-abstract-functions = true
+noqa-require-code = true
 dictionaries = en_US,python,technical
+ignore =
+    E203 # whitespace before :
 
 [coverage:report]
 show_missing = True

src/sphinx_argparse_cli/_logic.py

@@ -3,9 +3,14 @@
 import os
 import re
 import sys
-from argparse import _ArgumentGroup  # noqa
-from argparse import _SubParsersAction  # noqa
-from argparse import SUPPRESS, Action, ArgumentParser, HelpFormatter
+from argparse import (
+    SUPPRESS,
+    Action,
+    ArgumentParser,
+    HelpFormatter,
+    _ArgumentGroup,
+    _SubParsersAction,
+)
 from collections import defaultdict, namedtuple
 from typing import Iterator, cast
 
@@ -89,17 +94,17 @@ def parser(self) -> ArgumentParser:
         return self._parser
 
     def load_sub_parsers(self) -> Iterator[tuple[list[str], str, ArgumentParser]]:
-        top_sub_parser = self.parser._subparsers  # noqa
+        top_sub_parser = self.parser._subparsers
         if not top_sub_parser:
             return
         parser_to_args: dict[int, list[str]] = defaultdict(list)
         str_to_parser: dict[str, ArgumentParser] = {}
-        sub_parser = cast(_SubParsersAction, top_sub_parser._group_actions[0])  # noqa
-        for key, parser in sub_parser._name_parser_map.items():  # noqa
+        sub_parser = cast(_SubParsersAction, top_sub_parser._group_actions[0])
+        for key, parser in sub_parser._name_parser_map.items():
             parser_to_args[id(parser)].append(key)
             str_to_parser[key] = parser
         done_parser: set[int] = set()
-        for name, parser in sub_parser.choices.items():  # noqa
+        for name, parser in sub_parser.choices.items():
             parser_id = id(parser)
             if parser_id in done_parser:
                 continue
@@ -124,8 +129,8 @@ def run(self) -> list[Node]:
             home_section += desc_paragraph
         # construct groups excluding sub-parsers
         home_section += self._mk_usage(self.parser)
-        for group in self.parser._action_groups:  # noqa
-            if not group._group_actions or group is self.parser._subparsers:  # noqa
+        for group in self.parser._action_groups:
+            if not group._group_actions or group is self.parser._subparsers:
                 continue
             home_section += self._mk_option_group(group, prefix=self.parser.prog.split("/")[-1])
         # construct sub-parser
@@ -147,7 +152,7 @@ def _mk_option_group(self, group: _ArgumentGroup, prefix: str) -> section:
             group_section += paragraph("", Text(group.description))
         self._register_ref(ref_id, title_text, group_section)
         opt_group = bullet_list()
-        for action in group._group_actions:  # noqa
+        for action in group._group_actions:
             point = self._mk_option_line(action, prefix)
             opt_group += point
         group_section += opt_group
@@ -176,7 +181,7 @@ def _build_opt_grp_title(self, group: _ArgumentGroup, prefix: str, sub_title_pre
         title_text += group.title or ""
         return title_text
 
-    def _mk_option_line(self, action: Action, prefix: str) -> list_item:  # noqa
+    def _mk_option_line(self, action: Action, prefix: str) -> list_item:
         line = paragraph()
         as_key = action.dest
         if action.metavar:
@@ -259,7 +264,7 @@ def _mk_sub_command(self, aliases: list[str], help_msg: str, parser: ArgumentPar
             desc_paragraph = paragraph("", Text(command_desc))
             group_section += desc_paragraph
         group_section += self._mk_usage(parser)
-        for group in parser._action_groups:  # noqa
+        for group in parser._action_groups:
             if not group._group_actions:  # do not show empty groups
                 continue
             group_section += self._mk_option_group(group, prefix=parser.prog)

tests/complex.txt

@@ -7,8 +7,8 @@ argparse tester
            {first,f,second,third} ...
 
 
-complex optional arguments
-==========================
+complex options
+===============
 
 * **"-h"**, **"--help"** - show this help message and exit
 
@@ -49,8 +49,8 @@ complex first positional arguments
 * **"pos_two"** - second positional argument (default: "1")
 
 
-complex first optional arguments
---------------------------------
+complex first options
+---------------------
 
 * **"-h"**, **"--help"** - show this help message and exit
 
@@ -73,8 +73,8 @@ complex second positional arguments
 * **"pos_two"** - second positional argument (default: "green")
 
 
-complex second optional arguments
----------------------------------
+complex second options
+----------------------
 
 * **"-h"**, **"--help"** - show this help message and exit
 
@@ -89,7 +89,7 @@ complex third
    complex third [-h]
 
 
-complex third optional arguments
---------------------------------
+complex third options
+---------------------
 
 * **"-h"**, **"--help"** - show this help message and exit

tests/complex_pre_310.txt

@@ -0,0 +1,95 @@
+complex - CLI interface
+***********************
+
+argparse tester
+
+   complex [-h] [--root] [--no-help] [--outdir out_dir] [--in-dir IN_DIR] [--foo | --bar]
+           {first,f,second,third} ...
+
+
+complex optional arguments
+==========================
+
+* **"-h"**, **"--help"** - show this help message and exit
+
+* **"--root"** - root flag (default: "False")
+
+* **"--no-help"** (default: "False")
+
+* **"--outdir"** "OUT_DIR", **"-o"** "OUT_DIR" - output directory
+  (default: "None")
+
+* **"--in-dir"** "IN_DIR", **"-i"** "IN_DIR" - input directory
+  (default: "None")
+
+
+complex Exclusive
+=================
+
+this is an exclusive group
+
+* **"--foo"** - foo (default: "False")
+
+* **"--bar"** - bar (default: "False")
+
+
+complex first (f)
+=================
+
+a-first-desc
+
+   complex first [-h] [--flag] [--root] one pos_two
+
+
+complex first positional arguments
+----------------------------------
+
+* **"one"** - first positional argument (default: "None")
+
+* **"pos_two"** - second positional argument (default: "1")
+
+
+complex first optional arguments
+--------------------------------
+
+* **"-h"**, **"--help"** - show this help message and exit
+
+* **"--flag"** - a parser first flag (default: "False")
+
+* **"--root"** - root flag (default: "False")
+
+
+complex second
+==============
+
+   complex second [-h] [--flag] [--root] one pos_two
+
+
+complex second positional arguments
+-----------------------------------
+
+* **"one"** - first positional argument (default: "None")
+
+* **"pos_two"** - second positional argument (default: "green")
+
+
+complex second optional arguments
+---------------------------------
+
+* **"-h"**, **"--help"** - show this help message and exit
+
+* **"--flag"** - a parser second flag (default: "False")
+
+* **"--root"** - root flag (default: "False")
+
+
+complex third
+=============
+
+   complex third [-h]
+
+
+complex third optional arguments
+--------------------------------
+
+* **"-h"**, **"--help"** - show this help message and exit