Suppress newline from click.echo

Author: NickCao

packages/jumpstarter-cli-admin/jumpstarter_cli_admin/create.py

@@ -5,6 +5,7 @@
 from jumpstarter_cli_common import (
     AliasedGroup,
     OutputType,
+    echo,
     opt_context,
     opt_kubeconfig,
     opt_labels,
@@ -38,7 +39,7 @@ def create(log_level: Optional[str]):
 
 def print_created_client(client: V1Alpha1Client, output: OutputType):
     if output is not None:
-        click.echo(client.dump(output))
+        echo(client.dump(output))
 
 
 @create.command("client")
@@ -123,7 +124,7 @@ async def create_client(
 
 def print_created_exporter(exporter: V1Alpha1Exporter, output: OutputType):
     if output is not None:
-        click.echo(exporter.dump(output))
+        echo(exporter.dump(output))
 
 
 @create.command("exporter")

packages/jumpstarter-cli-admin/jumpstarter_cli_admin/create_test.py

@@ -66,7 +66,6 @@
   credential:
     name: {name}-credential
   endpoint: {endpoint}
-
 """.format(name=CLIENT_NAME, endpoint=CLIENT_ENDPOINT)
 
 UNSAFE_CLIENT_CONFIG = ClientConfigV1Alpha1(
@@ -214,7 +213,6 @@ async def test_create_client(
     name: {name}-credential
   devices: []
   endpoint: {endpoint}
-
 """.format(name=EXPORTER_NAME, endpoint=EXPORTER_ENDPOINT)
 
 EXPORTER_CONFIG = ExporterConfigV1Alpha1(

packages/jumpstarter-cli-admin/jumpstarter_cli_admin/get_test.py

@@ -75,7 +75,6 @@ def getheaders(self):
   credential:
     name: test-credential
   endpoint: grpc://example.com:443
-
 """
 
 
@@ -217,7 +216,6 @@ async def test_get_client(_load_kube_config_mock, get_client_mock: AsyncMock):
       name: another-credential
     endpoint: grpc://example.com:443
 kind: ClientList
-
 """
 
 CLIENTS_LIST_NAME = """client.jumpstarter.dev/test
@@ -227,7 +225,6 @@ async def test_get_client(_load_kube_config_mock, get_client_mock: AsyncMock):
 CLIENTS_LIST_EMPTY_YAML = """apiVersion: jumpstarter.dev/v1alpha1
 items: []
 kind: ClientList
-
 """
 
 
@@ -334,7 +331,6 @@ async def test_get_clients(_load_kube_config_mock, list_clients_mock: AsyncMock)
     name: test-credential
   devices: []
   endpoint: grpc://example.com:443
-
 """
 
 
@@ -448,7 +444,6 @@ async def test_get_exporter(_load_kube_config_mock, get_exporter_mock: AsyncMock
       hardware: rpi4
     uuid: f7cd30ac-64a3-42c6-ba31-b25f033b97c1
   endpoint: grpc://example.com:443
-
 """
 
 
@@ -592,7 +587,6 @@ async def test_get_exporter_devices(_load_kube_config_mock, get_exporter_mock: A
     devices: []
     endpoint: grpc://example.com:443
 kind: ExporterList
-
 """
 
 EXPORTERS_LIST_NAME = """exporter.jumpstarter.dev/test
@@ -760,7 +754,6 @@ async def test_get_exporters(_load_kube_config_mock, list_exporters_mock: AsyncM
       uuid: f7cd30ac-64a3-42c6-ba31-b25f033b97c1
     endpoint: grpc://example.com:443
 kind: ExporterList
-
 """
 
 EXPORTERS_DEVICES_LIST_NAME = EXPORTERS_LIST_NAME
@@ -936,7 +929,6 @@ async def test_get_exporters_devices(_load_kube_config_mock, list_exporters_mock
   ended: true
   exporter:
     name: test_exporter
-
 """
 
 
@@ -1145,7 +1137,6 @@ async def test_get_lease(_load_kube_config_mock, get_lease_mock: AsyncMock):
     exporter:
       name: test_exporter
 kind: LeaseList
-
 """
 
 LEASES_LIST_NAME = """lease.jumpstarter.dev/82a8ac0d-d7ff-4009-8948-18a3c5c607b1

packages/jumpstarter-cli-admin/jumpstarter_cli_admin/print.py

@@ -2,6 +2,7 @@
 from jumpstarter_cli_common import (
     OutputMode,
     OutputType,
+    echo,
     make_table,
     time_since,
 )
@@ -26,19 +27,19 @@ def make_client_row(client: V1Alpha1Client):
 def print_client(client: V1Alpha1Client, output: OutputType):
     match output:
         case OutputMode.JSON | OutputMode.YAML | OutputMode.NAME:
-            click.echo(client.dump(output))
+            echo(client.dump(output))
         case _:
-            click.echo(make_table(CLIENT_COLUMNS, [make_client_row(client)]))
+            echo(make_table(CLIENT_COLUMNS, [make_client_row(client)]))
 
 
 def print_clients(clients: V1Alpha1List[V1Alpha1Client], namespace: str, output: OutputType):
     match output:
         case OutputMode.JSON | OutputMode.YAML | OutputMode.NAME:
-            click.echo(clients.dump(output))
+            echo(clients.dump(output))
         case _:
             if len(clients.items) == 0:
                 raise click.ClickException(f'No resources found in "{namespace}" namespace')
-            click.echo(make_table(CLIENT_COLUMNS, list(map(make_client_row, clients.items))))
+            echo(make_table(CLIENT_COLUMNS, list(map(make_client_row, clients.items))))
 
 
 EXPORTER_COLUMNS = ["NAME", "ENDPOINT", "DEVICES", "AGE"]
@@ -80,26 +81,26 @@ def get_device_rows(exporters: list[V1Alpha1Exporter]):
 def print_exporter(exporter: V1Alpha1Exporter, devices: bool, output: OutputType):
     match output:
         case OutputMode.JSON | OutputMode.YAML | OutputMode.NAME:
-            click.echo(exporter.dump(output))
+            echo(exporter.dump(output))
         case _:
             if devices:
                 # Print the devices for the exporter
-                click.echo(make_table(DEVICE_COLUMNS, get_device_rows([exporter])))
+                echo(make_table(DEVICE_COLUMNS, get_device_rows([exporter])))
             else:
-                click.echo(make_table(EXPORTER_COLUMNS, [make_exporter_row(exporter)]))
+                echo(make_table(EXPORTER_COLUMNS, [make_exporter_row(exporter)]))
 
 
 def print_exporters(exporters: V1Alpha1List[V1Alpha1Exporter], namespace: str, devices: bool, output: OutputType):
     match output:
         case OutputMode.JSON | OutputMode.YAML | OutputMode.NAME:
-            click.echo(exporters.dump(output))
+            echo(exporters.dump(output))
         case _:
             if len(exporters.items) == 0:
                 raise click.ClickException(f'No resources found in "{namespace}" namespace')
             if devices:
-                click.echo(make_table(DEVICE_COLUMNS, get_device_rows(exporters.items)))
+                echo(make_table(DEVICE_COLUMNS, get_device_rows(exporters.items)))
             else:
-                click.echo(make_table(EXPORTER_COLUMNS, list(map(make_exporter_row, exporters.items))))
+                echo(make_table(EXPORTER_COLUMNS, list(map(make_exporter_row, exporters.items))))
 
 
 LEASE_COLUMNS = ["NAME", "CLIENT", "SELECTOR", "EXPORTER", "STATUS", "REASON", "BEGIN", "END", "DURATION", "AGE"]
@@ -144,16 +145,16 @@ def make_lease_row(lease: V1Alpha1Lease):
 def print_lease(lease: V1Alpha1Lease, output: OutputType):
     match output:
         case OutputMode.JSON | OutputMode.YAML | OutputMode.NAME:
-            click.echo(lease.dump(output))
+            echo(lease.dump(output))
         case _:
-            click.echo(make_table(LEASE_COLUMNS, [make_lease_row(lease)]))
+            echo(make_table(LEASE_COLUMNS, [make_lease_row(lease)]))
 
 
 def print_leases(leases: V1Alpha1List[V1Alpha1Lease], namespace: str, output: OutputType):
     match output:
         case OutputMode.JSON | OutputMode.YAML | OutputMode.NAME:
-            click.echo(leases.dump(output))
+            echo(leases.dump(output))
         case _:
             if len(leases.items) == 0:
                 raise click.ClickException(f'No resources found in "{namespace}" namespace')
-            click.echo(make_table(LEASE_COLUMNS, list(map(make_lease_row, leases.items))))
+            echo(make_table(LEASE_COLUMNS, list(map(make_lease_row, leases.items))))

packages/jumpstarter-cli-common/jumpstarter_cli_common/__init__.py

@@ -1,5 +1,6 @@
 from .alias import AliasedGroup
 from .config import opt_config
+from .echo import echo
 from .opt import (
     NameOutputType,
     OutputMode,
@@ -21,6 +22,7 @@
 
 __all__ = [
     "AliasedGroup",
+    "echo",
     "make_table",
     "opt_config",
     "opt_context",

packages/jumpstarter-cli-common/jumpstarter_cli_common/echo.py

@@ -0,0 +1,5 @@
+from functools import partial
+
+import asyncclick as click
+
+echo = partial(click.echo, nl=False)

packages/jumpstarter-kubernetes/jumpstarter_kubernetes/json.py

@@ -14,6 +14,6 @@ def dump(self, mode: OutputType = None):
                 return super().dump(mode)
 
     def dump_name(self):
-        return "{}.jumpstarter.dev/{}".format(self.kind.lower(), self.metadata.name)
+        return "{}.jumpstarter.dev/{}\n".format(self.kind.lower(), self.metadata.name)
 
     model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)

packages/jumpstarter-kubernetes/jumpstarter_kubernetes/list.py

@@ -15,4 +15,4 @@ class V1Alpha1List(JsonBaseModel, Generic[T]):
     kind: Literal["List"] = Field(default="List")
 
     def dump_name(self):
-        return "\n".join(item.dump_name() for item in self.items)
+        return "".join(item.dump_name() for item in self.items)

packages/jumpstarter/jumpstarter/common/pydantic.py

@@ -23,7 +23,7 @@ def dump(self, mode: OutputType = None):
                 raise NotImplementedError("unimplemented output mode: {}".format(mode))
 
     def dump_json(self):
-        return self.model_dump_json(indent=4, by_alias=True)
+        return self.model_dump_json(indent=4, by_alias=True) + "\n"
 
     def dump_yaml(self):
         return yaml.safe_dump(self.model_dump(mode="json", by_alias=True), indent=2)