Add CLI

Author: flying-sheep

pyproject.toml

@@ -54,6 +54,7 @@ optional-dependencies.test = [
 urls.Documentation = "https://github.com/flying-sheep/session-info2#readme"
 urls.Issues = "https://github.com/flying-sheep/session-info2/issues"
 urls.Source = "https://github.com/flying-sheep/session-info2"
+scripts.session-info = "session_info2.cli:main"
 
 [tool.hatch.version]
 source = "vcs"
@@ -105,7 +106,7 @@ lint.per-file-ignores."**/*.ipynb" = [
 lint.per-file-ignores."docs/conf.py" = [
   "INP001", # __init__.py
 ]
-lint.per-file-ignores."src/session_info2/__main__.py" = [
+lint.per-file-ignores."src/session_info2/cli.py" = [
   "T201", # print is fine
 ]
 lint.per-file-ignores."tests/*" = [

src/session_info2/__main__.py

@@ -3,6 +3,6 @@
 
 from __future__ import annotations
 
-from . import session_info
+from .cli import main
 
-print(session_info(cpu=True, dependencies=True))
+main()

src/session_info2/cli.py

@@ -0,0 +1,78 @@
+# SPDX-License-Identifier: MPL-2.0
+"""CLI."""
+
+from __future__ import annotations
+
+import sys
+from argparse import ArgumentParser, Namespace
+from argparse import BooleanOptionalAction as Ba
+from types import ModuleType
+from typing import Literal, get_args
+from unittest.mock import patch
+
+from . import _repr, session_info
+
+Format = Literal["text", "markdown", "html", "json"]
+
+
+class Args(Namespace):
+    """CLI arguments."""
+
+    packages: list[str]
+    os: bool
+    cpu: bool
+    gpu: bool
+    format: Format
+
+    @classmethod
+    def parser(cls) -> ArgumentParser:
+        """Return argument parser."""
+        parser = ArgumentParser()
+        parser.add_argument("packages", nargs="*", help="packages to import")
+        parser.add_argument(
+            "--os", default=True, action=Ba, help="include OS name and version"
+        )
+        parser.add_argument(
+            "--cpu", default=True, action=Ba, help="include number of CPU cores"
+        )
+        parser.add_argument(
+            "--gpu",
+            default=False,
+            action=Ba,
+            help="include information per supported GPU (disabled by default)",
+        )
+        parser.add_argument(
+            "-f",
+            "--format",
+            default="text",
+            choices=get_args(Format),
+            help="output format",
+        )
+        return parser
+
+    @classmethod
+    def parse(cls, args: list[str] | None = None) -> Args:
+        """Parse CLI arguments."""
+        return cls.parser().parse_args(args, cls())
+
+
+def main(args_: list[str] | None = None, /) -> None:
+    """Run CLI."""
+    args = Args.parse(args_)
+
+    modules = {name: __import__(name) for name in args.packages}
+
+    with patch.dict(sys.modules, __main__=type("__main__", (ModuleType,), modules)):
+        si = session_info(cpu=True, dependencies=True)
+
+    match args.format:
+        case "text":
+            print(si)
+        case "markdown":
+            print(_repr.repr_markdown(si))
+        case "html":
+            print(_repr.repr_html(si))
+        case "json":
+            print(_repr.repr_json(si))
+        case _:
+            raise AssertionError

tests/test_cli.py

@@ -0,0 +1,22 @@
+# SPDX-License-Identifier: MPL-2.0
+"""Test the Command Line Interface."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from session_info2.cli import main
+
+if TYPE_CHECKING:
+    import pytest
+
+
+def test_cli(capsys: pytest.CaptureFixture[str]) -> None:
+    main(["pytest"])
+
+    out, err = capsys.readouterr()
+
+    assert not err
+    assert "pytest" in out
+    assert "session-info2" in out
+    assert out.index("pytest") < out.index("---") < out.index("session-info2")