[DOP-21442] Add Excel API schema

Author: Ilyas Gasanov

syncmaster/schemas/v1/transfers/file_format.py

@@ -18,7 +18,7 @@ class CSV(BaseModel):
     encoding: str = "utf-8"
     quote: str = '"'
     escape: str = "\\"
-    header: bool = False
+    include_header: bool = False
     line_sep: str = "\n"
 
 
@@ -36,5 +36,5 @@ class JSON(BaseModel):
 
 class Excel(BaseModel):
     type: EXCEL_FORMAT
-    include_header: bool
+    include_header: bool = False
     start_cell: str | None = None

tests/resources/file_df_connection/generate_files.py

@@ -103,11 +103,11 @@ def _to_string(obj):
     return obj
 
 
-def _write_csv(data: list[dict], file: TextIO, header: bool = False, **kwargs) -> None:
+def _write_csv(data: list[dict], file: TextIO, include_header: bool = False, **kwargs) -> None:
     columns = list(data[0].keys())
     writer = csv.DictWriter(file, fieldnames=columns, lineterminator="\n", **kwargs)
 
-    if header:
+    if include_header:
         writer.writeheader()
 
     for row in data:
@@ -123,7 +123,7 @@ def save_as_csv_without_header(data: list[dict], path: Path) -> None:
 def save_as_csv_with_header(data: list[dict], path: Path) -> None:
     path.mkdir(parents=True, exist_ok=True)
     with open(path / "file.csv", "w", newline="") as file:
-        _write_csv(data, file, header=True)
+        _write_csv(data, file, include_header=True)
 
 
 def save_as_csv_with_delimiter(data: list[dict], path: Path) -> None:
@@ -403,12 +403,12 @@ def save_as_xlsx(data: list[dict], path: Path) -> None:
     shutil.rmtree(root, ignore_errors=True)
     root.mkdir(parents=True, exist_ok=True)
 
-    save_as_xlsx_with_options(data, root / "without_header", header=False)
-    save_as_xlsx_with_options(data, root / "with_header", header=True)
+    save_as_xlsx_with_options(data, root / "without_header", include_header=False)
+    save_as_xlsx_with_options(data, root / "with_header", include_header=True)
     save_as_xlsx_with_options(
         data,
         root / "with_data_address",
-        header=False,
+        include_header=False,
         sheet_name="ABC",
         startcol=10,
         startrow=5,
@@ -420,12 +420,12 @@ def save_as_xls(data: list[dict], path: Path) -> None:
     shutil.rmtree(root, ignore_errors=True)
     root.mkdir(parents=True, exist_ok=True)
 
-    save_as_xls_with_options(data, root / "without_header", header=False)
-    save_as_xls_with_options(data, root / "with_header", header=True)
+    save_as_xls_with_options(data, root / "without_header", include_header=False)
+    save_as_xls_with_options(data, root / "with_header", include_header=True)
     save_as_xls_with_options(
         data,
         root / "with_data_address",
-        header=False,
+        include_header=False,
         sheet_name="ABC",
         startcol=10,
         startrow=5,

tests/test_integration/test_run_transfer/conftest.py

@@ -515,7 +515,7 @@ def source_file_format(request: FixtureRequest):
     if name == "csv":
         return "csv", CSV(
             lineSep="\n",
-            header=True,
+            include_header=True,
             **params,
         )
 
@@ -542,7 +542,7 @@ def target_file_format(request: FixtureRequest):
     if name == "csv":
         return "csv", CSV(
             lineSep="\n",
-            header=True,
+            include_header=True,
             timestampFormat="yyyy-MM-dd'T'HH:mm:ss.SSSSSS+00:00",
             **params,
         )

tests/test_unit/test_transfers/test_file_transfers/test_create_transfer.py

@@ -32,7 +32,7 @@
                 "encoding": "utf-8",
                 "quote": '"',
                 "escape": "\\",
-                "header": False,
+                "include_header": False,
                 "line_sep": "\n",
             },
             "options": {
@@ -119,7 +119,7 @@ async def test_developer_plus_can_create_s3_transfer(
             "encoding": "utf-8",
             "quote": '"',
             "escape": "\\",
-            "header": False,
+            "include_header": False,
             "line_sep": "\n",
         },
         "excel": {
@@ -234,7 +234,7 @@ async def test_developer_plus_can_create_hdfs_transfer(
             "encoding": "utf-8",
             "quote": '"',
             "escape": "\\",
-            "header": False,
+            "include_header": False,
             "line_sep": "\n",
         },
         "excel": {

tests/test_unit/test_transfers/test_file_transfers/test_read_transfer.py

@@ -16,7 +16,7 @@
                 "delimiter": ",",
                 "encoding": "utf-8",
                 "escape": "\\",
-                "header": False,
+                "include_header": False,
                 "line_sep": "\n",
                 "quote": '"',
                 "type": "csv",

tests/test_unit/test_transfers/test_file_transfers/test_update_transfer.py

@@ -16,7 +16,7 @@
                 "delimiter": ",",
                 "encoding": "utf-8",
                 "escape": "\\",
-                "header": False,
+                "include_header": False,
                 "line_sep": "\n",
                 "quote": '"',
                 "type": "csv",

tests/test_unit/test_transfers/transfer_fixtures/transfers_fixture.py

@@ -57,7 +57,7 @@ async def group_transfers(
                 "delimiter": ",",
                 "encoding": "utf-8",
                 "escape": "\\",
-                "header": False,
+                "include_header": False,
                 "line_sep": "\n",
                 "quote": '"',
                 "type": "csv",