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@xxxxxxxxxxxx>
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@xxxxxxxxxxxx>
>
> 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:
signature.asc
Description: PGP signature
