Fixed #45: Creator now accepts pathlib for filename

Creator converts passed filename to str before passing it to wrapper.
This allows transparent use of pathlib.Path

Also, Creator.filename now returns a pathlib.Path, created on __init__ from the
wrapper returned filename.

Tests updated to use pathlib by default and check .filename type.
Test ensures passing regular str still works.

Author: renaud gaudin

libzim/wrapper.pyx

@@ -29,6 +29,7 @@ from libcpp.string cimport string
 from libcpp cimport bool
 from libcpp.memory cimport shared_ptr, make_shared, unique_ptr
 
+import pathlib
 import datetime
 
 
@@ -356,23 +357,23 @@ cdef class FilePy:
     ----------
     *c_file : File
         a pointer to a C++ File object
-    _filename : str
+    _filename : pathlib.Path
         the file name of the File Reader object
     """
 
     cdef wrapper.File *c_file
     cdef object _filename
 
-    def __cinit__(self, str filename):
+    def __cinit__(self, object filename):
         """Constructs a File from full zim file path.
         Parameters
         ----------
         filename : str
             Full path to a zim file
         """
 
-        self.c_file = new wrapper.File(filename.encode('UTF-8'))
-        self._filename = self.c_file.getFilename().decode("UTF-8", "strict")
+        self.c_file = new wrapper.File(str(filename).encode('UTF-8'))
+        self._filename = pathlib.Path(self.c_file.getFilename().decode("UTF-8", "strict"))
 
     def __dealloc__(self):
         if self.c_file != NULL:

libzim/writer.py

@@ -17,7 +17,7 @@
 # You should have received a copy of the GNU General Public License
 # along with this program. If not, see <http://www.gnu.org/licenses/>.
 
-
+import pathlib
 import datetime
 from collections import defaultdict
 
@@ -113,7 +113,7 @@ class Creator:
         a pointer to the C++ Creator object
     _finalized : bool
         flag if the creator was finalized
-    _filename : str
+    _filename : pathlib.Path
         Zim file path
     _main_page : str
         Zim file main page
@@ -128,8 +128,8 @@ class Creator:
     """
 
     def __init__(self, filename, main_page, index_language="eng", min_chunk_size=2048):
-        self._creatorWrapper = _Creator(filename, main_page, index_language, min_chunk_size)
-        self.filename = filename
+        self._creatorWrapper = _Creator(str(filename), main_page, index_language, min_chunk_size)
+        self.filename = pathlib.Path(filename)
         self.main_page = main_page
         self.language = index_language
         self._metadata = {}

tests/test_libzim.py

@@ -17,6 +17,7 @@
 # along with this program. If not, see <http://www.gnu.org/licenses/>.
 
 import pytest
+import pathlib
 
 from libzim.writer import Article, Blob, Creator
 from libzim.reader import File
@@ -108,7 +109,7 @@ def article(article_content):
 
 def test_write_article(tmpdir, article):
     with Creator(
-        str(tmpdir / "test.zim"), main_page="welcome", index_language="eng", min_chunk_size=2048,
+        tmpdir / "test.zim", main_page="welcome", index_language="eng", min_chunk_size=2048,
     ) as zim_creator:
         zim_creator.add_article(article)
         zim_creator.update_metadata(
@@ -122,14 +123,14 @@ def test_write_article(tmpdir, article):
 
 def test_article_metadata(tmpdir, metadata):
     with Creator(
-        str(tmpdir / "test.zim"), main_page="welcome", index_language="eng", min_chunk_size=2048,
+        tmpdir / "test.zim", main_page="welcome", index_language="eng", min_chunk_size=2048,
     ) as zim_creator:
         zim_creator.update_metadata(**metadata)
         assert zim_creator._metadata == metadata
 
 
 def test_creator_params(tmpdir):
-    path = str(tmpdir / "test.zim")
+    path = tmpdir / "test.zim"
     main_page = "welcome"
     main_page_url = f"A/{main_page}"
     index_language = "eng"
@@ -148,7 +149,7 @@ def test_creator_params(tmpdir):
 
 def test_segfault_on_realloc(tmpdir):
     """ assert that we are able to delete an unclosed Creator #31 """
-    creator = Creator(str(tmpdir / "test.zim"), "welcome", "eng", 2048)
+    creator = Creator(tmpdir / "test.zim", "welcome", "eng", 2048)
     del creator  # used to segfault
     assert True
 
@@ -157,23 +158,33 @@ def test_noleftbehind_empty(tmpdir):
     """ assert that ZIM with no articles don't leave files behind #41 """
     fname = "test_empty.zim"
     with Creator(
-        str(tmpdir / fname), main_page="welcome", index_language="eng", min_chunk_size=2048,
+        tmpdir / fname, main_page="welcome", index_language="eng", min_chunk_size=2048,
     ) as zim_creator:
         print(zim_creator)
 
     assert len([p for p in tmpdir.listdir() if p.basename.startswith(fname)]) == 1
 
 
 def test_double_close(tmpdir):
-    creator = Creator(str(tmpdir / "test.zim"), "welcome", "eng", 2048)
+    creator = Creator(tmpdir / "test.zim", "welcome", "eng", 2048)
     creator.close()
     with pytest.raises(RuntimeError):
         creator.close()
 
 
 def test_default_creator_params(tmpdir):
     """ ensure we can init a Creator without specifying all params """
-    creator = Creator(str(tmpdir / "test.zim"), "welcome")
+    creator = Creator(tmpdir / "test.zim", "welcome")
     assert True  # we could init the Creator without specifying other params
     assert creator.language == "eng"
     assert creator.main_page == "welcome"
+
+
+def test_filename_param_types(tmpdir):
+    path = tmpdir / "test.zim"
+    with Creator(path, "welcome") as creator:
+        assert creator.filename == path
+        assert isinstance(creator.filename, pathlib.Path)
+    with Creator(str(path), "welcome") as creator:
+        assert creator.filename == path
+        assert isinstance(creator.filename, pathlib.Path)

tests/test_libzim_file_reader.py

@@ -10,7 +10,7 @@
 
 ZIMFILES = [
     {
-        "filename": str(DATA_DIR / "wikipedia_es_physics_mini.zim"),
+        "filename": DATA_DIR / "wikipedia_es_physics_mini.zim",
         "checksum": "99ea7a5598c6040c4f50b8ac0653b703",
         "namespaces": "-AIMX",
         "article_count": 22027,
@@ -43,6 +43,7 @@ def article_data():
 def test_zim_filename(reader, zimdata):
     for k, v in zimdata.items():
         assert getattr(reader, k) == v
+    assert isinstance(reader.filename, Path)
 
 
 def test_zim_read(reader, article_data):