Reformat code using black and isort.

mgautierfr · mgautierfr · commit 7900d3e548ef · 2020-05-05T14:24:58.000+02:00
diff --git a/libzim/__init__.py b/libzim/__init__.py
@@ -18,14 +18,16 @@
 # along with this program. If not, see <http://www.gnu.org/licenses/>.
 
 
+import datetime
+from collections import defaultdict
+
 import libzim_wrapper
 
 ZimBlob = libzim_wrapper.ZimBlob
 
-from collections import defaultdict
-import datetime
 
-__all__  = ["ZimArticle", "ZimCreator", "ZimBlob"]
+__all__ = ["ZimArticle", "ZimCreator", "ZimBlob"]
+
 
 class ZimArticle:
     def __init__(self):
@@ -95,14 +97,16 @@ def get_data(self):
         return ZimBlob(self.metadata_content)
 
 
-MANDATORY_METADATA_KEYS =[
+MANDATORY_METADATA_KEYS = [
     "Name",
     "Title",
     "Creator",
     "Publisher",
     "Date",
     "Description",
-    "Language"]
+    "Language",
+]
+
 
 class ZimCreator:
     """
@@ -131,10 +135,8 @@ class ZimCreator:
     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)
+            filename, main_page, index_language, min_chunk_size
+        )
         self.filename = filename
         self.main_page = main_page
         self.language = index_language
@@ -162,15 +164,13 @@ def mandatory_metadata_ok(self):
         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"""
+        "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):
@@ -182,9 +182,7 @@ def write_metadata(self):
         self._creatorWrapper.add_article(article)
 
     def _get_counter_string(self):
-        return ";".join(
-            ["%s=%s" % (k,v) for (k,v) in self._article_counter.items()]
-        )
+        return ";".join(["%s=%s" % (k, v) for (k, v) in self._article_counter.items()])
 
     def close(self):
         self.write_metadata()
diff --git a/libzim/examples.py b/libzim/examples.py
@@ -17,10 +17,13 @@
 # along with this program. If not, see <http://www.gnu.org/licenses/>.
 
 
+# Write the article
+import uuid
+
 from libzim import ZimArticle, ZimBlob, ZimCreator
 
-class ZimTestArticle(ZimArticle):
 
+class ZimTestArticle(ZimArticle):
     def __init__(self, url, title, content):
         ZimArticle.__init__(self)
         self.url = url
@@ -35,13 +38,13 @@ def get_url(self):
 
     def get_title(self):
         return f"{self.title}"
-    
+
     def get_mime_type(self):
         return "text/html"
-    
+
     def get_filename(self):
         return ""
-    
+
     def should_compress(self):
         return True
 
@@ -51,42 +54,53 @@ def should_index(self):
     def get_data(self):
         return ZimBlob(self.content)
 
+
 # Create a ZimTestArticle article
 
-content = '''<!DOCTYPE html> 
+content = """<!DOCTYPE html>
                 <html class="client-js">
                 <head><meta charset="UTF-8">
                 <title>Monadical</title>
                 </head>
-                <h1> ñññ Hello, it works ñññ </h1></html>'''
+                <h1> ñññ Hello, it works ñññ </h1></html>"""
 
-content2 = '''<!DOCTYPE html> 
+content2 = """<!DOCTYPE html>
                 <html class="client-js">
                 <head><meta charset="UTF-8">
                 <title>Monadical 2</title>
                 </head>
-                <h1> ñññ Hello, it works 2 ñññ </h1></html>'''
+                <h1> ñññ Hello, it works 2 ñññ </h1></html>"""
 
 article = ZimTestArticle("Monadical_SAS", "Monadical", content)
 article2 = ZimTestArticle("Monadical_2", "Monadical 2", content2)
 
 print(article.content)
 
-# Write the article
-import uuid
-rnd_str = str(uuid.uuid1()) 
+
+rnd_str = str(uuid.uuid1())
 
 test_zim_file_path = "/opt/python-libzim/tests/kiwix-test"
 
-zim_creator = ZimCreator(test_zim_file_path + '-' + rnd_str + '.zim',main_page = "Monadical",index_language= "eng", min_chunk_size= 2048)
+zim_creator = ZimCreator(
+    test_zim_file_path + "-" + rnd_str + ".zim",
+    main_page="Monadical",
+    index_language="eng",
+    min_chunk_size=2048,
+)
 
 # Add articles to zim file
 zim_creator.add_article(article)
 zim_creator.add_article(article2)
 
 # Set mandatory metadata
 if not zim_creator.mandatory_metadata_ok():
-    zim_creator.update_metadata(creator='python-libzim',description='Created in python',name='Hola',publisher='Monadical',title='Test Zim')
+    zim_creator.update_metadata(
+        creator="python-libzim",
+        description="Created in python",
+        name="Hola",
+        publisher="Monadical",
+        title="Test Zim",
+    )
 
 print(zim_creator._get_metadata())
 
@@ -98,11 +112,13 @@ def get_data(self):
 
 rnd_str = str(uuid.uuid1())
 
-with ZimCreator(test_zim_file_path + '-' + rnd_str + '.zim') as zc:
+with ZimCreator(test_zim_file_path + "-" + rnd_str + ".zim") as zc:
     zc.add_article(article)
     zc.add_article(article2)
-    zc.update_metadata(creator='python-libzim',
-                       description='Created in python',
-                       name='Hola',publisher='Monadical',
-                       title='Test Zim')
-
+    zc.update_metadata(
+        creator="python-libzim",
+        description="Created in python",
+        name="Hola",
+        publisher="Monadical",
+        title="Test Zim",
+    )
diff --git a/libzim/libzim_wrapper.pxd b/libzim/libzim_wrapper.pxd
@@ -17,15 +17,15 @@
 # You should have received a copy of the GNU General Public License
 # along with this program. If not, see <http://www.gnu.org/licenses/>.
 
-from libcpp.string cimport string
+from cpython.ref cimport PyObject
+
 from libc.stdint cimport uint32_t, uint64_t
 from libcpp cimport bool
 from libcpp.memory cimport shared_ptr
+from libcpp.string cimport string
 from libcpp.vector cimport vector
 
 
-from cpython.ref cimport PyObject
-
 cdef extern from "zim/blob.h" namespace "zim":
     cdef cppclass Blob:
         Blob() except +
diff --git a/libzim/libzim_wrapper.pyx b/libzim/libzim_wrapper.pyx
@@ -19,7 +19,9 @@
 
 
 cimport libzim.libzim_wrapper as clibzim
+
 from cython.operator import dereference
+from cpython.ref cimport PyObject
 
 from libc.stdint cimport uint64_t
 from libcpp.string cimport string
@@ -28,7 +30,8 @@ from libcpp.memory cimport shared_ptr, make_shared
 
 import datetime
 
-from cpython.ref cimport PyObject
+
+
 
 #########################
 #       ZimBlob         #
@@ -162,4 +165,3 @@ cdef class ZimCreator:
         with nogil:
             self.c_creator.finalize()
         self._finalized = True
-
diff --git a/tests/test_libzim.py b/tests/test_libzim.py
@@ -17,7 +17,6 @@
 # along with this program. If not, see <http://www.gnu.org/licenses/>.
 
 import pytest
-import os,sys,inspect
 
 from libzim import ZimArticle, ZimBlob, ZimCreator
 
@@ -29,7 +28,7 @@
 def metadata():
     return {
         # Mandatory
-        "Name" : "wikipedia_fr_football",
+        "Name": "wikipedia_fr_football",
         "Title": "English Wikipedia",
         "Creator": "English speaking Wikipedia contributors",
         "Publisher": "Wikipedia user Foobar",
@@ -43,22 +42,24 @@ def metadata():
         "Flavour": "nopic",
         "Source": "https://en.wikipedia.org/",
         "Counter": "image/jpeg=5;image/gif=3;image/png=2",
-        "Scraper": "sotoki 1.2.3"
+        "Scraper": "sotoki 1.2.3",
     }
 
+
 @pytest.fixture(scope="session")
 def article_content():
-    content = '''<!DOCTYPE html>
+    content = """<!DOCTYPE html>
         <html class="client-js">
         <head><meta charset="UTF-8">
         <title>Monadical</title>
         </head>
-        <h1> ñññ Hello, it works ñññ </h1></html>'''
+        <h1> ñññ Hello, it works ñññ </h1></html>"""
     url = "A/Monadical_SAS"
     title = "Monadical SAS"
     mime_type = "text/html"
     return (content, url, title, mime_type)
 
+
 class ZimTestArticle(ZimArticle):
     def __init__(self, content, url, title, mime_type):
         ZimArticle.__init__(self)
@@ -93,7 +94,8 @@ def should_index(self):
         return True
 
     def get_data(self):
-        return ZimBlob(self.content.encode('UTF-8'))
+        return ZimBlob(self.content.encode("UTF-8"))
+
 
 @pytest.fixture(scope="session")
 def article(article_content):
