Merge pull request #79 from ImageMarkup/windows-newlines-fix

Author: danlamanna

isic_cli/cli/image.py

@@ -122,7 +122,7 @@ def download(
                 thread_pool.map(func, image_chunk)
 
         headers, records = _extract_metadata(images)
-        with (outdir / "metadata.csv").open("w", encoding="utf8") as outfile:
+        with (outdir / "metadata.csv").open("w", newline="", encoding="utf8") as outfile:
             writer = csv.DictWriter(outfile, headers)
             writer.writeheader()
             writer.writerows(records)

isic_cli/cli/metadata.py

@@ -3,6 +3,7 @@
 from collections import defaultdict
 import csv
 import itertools
+import os
 from pathlib import Path
 import sys
 from typing import TYPE_CHECKING
@@ -200,10 +201,11 @@ def download(
         headers, records = _extract_metadata(images, progress, task)
 
     if records:
-        if outfile:
-            stream = click.open_file(outfile.name, "w", encoding="utf8")
-        else:
-            stream = click.get_text_stream("stdout", encoding="utf8")
+        stream = (
+            sys.stdout
+            if outfile is None or os.fsdecode(outfile) == "-"
+            else Path(outfile).open("w", newline="", encoding="utf8")  # noqa: SIM115
+        )
 
         writer = csv.DictWriter(stream, headers)
         writer.writeheader()

tests/test_cli_image.py

@@ -45,3 +45,12 @@ def test_image_download(cli_run, outdir):
     assert Path(f"{outdir}/metadata.csv").exists()
     assert Path(f"{outdir}/attribution.txt").exists()
     assert Path(f"{outdir}/licenses/CC-0.txt").exists()
+
+
+@pytest.mark.usefixtures("_isolated_filesystem", "_mock_images")
+def test_image_download_metadata_newlines(cli_run, outdir):
+    result = cli_run(["image", "download", outdir])
+
+    assert result.exit_code == 0, result.exception
+    with Path(f"{outdir}/metadata.csv").open() as f:
+        assert f.read().count("\n") == 2

tests/test_cli_metadata.py

@@ -8,7 +8,7 @@
 
 @pytest.fixture()
 def _mock_image_metadata(mocker):
-    mocker.patch("isic_cli.cli.metadata.get_num_images", return_value=1)
+    mocker.patch("isic_cli.cli.metadata.get_num_images", return_value=2)
     mocker.patch(
         "isic_cli.cli.metadata.get_images",
         return_value=iter(
@@ -21,7 +21,16 @@ def _mock_image_metadata(mocker):
                         "acquisition": {},
                         "clinical": {"sex": "male", "diagnosis": "melanoma"},
                     },
-                }
+                },
+                {
+                    "isic_id": "ISIC_0000001",
+                    "attribution": "\U00001f600 Bar",
+                    "copyright_license": "CC-BY-NC",
+                    "metadata": {
+                        "acquisition": {},
+                        "clinical": {"sex": "female", "diagnosis": "nevus"},
+                    },
+                },
             ]
         ),
     )
@@ -67,3 +76,15 @@ def test_metadata_download_file(cli_run):
         output = f.read()
 
     assert re.search(r"ISIC_0000000.*Foo.*CC-0.*melanoma.*male", output), output
+
+
+@pytest.mark.usefixtures("_mock_image_metadata")
+def test_metadata_download_newlines(cli_run, mocker):
+    result = cli_run(["metadata", "download", "-o", "foo.csv"])
+
+    assert result.exit_code == 0, result.exception
+
+    with Path("foo.csv").open() as f:
+        output = f.read()
+
+    assert output.count("\n") == 3, output