* [PATCH 1/6] README: Update pylibfdt install instructions
[not found] ` <20211112041633.741598-1-robh-DgEjT+Ai2ygdnm+yROfE0A@public.gmane.org>
@ 2021-11-12 4:16 ` Rob Herring
2021-11-12 4:16 ` [PATCH 2/6] pylibfdt: Add packaging metadata Rob Herring
` (5 subsequent siblings)
6 siblings, 0 replies; 9+ messages in thread
From: Rob Herring @ 2021-11-12 4:16 UTC (permalink / raw)
To: David Gibson, Simon Glass; +Cc: devicetree-compiler-u79uwXL29TY76Z2rM5mHXA
Now that pip is supported for installs, update the install instructions to
use it. Using pip over setup.py is generally recommended and simpler.
Also, drop 'SETUP_PREFIX' as it doesn't exist anywhere.
Signed-off-by: Rob Herring <robh-DgEjT+Ai2ygdnm+yROfE0A@public.gmane.org>
---
README | 20 +++++++++++++-------
1 file changed, 13 insertions(+), 7 deletions(-)
diff --git a/README b/README
index d9bf850b9dc2..5f5655df6898 100644
--- a/README
+++ b/README
@@ -48,18 +48,24 @@ If you add new features, please check code coverage:
# Open 'htmlcov/index.html' in your browser
-To install the library via the normal setup.py method, use:
+The library can be installed with pip from a local source tree:
- ./pylibfdt/setup.py install [--prefix=/path/to/install_dir]
+ pip install . [--user|--prefix=/path/to/install_dir]
-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.
+Or directly from a remote git repo:
+
+ pip install git+git://git.kernel.org/pub/scm/utils/dtc/dtc.git@main
+
+The install depends on libfdt shared library being installed on the host system
+first. Generally, using --user or --prefix is not necessary and pip will use the
+default location for the Python installation which varies if the user is root or
+not.
+
+You can also install everything via make if you like, but pip is recommended.
To install both libfdt and pylibfdt you can use:
- make install [SETUP_PREFIX=/path/to/install_dir] \
- [PREFIX=/path/to/install_dir]
+ make install [PREFIX=/path/to/install_dir]
To disable building the python library, even if swig and Python are available,
use:
--
2.32.0
^ permalink raw reply related [flat|nested] 9+ messages in thread* [PATCH 2/6] pylibfdt: Add packaging metadata
[not found] ` <20211112041633.741598-1-robh-DgEjT+Ai2ygdnm+yROfE0A@public.gmane.org>
2021-11-12 4:16 ` [PATCH 1/6] README: Update pylibfdt install instructions Rob Herring
@ 2021-11-12 4:16 ` Rob Herring
2021-11-12 4:16 ` [PATCH 3/6] pylibfdt_tests: Don't depend on built dtbs Rob Herring
` (4 subsequent siblings)
6 siblings, 0 replies; 9+ messages in thread
From: Rob Herring @ 2021-11-12 4:16 UTC (permalink / raw)
To: David Gibson, Simon Glass; +Cc: devicetree-compiler-u79uwXL29TY76Z2rM5mHXA
PyPI expects to have various package metadata including long
description, license, and classifiers. Add them.
Signed-off-by: Rob Herring <robh-DgEjT+Ai2ygdnm+yROfE0A@public.gmane.org>
---
A test package is here: https://test.pypi.org/project/libfdt/
---
MANIFEST.in | 3 +++
setup.py | 17 +++++++++++++++++
2 files changed, 20 insertions(+)
diff --git a/MANIFEST.in b/MANIFEST.in
index 9e6c4ac4610c..ff8f5d637d46 100644
--- a/MANIFEST.in
+++ b/MANIFEST.in
@@ -1,6 +1,9 @@
# SPDX-License-Identifier: (GPL-2.0-or-later OR BSD-2-Clause)
global-exclude *
+include README
+include GPL
+include BSD-2-Clause
include setup.py
include pylibfdt/libfdt.i
include pylibfdt/*.py
diff --git a/setup.py b/setup.py
index 0a0daf1c201d..00444e64337b 100755
--- a/setup.py
+++ b/setup.py
@@ -17,6 +17,9 @@ import sys
srcdir = os.path.dirname(__file__)
+with open("README", "r") as fh:
+ long_description = fh.read()
+
def get_top_builddir():
if '--top-builddir' in sys.argv:
index = sys.argv.index('--top-builddir')
@@ -49,4 +52,18 @@ setup(
ext_modules=[libfdt_module],
package_dir={'': os.path.join(srcdir, 'pylibfdt')},
py_modules=['libfdt'],
+
+ long_description=long_description,
+ long_description_content_type="text/plain",
+ url="https://git.kernel.org/pub/scm/utils/dtc/dtc.git",
+ license="BSD",
+ license_files=["GPL", "BSD-2-Clause"],
+
+ classifiers=[
+ "Programming Language :: Python :: 3",
+ "License :: OSI Approved :: BSD License",
+ "License :: OSI Approved :: GNU General Public License v2 or later (GPLv2+)",
+ "Operating System :: OS Independent",
+ ],
+
)
--
2.32.0
^ permalink raw reply related [flat|nested] 9+ messages in thread* [PATCH 3/6] pylibfdt_tests: Don't depend on built dtbs
[not found] ` <20211112041633.741598-1-robh-DgEjT+Ai2ygdnm+yROfE0A@public.gmane.org>
2021-11-12 4:16 ` [PATCH 1/6] README: Update pylibfdt install instructions Rob Herring
2021-11-12 4:16 ` [PATCH 2/6] pylibfdt: Add packaging metadata Rob Herring
@ 2021-11-12 4:16 ` Rob Herring
[not found] ` <20211112041633.741598-4-robh-DgEjT+Ai2ygdnm+yROfE0A@public.gmane.org>
2021-11-12 4:16 ` [PATCH 4/6] tests: rename pylibfdt_tests.py to test_pylibfdt.py Rob Herring
` (3 subsequent siblings)
6 siblings, 1 reply; 9+ messages in thread
From: Rob Herring @ 2021-11-12 4:16 UTC (permalink / raw)
To: David Gibson, Simon Glass; +Cc: devicetree-compiler-u79uwXL29TY76Z2rM5mHXA
The pylibfdt tests depend on the rest of the tests to build dtbs, but
are otherwise independent. Modify the test to build dtbs itself so the
python tests can run standalone.
This also fixes an intermittent problem with the DT strings section size
varying depending on how the dtb was built. The test assumed the dtb was
built with '-H both' option which is pretty much impossible to tell from
run_tests.sh.
Signed-off-by: Rob Herring <robh-DgEjT+Ai2ygdnm+yROfE0A@public.gmane.org>
---
tests/pylibfdt_tests.py | 22 ++++++++++++++--------
tests/run_tests.sh | 1 -
2 files changed, 14 insertions(+), 9 deletions(-)
diff --git a/tests/pylibfdt_tests.py b/tests/pylibfdt_tests.py
index 64b5bd1258f8..1025f192207a 100644
--- a/tests/pylibfdt_tests.py
+++ b/tests/pylibfdt_tests.py
@@ -4,10 +4,14 @@
# Written by Simon Glass <sjg-F7+t8E8rja9g9hUCZPvPmw@public.gmane.org>
#
+import os
import struct
import sys
import types
import unittest
+import subprocess
+
+testsrc = os.path.dirname(__file__)
sys.path.insert(0, '../pylibfdt')
import libfdt
@@ -64,8 +68,9 @@ def _ReadFdt(fname):
Returns:
Fdt bytearray suitable for passing to libfdt functions
"""
- with open(fname, mode='rb') as f:
- return libfdt.Fdt(f.read())
+
+ dtb = subprocess.run(['dtc', '-O', 'dtb', fname], stdout=subprocess.PIPE)
+ return libfdt.Fdt(dtb.stdout)
class PyLibfdtBasicTests(unittest.TestCase):
"""Test class for basic pylibfdt access functions
@@ -76,9 +81,9 @@ class PyLibfdtBasicTests(unittest.TestCase):
def setUp(self):
"""Read in the device tree we use for testing"""
- self.fdt = _ReadFdt('test_tree1.dtb')
- self.fdt2 = _ReadFdt('test_props.dtb')
- self.fdt3 = _ReadFdt('aliases.dtb')
+ self.fdt = _ReadFdt(os.path.join(testsrc, 'test_tree1.dts'))
+ self.fdt2 = _ReadFdt(os.path.join(testsrc, 'test_props.dts'))
+ self.fdt3 = _ReadFdt(os.path.join(testsrc, 'aliases.dts'))
def GetPropList(self, node_path):
"""Read a list of properties from a node
@@ -291,7 +296,7 @@ class PyLibfdtBasicTests(unittest.TestCase):
self.assertEqual(self.fdt.version(), 17)
self.assertEqual(self.fdt.last_comp_version(), 16)
self.assertEqual(self.fdt.boot_cpuid_phys(), 0)
- self.assertEqual(self.fdt.size_dt_strings(), 105)
+ self.assertEqual(self.fdt.size_dt_strings(), 97)
self.assertEqual(self.fdt.size_dt_struct(), 564)
def testPack(self):
@@ -575,8 +580,9 @@ class PyLibfdtRoTests(unittest.TestCase):
def setUp(self):
"""Read in the device tree we use for testing"""
- with open('test_tree1.dtb', mode='rb') as f:
- self.fdt = libfdt.FdtRo(f.read())
+ dtb = subprocess.run(['dtc', '-O', 'dtb', os.path.join(testsrc, 'test_tree1.dts')],
+ stdout=subprocess.PIPE)
+ self.fdt = libfdt.FdtRo(dtb.stdout)
def testAccess(self):
"""Basic sanity check for the FdtRo class"""
diff --git a/tests/run_tests.sh b/tests/run_tests.sh
index d100d5aaa21f..140ac03e721d 100755
--- a/tests/run_tests.sh
+++ b/tests/run_tests.sh
@@ -1012,7 +1012,6 @@ fdtoverlay_tests() {
}
pylibfdt_tests () {
- run_dtc_test -I dts -O dtb -o test_props.dtb "$SRCDIR/test_props.dts"
TMP=/tmp/tests.stderr.$$
$PYTHON "$SRCDIR/pylibfdt_tests.py" -v 2> $TMP
--
2.32.0
^ permalink raw reply related [flat|nested] 9+ messages in thread* [PATCH 4/6] tests: rename pylibfdt_tests.py to test_pylibfdt.py
[not found] ` <20211112041633.741598-1-robh-DgEjT+Ai2ygdnm+yROfE0A@public.gmane.org>
` (2 preceding siblings ...)
2021-11-12 4:16 ` [PATCH 3/6] pylibfdt_tests: Don't depend on built dtbs Rob Herring
@ 2021-11-12 4:16 ` Rob Herring
2021-11-12 4:16 ` [PATCH 5/6] pylibfdt: Include tests and test data in packaging Rob Herring
` (2 subsequent siblings)
6 siblings, 0 replies; 9+ messages in thread
From: Rob Herring @ 2021-11-12 4:16 UTC (permalink / raw)
To: David Gibson, Simon Glass; +Cc: devicetree-compiler-u79uwXL29TY76Z2rM5mHXA
This follows the normal Python test_*.py naming convention. With this
change, pytest can automatically find and run the tests.
Signed-off-by: Rob Herring <robh-DgEjT+Ai2ygdnm+yROfE0A@public.gmane.org>
---
README | 4 ++--
tests/run_tests.sh | 2 +-
tests/{pylibfdt_tests.py => test_pylibfdt.py} | 0
3 files changed, 3 insertions(+), 3 deletions(-)
rename tests/{pylibfdt_tests.py => test_pylibfdt.py} (100%)
diff --git a/README b/README
index 5f5655df6898..380c79759ce9 100644
--- a/README
+++ b/README
@@ -32,7 +32,7 @@ compatible=subnode1
>>> print(fdt.getprop(node2, 'compatible').as_str())
test_tree1
-You will find tests in tests/pylibfdt_tests.py showing how to use each
+You will find tests in tests/test_pylibfdt.py showing how to use each
method. Help is available using the Python help command, e.g.:
$ cd pylibfdt
@@ -43,7 +43,7 @@ If you add new features, please check code coverage:
$ sudo apt-get install python3-coverage
$ cd tests
# It's just 'coverage' on most other distributions
- $ python3-coverage run pylibfdt_tests.py
+ $ python3-coverage run test_pylibfdt.py
$ python3-coverage html
# Open 'htmlcov/index.html' in your browser
diff --git a/tests/run_tests.sh b/tests/run_tests.sh
index 140ac03e721d..7c768052179d 100755
--- a/tests/run_tests.sh
+++ b/tests/run_tests.sh
@@ -1013,7 +1013,7 @@ fdtoverlay_tests() {
pylibfdt_tests () {
TMP=/tmp/tests.stderr.$$
- $PYTHON "$SRCDIR/pylibfdt_tests.py" -v 2> $TMP
+ $PYTHON "$SRCDIR/test_pylibfdt.py" -v 2> $TMP
# Use the 'ok' message meaning the test passed, 'ERROR' meaning it failed
# and the summary line for total tests (e.g. 'Ran 17 tests in 0.002s').
diff --git a/tests/pylibfdt_tests.py b/tests/test_pylibfdt.py
similarity index 100%
rename from tests/pylibfdt_tests.py
rename to tests/test_pylibfdt.py
--
2.32.0
^ permalink raw reply related [flat|nested] 9+ messages in thread* [PATCH 5/6] pylibfdt: Include tests and test data in packaging
[not found] ` <20211112041633.741598-1-robh-DgEjT+Ai2ygdnm+yROfE0A@public.gmane.org>
` (3 preceding siblings ...)
2021-11-12 4:16 ` [PATCH 4/6] tests: rename pylibfdt_tests.py to test_pylibfdt.py Rob Herring
@ 2021-11-12 4:16 ` Rob Herring
2021-11-12 4:16 ` [PATCH 6/6] pylibfdt: Add tox support Rob Herring
2021-11-12 6:10 ` [PATCH 0/6] More pylibfdt updates David Gibson
6 siblings, 0 replies; 9+ messages in thread
From: Rob Herring @ 2021-11-12 4:16 UTC (permalink / raw)
To: David Gibson, Simon Glass; +Cc: devicetree-compiler-u79uwXL29TY76Z2rM5mHXA
Packaging the tests is necessary for tox to work.
Signed-off-by: Rob Herring <robh-DgEjT+Ai2ygdnm+yROfE0A@public.gmane.org>
---
MANIFEST.in | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/MANIFEST.in b/MANIFEST.in
index ff8f5d637d46..d9fb71b77a65 100644
--- a/MANIFEST.in
+++ b/MANIFEST.in
@@ -10,3 +10,7 @@ include pylibfdt/*.py
include libfdt/libfdt.h
include libfdt/fdt.h
include libfdt/libfdt_env.h
+include tests/test_pylibfdt.py
+include tests/test_tree1.dts
+include tests/test_props.dts
+include tests/aliases.dts
--
2.32.0
^ permalink raw reply related [flat|nested] 9+ messages in thread* [PATCH 6/6] pylibfdt: Add tox support
[not found] ` <20211112041633.741598-1-robh-DgEjT+Ai2ygdnm+yROfE0A@public.gmane.org>
` (4 preceding siblings ...)
2021-11-12 4:16 ` [PATCH 5/6] pylibfdt: Include tests and test data in packaging Rob Herring
@ 2021-11-12 4:16 ` Rob Herring
2021-11-12 6:10 ` [PATCH 0/6] More pylibfdt updates David Gibson
6 siblings, 0 replies; 9+ messages in thread
From: Rob Herring @ 2021-11-12 4:16 UTC (permalink / raw)
To: David Gibson, Simon Glass; +Cc: devicetree-compiler-u79uwXL29TY76Z2rM5mHXA
'tox' allows running python tests under multiple environments.
Note that installing python versions is outside the scope of tox.
Signed-off-by: Rob Herring <robh-DgEjT+Ai2ygdnm+yROfE0A@public.gmane.org>
---
tox.ini | 6 ++++++
1 file changed, 6 insertions(+)
create mode 100644 tox.ini
diff --git a/tox.ini b/tox.ini
new file mode 100644
index 000000000000..7925d1e2f390
--- /dev/null
+++ b/tox.ini
@@ -0,0 +1,6 @@
+[tox]
+envlist = py36,py37,py38,py39,py310
+
+[testenv]
+deps = pytest
+commands = pytest
--
2.32.0
^ permalink raw reply related [flat|nested] 9+ messages in thread* Re: [PATCH 0/6] More pylibfdt updates
[not found] ` <20211112041633.741598-1-robh-DgEjT+Ai2ygdnm+yROfE0A@public.gmane.org>
` (5 preceding siblings ...)
2021-11-12 4:16 ` [PATCH 6/6] pylibfdt: Add tox support Rob Herring
@ 2021-11-12 6:10 ` David Gibson
6 siblings, 0 replies; 9+ messages in thread
From: David Gibson @ 2021-11-12 6:10 UTC (permalink / raw)
To: Rob Herring; +Cc: Simon Glass, devicetree-compiler-u79uwXL29TY76Z2rM5mHXA
[-- Attachment #1: Type: text/plain, Size: 1481 bytes --]
On Thu, Nov 11, 2021 at 10:16:27PM -0600, Rob Herring wrote:
> Another batch of pylibfdt updates. This series updates the README for
> installing, adds metadata for packaging, and reworks the tests to be
> able to run standalone using python test programs (pytest and tox).
>
> A test package is uploaded here:
> https://test.pypi.org/project/libfdt/
1..2 applied. I have some questions about 3.
>
> Rob
>
> Rob Herring (6):
> README: Update pylibfdt install instructions
> pylibfdt: Add packaging metadata
> pylibfdt_tests: Don't depend on built dtbs
> tests: rename pylibfdt_tests.py to test_pylibfdt.py
> pylibfdt: Include tests and test data in packaging
> pylibfdt: Add tox support
>
> MANIFEST.in | 7 ++++++
> README | 24 ++++++++++++-------
> setup.py | 17 +++++++++++++
> tests/run_tests.sh | 3 +--
> tests/{pylibfdt_tests.py => test_pylibfdt.py} | 22 ++++++++++-------
> tox.ini | 6 +++++
> 6 files changed, 60 insertions(+), 19 deletions(-)
> rename tests/{pylibfdt_tests.py => test_pylibfdt.py} (97%)
> create mode 100644 tox.ini
>
--
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: 833 bytes --]
^ permalink raw reply [flat|nested] 9+ messages in thread