bindings CHANGE add new python CFFI bindings

This is the integration of https://github.com/rjarry/libyang-cffi In the
long term, it is intended to replace the existing SWIG bindings.

Some highlights:

* Uses CFFI for interaction with libyang.so.
* More "pythonic" API. Should be easier to use for Python developers.
* All high-level code is in Python. Should ease maintenance.
* Virtualenv/pip friendly.
* Schema diff feature.
* New "print" data format: python dict.

To enable the generation, add the -DGEN_PYTHON_CFFI_BINDINGS=ON cmake
option. It does not depend on SWIG nor on the CPP bindings. It may be
enabled even if -DGEN_LANGUAGE_BINDINGS is OFF.

Signed-off-by: Robin Jarry <[email protected]>

Author: rjarry

.travis.yml

@@ -44,14 +44,14 @@ before_install:
   - cmake .. && make -j2 && sudo make install
   - cd ../..
   - if [ "$TRAVIS_OS_NAME" = "osx" ]; then brew update; fi
-  - if [ "$TRAVIS_OS_NAME" = "linux" ]; then sudo apt-get update -qq; sudo apt-get install -y valgrind libpcre3-dev python3-dev swig; fi
+  - if [ "$TRAVIS_OS_NAME" = "linux" ]; then sudo apt-get update -qq; sudo apt-get install -y valgrind libpcre3-dev python3-dev swig python3-cffi python3-setuptools twine; fi
   - if [ "$TRAVIS_OS_NAME" = "linux" -a "$CC" = "gcc" -a "$TRAVIS_ARCH" = "amd64" ]; then pip install --user codecov; export CFLAGS="-coverage"; fi
 
 script:
   - mkdir build && cd build
   - if [ "$TRAVIS_OS_NAME" = "osx" ]; then cmake -DENABLE_VALGRIND_TESTS=OFF ..; fi
-  - if [ "$TRAVIS_OS_NAME" = "linux" -a "$TRAVIS_ARCH" = "amd64" ]; then cmake -DGEN_LANGUAGE_BINDINGS=ON -DENABLE_STATIC=${ENABLE_STATIC:-OFF} ..; fi
-  - if [ "$TRAVIS_OS_NAME" = "linux" -a "$TRAVIS_ARCH" = "arm64" ]; then cmake -DGEN_LANGUAGE_BINDINGS=ON -DENABLE_VALGRIND_TESTS=OFF ..; fi
+  - if [ "$TRAVIS_OS_NAME" = "linux" -a "$TRAVIS_ARCH" = "amd64" ]; then cmake -DGEN_LANGUAGE_BINDINGS=ON -DENABLE_STATIC=${ENABLE_STATIC:-OFF} -DGEN_PYTHON_CFFI_BINDINGS=ON ..; fi
+  - if [ "$TRAVIS_OS_NAME" = "linux" -a "$TRAVIS_ARCH" = "arm64" ]; then cmake -DGEN_LANGUAGE_BINDINGS=ON -DENABLE_VALGRIND_TESTS=OFF -DGEN_PYTHON_CFFI_BINDINGS=ON ..; fi
   - make -j2 && ctest --output-on-failure
   - cd -
 
@@ -70,3 +70,10 @@ deploy:
     on:
       branch: master
       condition: $TRAVIS_OS_NAME = linux && $CC = gcc && $TRAVIS_ARCH = amd64
+  - provider: script
+    script: twine upload --skip-existing build/python/dist/*
+    skip_cleanup: true
+    verbose: true
+    on:
+      branch: master
+      condition: $TRAVIS_OS_NAME = linux && $CC = gcc && $TRAVIS_ARCH = amd64

CMakeLists.txt

@@ -106,8 +106,9 @@ set(USER_TYPES_PLUGINS_DIR_MACRO "${PLUGINS_DIR}/user_types")
 set(GEN_LANGUAGE_BINDINGS 0 CACHE BOOL "Enable language bindings generation.")
 set(GEN_CPP_BINDINGS 1 CACHE BOOL "Enable C++ bindings.")
 # Python bindings depend on C++ bindings because of SWIG
-set(GEN_PYTHON_BINDINGS 1 CACHE BOOL "Enable Python bindings.")
+set(GEN_PYTHON_BINDINGS 1 CACHE BOOL "Enable Python SWIG bindings.")
 set(GEN_PYTHON_VERSION "3" CACHE STRING "Python version")
+set(GEN_PYTHON_CFFI_BINDINGS 0 CACHE BOOL "Enable Python CFFI bindings.")
 set(GEN_JAVASCRIPT_BINDINGS 0 CACHE BOOL "Enable JavaScript bindings.")
 set(GEN_JAVA_BINDINGS 0 CACHE BOOL "Enable Java bindings.")
 
@@ -194,6 +195,8 @@ set(headers
 # link compat
 use_compat()
 
+set(CMAKE_POSITION_INDEPENDENT_CODE TRUE)
+
 # create static libyang library
 if(ENABLE_STATIC)
     add_definitions(-DSTATIC)
@@ -214,7 +217,6 @@ if(ENABLE_STATIC)
         set(ENABLE_VALGRIND_TESTS OFF)
     endif(ENABLE_VALGRIND_TESTS)
 else()
-    set(CMAKE_POSITION_INDEPENDENT_CODE TRUE)
     add_library(yangobj OBJECT ${libsrc})
     add_library(yang SHARED $<TARGET_OBJECTS:yangobj> $<TARGET_OBJECTS:compat>)
 
@@ -375,3 +377,7 @@ endif()
 if(GEN_LANGUAGE_BINDINGS AND GEN_CPP_BINDINGS)
     add_subdirectory(swig)
 endif()
+
+if(GEN_PYTHON_CFFI_BINDINGS)
+    add_subdirectory(python)
+endif()

README.md

@@ -258,8 +258,14 @@ More information about the specific binding can be found in their README files.
 Currently supported bindings are:
 
 * JavaScript
- * cmake option: `JAVASCRIPT_BINDING`
- * [README](./swig/javascript/README.md)
+    - cmake option: `JAVASCRIPT_BINDING`
+    - [README](./swig/javascript/README.md)
+* Python SWIG (uses SWIG, enabled by default if `GEN_LANGUAGE_BINDINGS` is set)
+    - cmake option: `GEN_PYTHON_BINDINGS` (depends on `GEN_CPP_BINDINGS`)
+    - [README](./swig/python/README.md)
+* Python CFFI (more "pythonic" API, not enabled by default)
+    - cmake option: `GEN_PYTHON_CFFI_BINDINGS`
+    - [README](./python/README.md)
 
 ## Project Information
 

packages/CMakeLists.txt

@@ -1,6 +1,7 @@
 set(PACKAGE "libyang")
 set(CPP_PACKAGE "libyang-cpp")
 set(PYTHON_PACKAGE "python3-yang")
+set(PYTHON_CFFI_PACKAGE "python3-libyang")
 
 find_program(DEB_BUILDER NAMES debuild)
 find_program(RPM_BUILDER NAMES rpmbuild)
@@ -25,6 +26,8 @@ configure_file(${PROJECT_SOURCE_DIR}/packages/debian.${CPP_PACKAGE}-dev.install
 # no python package for Debian because there is only SWIG 3.10 on Debian 9 :-/
 #configure_file(${PROJECT_SOURCE_DIR}/packages/debian.${PYTHON_PACKAGE}.install
 #               ${PROJECT_BINARY_DIR}/build-packages/debian.${PYTHON_PACKAGE}.install COPYONLY)
+configure_file(${PROJECT_SOURCE_DIR}/packages/debian.${PYTHON_CFFI_PACKAGE}.install
+               ${PROJECT_BINARY_DIR}/build-packages/debian.${PYTHON_CFFI_PACKAGE}.install COPYONLY)
 
 if(NOT DEB_BUILDER)
     message(STATUS "Missing tools (devscripts, debhelper package) for building DEB package.")

packages/debian.control.in

@@ -2,7 +2,20 @@ Source: @PACKAGE@
 Maintainer: CESNET <[email protected]>
 Priority: extra
 Standards-Version: 3.8.2
-Build-Depends: debhelper (>= 9), gcc
+Build-Depends:
+ debhelper (>= 9),
+ dh-python,
+ make,
+ gcc,
+ g++,
+ doxygen,
+ cmake,
+ pkg-config,
+ libpcre3-dev,
+ libcmocka-dev,
+ python3 (>= 3.5),
+ python3-cffi,
+ python3-setuptools,
 Homepage: https://github.com/CESNET/libyang
 
 Package: @PACKAGE@
@@ -40,3 +53,19 @@ Depends: @CPP_PACKAGE@ (=@LIBYANG_VERSION@)
 Section: debug
 Architecture: any
 Description: Debug symbols of C++ bidings of libyang library.
+
+Package: @PYTHON_CFFI_PACKAGE@
+Depends:
+ ${misc:Depends},
+ ${python3:Depends},
+ python3-cffi,
+ @PACKAGE@ (=@LIBYANG_VERSION@),
+Section: libs
+Architecture: any
+Description: CFFI bindings of libyang library to Python language.
+
+Package: @PYTHON_CFFI_PACKAGE@-dbg
+Depends: @PYTHON_CFFI_PACKAGE@ (=@LIBYANG_VERSION@)
+Section: debug
+Architecture: any
+Description: Debug symbols of Python CFFI bindings of libyang library.

packages/debian.python3-libyang.install

@@ -0,0 +1 @@
+usr/lib/python3*/dist-packages/*

packages/debian.python3-yang.install

@@ -4,16 +4,16 @@
 export DH_VERBOSE=1
 
 %:
-	dh $@
+	dh $@ --with python3
 
 override_dh_strip:
 	dh_strip -p@PACKAGE@  --dbg-package=@PACKAGE@-dbg
 	dh_strip -p@CPP_PACKAGE@ --dbg-package=@CPP_PACKAGE@-dbg
-#	dh_strip -p@PYTHON_PACKAGE@ --dbg-package=@PYTHON_PACKAGE@-dbg
+	dh_strip -p@PYTHON_CFFI_PACKAGE@ --dbg-package=@PYTHON_CFFI_PACKAGE@-dbg
 
 override_dh_auto_configure:
 	cmake -DCMAKE_INSTALL_PREFIX=/usr -DFORCE_INSRC_BUILD=ON -DCMAKE_BUILD_TYPE="Package" -DENABLE_LYD_PRIV=ON \
-	-DGEN_LANGUAGE_BINDINGS=ON -DGEN_PYTHON_BINDINGS=OFF .
+	-DGEN_LANGUAGE_BINDINGS=ON -DGEN_PYTHON_BINDINGS=OFF -DGEN_PYTHON_CFFI_BINDINGS=ON .
 
 override_dh_auto_test:
 	ctest --output-on-failure

packages/debian.rules.in

@@ -1,10 +1,31 @@
 Format: 3.0 (quilt)
 Source: @PACKAGE@
-Binary: @PACKAGE@, @PACKAGE@-dbg, @PACKAGE@-dev, @CPP_PACKAGE@, @CPP_PACKAGE@-dev, @CPP_PACKAGE@-dbg
+Binary:
+ @PACKAGE@,
+ @PACKAGE@-dbg,
+ @PACKAGE@-dev,
+ @CPP_PACKAGE@,
+ @CPP_PACKAGE@-dev,
+ @CPP_PACKAGE@-dbg,
+ @PYTHON_CFFI_PACKAGE@,
+ @PYTHON_CFFI_PACKAGE@-dbg,
 Maintainer: CESNET <[email protected]>
 Version: @LIBYANG_VERSION@
 Architecture: any
 Standards-Version: 3.8.2
 Homepage: https://github.com/CESNET/libyang
 Vcs-Git: https://github.com/CESNET/libyang
-Build-Depends: debhelper (>= 9), make, gcc, doxygen, cmake, pkg-config, libpcre3-dev, libcmocka-dev, g++
+Build-Depends:
+ debhelper (>= 9),
+ dh-python,
+ make,
+ gcc,
+ g++,
+ doxygen,
+ cmake,
+ pkg-config,
+ libpcre3-dev,
+ libcmocka-dev,
+ python3 (>= 3.5),
+ python3-cffi,
+ python3-setuptools,

packages/libyang.dsc.in

@@ -38,8 +38,12 @@ BuildRequires:  swig >= 3.0.12
 
 %if 0%{?suse_version} + 0%{?fedora} + 0%{?centos_version} > 0
 BuildRequires:  python3-devel
+BuildRequires:  python3-cffi
+BuildRequires:  python3-setuptools
 %else
 BuildRequires:  python36-devel
+BuildRequires:  python36-cffi
+BuildRequires:  python36-setuptools
 %endif
 
 %endif
@@ -60,18 +64,32 @@ Requires:   @CPP_PACKAGE@ = %{version}-%{release}
 Requires:   pcre-devel
 
 %package -n @PYTHON_PACKAGE@
-Summary:    Binding to python
+Summary:    SWIG binding to python
 Requires:   @CPP_PACKAGE@ = %{version}-%{release}
 Requires:   %{name} = %{version}-%{release}
 
+%package -n @PYTHON_CFFI_PACKAGE@
+Summary:    CFFI binding to python
+Requires:   %{name} = %{version}-%{release}
+%if 0%{?suse_version} + 0%{?fedora} + 0%{?centos_version} > 0
+Requires:   python3
+Requires:   python3-cffi
+%else
+Requires:   python36
+Requires:   python36-cffi
+%endif
+
 %description -n @CPP_PACKAGE@
 Bindings of libyang library to C++ language.
 
 %description -n @CPP_PACKAGE@-devel
 Headers of bindings to c++ language.
 
 %description -n @PYTHON_PACKAGE@
-Bindings of libyang library to python language.
+SWIG bindings of libyang library to python language.
+
+%description -n @PYTHON_CFFI_PACKAGE@
+CFFI bindings of libyang library to python language.
 %endif
 
 %description devel
@@ -87,7 +105,7 @@ mkdir build
 %build
 cd build
 %if %{with_lang_bind}
-    %define cmake_lang_bind "-DGEN_LANGUAGE_BINDINGS=ON"
+    %define cmake_lang_bind "-DGEN_LANGUAGE_BINDINGS=ON -DGEN_PYTHON_CFFI_BINDINGS=ON"
 %else
     %define cmake_lang_bind "-DGEN_LANGUAGE_BINDINGS=OFF"
 %endif
@@ -155,7 +173,12 @@ make DESTDIR=%{buildroot} install
 
 %files -n @PYTHON_PACKAGE@
 %defattr(-,root,root)
-%{_libdir}/python*
+%{_libdir}/python*/site-packages/yang*
+
+%files -n @PYTHON_CFFI_PACKAGE@
+%defattr(-,root,root)
+%{_libdir}/python3*/site-packages/libyang*
+%{_libdir}/python3*/site-packages/_libyang*.so
 %endif
 
 %changelog