From 1b8fb86234d51aff255b8e97435d4dbb3316eaec Mon Sep 17 00:00:00 2001 From: Michael Jeanson Date: Wed, 23 Aug 2017 11:43:05 -0400 Subject: [PATCH] Build Python bindings with distutils for consistent installs MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit This patch changes the build system used to compile and install the Python Bindings. Distutils is used to find the right install directory. When the install directory generated from the install prefix is not in the Python search path (PYTHONPATH), we print a warning explaining what can be done to include it. It uses Distutils which is part of the Python standard library. Signed-off-by: Francis Deslauriers Signed-off-by: Michael Jeanson Signed-off-by: Jérémie Galarneau --- bindings/python/bt2/.gitignore | 10 +- bindings/python/bt2/Makefile.am | 179 +++++++++--------- bindings/python/bt2/{ => bt2}/__init__.py.in | 0 bindings/python/bt2/{ => bt2}/clock_class.py | 0 .../bt2/{ => bt2}/clock_class_priority_map.py | 0 bindings/python/bt2/{ => bt2}/component.py | 0 bindings/python/bt2/{ => bt2}/connection.py | 0 bindings/python/bt2/{ => bt2}/ctf_writer.py | 0 bindings/python/bt2/{ => bt2}/event.py | 0 bindings/python/bt2/{ => bt2}/event_class.py | 0 bindings/python/bt2/{ => bt2}/field_types.py | 0 bindings/python/bt2/{ => bt2}/fields.py | 0 bindings/python/bt2/{ => bt2}/graph.py | 0 bindings/python/bt2/{ => bt2}/logging.c | 0 bindings/python/bt2/{ => bt2}/logging.h | 0 bindings/python/bt2/{ => bt2}/logging.py | 0 bindings/python/bt2/{ => bt2}/native_bt.i | 2 + .../python/bt2/{ => bt2}/native_btccpriomap.i | 0 .../bt2/{ => bt2}/native_btclockclass.i | 0 .../python/bt2/{ => bt2}/native_btcomponent.i | 0 .../bt2/{ => bt2}/native_btcomponentclass.i | 0 .../bt2/{ => bt2}/native_btconnection.i | 0 .../python/bt2/{ => bt2}/native_btctfwriter.i | 0 .../python/bt2/{ => bt2}/native_btevent.i | 0 .../bt2/{ => bt2}/native_bteventclass.i | 0 .../python/bt2/{ => bt2}/native_btfields.i | 0 bindings/python/bt2/{ => bt2}/native_btft.i | 0 .../python/bt2/{ => bt2}/native_btgraph.i | 0 .../python/bt2/{ => bt2}/native_btlogging.i | 0 .../bt2/{ => bt2}/native_btnotification.i | 0 .../python/bt2/{ => bt2}/native_btnotifiter.i | 0 .../python/bt2/{ => bt2}/native_btpacket.i | 0 .../python/bt2/{ => bt2}/native_btplugin.i | 0 bindings/python/bt2/{ => bt2}/native_btport.i | 0 bindings/python/bt2/{ => bt2}/native_btref.i | 0 .../python/bt2/{ => bt2}/native_btstream.i | 0 .../bt2/{ => bt2}/native_btstreamclass.i | 0 .../python/bt2/{ => bt2}/native_bttrace.i | 0 .../python/bt2/{ => bt2}/native_btvalues.i | 0 .../python/bt2/{ => bt2}/native_btversion.i | 0 bindings/python/bt2/{ => bt2}/notification.py | 0 .../bt2/{ => bt2}/notification_iterator.py | 0 bindings/python/bt2/{ => bt2}/object.py | 0 bindings/python/bt2/{ => bt2}/packet.py | 0 bindings/python/bt2/{ => bt2}/plugin.py | 0 bindings/python/bt2/{ => bt2}/port.py | 0 bindings/python/bt2/{ => bt2}/py_plugin.py | 0 bindings/python/bt2/{ => bt2}/stream.py | 0 bindings/python/bt2/{ => bt2}/stream_class.py | 0 bindings/python/bt2/{ => bt2}/trace.py | 0 bindings/python/bt2/{ => bt2}/utils.py | 0 bindings/python/bt2/{ => bt2}/values.py | 0 bindings/python/bt2/setup.py.in | 86 +++++++++ configure.ac | 3 +- tests/bindings/python/bt2/test_python_bt2.in | 6 +- 55 files changed, 186 insertions(+), 100 deletions(-) rename bindings/python/bt2/{ => bt2}/__init__.py.in (100%) rename bindings/python/bt2/{ => bt2}/clock_class.py (100%) rename bindings/python/bt2/{ => bt2}/clock_class_priority_map.py (100%) rename bindings/python/bt2/{ => bt2}/component.py (100%) rename bindings/python/bt2/{ => bt2}/connection.py (100%) rename bindings/python/bt2/{ => bt2}/ctf_writer.py (100%) rename bindings/python/bt2/{ => bt2}/event.py (100%) rename bindings/python/bt2/{ => bt2}/event_class.py (100%) rename bindings/python/bt2/{ => bt2}/field_types.py (100%) rename bindings/python/bt2/{ => bt2}/fields.py (100%) rename bindings/python/bt2/{ => bt2}/graph.py (100%) rename bindings/python/bt2/{ => bt2}/logging.c (100%) rename bindings/python/bt2/{ => bt2}/logging.h (100%) rename bindings/python/bt2/{ => bt2}/logging.py (100%) rename bindings/python/bt2/{ => bt2}/native_bt.i (99%) rename bindings/python/bt2/{ => bt2}/native_btccpriomap.i (100%) rename bindings/python/bt2/{ => bt2}/native_btclockclass.i (100%) rename bindings/python/bt2/{ => bt2}/native_btcomponent.i (100%) rename bindings/python/bt2/{ => bt2}/native_btcomponentclass.i (100%) rename bindings/python/bt2/{ => bt2}/native_btconnection.i (100%) rename bindings/python/bt2/{ => bt2}/native_btctfwriter.i (100%) rename bindings/python/bt2/{ => bt2}/native_btevent.i (100%) rename bindings/python/bt2/{ => bt2}/native_bteventclass.i (100%) rename bindings/python/bt2/{ => bt2}/native_btfields.i (100%) rename bindings/python/bt2/{ => bt2}/native_btft.i (100%) rename bindings/python/bt2/{ => bt2}/native_btgraph.i (100%) rename bindings/python/bt2/{ => bt2}/native_btlogging.i (100%) rename bindings/python/bt2/{ => bt2}/native_btnotification.i (100%) rename bindings/python/bt2/{ => bt2}/native_btnotifiter.i (100%) rename bindings/python/bt2/{ => bt2}/native_btpacket.i (100%) rename bindings/python/bt2/{ => bt2}/native_btplugin.i (100%) rename bindings/python/bt2/{ => bt2}/native_btport.i (100%) rename bindings/python/bt2/{ => bt2}/native_btref.i (100%) rename bindings/python/bt2/{ => bt2}/native_btstream.i (100%) rename bindings/python/bt2/{ => bt2}/native_btstreamclass.i (100%) rename bindings/python/bt2/{ => bt2}/native_bttrace.i (100%) rename bindings/python/bt2/{ => bt2}/native_btvalues.i (100%) rename bindings/python/bt2/{ => bt2}/native_btversion.i (100%) rename bindings/python/bt2/{ => bt2}/notification.py (100%) rename bindings/python/bt2/{ => bt2}/notification_iterator.py (100%) rename bindings/python/bt2/{ => bt2}/object.py (100%) rename bindings/python/bt2/{ => bt2}/packet.py (100%) rename bindings/python/bt2/{ => bt2}/plugin.py (100%) rename bindings/python/bt2/{ => bt2}/port.py (100%) rename bindings/python/bt2/{ => bt2}/py_plugin.py (100%) rename bindings/python/bt2/{ => bt2}/stream.py (100%) rename bindings/python/bt2/{ => bt2}/stream_class.py (100%) rename bindings/python/bt2/{ => bt2}/trace.py (100%) rename bindings/python/bt2/{ => bt2}/utils.py (100%) rename bindings/python/bt2/{ => bt2}/values.py (100%) create mode 100644 bindings/python/bt2/setup.py.in diff --git a/bindings/python/bt2/.gitignore b/bindings/python/bt2/.gitignore index 56bd6e98..b893bced 100644 --- a/bindings/python/bt2/.gitignore +++ b/bindings/python/bt2/.gitignore @@ -1,3 +1,7 @@ -__init__.py -native_bt.py -native_bt_wrap.c +bt2/__init__.py +bt2/native_bt.py +bt2/native_bt_wrap.c +build +build-python-bindings.stamp +installed_files.txt +setup.py diff --git a/bindings/python/bt2/Makefile.am b/bindings/python/bt2/Makefile.am index 7b20517f..f41e2c07 100644 --- a/bindings/python/bt2/Makefile.am +++ b/bindings/python/bt2/Makefile.am @@ -1,107 +1,100 @@ -# native module name (without `.i` extension) -NATIVE_MODULE = native_bt +# Since the shared object used by the python bindings is not built with +# libtool, we need to add the directory containing libbabeltrace to the +# linker path. +AM_LDFLAGS=-L$(top_builddir)/lib/.libs -# interface dependencies (without `native_bt` prefix and `.i` extension) -NATIVE_MODULE_DEPS = \ - ccpriomap \ - clockclass \ - component \ - componentclass \ - connection \ - ctfwriter \ - event \ - eventclass \ - fields \ - ft \ - graph \ - logging \ - notification \ - notifiter \ - packet \ - plugin \ - port \ - ref \ - stream \ - streamclass \ - trace \ - values \ - version +INSTALLED_FILES=$(builddir)/installed_files.txt -# Python modules (without `.py` extension) -EXTRA_MODULES = \ - clock_class \ - clock_class_priority_map \ - component \ - connection \ - ctf_writer \ - event \ - event_class \ - field_types \ - fields \ - graph \ - logging \ - notification \ - notification_iterator \ - object \ - packet \ - plugin \ - port \ - py_plugin \ - stream \ - stream_class \ - trace \ - utils \ - values +STATIC_BINDINGS_DEPS = \ + bt2/logging.c \ + bt2/logging.h \ + bt2/native_btccpriomap.i \ + bt2/native_btclockclass.i \ + bt2/native_btcomponentclass.i \ + bt2/native_btcomponent.i \ + bt2/native_btconnection.i \ + bt2/native_btctfwriter.i \ + bt2/native_bteventclass.i \ + bt2/native_btevent.i \ + bt2/native_btfields.i \ + bt2/native_btft.i \ + bt2/native_btgraph.i \ + bt2/native_bt.i \ + bt2/native_btlogging.i \ + bt2/native_btnotification.i \ + bt2/native_btnotifiter.i \ + bt2/native_btpacket.i \ + bt2/native_btplugin.i \ + bt2/native_btport.i \ + bt2/native_btref.i \ + bt2/native_btstreamclass.i \ + bt2/native_btstream.i \ + bt2/native_bttrace.i \ + bt2/native_btvalues.i \ + bt2/native_btversion.i \ + bt2/clock_class_priority_map.py \ + bt2/clock_class.py \ + bt2/component.py \ + bt2/connection.py \ + bt2/ctf_writer.py \ + bt2/event_class.py \ + bt2/event.py \ + bt2/fields.py \ + bt2/field_types.py \ + bt2/graph.py \ + bt2/logging.py \ + bt2/notification_iterator.py \ + bt2/notification.py \ + bt2/object.py \ + bt2/packet.py \ + bt2/plugin.py \ + bt2/port.py \ + bt2/py_plugin.py \ + bt2/stream_class.py \ + bt2/stream.py \ + bt2/trace.py \ + bt2/utils.py \ + bt2/values.py -# automatically generated file lists -EXTRA_MODULES_PY = $(addprefix $(srcdir)/,$(addsuffix .py,$(EXTRA_MODULES))) -NATIVE_MODULE_I = $(srcdir)/$(NATIVE_MODULE).i -NATIVE_MODULE_PY = $(NATIVE_MODULE).py -NATIVE_MODULE_C = $(NATIVE_MODULE)_wrap.c -NATIVE_MODULE_DEPS_I = $(addprefix $(srcdir)/native_bt,$(addsuffix .i,$(NATIVE_MODULE_DEPS))) +GENERATED_BINDINGS_DEPS = \ + bt2/__init__.py \ + setup.py -# installed Python package -nodist_bt2package_PYTHON = __init__.py $(EXTRA_MODULES_PY) $(NATIVE_MODULE_PY) +BUILD_FLAGS=CC="$(CC)" \ + CFLAGS="$(GLIB_CFLAGS) $(AM_CFLAGS) $(CFLAGS)" \ + CPPFLAGS="$(AM_CPPFLAGS) $(CPPFLAGS)" \ + LDFLAGS="$(AM_LDFLAGS) $(LDFLAGS) $(GLIB_LIBS) $(LIBS)" -# native libraries to build -nativelibs_LTLIBRARIES = _native_bt.la +all-local: build-python-bindings.stamp -# installation directory for the `bt2` package -bt2packagedir = $(pythondir)/bt2 -nativelibsdir = $(bt2packagedir) +build-python-bindings.stamp: $(STATIC_BINDINGS_DEPS) $(GENERATED_BINDINGS_DEPS) + $(BUILD_FLAGS) $(PYTHON) $(builddir)/setup.py build_ext + $(BUILD_FLAGS) $(PYTHON) $(builddir)/setup.py build + touch $@ -# SWIG to C wrapper (and Python file) -$(NATIVE_MODULE_C): $(NATIVE_MODULE_I) $(NATIVE_MODULE_DEPS_I) - $(SWIG) -python -Wall -I$(srcdir) -I$(top_srcdir)/include -module $(NATIVE_MODULE) -outcurrentdir $(NATIVE_MODULE_I) +install-exec-local: build-python-bindings.stamp + @opts="--prefix=$(prefix) --record $(INSTALLED_FILES) --verbose --no-compile $(DISTSETUPOPTS)"; \ + if [ "$(DESTDIR)" != "" ]; then \ + opts="$$opts --root=$(DESTDIR)"; \ + fi; \ + $(PYTHON) $(builddir)/setup.py install $$opts; -# native_bt module -_native_bt_la_SOURCES = logging.h logging.c -nodist__native_bt_la_SOURCES = native_bt_wrap.c -_native_bt_la_LDFLAGS = -module -_native_bt_la_CFLAGS = $(PYTHON_INCLUDE) -I$(srcdir) $(AM_CFLAGS) -_native_bt_la_LIBADD = \ - $(top_builddir)/lib/libbabeltrace.la \ - $(top_builddir)/logging/libbabeltrace-logging.la \ - $(top_builddir)/common/libbabeltrace-common.la - -# extra module sources -> build directory -all-local: - @if [ x"$(srcdir)" != x"$(builddir)" ]; then \ - for file in $(EXTRA_MODULES_PY); do \ - cp -f "$(srcdir)/$$file" "$(builddir)"; \ - done; \ - fi - -# clean extra module sources in build directory clean-local: - @if [ x"$(srcdir)" != x"$(builddir)" ]; then \ - for file in $(EXTRA_MODULES_PY); do \ - rm -f "$(srcdir)/$$file" "$(builddir)"; \ - done; \ + rm -rf $(builddir)/build + +# Distutils' setup.py does not include an uninstall target, we thus need to do +# it manually. We save the path of the files that were installed during the install target +# and delete them during the uninstallation. +uninstall-local: + if [ "$(DESTDIR)" != "" ]; then \ + $(SED) -i "s|^|$(DESTDIR)/|g" $(INSTALLED_FILES); \ fi + cat $(INSTALLED_FILES) | xargs rm -rf || true + $(GREP) "__init__.py" $(INSTALLED_FILES) | xargs dirname | xargs rm -rf || true + rm -f $(INSTALLED_FILES) # distribute: extra Python modules and SWIG interface files -EXTRA_DIST = __init__.py.in $(EXTRA_MODULES_PY) $(NATIVE_MODULE_I) $(NATIVE_MODULE_DEPS_I) +EXTRA_DIST = $(STATIC_BINDINGS_DEPS) # clean: generated C and Python files (by SWIG) -CLEANFILES = $(NATIVE_MODULE_PY) $(NATIVE_MODULE_C) +CLEANFILES = bt2/native_bt.py bt2/native_bt_wrap.c build-python-bindings.stamp diff --git a/bindings/python/bt2/__init__.py.in b/bindings/python/bt2/bt2/__init__.py.in similarity index 100% rename from bindings/python/bt2/__init__.py.in rename to bindings/python/bt2/bt2/__init__.py.in diff --git a/bindings/python/bt2/clock_class.py b/bindings/python/bt2/bt2/clock_class.py similarity index 100% rename from bindings/python/bt2/clock_class.py rename to bindings/python/bt2/bt2/clock_class.py diff --git a/bindings/python/bt2/clock_class_priority_map.py b/bindings/python/bt2/bt2/clock_class_priority_map.py similarity index 100% rename from bindings/python/bt2/clock_class_priority_map.py rename to bindings/python/bt2/bt2/clock_class_priority_map.py diff --git a/bindings/python/bt2/component.py b/bindings/python/bt2/bt2/component.py similarity index 100% rename from bindings/python/bt2/component.py rename to bindings/python/bt2/bt2/component.py diff --git a/bindings/python/bt2/connection.py b/bindings/python/bt2/bt2/connection.py similarity index 100% rename from bindings/python/bt2/connection.py rename to bindings/python/bt2/bt2/connection.py diff --git a/bindings/python/bt2/ctf_writer.py b/bindings/python/bt2/bt2/ctf_writer.py similarity index 100% rename from bindings/python/bt2/ctf_writer.py rename to bindings/python/bt2/bt2/ctf_writer.py diff --git a/bindings/python/bt2/event.py b/bindings/python/bt2/bt2/event.py similarity index 100% rename from bindings/python/bt2/event.py rename to bindings/python/bt2/bt2/event.py diff --git a/bindings/python/bt2/event_class.py b/bindings/python/bt2/bt2/event_class.py similarity index 100% rename from bindings/python/bt2/event_class.py rename to bindings/python/bt2/bt2/event_class.py diff --git a/bindings/python/bt2/field_types.py b/bindings/python/bt2/bt2/field_types.py similarity index 100% rename from bindings/python/bt2/field_types.py rename to bindings/python/bt2/bt2/field_types.py diff --git a/bindings/python/bt2/fields.py b/bindings/python/bt2/bt2/fields.py similarity index 100% rename from bindings/python/bt2/fields.py rename to bindings/python/bt2/bt2/fields.py diff --git a/bindings/python/bt2/graph.py b/bindings/python/bt2/bt2/graph.py similarity index 100% rename from bindings/python/bt2/graph.py rename to bindings/python/bt2/bt2/graph.py diff --git a/bindings/python/bt2/logging.c b/bindings/python/bt2/bt2/logging.c similarity index 100% rename from bindings/python/bt2/logging.c rename to bindings/python/bt2/bt2/logging.c diff --git a/bindings/python/bt2/logging.h b/bindings/python/bt2/bt2/logging.h similarity index 100% rename from bindings/python/bt2/logging.h rename to bindings/python/bt2/bt2/logging.h diff --git a/bindings/python/bt2/logging.py b/bindings/python/bt2/bt2/logging.py similarity index 100% rename from bindings/python/bt2/logging.py rename to bindings/python/bt2/bt2/logging.py diff --git a/bindings/python/bt2/native_bt.i b/bindings/python/bt2/bt2/native_bt.i similarity index 99% rename from bindings/python/bt2/native_bt.i rename to bindings/python/bt2/bt2/native_bt.i index 0852b743..c7ae8d63 100644 --- a/bindings/python/bt2/native_bt.i +++ b/bindings/python/bt2/bt2/native_bt.i @@ -26,6 +26,8 @@ # error Unsupported output language #endif +%module native_bt + %{ #define BT_LOG_TAG "PY-NATIVE" #include "logging.h" diff --git a/bindings/python/bt2/native_btccpriomap.i b/bindings/python/bt2/bt2/native_btccpriomap.i similarity index 100% rename from bindings/python/bt2/native_btccpriomap.i rename to bindings/python/bt2/bt2/native_btccpriomap.i diff --git a/bindings/python/bt2/native_btclockclass.i b/bindings/python/bt2/bt2/native_btclockclass.i similarity index 100% rename from bindings/python/bt2/native_btclockclass.i rename to bindings/python/bt2/bt2/native_btclockclass.i diff --git a/bindings/python/bt2/native_btcomponent.i b/bindings/python/bt2/bt2/native_btcomponent.i similarity index 100% rename from bindings/python/bt2/native_btcomponent.i rename to bindings/python/bt2/bt2/native_btcomponent.i diff --git a/bindings/python/bt2/native_btcomponentclass.i b/bindings/python/bt2/bt2/native_btcomponentclass.i similarity index 100% rename from bindings/python/bt2/native_btcomponentclass.i rename to bindings/python/bt2/bt2/native_btcomponentclass.i diff --git a/bindings/python/bt2/native_btconnection.i b/bindings/python/bt2/bt2/native_btconnection.i similarity index 100% rename from bindings/python/bt2/native_btconnection.i rename to bindings/python/bt2/bt2/native_btconnection.i diff --git a/bindings/python/bt2/native_btctfwriter.i b/bindings/python/bt2/bt2/native_btctfwriter.i similarity index 100% rename from bindings/python/bt2/native_btctfwriter.i rename to bindings/python/bt2/bt2/native_btctfwriter.i diff --git a/bindings/python/bt2/native_btevent.i b/bindings/python/bt2/bt2/native_btevent.i similarity index 100% rename from bindings/python/bt2/native_btevent.i rename to bindings/python/bt2/bt2/native_btevent.i diff --git a/bindings/python/bt2/native_bteventclass.i b/bindings/python/bt2/bt2/native_bteventclass.i similarity index 100% rename from bindings/python/bt2/native_bteventclass.i rename to bindings/python/bt2/bt2/native_bteventclass.i diff --git a/bindings/python/bt2/native_btfields.i b/bindings/python/bt2/bt2/native_btfields.i similarity index 100% rename from bindings/python/bt2/native_btfields.i rename to bindings/python/bt2/bt2/native_btfields.i diff --git a/bindings/python/bt2/native_btft.i b/bindings/python/bt2/bt2/native_btft.i similarity index 100% rename from bindings/python/bt2/native_btft.i rename to bindings/python/bt2/bt2/native_btft.i diff --git a/bindings/python/bt2/native_btgraph.i b/bindings/python/bt2/bt2/native_btgraph.i similarity index 100% rename from bindings/python/bt2/native_btgraph.i rename to bindings/python/bt2/bt2/native_btgraph.i diff --git a/bindings/python/bt2/native_btlogging.i b/bindings/python/bt2/bt2/native_btlogging.i similarity index 100% rename from bindings/python/bt2/native_btlogging.i rename to bindings/python/bt2/bt2/native_btlogging.i diff --git a/bindings/python/bt2/native_btnotification.i b/bindings/python/bt2/bt2/native_btnotification.i similarity index 100% rename from bindings/python/bt2/native_btnotification.i rename to bindings/python/bt2/bt2/native_btnotification.i diff --git a/bindings/python/bt2/native_btnotifiter.i b/bindings/python/bt2/bt2/native_btnotifiter.i similarity index 100% rename from bindings/python/bt2/native_btnotifiter.i rename to bindings/python/bt2/bt2/native_btnotifiter.i diff --git a/bindings/python/bt2/native_btpacket.i b/bindings/python/bt2/bt2/native_btpacket.i similarity index 100% rename from bindings/python/bt2/native_btpacket.i rename to bindings/python/bt2/bt2/native_btpacket.i diff --git a/bindings/python/bt2/native_btplugin.i b/bindings/python/bt2/bt2/native_btplugin.i similarity index 100% rename from bindings/python/bt2/native_btplugin.i rename to bindings/python/bt2/bt2/native_btplugin.i diff --git a/bindings/python/bt2/native_btport.i b/bindings/python/bt2/bt2/native_btport.i similarity index 100% rename from bindings/python/bt2/native_btport.i rename to bindings/python/bt2/bt2/native_btport.i diff --git a/bindings/python/bt2/native_btref.i b/bindings/python/bt2/bt2/native_btref.i similarity index 100% rename from bindings/python/bt2/native_btref.i rename to bindings/python/bt2/bt2/native_btref.i diff --git a/bindings/python/bt2/native_btstream.i b/bindings/python/bt2/bt2/native_btstream.i similarity index 100% rename from bindings/python/bt2/native_btstream.i rename to bindings/python/bt2/bt2/native_btstream.i diff --git a/bindings/python/bt2/native_btstreamclass.i b/bindings/python/bt2/bt2/native_btstreamclass.i similarity index 100% rename from bindings/python/bt2/native_btstreamclass.i rename to bindings/python/bt2/bt2/native_btstreamclass.i diff --git a/bindings/python/bt2/native_bttrace.i b/bindings/python/bt2/bt2/native_bttrace.i similarity index 100% rename from bindings/python/bt2/native_bttrace.i rename to bindings/python/bt2/bt2/native_bttrace.i diff --git a/bindings/python/bt2/native_btvalues.i b/bindings/python/bt2/bt2/native_btvalues.i similarity index 100% rename from bindings/python/bt2/native_btvalues.i rename to bindings/python/bt2/bt2/native_btvalues.i diff --git a/bindings/python/bt2/native_btversion.i b/bindings/python/bt2/bt2/native_btversion.i similarity index 100% rename from bindings/python/bt2/native_btversion.i rename to bindings/python/bt2/bt2/native_btversion.i diff --git a/bindings/python/bt2/notification.py b/bindings/python/bt2/bt2/notification.py similarity index 100% rename from bindings/python/bt2/notification.py rename to bindings/python/bt2/bt2/notification.py diff --git a/bindings/python/bt2/notification_iterator.py b/bindings/python/bt2/bt2/notification_iterator.py similarity index 100% rename from bindings/python/bt2/notification_iterator.py rename to bindings/python/bt2/bt2/notification_iterator.py diff --git a/bindings/python/bt2/object.py b/bindings/python/bt2/bt2/object.py similarity index 100% rename from bindings/python/bt2/object.py rename to bindings/python/bt2/bt2/object.py diff --git a/bindings/python/bt2/packet.py b/bindings/python/bt2/bt2/packet.py similarity index 100% rename from bindings/python/bt2/packet.py rename to bindings/python/bt2/bt2/packet.py diff --git a/bindings/python/bt2/plugin.py b/bindings/python/bt2/bt2/plugin.py similarity index 100% rename from bindings/python/bt2/plugin.py rename to bindings/python/bt2/bt2/plugin.py diff --git a/bindings/python/bt2/port.py b/bindings/python/bt2/bt2/port.py similarity index 100% rename from bindings/python/bt2/port.py rename to bindings/python/bt2/bt2/port.py diff --git a/bindings/python/bt2/py_plugin.py b/bindings/python/bt2/bt2/py_plugin.py similarity index 100% rename from bindings/python/bt2/py_plugin.py rename to bindings/python/bt2/bt2/py_plugin.py diff --git a/bindings/python/bt2/stream.py b/bindings/python/bt2/bt2/stream.py similarity index 100% rename from bindings/python/bt2/stream.py rename to bindings/python/bt2/bt2/stream.py diff --git a/bindings/python/bt2/stream_class.py b/bindings/python/bt2/bt2/stream_class.py similarity index 100% rename from bindings/python/bt2/stream_class.py rename to bindings/python/bt2/bt2/stream_class.py diff --git a/bindings/python/bt2/trace.py b/bindings/python/bt2/bt2/trace.py similarity index 100% rename from bindings/python/bt2/trace.py rename to bindings/python/bt2/bt2/trace.py diff --git a/bindings/python/bt2/utils.py b/bindings/python/bt2/bt2/utils.py similarity index 100% rename from bindings/python/bt2/utils.py rename to bindings/python/bt2/bt2/utils.py diff --git a/bindings/python/bt2/values.py b/bindings/python/bt2/bt2/values.py similarity index 100% rename from bindings/python/bt2/values.py rename to bindings/python/bt2/bt2/values.py diff --git a/bindings/python/bt2/setup.py.in b/bindings/python/bt2/setup.py.in new file mode 100644 index 00000000..d4e1ad23 --- /dev/null +++ b/bindings/python/bt2/setup.py.in @@ -0,0 +1,86 @@ +# The MIT License (MIT) +# +# Copyright (C) 2017 - Francis Deslauriers +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), to deal +# in the Software without restriction, including without limitation the rights +# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +# copies of the Software, and to permit persons to whom the Software is +# furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +# THE SOFTWARE. + +import sys + +from distutils.core import setup, Extension + +PY_PATH_WARN_MSG = """ +-------------------------------------WARNING------------------------------------ +The install directory used:\n ({})\nis not included in your PYTHONPATH. + +To add this directory to your Python search path permanently you can add the +following command to your .bashrc/.zshrc: + export PYTHONPATH="${{PYTHONPATH}}:{}" +-------------------------------------------------------------------------------- +""" + +def main(): + babeltrace_ext = Extension('_native_bt', + sources=['bt2/native_bt.i', 'bt2/logging.c'], + libraries=['babeltrace', 'glib-2.0'], + extra_objects=['@top_builddir@/logging/.libs/libbabeltrace-logging.a', + '@top_builddir@/common/.libs/libbabeltrace-common.a'],) + + dist = setup(name='bt2', + version='@PACKAGE_VERSION@', + description='Babeltrace 2 Python Bindings', + packages=['bt2'], + package_dir={'bt2': 'bt2'}, + options={'build': + { + 'build_base': 'build', + 'build_lib': 'build/build_lib' + }, + 'build_ext': + { + 'build_lib': 'build/build_lib' + } + }, + url='http://diamon.org/babeltrace', + ext_modules=[babeltrace_ext], + license='MIT', + classifiers=[ + 'Development Status :: 5 - Production/Stable', + 'Intended Audience :: Developers', + 'License :: OSI Approved :: The MIT License', + 'Programming Language :: Python :: 3' + 'Topic :: System :: Logging', + ]) + +# After the installation, we check that the install directory is included in +# the Python search path and we print a warning message when it's not. +# We need to do this because Python search path differs depending on the distro +# and some distros don't include any /usr/local/ in the search path. This is +# also useful for out-of-tree installs and tests. +# It's only relevant to make this check on the `install` command. + + if 'install' in dist.command_obj: + install_dir = dist.command_obj['install'].install_libbase + if install_dir not in sys.path: + # We can't consider this an error because if affects every + # distro differently. We only warn the user that some + # extra configuration is needed to use the bindings + print(PY_PATH_WARN_MSG.format(install_dir, install_dir)) + +if __name__ == "__main__": + main() diff --git a/configure.ac b/configure.ac index 3102dc72..0f27f1c5 100644 --- a/configure.ac +++ b/configure.ac @@ -662,7 +662,8 @@ AC_CONFIG_FILES([ Makefile bindings/python/Makefile bindings/python/bt2/Makefile - bindings/python/bt2/__init__.py + bindings/python/bt2/setup.py + bindings/python/bt2/bt2/__init__.py common/Makefile compat/Makefile cli/Makefile diff --git a/tests/bindings/python/bt2/test_python_bt2.in b/tests/bindings/python/bt2/test_python_bt2.in index d32cb01d..4fa569e8 100644 --- a/tests/bindings/python/bt2/test_python_bt2.in +++ b/tests/bindings/python/bt2/test_python_bt2.in @@ -27,8 +27,8 @@ check_coverage() { export BABELTRACE_PYTHON_BT2_NO_TRACEBACK=1 export TEST_PLUGIN_PLUGINS_PATH="${BT_BUILD_PATH}/plugins" export BABELTRACE_PLUGIN_PATH="${BT_BUILD_PATH}/plugins/ctf:${BT_BUILD_PATH}/plugins/utils:${BT_BUILD_PATH}/plugins/text" -PYTHON_BUILD_DIR="${BT_BUILD_PATH}/bindings/python" -BT2_NATIVE_LIBS_DIR="${BT_BUILD_PATH}/bindings/python/bt2/.libs" +export LD_LIBRARY_PATH="${BT_BUILD_PATH}/lib/.libs" +PYTHON_BUILD_DIR="${BT_BUILD_PATH}/bindings/python/bt2/build/build_lib" TESTS_UTILS_PYTHON_DIR="${BT_SRC_PATH}/tests/utils/python" TESTRUNNER_PY="${BT_SRC_PATH}/tests/utils/python/testrunner.py" THIS_DIR="${BT_SRC_PATH}/tests/bindings/python/bt2" @@ -40,7 +40,7 @@ else fi -PYTHONPATH="$PYTHON_BUILD_DIR:$BT2_NATIVE_LIBS_DIR:$TESTS_UTILS_PYTHON_DIR" \ +PYTHONPATH="$PYTHON_BUILD_DIR:$TESTS_UTILS_PYTHON_DIR" \ "$EXEC" "$TESTRUNNER_PY" "$THIS_DIR" res=$? -- 2.34.1