* [PATCH v3 0/5] pylibfdt: Add installation support
@ 2017-04-05 16:01 Simon Glass
[not found] ` <20170405160142.10564-1-sjg-F7+t8E8rja9g9hUCZPvPmw@public.gmane.org>
0 siblings, 1 reply; 9+ messages in thread
From: Simon Glass @ 2017-04-05 16:01 UTC (permalink / raw)
To: Devicetree Compiler; +Cc: Mike Frysinger, David Gibson, Simon Glass
This series adds support for installation of the Pylib module. It adjusts
the setup.py file to provide this functionality and the Makefile rules
to call it correctly.
It also adds a way to disable building the Python module. This is useful
since some build systems want to use setup.py to do both the build and
the install step. In this case the correct build commands would be:
make NO_PYTHON=1
make install_pylibfdt SETUP_PREFIX=/path/to/install_prefix
Version 3 adds support for running setup.py stand-alone:
./pylibfdt/setup.py --install_path [--prefix=/path/to/install_dir]
Changes in v3:
- Add new patch to fix code style in setup.py
- Update README to suggest using setup.py for an easy install
- Allow setup.py to be run from the base directory
- Make setup.py executable
- Use define..endef instead of line continuations
- Add new patch to move to Makefile constructs for NO_PYTHON
- Add a new patch to use setup.py to build the swig file
Changes in v2:
- Add new patch to rename libfdt.swig to libfdt.i
- Add new patch to allow setup.py to operation stand-alone
- Rebase to master
Simon Glass (5):
pylibfdt: Rename libfdt.swig to libfdt.i
pylibfdt: Fix code style in setup.py
pylibfdt: Allow setup.py to operate stand-alone
pylibfdt: Use Makefile constructs to implement NO_PYTHON
pylibfdt: Use setup.py to build the swig file
Makefile | 13 ++++-
README | 14 +++--
pylibfdt/Makefile.pylibfdt | 29 ++++------
pylibfdt/{libfdt.swig => libfdt.i} | 0
pylibfdt/setup.py | 113 ++++++++++++++++++++++++++++++++-----
5 files changed, 130 insertions(+), 39 deletions(-)
rename pylibfdt/{libfdt.swig => libfdt.i} (100%)
mode change 100644 => 100755 pylibfdt/setup.py
--
2.12.2.715.g7642488e1d-goog
^ permalink raw reply [flat|nested] 9+ messages in thread
* [PATCH v3 1/5] pylibfdt: Rename libfdt.swig to libfdt.i
[not found] ` <20170405160142.10564-1-sjg-F7+t8E8rja9g9hUCZPvPmw@public.gmane.org>
@ 2017-04-05 16:01 ` Simon Glass
2017-04-05 16:01 ` [PATCH v3 2/5] pylibfdt: Fix code style in setup.py Simon Glass
` (4 subsequent siblings)
5 siblings, 0 replies; 9+ messages in thread
From: Simon Glass @ 2017-04-05 16:01 UTC (permalink / raw)
To: Devicetree Compiler; +Cc: Mike Frysinger, David Gibson, Simon Glass
The .i extension allows Python distutils to automatically handle the swig
file. Rename it.
Signed-off-by: Simon Glass <sjg-F7+t8E8rja9g9hUCZPvPmw@public.gmane.org>
Suggested-by: Mike Frysinger <vapier-aBrp7R+bbdUdnm+yROfE0A@public.gmane.org>
---
Changes in v3: None
Changes in v2:
- Add new patch to rename libfdt.swig to libfdt.i
pylibfdt/Makefile.pylibfdt | 2 +-
pylibfdt/{libfdt.swig => libfdt.i} | 0
2 files changed, 1 insertion(+), 1 deletion(-)
rename pylibfdt/{libfdt.swig => libfdt.i} (100%)
diff --git a/pylibfdt/Makefile.pylibfdt b/pylibfdt/Makefile.pylibfdt
index 0d95c11..06f9296 100644
--- a/pylibfdt/Makefile.pylibfdt
+++ b/pylibfdt/Makefile.pylibfdt
@@ -13,7 +13,7 @@ $(PYMODULE): $(PYLIBFDT_srcs) $(WRAP)
@$(VECHO) PYMOD $@
$(call run_setup, $^, build_ext --inplace)
-$(WRAP): $(PYLIBFDT_srcdir)/libfdt.swig
+$(WRAP): $(PYLIBFDT_srcdir)/libfdt.i
@$(VECHO) SWIG $@
$(SWIG) -python -o $@ $<
diff --git a/pylibfdt/libfdt.swig b/pylibfdt/libfdt.i
similarity index 100%
rename from pylibfdt/libfdt.swig
rename to pylibfdt/libfdt.i
--
2.12.2.715.g7642488e1d-goog
^ permalink raw reply related [flat|nested] 9+ messages in thread
* [PATCH v3 2/5] pylibfdt: Fix code style in setup.py
[not found] ` <20170405160142.10564-1-sjg-F7+t8E8rja9g9hUCZPvPmw@public.gmane.org>
2017-04-05 16:01 ` [PATCH v3 1/5] pylibfdt: Rename libfdt.swig to libfdt.i Simon Glass
@ 2017-04-05 16:01 ` Simon Glass
2017-04-05 16:01 ` [PATCH v3 3/5] pylibfdt: Allow setup.py to operate stand-alone Simon Glass
` (3 subsequent siblings)
5 siblings, 0 replies; 9+ messages in thread
From: Simon Glass @ 2017-04-05 16:01 UTC (permalink / raw)
To: Devicetree Compiler; +Cc: Mike Frysinger, David Gibson, Simon Glass
We should follow PEP8 even for our setup() call.
Signed-off-by: Simon Glass <sjg-F7+t8E8rja9g9hUCZPvPmw@public.gmane.org>
Suggested-by: Mike Frysinger <vapier-aBrp7R+bbdUdnm+yROfE0A@public.gmane.org>
---
Changes in v3:
- Add new patch to fix code style in setup.py
Changes in v2: None
pylibfdt/setup.py | 17 +++++++++--------
1 file changed, 9 insertions(+), 8 deletions(-)
diff --git a/pylibfdt/setup.py b/pylibfdt/setup.py
index 3bafe30..1597b44 100644
--- a/pylibfdt/setup.py
+++ b/pylibfdt/setup.py
@@ -24,11 +24,12 @@ libfdt_module = Extension(
extra_compile_args = cflags
)
-setup (name = 'libfdt',
- version = version,
- author = "Simon Glass <sjg-F7+t8E8rja9g9hUCZPvPmw@public.gmane.org>",
- description = """Python binding for libfdt""",
- ext_modules = [libfdt_module],
- package_dir = {'': objdir},
- py_modules = ["libfdt"],
- )
+setup(
+ name='libfdt',
+ version= version,
+ author='Simon Glass <sjg-F7+t8E8rja9g9hUCZPvPmw@public.gmane.org>',
+ description='Python binding for libfdt',
+ ext_modules=[libfdt_module],
+ package_dir={'': objdir},
+ py_modules=['libfdt'],
+)
--
2.12.2.715.g7642488e1d-goog
^ permalink raw reply related [flat|nested] 9+ messages in thread
* [PATCH v3 3/5] pylibfdt: Allow setup.py to operate stand-alone
[not found] ` <20170405160142.10564-1-sjg-F7+t8E8rja9g9hUCZPvPmw@public.gmane.org>
2017-04-05 16:01 ` [PATCH v3 1/5] pylibfdt: Rename libfdt.swig to libfdt.i Simon Glass
2017-04-05 16:01 ` [PATCH v3 2/5] pylibfdt: Fix code style in setup.py Simon Glass
@ 2017-04-05 16:01 ` Simon Glass
[not found] ` <20170405160142.10564-4-sjg-F7+t8E8rja9g9hUCZPvPmw@public.gmane.org>
2017-04-05 16:01 ` [PATCH v3 4/5] pylibfdt: Use Makefile constructs to implement NO_PYTHON Simon Glass
` (2 subsequent siblings)
5 siblings, 1 reply; 9+ messages in thread
From: Simon Glass @ 2017-04-05 16:01 UTC (permalink / raw)
To: Devicetree Compiler; +Cc: Mike Frysinger, David Gibson, Simon Glass
At present we require that setup.py is executed from the Makefile, which
sets up various important things like the list of files to build and the
version number.
However many installation systems expect to be able to change to the
directory containing setup.py and run it. This allows them to support (for
example) building/installing for multiple Python versions, varying
installation paths, particular C flags, etc.
The problem in implementing this is that we don't want to duplicate the
information in the Makefile. A common solution (so I am told) is to parse
the Makefile to obtain the required information.
Update the setup.py script to read a few Makefiles when it does not see
the required information in its environment. This allows installation
using:
./pylibfdt/setup.py install
Signed-off-by: Simon Glass <sjg-F7+t8E8rja9g9hUCZPvPmw@public.gmane.org>
---
Changes in v3:
- Update README to suggest using setup.py for an easy install
- Allow setup.py to be run from the base directory
- Make setup.py executable
- Use define..endef instead of line continuations
Changes in v2:
- Add new patch to allow setup.py to operation stand-alone
- Rebase to master
README | 14 +++++--
pylibfdt/Makefile.pylibfdt | 8 ++--
pylibfdt/setup.py | 98 +++++++++++++++++++++++++++++++++++++++++++---
3 files changed, 107 insertions(+), 13 deletions(-)
mode change 100644 => 100755 pylibfdt/setup.py
diff --git a/README b/README
index 5add557..17dc845 100644
--- a/README
+++ b/README
@@ -50,12 +50,18 @@ If you add new features, please check code coverage:
# Open 'htmlcov/index.html' in your browser
-To install the library use:
+To install the library via the normal setup.py method, use:
- make install_pylibfdt SETUP_PREFIX=/path/to/install_dir
+ ./pylibfdt/setup.py [--prefix=/path/to/install_dir]
-If SETUP_PREFIX is not provided, the default prefix is used, typically '/usr'
-or '/usr/local'. See Python's distutils documentation for details.
+If --prefix is not provided, the default prefix is used, typically '/usr'
+or '/usr/local'. See Python's distutils documentation for details. You can
+also install via the Makefile if you like, but the above is more common.
+
+To install both libfdt and pylibfdt you can use:
+
+ make install [SETUP_PREFIX=/path/to/install_dir] \
+ [PREFIX=/path/to/install_dir]
To disable building the python library, even if swig and Python are available,
use:
diff --git a/pylibfdt/Makefile.pylibfdt b/pylibfdt/Makefile.pylibfdt
index 06f9296..f7f9d5e 100644
--- a/pylibfdt/Makefile.pylibfdt
+++ b/pylibfdt/Makefile.pylibfdt
@@ -5,9 +5,11 @@ PYLIBFDT_srcs = $(addprefix $(LIBFDT_srcdir)/,$(LIBFDT_SRCS))
WRAP = $(PYLIBFDT_objdir)/libfdt_wrap.c
PYMODULE = $(PYLIBFDT_objdir)/_libfdt.so
-run_setup = SOURCES="$(1)" CPPFLAGS="$(CPPFLAGS)" OBJDIR="$(PYLIBFDT_objdir)" \
- VERSION="$(dtc_version)" \
- python $(PYLIBFDT_objdir)/setup.py --quiet $(2)
+define run_setup
+ SOURCES="$(1)" CPPFLAGS="$(CPPFLAGS)" OBJDIR="$(PYLIBFDT_objdir)"
+ VERSION="$(dtc_version)"
+ $(PYLIBFDT_objdir)/setup.py --quiet $(2)
+endef
$(PYMODULE): $(PYLIBFDT_srcs) $(WRAP)
@$(VECHO) PYMOD $@
diff --git a/pylibfdt/setup.py b/pylibfdt/setup.py
old mode 100644
new mode 100755
index 1597b44..90e80f3
--- a/pylibfdt/setup.py
+++ b/pylibfdt/setup.py
@@ -2,26 +2,112 @@
"""
setup.py file for SWIG libfdt
+Copyright (C) 2017 Google, Inc.
+Written by Simon Glass <sjg-F7+t8E8rja9g9hUCZPvPmw@public.gmane.org>
Files to be built into the extension are provided in SOURCES
C flags to use are provided in CPPFLAGS
Object file directory is provided in OBJDIR
+Version is provided in VERSION
+
+If these variables are not given they are parsed from the Makefiles. This
+allows this script to be run stand-alone, e.g.:
+
+ ./pylibfdt/setup.py install [--prefix=...]
"""
from distutils.core import setup, Extension
import os
+import re
import sys
+# Decodes a Makefile assignment line into key and value (and plus for +=)
+RE_KEY_VALUE = re.compile('(?P<key>\w+) *(?P<plus>[+])?= *(?P<value>.*)$')
+
+
+def ParseMakefile(fname):
+ """Parse a Makefile to obtain its variables.
+
+ This collects variable assigments of the form:
+
+ VAR = value
+ VAR += more
+
+ It does not pick out := assignments, as these are not needed here. It does
+ handle line continuation.
+
+ Returns a dict:
+ key: Variable name (e.g. 'VAR')
+ value: Variable value (e.g. 'value more')
+ """
+ makevars = {}
+ with open(fname) as fd:
+ prev_text = '' # Continuation text from previous line(s)
+ for line in fd.read().splitlines():
+ if line and line[-1] == '\\': # Deal with line continuation
+ prev_text += line[:-1]
+ continue
+ elif prev_text:
+ line = prev_text + line
+ prev_text = '' # Continuation is now used up
+ m = RE_KEY_VALUE.match(line)
+ if m:
+ value = m.group('value') or ''
+ key = m.group('key')
+
+ # Appending to a variable inserts a space beforehand
+ if 'plus' in m.groupdict() and key in makevars:
+ makevars[key] += ' ' + value
+ else:
+ makevars[key] = value
+ return makevars
+
+def GetEnvFromMakefiles():
+ """Scan the Makefiles to obtain the settings we need.
+
+ This assumes that this script is being run from the top-level directory,
+ not the pylibfdt directory.
+
+ Returns:
+ Tuple with:
+ List of swig options
+ Version string
+ List of files to build
+ List of extra C preprocessor flags needed
+ Object directory to use (always '')
+ """
+ basedir = os.path.dirname(os.path.dirname(os.path.abspath(sys.argv[0])))
+ swig_opts = ['-I%s' % basedir]
+ makevars = ParseMakefile(os.path.join(basedir, 'Makefile'))
+ version = '%s.%s.%s' % (makevars['VERSION'], makevars['PATCHLEVEL'],
+ makevars['SUBLEVEL'])
+ makevars = ParseMakefile(os.path.join(basedir, 'libfdt', 'Makefile.libfdt'))
+ files = makevars['LIBFDT_SRCS'].split()
+ files = [os.path.join(basedir, 'libfdt', fname) for fname in files]
+ files.append('pylibfdt/libfdt.i')
+ cflags = ['-I%s' % basedir, '-I%s/libfdt' % basedir]
+ objdir = ''
+ return swig_opts, version, files, cflags, objdir
+
+
progname = sys.argv[0]
-files = os.environ['SOURCES'].split()
-cflags = os.environ['CPPFLAGS'].split()
-objdir = os.environ['OBJDIR']
-version = os.environ['VERSION']
+files = os.environ.get('SOURCES', '').split()
+cflags = os.environ.get('CPPFLAGS', '').split()
+objdir = os.environ.get('OBJDIR')
+version = os.environ.get('VERSION')
+swig_opts = []
+
+# If we were called directly rather than through our Makefile (which is often
+# the case with Python module installation), read the settings from the
+# Makefile.
+if not all((version, files, cflags, objdir)):
+ swig_opts, version, files, cflags, objdir = GetEnvFromMakefiles()
libfdt_module = Extension(
'_libfdt',
sources = files,
- extra_compile_args = cflags
+ extra_compile_args = cflags,
+ swig_opts = swig_opts,
)
setup(
@@ -31,5 +117,5 @@ setup(
description='Python binding for libfdt',
ext_modules=[libfdt_module],
package_dir={'': objdir},
- py_modules=['libfdt'],
+ py_modules=['pylibfdt/libfdt'],
)
--
2.12.2.715.g7642488e1d-goog
^ permalink raw reply related [flat|nested] 9+ messages in thread
* [PATCH v3 4/5] pylibfdt: Use Makefile constructs to implement NO_PYTHON
[not found] ` <20170405160142.10564-1-sjg-F7+t8E8rja9g9hUCZPvPmw@public.gmane.org>
` (2 preceding siblings ...)
2017-04-05 16:01 ` [PATCH v3 3/5] pylibfdt: Allow setup.py to operate stand-alone Simon Glass
@ 2017-04-05 16:01 ` Simon Glass
2017-04-05 16:01 ` [PATCH v3 5/5] pylibfdt: Use setup.py to build the swig file Simon Glass
2017-04-07 5:49 ` [PATCH v3 0/5] pylibfdt: Add installation support David Gibson
5 siblings, 0 replies; 9+ messages in thread
From: Simon Glass @ 2017-04-05 16:01 UTC (permalink / raw)
To: Devicetree Compiler; +Cc: Mike Frysinger, David Gibson, Simon Glass
The current mechanism uses a shell construct, but it seems better to use
a Makefile approach.
Signed-off-by: Simon Glass <sjg-F7+t8E8rja9g9hUCZPvPmw@public.gmane.org>
Suggested-by: Mike Frysinger <vapier-aBrp7R+bbdUdnm+yROfE0A@public.gmane.org>
---
Changes in v3:
- Add new patch to move to Makefile constructs for NO_PYTHON
Changes in v2: None
Makefile | 13 ++++++++++---
pylibfdt/Makefile.pylibfdt | 7 -------
2 files changed, 10 insertions(+), 10 deletions(-)
diff --git a/Makefile b/Makefile
index 52ff72c..88cbfe2 100644
--- a/Makefile
+++ b/Makefile
@@ -117,10 +117,11 @@ BIN += fdtput
SCRIPTS = dtdiff
+all: $(BIN) libfdt
+
# We need both Python and swig to build pylibfdt.
.PHONY: maybe_pylibfdt
maybe_pylibfdt: FORCE
- if [ -n "${NO_PYTHON}" ]; then exit; fi; \
if $(PKG_CONFIG) --cflags python >/dev/null 2>&1; then \
if which swig >/dev/null 2>&1; then \
can_build=yes; \
@@ -132,7 +133,9 @@ maybe_pylibfdt: FORCE
echo "## Skipping pylibfdt (install python dev and swig to build)"; \
fi
-all: $(BIN) libfdt maybe_pylibfdt
+ifeq ($(NO_PYTHON),)
+all: maybe_pylibfdt
+endif
ifneq ($(DEPTARGETS),)
@@ -195,7 +198,11 @@ install-includes:
$(INSTALL) -d $(DESTDIR)$(INCLUDEDIR)
$(INSTALL) -m 644 $(LIBFDT_include) $(DESTDIR)$(INCLUDEDIR)
-install: install-bin install-lib install-includes maybe_install_pylibfdt
+install: install-bin install-lib install-includes
+
+ifeq ($(NO_PYTHON),)
+install: install_pylibfdt
+endif
$(VERSION_FILE): Makefile FORCE
$(call filechk,version)
diff --git a/pylibfdt/Makefile.pylibfdt b/pylibfdt/Makefile.pylibfdt
index f7f9d5e..7ee72f2 100644
--- a/pylibfdt/Makefile.pylibfdt
+++ b/pylibfdt/Makefile.pylibfdt
@@ -24,11 +24,4 @@ install_pylibfdt: $(WRAP) $(PYMODULE)
$(call run_setup, $(PYLIBFDT_srcs) $(WRAP), \
install $(if $(SETUP_PREFIX),--prefix=$(SETUP_PREFIX)))
-maybe_install_pylibfdt:
- if [ -e $(PYMODULE) ]; then \
- if [ -z "$(NO_PYTHON)" ]; then \
- $(MAKE) install_pylibfdt; \
- fi; \
- fi
-
PYLIBFDT_cleanfiles = libfdt_wrap.c libfdt.py libfdt.pyc _libfdt.so
--
2.12.2.715.g7642488e1d-goog
^ permalink raw reply related [flat|nested] 9+ messages in thread
* [PATCH v3 5/5] pylibfdt: Use setup.py to build the swig file
[not found] ` <20170405160142.10564-1-sjg-F7+t8E8rja9g9hUCZPvPmw@public.gmane.org>
` (3 preceding siblings ...)
2017-04-05 16:01 ` [PATCH v3 4/5] pylibfdt: Use Makefile constructs to implement NO_PYTHON Simon Glass
@ 2017-04-05 16:01 ` Simon Glass
2017-04-07 5:49 ` [PATCH v3 0/5] pylibfdt: Add installation support David Gibson
5 siblings, 0 replies; 9+ messages in thread
From: Simon Glass @ 2017-04-05 16:01 UTC (permalink / raw)
To: Devicetree Compiler; +Cc: Mike Frysinger, David Gibson, Simon Glass
Since we are using the standard .i extension for the swig file, we can use
setup.py to build the wrapper. Drop the existing build code since it is
not needed.
Signed-off-by: Simon Glass <sjg-F7+t8E8rja9g9hUCZPvPmw@public.gmane.org>
---
Changes in v3:
- Add a new patch to use setup.py to build the swig file
Changes in v2: None
pylibfdt/Makefile.pylibfdt | 14 +++++---------
1 file changed, 5 insertions(+), 9 deletions(-)
diff --git a/pylibfdt/Makefile.pylibfdt b/pylibfdt/Makefile.pylibfdt
index 7ee72f2..2843ef5 100644
--- a/pylibfdt/Makefile.pylibfdt
+++ b/pylibfdt/Makefile.pylibfdt
@@ -1,8 +1,8 @@
# Makefile.pylibfdt
#
-PYLIBFDT_srcs = $(addprefix $(LIBFDT_srcdir)/,$(LIBFDT_SRCS))
-WRAP = $(PYLIBFDT_objdir)/libfdt_wrap.c
+PYLIBFDT_srcs = $(addprefix $(LIBFDT_srcdir)/,$(LIBFDT_SRCS)) \
+ $(PYLIBFDT_srcdir)/libfdt.i
PYMODULE = $(PYLIBFDT_objdir)/_libfdt.so
define run_setup
@@ -11,17 +11,13 @@ define run_setup
$(PYLIBFDT_objdir)/setup.py --quiet $(2)
endef
-$(PYMODULE): $(PYLIBFDT_srcs) $(WRAP)
+$(PYMODULE): $(PYLIBFDT_srcs)
@$(VECHO) PYMOD $@
$(call run_setup, $^, build_ext --inplace)
-$(WRAP): $(PYLIBFDT_srcdir)/libfdt.i
- @$(VECHO) SWIG $@
- $(SWIG) -python -o $@ $<
-
-install_pylibfdt: $(WRAP) $(PYMODULE)
+install_pylibfdt: $(PYMODULE)
$(VECHO) INSTALL-PYLIB; \
- $(call run_setup, $(PYLIBFDT_srcs) $(WRAP), \
+ $(call run_setup, $(PYLIBFDT_srcs), \
install $(if $(SETUP_PREFIX),--prefix=$(SETUP_PREFIX)))
PYLIBFDT_cleanfiles = libfdt_wrap.c libfdt.py libfdt.pyc _libfdt.so
--
2.12.2.715.g7642488e1d-goog
^ permalink raw reply related [flat|nested] 9+ messages in thread
* Re: [PATCH v3 3/5] pylibfdt: Allow setup.py to operate stand-alone
[not found] ` <20170405160142.10564-4-sjg-F7+t8E8rja9g9hUCZPvPmw@public.gmane.org>
@ 2017-04-07 5:46 ` David Gibson
2017-04-07 21:48 ` Simon Glass
0 siblings, 1 reply; 9+ messages in thread
From: David Gibson @ 2017-04-07 5:46 UTC (permalink / raw)
To: Simon Glass; +Cc: Devicetree Compiler, Mike Frysinger
[-- Attachment #1: Type: text/plain, Size: 8492 bytes --]
On Wed, Apr 05, 2017 at 10:01:40AM -0600, Simon Glass wrote:
> At present we require that setup.py is executed from the Makefile, which
> sets up various important things like the list of files to build and the
> version number.
>
> However many installation systems expect to be able to change to the
> directory containing setup.py and run it. This allows them to support (for
> example) building/installing for multiple Python versions, varying
> installation paths, particular C flags, etc.
>
> The problem in implementing this is that we don't want to duplicate the
> information in the Makefile. A common solution (so I am told) is to parse
> the Makefile to obtain the required information.
>
> Update the setup.py script to read a few Makefiles when it does not see
> the required information in its environment. This allows installation
> using:
>
> ./pylibfdt/setup.py install
>
> Signed-off-by: Simon Glass <sjg-F7+t8E8rja9g9hUCZPvPmw@public.gmane.org>
I'm not sure quite how or why, but this patch has the side-effect of
stopping the Python tests from running with "make check".
> ---
>
> Changes in v3:
> - Update README to suggest using setup.py for an easy install
> - Allow setup.py to be run from the base directory
> - Make setup.py executable
> - Use define..endef instead of line continuations
>
> Changes in v2:
> - Add new patch to allow setup.py to operation stand-alone
> - Rebase to master
>
> README | 14 +++++--
> pylibfdt/Makefile.pylibfdt | 8 ++--
> pylibfdt/setup.py | 98 +++++++++++++++++++++++++++++++++++++++++++---
> 3 files changed, 107 insertions(+), 13 deletions(-)
> mode change 100644 => 100755 pylibfdt/setup.py
>
> diff --git a/README b/README
> index 5add557..17dc845 100644
> --- a/README
> +++ b/README
> @@ -50,12 +50,18 @@ If you add new features, please check code coverage:
> # Open 'htmlcov/index.html' in your browser
>
>
> -To install the library use:
> +To install the library via the normal setup.py method, use:
>
> - make install_pylibfdt SETUP_PREFIX=/path/to/install_dir
> + ./pylibfdt/setup.py [--prefix=/path/to/install_dir]
>
> -If SETUP_PREFIX is not provided, the default prefix is used, typically '/usr'
> -or '/usr/local'. See Python's distutils documentation for details.
> +If --prefix is not provided, the default prefix is used, typically '/usr'
> +or '/usr/local'. See Python's distutils documentation for details. You can
> +also install via the Makefile if you like, but the above is more common.
> +
> +To install both libfdt and pylibfdt you can use:
> +
> + make install [SETUP_PREFIX=/path/to/install_dir] \
> + [PREFIX=/path/to/install_dir]
>
> To disable building the python library, even if swig and Python are available,
> use:
> diff --git a/pylibfdt/Makefile.pylibfdt b/pylibfdt/Makefile.pylibfdt
> index 06f9296..f7f9d5e 100644
> --- a/pylibfdt/Makefile.pylibfdt
> +++ b/pylibfdt/Makefile.pylibfdt
> @@ -5,9 +5,11 @@ PYLIBFDT_srcs = $(addprefix $(LIBFDT_srcdir)/,$(LIBFDT_SRCS))
> WRAP = $(PYLIBFDT_objdir)/libfdt_wrap.c
> PYMODULE = $(PYLIBFDT_objdir)/_libfdt.so
>
> -run_setup = SOURCES="$(1)" CPPFLAGS="$(CPPFLAGS)" OBJDIR="$(PYLIBFDT_objdir)" \
> - VERSION="$(dtc_version)" \
> - python $(PYLIBFDT_objdir)/setup.py --quiet $(2)
> +define run_setup
> + SOURCES="$(1)" CPPFLAGS="$(CPPFLAGS)" OBJDIR="$(PYLIBFDT_objdir)"
> + VERSION="$(dtc_version)"
> + $(PYLIBFDT_objdir)/setup.py --quiet $(2)
> +endef
>
> $(PYMODULE): $(PYLIBFDT_srcs) $(WRAP)
> @$(VECHO) PYMOD $@
> diff --git a/pylibfdt/setup.py b/pylibfdt/setup.py
> old mode 100644
> new mode 100755
> index 1597b44..90e80f3
> --- a/pylibfdt/setup.py
> +++ b/pylibfdt/setup.py
> @@ -2,26 +2,112 @@
>
> """
> setup.py file for SWIG libfdt
> +Copyright (C) 2017 Google, Inc.
> +Written by Simon Glass <sjg-F7+t8E8rja9g9hUCZPvPmw@public.gmane.org>
>
> Files to be built into the extension are provided in SOURCES
> C flags to use are provided in CPPFLAGS
> Object file directory is provided in OBJDIR
> +Version is provided in VERSION
> +
> +If these variables are not given they are parsed from the Makefiles. This
> +allows this script to be run stand-alone, e.g.:
> +
> + ./pylibfdt/setup.py install [--prefix=...]
> """
>
> from distutils.core import setup, Extension
> import os
> +import re
> import sys
>
> +# Decodes a Makefile assignment line into key and value (and plus for +=)
> +RE_KEY_VALUE = re.compile('(?P<key>\w+) *(?P<plus>[+])?= *(?P<value>.*)$')
> +
> +
> +def ParseMakefile(fname):
> + """Parse a Makefile to obtain its variables.
> +
> + This collects variable assigments of the form:
> +
> + VAR = value
> + VAR += more
> +
> + It does not pick out := assignments, as these are not needed here. It does
> + handle line continuation.
> +
> + Returns a dict:
> + key: Variable name (e.g. 'VAR')
> + value: Variable value (e.g. 'value more')
> + """
> + makevars = {}
> + with open(fname) as fd:
> + prev_text = '' # Continuation text from previous line(s)
> + for line in fd.read().splitlines():
> + if line and line[-1] == '\\': # Deal with line continuation
> + prev_text += line[:-1]
> + continue
> + elif prev_text:
> + line = prev_text + line
> + prev_text = '' # Continuation is now used up
> + m = RE_KEY_VALUE.match(line)
> + if m:
> + value = m.group('value') or ''
> + key = m.group('key')
> +
> + # Appending to a variable inserts a space beforehand
> + if 'plus' in m.groupdict() and key in makevars:
> + makevars[key] += ' ' + value
> + else:
> + makevars[key] = value
> + return makevars
> +
> +def GetEnvFromMakefiles():
> + """Scan the Makefiles to obtain the settings we need.
> +
> + This assumes that this script is being run from the top-level directory,
> + not the pylibfdt directory.
> +
> + Returns:
> + Tuple with:
> + List of swig options
> + Version string
> + List of files to build
> + List of extra C preprocessor flags needed
> + Object directory to use (always '')
> + """
> + basedir = os.path.dirname(os.path.dirname(os.path.abspath(sys.argv[0])))
> + swig_opts = ['-I%s' % basedir]
> + makevars = ParseMakefile(os.path.join(basedir, 'Makefile'))
> + version = '%s.%s.%s' % (makevars['VERSION'], makevars['PATCHLEVEL'],
> + makevars['SUBLEVEL'])
> + makevars = ParseMakefile(os.path.join(basedir, 'libfdt', 'Makefile.libfdt'))
> + files = makevars['LIBFDT_SRCS'].split()
> + files = [os.path.join(basedir, 'libfdt', fname) for fname in files]
> + files.append('pylibfdt/libfdt.i')
> + cflags = ['-I%s' % basedir, '-I%s/libfdt' % basedir]
> + objdir = ''
> + return swig_opts, version, files, cflags, objdir
> +
> +
> progname = sys.argv[0]
> -files = os.environ['SOURCES'].split()
> -cflags = os.environ['CPPFLAGS'].split()
> -objdir = os.environ['OBJDIR']
> -version = os.environ['VERSION']
> +files = os.environ.get('SOURCES', '').split()
> +cflags = os.environ.get('CPPFLAGS', '').split()
> +objdir = os.environ.get('OBJDIR')
> +version = os.environ.get('VERSION')
> +swig_opts = []
> +
> +# If we were called directly rather than through our Makefile (which is often
> +# the case with Python module installation), read the settings from the
> +# Makefile.
> +if not all((version, files, cflags, objdir)):
> + swig_opts, version, files, cflags, objdir = GetEnvFromMakefiles()
>
> libfdt_module = Extension(
> '_libfdt',
> sources = files,
> - extra_compile_args = cflags
> + extra_compile_args = cflags,
> + swig_opts = swig_opts,
> )
>
> setup(
> @@ -31,5 +117,5 @@ setup(
> description='Python binding for libfdt',
> ext_modules=[libfdt_module],
> package_dir={'': objdir},
> - py_modules=['libfdt'],
> + py_modules=['pylibfdt/libfdt'],
> )
--
David Gibson | I'll have my music baroque, and my code
david AT gibson.dropbear.id.au | minimalist, thank you. NOT _the_ _other_
| _way_ _around_!
http://www.ozlabs.org/~dgibson
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 819 bytes --]
^ permalink raw reply [flat|nested] 9+ messages in thread
* Re: [PATCH v3 0/5] pylibfdt: Add installation support
[not found] ` <20170405160142.10564-1-sjg-F7+t8E8rja9g9hUCZPvPmw@public.gmane.org>
` (4 preceding siblings ...)
2017-04-05 16:01 ` [PATCH v3 5/5] pylibfdt: Use setup.py to build the swig file Simon Glass
@ 2017-04-07 5:49 ` David Gibson
5 siblings, 0 replies; 9+ messages in thread
From: David Gibson @ 2017-04-07 5:49 UTC (permalink / raw)
To: Simon Glass; +Cc: Devicetree Compiler, Mike Frysinger
[-- Attachment #1: Type: text/plain, Size: 2262 bytes --]
On Wed, Apr 05, 2017 at 10:01:37AM -0600, Simon Glass wrote:
> This series adds support for installation of the Pylib module. It adjusts
> the setup.py file to provide this functionality and the Makefile rules
> to call it correctly.
>
> It also adds a way to disable building the Python module. This is useful
> since some build systems want to use setup.py to do both the build and
> the install step. In this case the correct build commands would be:
>
> make NO_PYTHON=1
> make install_pylibfdt SETUP_PREFIX=/path/to/install_prefix
>
> Version 3 adds support for running setup.py stand-alone:
>
> ./pylibfdt/setup.py --install_path
> [--prefix=/path/to/install_dir]
I've applied 1&2, 3 breaks make check, somehow, so I've left the rest.
>
> Changes in v3:
> - Add new patch to fix code style in setup.py
> - Update README to suggest using setup.py for an easy install
> - Allow setup.py to be run from the base directory
> - Make setup.py executable
> - Use define..endef instead of line continuations
> - Add new patch to move to Makefile constructs for NO_PYTHON
> - Add a new patch to use setup.py to build the swig file
>
> Changes in v2:
> - Add new patch to rename libfdt.swig to libfdt.i
> - Add new patch to allow setup.py to operation stand-alone
> - Rebase to master
>
> Simon Glass (5):
> pylibfdt: Rename libfdt.swig to libfdt.i
> pylibfdt: Fix code style in setup.py
> pylibfdt: Allow setup.py to operate stand-alone
> pylibfdt: Use Makefile constructs to implement NO_PYTHON
> pylibfdt: Use setup.py to build the swig file
>
> Makefile | 13 ++++-
> README | 14 +++--
> pylibfdt/Makefile.pylibfdt | 29 ++++------
> pylibfdt/{libfdt.swig => libfdt.i} | 0
> pylibfdt/setup.py | 113 ++++++++++++++++++++++++++++++++-----
> 5 files changed, 130 insertions(+), 39 deletions(-)
> rename pylibfdt/{libfdt.swig => libfdt.i} (100%)
> mode change 100644 => 100755 pylibfdt/setup.py
>
--
David Gibson | I'll have my music baroque, and my code
david AT gibson.dropbear.id.au | minimalist, thank you. NOT _the_ _other_
| _way_ _around_!
http://www.ozlabs.org/~dgibson
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 819 bytes --]
^ permalink raw reply [flat|nested] 9+ messages in thread
* Re: [PATCH v3 3/5] pylibfdt: Allow setup.py to operate stand-alone
2017-04-07 5:46 ` David Gibson
@ 2017-04-07 21:48 ` Simon Glass
0 siblings, 0 replies; 9+ messages in thread
From: Simon Glass @ 2017-04-07 21:48 UTC (permalink / raw)
To: David Gibson; +Cc: Devicetree Compiler, Mike Frysinger
Hi David,
On 6 April 2017 at 23:46, David Gibson <david-xT8FGy+AXnRB3Ne2BGzF6laj5H9X9Tb+@public.gmane.org> wrote:
> On Wed, Apr 05, 2017 at 10:01:40AM -0600, Simon Glass wrote:
>> At present we require that setup.py is executed from the Makefile, which
>> sets up various important things like the list of files to build and the
>> version number.
>>
>> However many installation systems expect to be able to change to the
>> directory containing setup.py and run it. This allows them to support (for
>> example) building/installing for multiple Python versions, varying
>> installation paths, particular C flags, etc.
>>
>> The problem in implementing this is that we don't want to duplicate the
>> information in the Makefile. A common solution (so I am told) is to parse
>> the Makefile to obtain the required information.
>>
>> Update the setup.py script to read a few Makefiles when it does not see
>> the required information in its environment. This allows installation
>> using:
>>
>> ./pylibfdt/setup.py install
>>
>> Signed-off-by: Simon Glass <sjg-F7+t8E8rja9g9hUCZPvPmw@public.gmane.org>
>
> I'm not sure quite how or why, but this patch has the side-effect of
> stopping the Python tests from running with "make check".
Yes I did see that at one point but unfortunately didn't go back and
investigate. There's a dependency problem since tests don't currently
build the module. Will send a new version.
Regards,
Simon
^ permalink raw reply [flat|nested] 9+ messages in thread
end of thread, other threads:[~2017-04-07 21:48 UTC | newest]
Thread overview: 9+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2017-04-05 16:01 [PATCH v3 0/5] pylibfdt: Add installation support Simon Glass
[not found] ` <20170405160142.10564-1-sjg-F7+t8E8rja9g9hUCZPvPmw@public.gmane.org>
2017-04-05 16:01 ` [PATCH v3 1/5] pylibfdt: Rename libfdt.swig to libfdt.i Simon Glass
2017-04-05 16:01 ` [PATCH v3 2/5] pylibfdt: Fix code style in setup.py Simon Glass
2017-04-05 16:01 ` [PATCH v3 3/5] pylibfdt: Allow setup.py to operate stand-alone Simon Glass
[not found] ` <20170405160142.10564-4-sjg-F7+t8E8rja9g9hUCZPvPmw@public.gmane.org>
2017-04-07 5:46 ` David Gibson
2017-04-07 21:48 ` Simon Glass
2017-04-05 16:01 ` [PATCH v3 4/5] pylibfdt: Use Makefile constructs to implement NO_PYTHON Simon Glass
2017-04-05 16:01 ` [PATCH v3 5/5] pylibfdt: Use setup.py to build the swig file Simon Glass
2017-04-07 5:49 ` [PATCH v3 0/5] pylibfdt: Add installation support David Gibson
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.