devicetree-compiler.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Simon Glass <sjg@chromium.org>
To: Devicetree Compiler <devicetree-compiler@vger.kernel.org>
Cc: David Gibson <david@gibson.dropbear.id.au>,
	Gua Guo <gua.guo@intel.com>, Simon Glass <sjg@chromium.org>
Subject: [PATCH 3/6] setup: Move version and full_description into a function
Date: Sun, 11 Aug 2024 09:02:45 -0600	[thread overview]
Message-ID: <20240811150248.7537-3-sjg@chromium.org> (raw)
In-Reply-To: <20240811150248.7537-1-sjg@chromium.org>

Do this processing in a function and return the result, to reduce the
amount of code at the top level.

Signed-off-by: Simon Glass <sjg@chromium.org>
---

 setup.py | 22 ++++++++++++++++++----
 1 file changed, 18 insertions(+), 4 deletions(-)

diff --git a/setup.py b/setup.py
index 4e880e4..eb0963c 100755
--- a/setup.py
+++ b/setup.py
@@ -16,11 +16,24 @@ from setuptools.command.build_py import build_py as _build_py
 
 srcdir = os.path.dirname(__file__)
 
-with open(os.path.join(srcdir, "README.md"), "r", encoding='utf-8') as fh:
-    long_description = fh.read()
+def scan_for_info(srcdir):
+    """Scan for the version and long_description fields
+
+    Args:
+        srcdir (str): Source-directory path
+
+    Returns: tuple
+        str: Full description (contents of README.md)
+        str: Version string
+    """
+    with open(os.path.join(srcdir, "VERSION.txt"), "r", encoding='utf-8') as fh:
+        version = fh.readline().strip()
+
+    with open(os.path.join(srcdir, "README.md"), "r", encoding='utf-8') as fh:
+        long_description = fh.read()
+
+    return version, long_description
 
-with open(os.path.join(srcdir, "VERSION.txt"), "r", encoding='utf-8') as fh:
-    version = fh.readline().strip()
 
 def get_top_builddir():
     """Figure out the top-level directory containing the source code
@@ -53,6 +66,7 @@ class BuildPy(_build_py):
         self.run_command("build_ext")
         return super().run()
 
+version, long_description = scan_for_info(srcdir)
 
 setup(
     name='libfdt',
-- 
2.34.1


  parent reply	other threads:[~2024-08-11 15:03 UTC|newest]

Thread overview: 14+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-08-11 15:02 [PATCH 1/6] Require Python 3 Simon Glass
2024-08-11 15:02 ` [PATCH 2/6] Tidy up some pylint warnings Simon Glass
2024-08-12  1:40   ` David Gibson
2024-08-11 15:02 ` Simon Glass [this message]
2024-08-12  1:42   ` [PATCH 3/6] setup: Move version and full_description into a function David Gibson
2024-08-11 15:02 ` [PATCH 4/6] setup: Collect top-level code together Simon Glass
2024-08-11 15:02 ` [PATCH 5/6] setup: Move setting of srcdir down to the bottom Simon Glass
2024-08-12  1:50   ` David Gibson
2024-08-11 15:02 ` [PATCH 6/6] setup: Add dependencies for Windows Simon Glass
2024-08-12  1:51   ` David Gibson
2024-08-12  2:01     ` David Gibson
2024-08-14  2:15       ` Simon Glass
2024-08-11 15:05 ` [PATCH 1/6] Require Python 3 Simon Glass
2024-08-12  1:39 ` David Gibson

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20240811150248.7537-3-sjg@chromium.org \
    --to=sjg@chromium.org \
    --cc=david@gibson.dropbear.id.au \
    --cc=devicetree-compiler@vger.kernel.org \
    --cc=gua.guo@intel.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).