Fixed #38: raising NotFound on unavailable article

raise RuntimeError on out-of-bound get_article_by_id()
changed get_article_by_id signature to not use the reserved python keyword `id`

Author: renaud gaudin

libzim/reader.py

@@ -1,4 +1,4 @@
 # flake8: noqa
 
-from .wrapper import FilePy as File
+from .wrapper import FilePy as File, NotFound
 from .wrapper import ReadArticle as Article

libzim/wrapper.pyx

@@ -31,6 +31,9 @@ from libcpp.memory cimport shared_ptr, make_shared, unique_ptr
 
 import datetime
 
+class NotFound(RuntimeError):
+    pass
+
 #########################
 #         Blob          #
 #########################
@@ -392,13 +395,13 @@ cdef class FilePy:
             The Article object
         Raises
         ------
-            RuntimeError
+            NotFound
                 If an article with the provided long url is not found in the file
         """
         # Read to a zim::Article
         cdef wrapper.Article art = self.c_file.getArticleByUrl(url.encode('UTF-8'))
         if not art.good():
-            raise RuntimeError("Article not found for url")
+            raise NotFound("Article not found for url")
 
         article = ReadArticle.from_read_article(art)
         return article
@@ -413,12 +416,12 @@ cdef class FilePy:
         article = self.get_article(f"M/{name}")
         return article.content
 
-    def get_article_by_id(self, id):
+    def get_article_by_id(self, article_id):
         """Get a ZimFileArticle with a copy of the file article by article id.
 
         Parameters
         ----------
-        id : int
+        article_id : int
             The id of the article
         Returns
         -------
@@ -427,13 +430,15 @@ cdef class FilePy:
         Raises
         ------
             RuntimeError
+                If there is a problem in retrieving article (ex: id is out of bound)
+            NotFound
                 If an article with the provided id is not found in the file
         """
 
         # Read to a zim::Article
-        cdef wrapper.Article art = self.c_file.getArticle(<int> id)
+        cdef wrapper.Article art = self.c_file.getArticle(<int> article_id)
         if not art.good():
-            raise RuntimeError("Article not found for id")
+            raise NotFound("Article not found for id")
 
         article = ReadArticle.from_read_article(art)
         return article

tests/test_libzim_file_reader.py

@@ -3,7 +3,7 @@
 
 import pytest
 
-from libzim.reader import File
+from libzim.reader import File, NotFound
 
 DATA_DIR = Path(__file__).parent
 
@@ -110,9 +110,9 @@ def test_search(reader):
 
 
 def test_get_wrong_article(reader):
-    with pytest.raises(RuntimeError):
+    with pytest.raises(RuntimeError):  # out of range
         reader.get_article_by_id(reader.article_count + 100)
-    with pytest.raises(RuntimeError):
+    with pytest.raises(NotFound):
         reader.get_article("A/I_do_not_exists")