Add better inspector arg parsing (#2642)

Author: ahopkins

sanic/cli/app.py

@@ -148,8 +148,17 @@ def _inspector(self):
         if unknown:
             for arg in unknown:
                 if arg.startswith("--"):
-                    key, value = arg.split("=")
-                    setattr(self.args, key.lstrip("-"), value)
+                    try:
+                        key, value = arg.split("=")
+                        key = key.lstrip("-")
+                    except ValueError:
+                        value = False if arg.startswith("--no-") else True
+                        key = (
+                            arg.replace("--no-", "")
+                            .lstrip("-")
+                            .replace("-", "_")
+                        )
+                    setattr(self.args, key, value)
 
         kwargs = {**self.args.__dict__}
         host = kwargs.pop("host")

sanic/cli/inspector.py

@@ -47,11 +47,16 @@ def make_inspector_parser(parser: ArgumentParser) -> None:
         action=SanicSubParsersAction,
         dest="action",
         description=(
-            "Run one of the below subcommands. If you have created a custom "
-            "Inspector instance, then you can run custom commands. See ___ "
+            "Run one or none of the below subcommands. Using inspect without "
+            "a subcommand will fetch general information about the state "
+            "of the application instance.\n\n"
+            "Or, you can optionally follow inspect with a subcommand. "
+            "If you have created a custom "
+            "Inspector instance, then you can run custom commands. See "
+            "https://sanic.dev/en/guide/deployment/inspector.html"
             "for more details."
         ),
-        title="Required\n========\n  Subcommands",
+        title="  Subcommands",
         parser_class=InspectorSubParser,
     )
     reloader = subparsers.add_parser(

sanic/config.py

@@ -126,7 +126,9 @@ class Config(dict, metaclass=DescriptorMeta):
 
     def __init__(
         self,
-        defaults: Dict[str, Union[str, bool, int, float, None]] = None,
+        defaults: Optional[
+            Dict[str, Union[str, bool, int, float, None]]
+        ] = None,
         env_prefix: Optional[str] = SANIC_PREFIX,
         keep_alive: Optional[bool] = None,
         *,

sanic/worker/inspector.py

@@ -71,7 +71,8 @@ async def _action(self, request: Request, action: str):
             kwargs = {}
             if request.body:
                 kwargs = request.json
-            output = method(**kwargs)
+            args = kwargs.pop("args", ())
+            output = method(*args, **kwargs)
             if isawaitable(output):
                 output = await output
 

tests/test_cli.py

@@ -326,6 +326,8 @@ def test_inspector_inspect(urlopen, caplog, capsys):
         (["shutdown"], {}),
         (["scale", "9"], {"replicas": 9}),
         (["foo", "--bar=something"], {"bar": "something"}),
+        (["foo", "--bar"], {"bar": True}),
+        (["foo", "--no-bar"], {"bar": False}),
         (["foo", "positional"], {"args": ["positional"]}),
         (
             ["foo", "positional", "--bar=something"],