Fixed #30: get_metadata() now returns bytes

mandatory metadata references gone, as per the spec

Author: renaud gaudin

libzim/wrapper.pyx

@@ -31,6 +31,7 @@ from libcpp.memory cimport shared_ptr, make_shared, unique_ptr
 
 import datetime
 
+
 class NotFound(RuntimeError):
     pass
 
@@ -407,14 +408,13 @@ cdef class FilePy:
         return article
 
     def get_metadata(self, name):
-        """Get the file metadata.
+        """Get a metadata
         Returns
         -------
-        dict
-            A dictionary with the file metadata
+        bytes
+            Metadata article's content. Can be of any type.
         """
-        article = self.get_article(f"M/{name}")
-        return article.content
+        return bytes(self.get_article(f"M/{name}").content)
 
     def get_article_by_id(self, article_id):
         """Get a ZimFileArticle with a copy of the file article by article id.

libzim/writer.py

@@ -98,17 +98,6 @@ def get_data(self):
         return Blob(self.metadata_content)
 
 
-MANDATORY_METADATA_KEYS = [
-    "Name",
-    "Title",
-    "Creator",
-    "Publisher",
-    "Date",
-    "Description",
-    "Language",
-]
-
-
 def pascalize(keyword):
     """ Converts python case to pascal case. example: long_description-> LongDescription """
     return "".join(keyword.title().split("_"))
@@ -165,13 +154,8 @@ def _update_article_counter(self, article):
         # default dict update
         self._article_counter[article.get_mime_type().strip()] += 1
 
-    def mandatory_metadata_ok(self):
-        """Flag if mandatory metadata is complete and not empty"""
-        metadata_item_ok = [k in self._metadata for k in MANDATORY_METADATA_KEYS]
-        return all(metadata_item_ok)
-
-    def update_metadata(self, **kwargs):
-        "Updates article metadata" ""
+    def update_metadata(self, **kwargs: str):
+        """ Updates Creator metadata for ZIM, supplied as keyword arguments """
         new_metadata = {pascalize(k): v for k, v in kwargs.items()}
         self._metadata.update(new_metadata)
 

tests/test_libzim.py

@@ -128,21 +128,6 @@ def test_article_metadata(tmpdir, metadata):
         assert zim_creator._metadata == metadata
 
 
-def test_check_mandatory_metadata(tmpdir):
-    with Creator(
-        str(tmpdir / "test.zim"), main_page="welcome", index_language="eng", min_chunk_size=2048,
-    ) as zim_creator:
-        assert not zim_creator.mandatory_metadata_ok()
-        zim_creator.update_metadata(
-            creator="python-libzim",
-            description="Created in python",
-            name="Hola",
-            publisher="Monadical",
-            title="Test Zim",
-        )
-        assert zim_creator.mandatory_metadata_ok()
-
-
 def test_creator_params(tmpdir):
     path = str(tmpdir / "test.zim")
     main_page = "welcome"