Merge pull request #183 from tamird/restore-bash-completions

Restore bash completions

Author: arighi

.github/workflows/pylint.yml

@@ -11,17 +11,26 @@ jobs:
       matrix:
         python-version: ["3.8", "3.9", "3.10"]
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v3
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
     - name: Install dependencies
       run: |
+        set -euxo pipefail
+
         python -m pip install --upgrade pip
-        pip install -r requirements.txt
-        pip install pylint
-        pip install flake8
+
+        # Both build and runtime deps. This is the price of using pip.
+        pip install 'argparse-manpage[setuptools]' argcomplete requests
+
+        pip install  pylint flake8
     - name: Analysing the code with pylint
       run: |
-        python setup.py lint
+        set -euxo pipefail
+
+        pylint vng '**/*.py'
+
+        flake8 vng
+        find . -name '*.py' | xargs flake8

MANIFEST.in

@@ -7,8 +7,8 @@ GIT_DESCRIBE := $(shell git describe --always --long --dirty)
 install: install_from_source
 install_from_source:
 	@echo "Version: $(GIT_DESCRIBE)"
-	BUILD_VIRTME_NG_INIT=1 pip3 install --verbose -r requirements.txt $(INSTALL_ARGS) .
+	BUILD_VIRTME_NG_INIT=1 pip3 install --verbose $(INSTALL_ARGS) .
 
 install_only_top:
 	@echo "Version: $(GIT_DESCRIBE)"
-	BUILD_VIRTME_NG_INIT=0 pip3 install --verbose -r requirements.txt $(INSTALL_ARGS) .
+	BUILD_VIRTME_NG_INIT=0 pip3 install --verbose $(INSTALL_ARGS) .

Makefile

@@ -79,18 +79,19 @@ To install virtme-ng from source you can clone this git repository and build a
 standalone virtme-ng running the following commands:
 ```
  $ git clone --recurse-submodules https://github.com/arighi/virtme-ng.git
- $ BUILD_VIRTME_NG_INIT=1 pip3 install --verbose -r requirements.txt .
+ $ BUILD_VIRTME_NG_INIT=1 pip3 install .
 ```
 
 If you are in Debian/Ubuntu you may need to install the following packages to
 build virtme-ng from source properly:
 ```
- $ sudo apt install python3-pip python3-argcomplete flake8 pylint \
-   cargo rustc qemu-system-x86
+ $ sudo apt install python3-pip flake8 pylint cargo rustc qemu-system-x86
 ```
 
-In recent versions of pip3 you may need to specify `--break-system-packages` to
-properly install virtme-ng in your system from source.
+If you'd prefer to use `uv`:
+```
+ $ BUILD_VIRTME_NG_INIT=1 uv tool install .
+```
 
 * Run from source
 

README.md

@@ -0,0 +1,22 @@
+[build-system]
+requires = [
+  "argparse-manpage[setuptools]",
+  "setuptools",
+
+  # Runtime dependencies, needed to generate manpages.
+  "argcomplete",
+  "requests",
+]
+
+[tool.build_manpages]
+manpages = [
+  """\
+  man/vng.1\
+  :pyfile=virtme_ng/run.py\
+  :function=make_parser\
+  :author=virtme-ng is written by Andrea Righi <arighi@nvidia.com>\
+  :author=Based on virtme by Andy Lutomirski <luto@kernel.org>\
+  :manual_title=virtme-ng\
+  :description=Quickly run kernels inside a virtualized snapshot of your live system\
+  """,
+]

pyproject.toml

@@ -1,13 +1,13 @@
 #!/usr/bin/env python3
 
 import os
-import sys
 import platform
+import subprocess
+import sys
 import sysconfig
-from glob import glob
-from shutil import which
-from subprocess import check_call, CalledProcessError
-from setuptools import setup, Command
+from argcomplete import shell_integration
+from build_manpages import build_manpages, get_build_py_cmd, get_install_cmd
+from setuptools import setup
 from setuptools.command.build_py import build_py
 from setuptools.command.egg_info import egg_info
 from virtme_ng.version import get_version_string
@@ -29,62 +29,12 @@
 # Make sure virtme-ng-init submodule has been cloned
 if build_virtme_ng_init and not os.path.exists("virtme_ng_init/Cargo.toml"):
     sys.stderr.write("WARNING: virtme-ng-init submodule not available, trying to clone it\n")
-    check_call("git submodule update --init --recursive", shell=True)
+    subprocess.check_call("git submodule update --init --recursive", shell=True)
 
 # Always include standard site-packages to PYTHONPATH
 os.environ['PYTHONPATH'] = sysconfig.get_paths()['purelib']
 
 
-def is_arm_32bit():
-    arch = platform.machine()
-    return arch.startswith("arm") and platform.architecture()[0] == "32bit"
-
-
-def parse_requirements(filename):
-    with open(filename, 'r', encoding="utf-8") as file:
-        lines = file.readlines()
-    return [line.strip() for line in lines if line.strip() and not line.startswith('#')]
-
-
-class LintCommand(Command):
-    description = "Run coding style checks"
-    user_options = []
-
-    def initialize_options(self):
-        pass
-
-    def finalize_options(self):
-        pass
-
-    def run(self):
-        try:
-            for cmd in ("flake8", "pylint"):
-                command = [cmd]
-                for pattern in (
-                    "vng",
-                    "*.py",
-                    "virtme/*.py",
-                    "virtme/*/*.py",
-                    "virtme_ng/*.py",
-                ):
-                    command += glob(pattern)
-                check_call(command)
-        except CalledProcessError:
-            sys.exit(1)
-
-
-man_command = f"""
-argparse-manpage \
-  --pyfile ./virtme_ng/run.py --function make_parser \
-  --prog vng --version v{VERSION} \
-  --author "virtme-ng is written by Andrea Righi <arighi@nvidia.com>" \
-  --author "Based on virtme by Andy Lutomirski <luto@kernel.org>" \
-  --project-name virtme-ng --manual-title virtme-ng \
-  --description "Quickly run kernels inside a virtualized snapshot of your live system" \
-  --url https://github.com/arighi/virtme-ng > vng.1
-"""
-
-
 class BuildPy(build_py):
     def run(self):
         print(f"BUILD_VIRTME_NG_INIT: {build_virtme_ng_init}")
@@ -102,28 +52,17 @@ def run(self):
                     "--target", target,
                     "--config", f"target.{target}.linker = \"rust-lld\"",
                 ])
-            check_call(args, cwd="virtme_ng_init")
-            check_call(
+            subprocess.check_call(args, cwd="virtme_ng_init")
+            subprocess.check_call(
                 ["strip", os.path.join(root, "bin", "virtme-ng-init")],
                 cwd=cwd,
             )
-        # Generate manpage
-        if which('argparse-manpage'):
-            env = os.environ.copy()
-            env["PYTHONPATH"] = os.path.dirname(os.path.abspath(__file__))
-            check_call(man_command, shell=True, env=env)
 
         # Generate bash autocompletion scripts
-        completion_command = ''
-        if which("register-python-argcomplete"):
-            completion_command = "register-python-argcomplete"
-        elif which("register-python-argcomplete3"):
-            completion_command = "register-python-argcomplete3"
-        else:
-            print("ERROR: 'register-python-argcomplete' or 'register-python-argcomplete3' not found.")
-            sys.exit(1)
-        check_call(completion_command + ' virtme-ng > virtme-ng-prompt', shell=True)
-        check_call(completion_command + ' vng > vng-prompt', shell=True)
+        with open("virtme-ng-prompt", "w", encoding="utf-8") as f:
+            f.write(shell_integration.shellcode(["virtme-ng"]))
+        with open("vng-prompt", "w", encoding="utf-8") as f:
+            f.write(shell_integration.shellcode(["vng"]))
 
         # Run the rest of virtme-ng build
         build_py.run(self)
@@ -166,26 +105,30 @@ def run(self):
 
 data_files = [
     ("/etc", ["cfg/virtme-ng.conf"]),
-    ("/usr/share/bash-completion/completions", ["virtme-ng-prompt"]),
-    ("/usr/share/bash-completion/completions", ["vng-prompt"]),
+    ("/usr/share/bash-completion/completions", ["virtme-ng-prompt", "vng-prompt"]),
+    ("/usr/share/man/man1", ["man/vng.1"]),
 ]
 
-if which('argparse-manpage'):
-    data_files.append(("/usr/share/man/man1", ["vng.1"]))
-
 setup(
     name="virtme-ng",
     version=VERSION,
     author="Andrea Righi",
     author_email="arighi@nvidia.com",
     description="Build and run a kernel inside a virtualized snapshot of your live system",
-    url="https://git.launchpad.net/~arighi/+git/virtme-ng",
+    url="https://github.com/arighi/virtme-ng",
     license="GPLv2",
     long_description=open(
         os.path.join(os.path.dirname(__file__), "README.md"), "r", encoding="utf-8"
     ).read(),
     long_description_content_type="text/markdown",
-    install_requires=parse_requirements('requirements.txt'),
+    install_requires=[
+        'argcomplete',
+        'requests',
+        # `pkg_resources` is removed in python 3.12, moved to setuptools.
+        #
+        # TODO: replace pkg_resources with importlib. # pylint: disable=fixme
+        'setuptools',
+    ],
     entry_points={
         "console_scripts": [
             "vng = virtme_ng.run:main",
@@ -196,9 +139,10 @@ def run(self):
         ]
     },
     cmdclass={
-        "build_py": BuildPy,
+        "build_manpages": build_manpages,
+        "build_py": get_build_py_cmd(BuildPy),
+        "install": get_install_cmd(),
         "egg_info": EggInfo,
-        "lint": LintCommand,
     },
     packages=packages,
     package_data={"virtme.guest": package_files},

requirements.txt

@@ -23,12 +23,8 @@
 )
 from select import select
 from pathlib import Path
-try:
-    from argcomplete import autocomplete
-except ModuleNotFoundError:
-    def autocomplete(*args, **kwargs):
-        # pylint: disable=unused-argument
-        pass
+
+import argcomplete
 
 from virtme.util import SilentError, get_username
 from virtme_ng.utils import CONF_FILE, spinner_decorator
@@ -79,6 +75,7 @@ def make_parser():
     """Main virtme-ng command line parser."""
 
     parser = argparse.ArgumentParser(
+        prog="vng",
         formatter_class=argparse.RawTextHelpFormatter,
         description="Build and run kernels inside a virtualized snapshot of your live system",
         epilog="""\
@@ -1245,7 +1242,7 @@ def dump(kern_source, args):
 
 def do_it() -> int:
     """Main body."""
-    autocomplete(_ARGPARSER)
+    argcomplete.autocomplete(_ARGPARSER)
     args = _ARGPARSER.parse_args()
 
     kern_source = KernelSource()