Cleanup Standalone CLI

Author: jwindgassen

jupyter_server_proxy/standalone/app.py

@@ -58,7 +58,7 @@ def _validate_prefix(self, proposal):
             prefix = prefix[:-1]
         return prefix
 
-    skip_authentication = Bool(
+    no_authentication = Bool(
         default=False,
         help="""
         Do not authenticate access to the server via JupyterHub. When set,
@@ -146,11 +146,16 @@ def __init__(self, **kwargs):
                 {"ServerProcess": {"raw_socket_proxy": True}},
                 dedent(ServerProcess.raw_socket_proxy.help),
             ),
-            "skip-authentication": (
-                {"StandaloneProxyServer": {"skip_authentication": True}},
-                dedent(self.__class__.skip_authentication.help),
+            "no-authentication": (
+                {"StandaloneProxyServer": {"no_authentication": True}},
+                dedent(self.__class__.no_authentication.help),
             ),
         }
+        self.flags.pop("y")
+
+        # Some traits in ServerProcess are not defined to be configurable, but we need that for the standalone proxy
+        for name, trait in ServerProcess.class_own_traits().items():
+            trait.tag(config=True)
 
         # Create an Alias to all Traits defined in ServerProcess, with some
         # exceptions we do not need, for easier use of the CLI
@@ -164,20 +169,20 @@ def __init__(self, **kwargs):
             "command",
         ]
         server_process_aliases = {
-            trait: f"StandaloneProxyServer.{trait}"
+            trait.replace("_", "-"): f"StandaloneProxyServer.{trait}"
             for trait in ServerProcess.class_traits(config=True)
             if trait not in ignore_traits and trait not in self.flags
         }
 
         self.aliases = {
             **super().aliases,
             **server_process_aliases,
-            "base_url": "StandaloneProxyServer.base_url",
+            "base-url": "StandaloneProxyServer.base_url",
             "address": "StandaloneProxyServer.address",
             "port": "StandaloneProxyServer.port",
-            "server_port": "StandaloneProxyServer.server_port",
-            "activity_interval": "StandaloneProxyServer.activity_interval",
-            "websocket_max_message_size": "StandaloneProxyServer.websocket_max_message_size",
+            "server-port": "StandaloneProxyServer.server_port",
+            "activity-interval": "StandaloneProxyServer.activity_interval",
+            "websocket-max-message-size": "StandaloneProxyServer.websocket_max_message_size",
         }
 
     def emit_alias_help(self):
@@ -206,7 +211,7 @@ def get_proxy_attributes(self) -> dict:
         attributes["proxy_base"] = "/"
 
         attributes["requested_port"] = self.server_port
-        attributes["skip_authentication"] = self.skip_authentication
+        attributes["no_authentication"] = self.no_authentication
 
         return attributes
 
@@ -278,7 +283,7 @@ def _configure_ssl(self) -> dict | None:
         return ssl_options
 
     def start(self):
-        if self.skip_authentication:
+        if self.no_authentication:
             self.log.warn("Disabling Authentication with JuypterHub Server!")
 
         app = self.create_app()

jupyter_server_proxy/standalone/proxy.py

@@ -32,7 +32,7 @@ def __init__(self, *args, **kwargs):
             super().__init__(*args, **kwargs)
             self.environment = {}
             self.timeout = 60
-            self.skip_authentication = False
+            self.no_authentication = False
 
         @property
         def log(self) -> Logger:
@@ -69,7 +69,7 @@ def write_error(self, status_code: int, **kwargs):
             return RequestHandler.write_error(self, status_code, **kwargs)
 
         async def proxy(self, port, path):
-            if self.skip_authentication:
+            if self.no_authentication:
                 return await super().proxy(port, path)
             else:
                 return await ensure_async(self.oauth_proxy(port, path))

tests/test_standalone.py

@@ -40,7 +40,7 @@ class _TestStandaloneBase(testing.AsyncHTTPTestCase):
     runTest = None  # Required for Tornado 6.1
 
     unix_socket: bool
-    skip_authentication: bool
+    no_authentication: bool
 
     def get_app(self):
         command = [
@@ -55,7 +55,7 @@ def get_app(self):
             base_url="/some/prefix",
             unix_socket=self.unix_socket,
             timeout=60,
-            skip_authentication=self.skip_authentication,
+            no_authentication=self.no_authentication,
             log_level=logging.DEBUG,
         )
 
@@ -69,7 +69,7 @@ class TestStandaloneProxyRedirect(_TestStandaloneBase):
     """
 
     unix_socket = False
-    skip_authentication = True
+    no_authentication = True
 
     def test_add_slash(self):
         response = self.fetch("/some/prefix", follow_redirects=False)
@@ -97,7 +97,7 @@ def test_on_prefix(self):
 )
 class TestStandaloneProxyWithUnixSocket(_TestStandaloneBase):
     unix_socket = True
-    skip_authentication = True
+    no_authentication = True
 
     def test_with_unix_socket(self):
         response = self.fetch("/some/prefix/")
@@ -115,7 +115,7 @@ class TestStandaloneProxyLogin(_TestStandaloneBase):
     """
 
     unix_socket = False
-    skip_authentication = False
+    no_authentication = False
 
     def test_redirect_to_login_url(self):
         response = self.fetch("/some/prefix/", follow_redirects=False)