Merge pull request #126 from IMayBeABitShy/issue_125

Fix handling of tag list in Creator.add_metadata (fix #125)

pyproject.toml

@@ -240,3 +240,4 @@ exclude = [".env/**", ".venv/**"]
 extraPaths = ["src"]
 pythonVersion = "3.8"
 typeCheckingMode="basic"
+disableBytesTypePromotions = true

src/zimscraperlib/zim/creator.py

@@ -17,6 +17,7 @@
     - content stored on object
     - can be used to store a filepath and content read from it (not stored) """
 
+import collections.abc
 import datetime
 import pathlib
 import re
@@ -183,10 +184,19 @@ def validate_metadata(
     def add_metadata(
         self,
         name: str,
-        content: Union[str, bytes, datetime.date, datetime.datetime],
+        content: Union[str, bytes, datetime.date, datetime.datetime, Iterable[str]],
         mimetype: str = "text/plain;charset=UTF-8",
     ):
         self.validate_metadata(name, content)
+        if name == "Date" and isinstance(content, (datetime.date, datetime.datetime)):
+            content = content.strftime("%Y-%m-%d").encode("UTF-8")
+        if (
+            name == "Tags"
+            and not isinstance(content, str)
+            and not isinstance(content, bytes)
+            and isinstance(content, collections.abc.Iterable)
+        ):
+            content = ";".join(content)
         super().add_metadata(name, content, mimetype)
 
     def config_metadata(

tests/zim/test_zim_creator.py

@@ -514,7 +514,26 @@ def test_check_metadata(tmp_path):
         Creator(tmp_path, "").config_dev_metadata(LongDescription="T" * 5000).start()
 
 
-def test_config_metadata(tmp_path, png_image):
+@pytest.mark.parametrize(
+    "tags",
+    [
+        (
+            "wikipedia;_category:wikipedia;_pictures:no;_videos:no;_details:yes;"
+            "_ftindex:yes"
+        ),
+        (
+            [
+                "wikipedia",
+                "_category:wikipedia",
+                "_pictures:no",
+                "_videos:no",
+                "_details:yes",
+                "_ftindex:yes",
+            ]
+        ),
+    ],
+)
+def test_config_metadata(tmp_path, png_image, tags):
     fpath = tmp_path / "test_config.zim"
     with open(png_image, "rb") as fh:
         png_data = fh.read()
@@ -529,8 +548,7 @@ def test_config_metadata(tmp_path, png_image):
         " from the english Wikipedia by 2009-11-10. The topics are...",
         Language="eng",
         License="CC-BY",
-        Tags="wikipedia;_category:wikipedia;_pictures:no;_videos:no;"
-        "_details:yes;_ftindex:yes",
+        Tags=tags,
         Flavour="nopic",
         Source="https://en.wikipedia.org/",
         Scraper="mwoffliner 1.2.3",