Don't render default values for store_true and store_false actions (#30)

Author: mondeja

CHANGELOG.md

@@ -2,6 +2,11 @@
 
 All notable changes to this project will be documented in this file.
 
+## 1.8.1
+
+- Fix reference clashing for options which only differ between upper and lower case
+- Do not render default values for `store_true` and `store_false` actions
+
 ## 1.6.0 (2021-04-15)
 
 - Support for using the `ref` sphinx role to refer to all anchor-able objects generated by the tool

roots/test-store-true-false/conf.py

@@ -0,0 +1,8 @@
+from __future__ import annotations
+
+import sys
+from pathlib import Path
+
+sys.path.insert(0, str(Path(__file__).parent))
+extensions = ["sphinx_argparse_cli"]
+nitpicky = True

roots/test-store-true-false/index.rst

@@ -0,0 +1,3 @@
+.. sphinx_argparse_cli::
+  :module: parser
+  :func: make

roots/test-store-true-false/parser.py

@@ -0,0 +1,10 @@
+from __future__ import annotations
+
+from argparse import ArgumentParser
+
+
+def make() -> ArgumentParser:
+    parser = ArgumentParser(prog="basic")
+    parser.add_argument("--no-foo", dest="foo", action="store_false")
+    parser.add_argument("--bar", dest="bar", action="store_true")
+    return parser

setup.cfg

@@ -63,6 +63,7 @@ noqa-require-code = true
 dictionaries = en_US,python,technical
 ignore =
     E203 # whitespace before :
+    W503 # line break before binary operator
 
 [coverage:report]
 show_missing = True

src/sphinx_argparse_cli/_logic.py

@@ -9,6 +9,8 @@
     ArgumentParser,
     HelpFormatter,
     _ArgumentGroup,
+    _StoreFalseAction,
+    _StoreTrueAction,
     _SubParsersAction,
 )
 from collections import defaultdict, namedtuple
@@ -209,7 +211,11 @@ def _mk_option_line(self, action: Action, prefix: str) -> list_item:
             line += Text(" - ")
             for content in cast(paragraph, temp.children[0]).children:
                 line += content
-        if action.default != SUPPRESS and not re.match(r".*[ (]default[s]? .*", (action.help or "")):
+        if (
+            action.default != SUPPRESS
+            and not re.match(r".*[ (]default[s]? .*", (action.help or ""))
+            and not isinstance(action, (_StoreTrueAction, _StoreFalseAction))
+        ):
             line += Text(" (default: ")
             line += literal(text=str(action.default).replace(os.getcwd(), "{cwd}"))
             line += Text(")")

tests/complex.txt

@@ -12,9 +12,9 @@ complex options
 
 * **"-h"**, **"--help"** - show this help message and exit
 
-* **"--root"** - root flag (default: "False")
+* **"--root"** - root flag
 
-* **"--no-help"** (default: "False")
+* **"--no-help"**
 
 * **"--outdir"** "OUT_DIR", **"-o"** "OUT_DIR" - output directory
   (default: "None")
@@ -28,9 +28,9 @@ complex Exclusive
 
 this is an exclusive group
 
-* **"--foo"** - foo (default: "False")
+* **"--foo"** - foo
 
-* **"--bar"** - bar (default: "False")
+* **"--bar"** - bar
 
 
 complex first (f)
@@ -54,9 +54,9 @@ complex first options
 
 * **"-h"**, **"--help"** - show this help message and exit
 
-* **"--flag"** - a parser first flag (default: "False")
+* **"--flag"** - a parser first flag
 
-* **"--root"** - root flag (default: "False")
+* **"--root"** - root flag
 
 
 complex second
@@ -78,9 +78,9 @@ complex second options
 
 * **"-h"**, **"--help"** - show this help message and exit
 
-* **"--flag"** - a parser second flag (default: "False")
+* **"--flag"** - a parser second flag
 
-* **"--root"** - root flag (default: "False")
+* **"--root"** - root flag
 
 
 complex third

tests/complex_pre_310.txt

@@ -12,9 +12,9 @@ complex optional arguments
 
 * **"-h"**, **"--help"** - show this help message and exit
 
-* **"--root"** - root flag (default: "False")
+* **"--root"** - root flag
 
-* **"--no-help"** (default: "False")
+* **"--no-help"**
 
 * **"--outdir"** "OUT_DIR", **"-o"** "OUT_DIR" - output directory
   (default: "None")
@@ -28,9 +28,9 @@ complex Exclusive
 
 this is an exclusive group
 
-* **"--foo"** - foo (default: "False")
+* **"--foo"** - foo
 
-* **"--bar"** - bar (default: "False")
+* **"--bar"** - bar
 
 
 complex first (f)
@@ -54,9 +54,9 @@ complex first optional arguments
 
 * **"-h"**, **"--help"** - show this help message and exit
 
-* **"--flag"** - a parser first flag (default: "False")
+* **"--flag"** - a parser first flag
 
-* **"--root"** - root flag (default: "False")
+* **"--root"** - root flag
 
 
 complex second
@@ -78,9 +78,9 @@ complex second optional arguments
 
 * **"-h"**, **"--help"** - show this help message and exit
 
-* **"--flag"** - a parser second flag (default: "False")
+* **"--flag"** - a parser second flag
 
-* **"--root"** - root flag (default: "False")
+* **"--root"** - root flag
 
 
 complex third

tests/test_logic.py

@@ -201,3 +201,9 @@ def test_group_title_prefix_sub_command_replacement(build_outcome: str, opt_grp_
     assert '<h2>bar Exclusive<a class="headerlink" href="#bar-exclusive"' in build_outcome
     assert '<h2>bar baronlyroot (f)<a class="headerlink" href="#bar-root-first-(f)"' in build_outcome
     assert '<h3>bar baronlyroot first positional arguments<a class="headerlink"' in build_outcome
+
+
+@pytest.mark.sphinx(buildername="html", testroot="store-true-false")
+def test_store_true_false(build_outcome: str) -> None:
+    assert "False" not in build_outcome
+    assert "True" not in build_outcome