Move public writer classes in a writer sub-module.

Fix #17

Author: mgautierfr

libzim/__init__.py

@@ -18,175 +18,6 @@
 # along with this program. If not, see <http://www.gnu.org/licenses/>.
 
 
-import datetime
-from collections import defaultdict
+from libzim_wrapper import Blob
 
-import libzim_wrapper
-
-ZimBlob = libzim_wrapper.ZimBlob
-
-
-__all__ = ["ZimArticle", "ZimCreator", "ZimBlob"]
-
-
-class ZimArticle:
-    def __init__(self):
-        self._blob = None
-
-    def get_url(self):
-        raise NotImplementedError
-
-    def get_title(self):
-        raise NotImplementedError
-
-    def is_redirect(self):
-        raise NotImplementedError
-
-    def get_mime_type(self):
-        raise NotImplementedError
-
-    def get_filename(self):
-        raise NotImplementedError
-
-    def should_compress(self):
-        raise NotImplementedError
-
-    def should_index(self):
-        raise NotImplementedError
-
-    def redirect_url(self):
-        raise NotImplementedError
-
-    def _get_data(self):
-        if self._blob is None:
-            self._blob = self.get_data()
-        return self._blob
-
-    def get_data(self):
-        raise NotImplementedError
-
-
-class ZimMetadataArticle(ZimArticle):
-    def __init__(self, url, metadata_content):
-        ZimArticle.__init__(self)
-        self.url = url
-        self.metadata_content = metadata_content
-
-    def is_redirect(self):
-        return False
-
-    def get_url(self):
-        return f"M/{self.url}"
-
-    def get_title(self):
-        return ""
-
-    def get_mime_type(self):
-        return "text/plain"
-
-    def get_filename(self):
-        return ""
-
-    def should_compress(self):
-        return True
-
-    def should_index(self):
-        return False
-
-    def get_data(self):
-        return ZimBlob(self.metadata_content)
-
-
-MANDATORY_METADATA_KEYS = [
-    "Name",
-    "Title",
-    "Creator",
-    "Publisher",
-    "Date",
-    "Description",
-    "Language",
-]
-
-
-class ZimCreator:
-    """
-    A class to represent a Zim Creator.
-
-    Attributes
-    ----------
-    *c_creator : zim.ZimCreatorWrapper
-        a pointer to the C++ Creator object
-    _finalized : bool
-        flag if the creator was finalized
-    _filename : str
-        Zim file path
-    _main_page : str
-        Zim file main page
-    _index_language : str
-        Zim file Index language
-    _min_chunk_size : str
-        Zim file minimum chunk size
-    _article_counter
-        Zim file article counter
-    _metadata
-        Zim file metadata
-    """
-
-    def __init__(self, filename, main_page, index_language, min_chunk_size):
-        print(filename)
-        self._creatorWrapper = libzim_wrapper.ZimCreator(
-            filename, main_page, index_language, min_chunk_size
-        )
-        self.filename = filename
-        self.main_page = main_page
-        self.language = index_language
-        self._metadata = {}
-        self._article_counter = defaultdict(int)
-        self.update_metadata(date=datetime.date.today(), language=index_language)
-
-    def __enter__(self):
-        return self
-
-    def __exit__(self, *args):
-        self.close()
-
-    def add_article(self, article):
-        self._creatorWrapper.add_article(article)
-        if not article.is_redirect():
-            self._update_article_counter(article)
-
-    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" ""
-        # Converts python case to pascal case. example: long_description-> LongDescription
-        pascalize = lambda keyword: "".join(keyword.title().split("_"))
-        new_metadata = {pascalize(k): v for k, v in kwargs.items()}
-        self._metadata.update(new_metadata)
-
-    def write_metadata(self):
-        for key, value in self._metadata.items():
-            if key == "date" and isinstance(value, datetime.date):
-                value = value.strftime("%Y-%m-%d")
-            article = ZimMetadataArticle(key, value)
-            self._creatorWrapper.add_article(article)
-
-        article = ZimMetadataArticle("Counter", self._get_counter_string())
-        self._creatorWrapper.add_article(article)
-
-    def _get_counter_string(self):
-        return ";".join(["%s=%s" % (k, v) for (k, v) in self._article_counter.items()])
-
-    def close(self):
-        self.write_metadata()
-        self._creatorWrapper.finalize()
-
-    def __repr__(self):
-        return f"ZimCreator(filename={self.filename})"
+__all__ = ["Blob"]

libzim/examples.py

@@ -20,12 +20,12 @@
 # Write the article
 import uuid
 
-from libzim import ZimArticle, ZimBlob, ZimCreator
+from libzim.writer import Article, Blob, Creator
 
 
-class ZimTestArticle(ZimArticle):
+class TestArticle(Article):
     def __init__(self, url, title, content):
-        ZimArticle.__init__(self)
+        Article.__init__(self)
         self.url = url
         self.title = title
         self.content = content
@@ -52,10 +52,10 @@ def should_index(self):
         return True
 
     def get_data(self):
-        return ZimBlob(self.content)
+        return Blob(self.content)
 
 
-# Create a ZimTestArticle article
+# Create a TestArticle article
 
 content = """<!DOCTYPE html>
                 <html class="client-js">
@@ -71,8 +71,8 @@ def get_data(self):
                 </head>
                 <h1> ñññ Hello, it works 2 ñññ </h1></html>"""
 
-article = ZimTestArticle("Monadical_SAS", "Monadical", content)
-article2 = ZimTestArticle("Monadical_2", "Monadical 2", content2)
+article = TestArticle("Monadical_SAS", "Monadical", content)
+article2 = TestArticle("Monadical_2", "Monadical 2", content2)
 
 print(article.content)
 
@@ -81,7 +81,7 @@ def get_data(self):
 
 test_zim_file_path = "/opt/python-libzim/tests/kiwix-test"
 
-zim_creator = ZimCreator(
+zim_creator = Creator(
     test_zim_file_path + "-" + rnd_str + ".zim",
     main_page="Monadical",
     index_language="eng",
@@ -112,7 +112,7 @@ def get_data(self):
 
 rnd_str = str(uuid.uuid1())
 
-with ZimCreator(test_zim_file_path + "-" + rnd_str + ".zim") as zc:
+with Creator(test_zim_file_path + "-" + rnd_str + ".zim") as zc:
     zc.add_article(article)
     zc.add_article(article2)
     zc.update_metadata(

libzim/libzim_wrapper.pyx

@@ -34,10 +34,10 @@ import datetime
 
 
 #########################
-#       ZimBlob         #
+#         Blob          #
 #########################
 
-cdef class ZimBlob:
+cdef class Blob:
     cdef clibzim.Blob* c_blob
     cdef bytes ref_content
 
@@ -53,10 +53,6 @@ cdef class ZimBlob:
             del self.c_blob
 
 
-#########################
-#       ZimArticle      #
-#########################
-
 #------ Helper for pure virtual methods --------
 
 cdef get_article_method_from_object(object obj, string method, int *error) with gil:
@@ -80,7 +76,7 @@ cdef public api:
 
     clibzim.Blob blob_cy_call_fct(object obj, string method, int *error) with gil:
         """Lookup and execute a pure virtual method on ZimArticle returning a Blob"""
-        cdef ZimBlob blob
+        cdef Blob blob
 
         func = get_article_method_from_object(obj, method, error)
         blob = func()
@@ -96,7 +92,7 @@ cdef public api:
         func = get_article_method_from_object(obj, method, error)
         return <uint64_t> func()
 
-cdef class ZimCreator:
+cdef class Creator:
     """
     A class to represent a Zim Creator.