Merge pull request #159 from openzim/issue-148-fixes

Introducing printVersions() and getVersions()

Author: rgaudin

CHANGELOG.md

@@ -5,6 +5,15 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [Unreleased]
+
+### Added
+
+* `version` module with
+  * `version.get_versions()` returning an OrderedDict of library:version inclusing libzim
+  * `version.print_versions()` print it on stdout (or another fd)
+  * `version.get_libzim_version()` returns the libzim version only
+
 ## [2.1.0] - 2022-12-06
 
 ### Added

libzim/libzim.pyx

@@ -39,6 +39,7 @@ import os
 import pathlib
 import sys
 import traceback
+from collections import OrderedDict
 from types import ModuleType
 from typing import Dict, Generator, Iterator, List, Optional, Set, Tuple, Union
 from uuid import UUID
@@ -1243,6 +1244,47 @@ suggestion_public_objects = [
 ]
 suggestion = create_module(suggestion_module_name, suggestion_module_doc, suggestion_public_objects)
 
+version_module_doc = """libzim version module
+- Get version of libzim and its dependencies
+- Print version of libzim and its dependencies
+- Get libzim version
+
+Usage:
+    from libzim.version import get_libzim_version, get_versions, print_versions
+    major, minor, patch = get_libzim_version().split(".", 2)
+
+    for dependency, version in get_versions().items():
+        print(f"- {dependency}={version}")
+
+    print_versions()"""
+
+
+def print_versions(out: Union[sys.stdout, sys.stderr] = sys.stdout):
+    """print libzim and its dependencies list with their versions"""
+    for library, version in get_versions().items():
+        prefix = "" if library == "libzim" else "+ "
+        print(f"{prefix}{library} {version}", file=out or sys.stdout)
+
+
+def get_versions() -> OrderedDict[str, str]:
+    """ library: version mapping. Always includes `libzim`"""
+    versions = zim.getVersions()
+    return OrderedDict({
+        library.decode("UTF-8"): version.decode("UTF-8")
+        for library, version in versions
+    })
+
+def get_libzim_version() -> str:
+    """libzim version string"""
+    return get_versions()["libzim"]
+
+version_public_objects = [
+    get_libzim_version,
+    get_versions,
+    print_versions,
+]
+version_module_name = f"{__name__}.version"
+version = create_module(version_module_name, version_module_doc, version_public_objects)
 
 
 class ModuleLoader(importlib.abc.Loader):
@@ -1253,7 +1295,8 @@ class ModuleLoader(importlib.abc.Loader):
             'libzim.writer': writer,
             'libzim.reader': reader,
             'libzim.search': search,
-            'libzim.suggestion': suggestion
+            'libzim.suggestion': suggestion,
+            'libzim.version': version 
         }.get(spec.name, None)
 
     @staticmethod
@@ -1272,5 +1315,5 @@ class ModuleFinder(importlib.abc.MetaPathFinder):
 # register finder for our submodules
 sys.meta_path.insert(0, ModuleFinder())
 
-__all__ = ["writer", "reader", "search", "suggestion"]
+__all__ = ["writer", "reader", "search", "suggestion", "version"]
 

libzim/zim.pxd

@@ -22,6 +22,7 @@ from libc.stdint cimport uint32_t, uint64_t
 from libcpp cimport bool
 from libcpp.map cimport map
 from libcpp.memory cimport shared_ptr
+from libcpp.pair cimport pair
 from libcpp.set cimport set
 from libcpp.string cimport string
 from libcpp.vector cimport vector
@@ -218,3 +219,6 @@ cdef extern from "libwrapper.h" namespace "wrapper":
         SuggestionIterator begin()
         SuggestionIterator end()
         int size()
+
+cdef extern from "zim/version.h" namespace "zim":
+    cdef vector[pair[string, string]] getVersions()

tests/test_libzim_version.py

@@ -0,0 +1,33 @@
+import re
+import sys
+
+from libzim.version import get_libzim_version, get_versions, print_versions
+
+
+def test_version_print_version_with_stdout(capsys):
+    print_versions()
+    print("", file=sys.stdout, flush=True)
+    stdout, stderr = capsys.readouterr()
+    assert len(stdout) != 0
+
+
+def test_version_print_version_with_stderr(capsys):
+    print_versions(sys.stderr)
+    print("", file=sys.stderr, flush=True)
+    stdout, stderr = capsys.readouterr()
+    assert len(stderr) != 0
+
+
+def test_get_versions():
+    versions = get_versions()
+    assert versions
+    assert "libzim" in versions
+    assert len(versions.keys()) > 1
+    for library, version in versions.items():
+        assert isinstance(library, str)
+        assert isinstance(version, str)
+
+
+def test_get_libzim_version():
+    # libzim uses semantic versioning
+    assert re.match(r"\d+\.\d+\.\d+", get_libzim_version())