Skip to content

Commit 152e89a

Browse files
committed
filename return type workaround and google style fix for get_entry_by_path
1 parent 725297e commit 152e89a

File tree

1 file changed

+17
-13
lines changed

1 file changed

+17
-13
lines changed

libzim/libzim.pyx

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -593,6 +593,7 @@ class Creator(_Creator):
593593
return f"Creator(filename={self.filename})"
594594

595595
writer_module_doc = """libzim writer module
596+
596597
- Creator to create ZIM files
597598
- Item to store ZIM articles metadata
598599
- ContentProvider to store an Item's content
@@ -835,6 +836,10 @@ cdef class Archive:
835836

836837
@property
837838
def filename(self) -> pathlib.Path:
839+
""" Path (not just file name) of the ZIM Archive
840+
841+
Returns:
842+
(pathlib.Path): Archive\'s ZIM file path"""
838843
return self._filename
839844

840845
@property
@@ -847,20 +852,17 @@ cdef class Archive:
847852
return self.c_archive.hasEntryByPath(<string>path.encode('UTF-8'))
848853

849854
def get_entry_by_path(self, path: str) -> Entry:
850-
"""Entry from a path -> Entry
855+
"""Entry from a path
856+
857+
Args:
858+
path: The path of the article
859+
860+
Returns:
861+
The Entry object
862+
863+
Raises:
864+
KeyError: If an entry with the provided path is not found in the archive"""
851865

852-
Parameters
853-
----------
854-
path : str
855-
The path of the article
856-
Returns
857-
-------
858-
Entry
859-
The Entry object
860-
Raises
861-
------
862-
KeyError
863-
If an entry with the provided path is not found in the archive"""
864866
cdef zim.Entry entry
865867
try:
866868
entry = move(self.c_archive.getEntryByPath(<string>path.encode('UTF-8')))
@@ -1254,6 +1256,7 @@ cdef class SuggestionSearcher:
12541256
return SuggestionSearch.from_search(move(self.c_searcher.suggest(query.encode('UTF-8'))))
12551257

12561258
suggestion_module_doc = """libzim suggestion module
1259+
12571260
- SuggestionSearcher to perform a suggestion search over a libzim.reader.Archive
12581261
12591262
Usage:
@@ -1271,6 +1274,7 @@ suggestion_public_objects = [
12711274
suggestion = create_module(suggestion_module_name, suggestion_module_doc, suggestion_public_objects)
12721275

12731276
version_module_doc = """libzim version module
1277+
12741278
- Get version of libzim and its dependencies
12751279
- Print version of libzim and its dependencies
12761280
- Get libzim version

0 commit comments

Comments
 (0)