From nobody Mon Feb 9 09:34:25 2026 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1682366653; cv=none; d=zohomail.com; s=zohoarc; b=PH872swGo4aqtAkl50UeuYx4VHXp81052pIPycqoG4382ufvrDpPtXi2dKcvBQKSvr9NGpkQmDfArMjxQLsNovDh7gOZhl4R45h8KclnuDwCyhio0QQg2oQHGylRIwSWc+DuiGCc3nzwgY7IdMyopFDAvu32HGgXhiEfxmVMrQs= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1682366653; h=Content-Transfer-Encoding:Cc:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=zrQG5EG4WH92khExZ1+Awaq414GPQVReIfZciIMh9fo=; b=FKG9256iYfWovWQWgFVzI4BWlQBPy81GQuwdaODInwIKQ9oWvc+FPLnQALdbxdoJR+tTOJ+RqhORRlFzUjWHQ0CxWhzVQtHezVtIyfVntpm06nwZg6hb0P0SLttE6ZqNzAkTJGhE9dmzFmjRjvIHufweK2pRHSVpnn5a5VldJLc= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass header.from= (p=none dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1682366653513633.9304282523419; Mon, 24 Apr 2023 13:04:13 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1pr2Op-0007ci-7J; Mon, 24 Apr 2023 16:02:59 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1pr2On-0007Zk-PW for qemu-devel@nongnu.org; Mon, 24 Apr 2023 16:02:57 -0400 Received: from us-smtp-delivery-124.mimecast.com ([170.10.133.124]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1pr2Om-0000wJ-4B for qemu-devel@nongnu.org; Mon, 24 Apr 2023 16:02:57 -0400 Received: from mimecast-mx02.redhat.com (mimecast-mx02.redhat.com [66.187.233.88]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-510-7RqXZyvYPWeFs6BWN6UXXA-1; Mon, 24 Apr 2023 16:02:54 -0400 Received: from smtp.corp.redhat.com (int-mx03.intmail.prod.int.rdu2.redhat.com [10.11.54.3]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 4918AA0F392; Mon, 24 Apr 2023 20:02:53 +0000 (UTC) Received: from scv.redhat.com (unknown [10.22.34.213]) by smtp.corp.redhat.com (Postfix) with ESMTP id 97B591121319; Mon, 24 Apr 2023 20:02:52 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1682366575; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=zrQG5EG4WH92khExZ1+Awaq414GPQVReIfZciIMh9fo=; b=ZWWY2fLow4jC6IDg/ob/SHD0y3Bkw7Mo/ZB/wMJHMNWr264Z3erIGC6GUqLlITEcRlxYj0 3inahq1PdzcOeFAs0xKg1dZg+EFzU5+9JRGSRAGTqXpjm+B7g4Ln/ea7kv5x3+8xXPjBQz 25vwKAz9nkN4Srxa4NF0qYvEeS7hemQ= X-MC-Unique: 7RqXZyvYPWeFs6BWN6UXXA-1 From: John Snow To: qemu-devel@nongnu.org Cc: Warner Losh , Beraldo Leal , John Snow , Kyle Evans , Paolo Bonzini , Thomas Huth , Daniel Berrange , Reinoud Zandijk , Wainer dos Santos Moschetta , Cleber Rosa , Ryo ONODERA , =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= , Ani Sinha , "Michael S. Tsirkin" , =?UTF-8?q?Alex=20Benn=C3=A9e?= Subject: [RFC PATCH v3 05/20] mkvenv: generate console entry shims from inside the venv Date: Mon, 24 Apr 2023 16:02:33 -0400 Message-Id: <20230424200248.1183394-6-jsnow@redhat.com> In-Reply-To: <20230424200248.1183394-1-jsnow@redhat.com> References: <20230424200248.1183394-1-jsnow@redhat.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.1 on 10.11.54.3 Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=170.10.133.124; envelope-from=jsnow@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -22 X-Spam_score: -2.3 X-Spam_bar: -- X-Spam_report: (-2.3 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.171, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H2=-0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: qemu-devel-bounces+importer=patchew.org@nongnu.org X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1682366654284100007 Content-Type: text/plain; charset="utf-8" This patch is meant to ensure that console entry point scripts will always generate on Python 3.7 installations where we may not have access to importlib.metadata. By running it from a separate process *inside* the venv, we can be assured to have access to setuptools and by extension pkg_resources as a fallback. It isn't strictly necessary to do this for Python 3.8+, which will always have importlib.metadata available. Signed-off-by: John Snow --- python/scripts/mkvenv.py | 99 ++++++++++++++++++++++++++++++++++------ 1 file changed, 85 insertions(+), 14 deletions(-) diff --git a/python/scripts/mkvenv.py b/python/scripts/mkvenv.py index 2172774403..4daa652f12 100644 --- a/python/scripts/mkvenv.py +++ b/python/scripts/mkvenv.py @@ -11,6 +11,8 @@ Commands: command Description create create a venv + post_init + post-venv initialization =20 -------------------------------------------------- =20 @@ -23,6 +25,15 @@ -h, --help show this help message and exit --gen GEN Regenerate console_scripts for given packages, if found. =20 +-------------------------------------------------- + +usage: mkvenv post_init [-h] [--gen GEN] [--binpath BINPATH] + +options: + -h, --help show this help message and exit + --gen GEN Regenerate console_scripts for given packages, if fou= nd. + --binpath BINPATH Path where console script shims should be generated + """ =20 # Copyright (C) 2022-2023 Red Hat, Inc. @@ -59,6 +70,7 @@ # Do not add any mandatory dependencies from outside the stdlib: # This script *must* be usable standalone! =20 +DirType =3D Union[str, bytes, "os.PathLike[str]", "os.PathLike[bytes]"] logger =3D logging.getLogger("mkvenv") =20 =20 @@ -89,23 +101,42 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: self.script_packages =3D kwargs.pop("script_packages", ()) super().__init__(*args, **kwargs) =20 - # The EnvBuilder class is cute and toggles this setting off - # before post_setup, but we need it to decide if we want to - # generate shims or not. - self._system_site_packages =3D self.system_site_packages + # Make the context available post-creation: + self._context: Optional[SimpleNamespace] =3D None + + def ensure_directories(self, env_dir: DirType) -> SimpleNamespace: + logger.debug("ensure_directories(env_dir=3D%s)", env_dir) + self._context =3D super().ensure_directories(env_dir) + return self._context + + def create(self, env_dir: DirType) -> None: + logger.debug("create(env_dir=3D%s)", env_dir) + super().create(env_dir) + assert self._context is not None + self.post_post_setup(self._context) =20 def post_setup(self, context: SimpleNamespace) -> None: logger.debug("post_setup(...)") - - # Generate console_script entry points for system packages: - if self._system_site_packages: - generate_console_scripts( - context.env_exe, context.bin_path, self.script_packages - ) - # print the python executable to stdout for configure. print(context.env_exe) =20 + def post_post_setup(self, context: SimpleNamespace) -> None: + """ + The final, final hook. Enter the venv and run commands inside of i= t. + """ + args =3D [ + context.env_exe, + __file__, + "post_init", + "--binpath", + context.bin_path, + ] + if self.system_site_packages: + scripts =3D ",".join(self.script_packages) + if scripts: + args +=3D ["--gen", scripts] + subprocess.run(args, check=3DTrue) + =20 def need_ensurepip() -> bool: """ @@ -359,6 +390,13 @@ def generate_console_scripts( """ Generate script shims for console_script entry points in @packages. """ + logger.debug( + "generate_console_scripts(python_path=3D%s, bin_path=3D%s, package= s=3D%s)", + python_path, + bin_path, + packages, + ) + if not packages: return =20 @@ -392,6 +430,17 @@ def _get_entry_points() -> Iterator[Dict[str, str]]: logger.debug("wrote '%s'", script_path) =20 =20 +def post_venv_setup(bin_path: str, packages: Sequence[str] =3D ()) -> None: + """ + This is intended to be run *inside the venv* after it is created. + """ + python_path =3D sys.executable + logger.debug( + "post_venv_setup(bin_path=3D%s, packages=3D%s)", bin_path, packages + ) + generate_console_scripts(python_path, bin_path, packages) + + def _add_create_subcommand(subparsers: Any) -> None: subparser =3D subparsers.add_parser("create", help=3D"create a venv") subparser.add_argument( @@ -408,6 +457,24 @@ def _add_create_subcommand(subparsers: Any) -> None: ) =20 =20 +def _add_post_init_subcommand(subparsers: Any) -> None: + subparser =3D subparsers.add_parser( + "post_init", help=3D"post-venv initialization" + ) + subparser.add_argument( + "--gen", + type=3Dstr, + action=3D"append", + help=3D"Regenerate console_scripts for given packages, if found.", + ) + subparser.add_argument( + "--binpath", + type=3Dstr, + action=3D"store", + help=3D"Path where console script shims should be generated", + ) + + def main() -> int: """CLI interface to make_qemu_venv. See module docstring.""" if os.environ.get("DEBUG") or os.environ.get("GITLAB_CI"): @@ -429,19 +496,23 @@ def main() -> int: ) =20 _add_create_subcommand(subparsers) + _add_post_init_subcommand(subparsers) =20 args =3D parser.parse_args() + script_packages =3D [] + for element in args.gen or (): + script_packages.extend(element.split(",")) + try: if args.command =3D=3D "create": - script_packages =3D [] - for element in args.gen or (): - script_packages.extend(element.split(",")) make_venv( args.target, system_site_packages=3DTrue, clear=3DTrue, script_packages=3Dscript_packages, ) + if args.command =3D=3D "post_init": + post_venv_setup(args.binpath, script_packages) logger.debug("mkvenv.py %s: exiting", args.command) except Ouch as exc: print("\n*** Ouch! ***\n", file=3Dsys.stderr) --=20 2.39.2