[io] feat: add jsonl format to ConsoleWriter

Author: AndreyMarkinPPC

libs/garf_io/README.md

@@ -9,7 +9,7 @@ Currently it supports writing data to the following destination:
 
 | identifier | Writer           | Options  |
 |------------| ---------------- | -------- |
-| `console`  | ConsoleWriter    | `page-size=10`,`format=table\|json`|
+| `console`  | ConsoleWriter    | `page-size=10`,`format=table\|json\|jsonl`|
 | `csv`      | CsvWriter        | `destination-folder` |
 | `json`     | JsonWriter       | `destination-folder`,`format=json\|jsonl`|
 | `bq`       | BigQueryWriter   | `project`, `dataset`, `location`, `write-disposition` |

libs/garf_io/garf_io/__init__.py

@@ -12,4 +12,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-__version__ = '0.0.6'
+__version__ = '0.0.7'

libs/garf_io/garf_io/writers/console_writer.py

@@ -15,9 +15,10 @@
 
 from __future__ import annotations
 
+from typing import Literal
+
 import rich
 from rich import console, table
-from rich import json as rich_json
 
 from garf_core import report as garf_report
 from garf_io.writers import abs_writer
@@ -32,13 +33,16 @@ class ConsoleWriter(abs_writer.AbsWriter):
   """
 
   def __init__(
-    self, page_size: int = 10, format: str = 'table', **kwargs: str
+    self,
+    page_size: int = 10,
+    format: Literal['table', 'json', 'jsonl'] = 'table',
+    **kwargs: str,
   ) -> None:
     """Initializes ConsoleWriter.
 
     Args:
         page_size: How many row of report should be written
-        format: Type of output ('table', 'json').
+        format: Type of output.
         kwargs: Optional parameter to initialize writer.
     """
     super().__init__(**kwargs)
@@ -68,5 +72,7 @@ def write(self, report: garf_report.GarfReport, destination: str) -> None:
         if i < self.page_size:
           output_table.add_row(*[str(field) for field in row])
     elif self.format == 'json':
-      output_table = rich_json.JSON(report.to_json())
+      output_table = report.to_json()
+    elif self.format == 'jsonl':
+      output_table = report.to_jsonl()
     console.Console().print(output_table)

libs/garf_io/tests/unit/writers/test_console_writer.py

@@ -94,3 +94,30 @@ def test_write_multi_column_report_with_arrays_returns_concatenated_strings(
     expected_result = json.loads(sample_data.to_json())
     res = json.loads(prepared_output.replace("'", '"'))
     assert res == expected_result
+
+
+class TestConsoleJsonlWriter:
+  @pytest.fixture
+  def console_writer(self):
+    return console_writer.ConsoleWriter(format='jsonl')
+
+  def test_write_multi_column_report_returns_arrays(
+    self, capsys, console_writer, sample_data
+  ):
+    console_writer.array_handling = 'arrays'
+    console_writer.write(sample_data, _TMP_NAME)
+    output = capsys.readouterr().out.strip()
+    for i, res in enumerate(output.split('\n')):
+      expected_result = sample_data[i].to_dict()
+      assert json.loads(res) == expected_result
+
+  def test_write_multi_column_report_with_arrays_returns_concatenated_strings(
+    self, capsys, console_writer, sample_data
+  ):
+    console_writer.array_handling = 'strings'
+    console_writer.write(sample_data, _TMP_NAME)
+    output = capsys.readouterr().out.strip()
+    for i, res in enumerate(output.split('\n')):
+      expected_result = sample_data[i].to_dict()
+      expected_result['column_3'] = '3|4'
+      assert json.loads(res) == expected_result