Merge pull request #64 from martindurant/cli-refactor

Make CLI subcommands; make config more flexible

Author: martindurant

src/projspec/__main__.py

@@ -10,8 +10,23 @@
 import projspec.proj
 
 
-@click.command()
-@click.argument("path", default=".")
+# global runtime config
+context = {}
+
+
+@click.group()
+def main():
+    pass
+
+
+@main.command("make")
+@click.argument("artifact", type=str)
+@click.argument("path", default=".", type=str)
+@click.option(
+    "--storage_options",
+    default="",
+    help="storage options dict for the given URL, as JSON",
+)
 @click.option(
     "--types",
     default="ALL",
@@ -22,81 +37,175 @@
     default="NONE",
     help="List of spec types to ignore (comma-separated list in camel or snake case)",
 )
-@click.option("--walk", is_flag=True, help="To descend into all child directories")
-@click.option("--summary", is_flag=True, help="Show abbreviated output")
-@click.option("--version", is_flag=True, default=False, help="Print version and quit")
+def make(artifact, path, storage_options, types, xtypes):
+    """Make the given artifact in the project at the given path.
+
+    artifact: str , of the form [<spec>.]<artifact-type>[.<name>]
+
+    path: str, path to the project directory, defaults to "."
+    """
+    if types in {"ALL", ""}:
+        types = None
+    else:
+        types = types.split(",")
+    proj = projspec.Project(
+        path, storage_options=storage_options, types=types, xtypes=xtypes
+    )
+    proj.make(artifact)
+
+
+@main.command()
+def version():
+    print(f"projspec version: {projspec.__version__}")
+
+
+@main.command("scan")
+@click.argument("path", default=".")
 @click.option(
-    "--json-out", is_flag=True, default=False, help="JSON output, for projects only"
+    "--storage_options",
+    default="",
+    help="storage options dict for the given URL, as JSON",
 )
 @click.option(
-    "--html-out", is_flag=True, default=False, help="HTML output, for projects only"
+    "--types",
+    default="ALL",
+    help='Type names to scan for (comma-separated list in camel or snake case); defaults to "ALL"',
 )
 @click.option(
-    "--make",
-    help="(Re)Create the first artifact found matching this type name; matches [spec.]artifact[.name]",
+    "--xtypes",
+    default="NONE",
+    help="List of spec types to ignore (comma-separated list in camel or snake case)",
 )
 @click.option(
-    "--info",
-    help="Give information about a names entity type (spec, contents or artifact)",
+    "--json-out", is_flag=True, default=False, help="JSON output, for projects only"
 )
 @click.option(
-    "--storage_options",
-    default="",
-    help="storage options dict for the given URL, as JSON",
+    "--html-out", is_flag=True, default=False, help="HTML output, for projects only"
 )
-def main(
-    path,
-    types,
-    xtypes,
-    walk,
-    summary,
-    version,
-    json_out,
-    html_out,
-    make,
-    info,
-    storage_options,
+@click.option("--walk", is_flag=True, help="To descend into all child directories")
+@click.option("--summary", is_flag=True, help="Show abbreviated output")
+@click.option("--library", is_flag=True, help="Add to library")
+def scan(
+    path, storage_options, types, xtypes, json_out, html_out, walk, summary, library
 ):
-    if version:
-        print(projspec.__version__)
-        return
+    """Scan the given path for projects, and display
+
+    path: str, path to the project directory, defaults to "."
+    """
     if types in {"ALL", ""}:
         types = None
     else:
         types = types.split(",")
-    if info:
-        info = projspec.utils.camel_to_snake(info)
+    proj = projspec.Project(
+        path, storage_options=storage_options, types=types, xtypes=xtypes, walk=walk
+    )
+    if summary:
+        print(proj.text_summary())
+    else:
+        if json_out:
+            print(json.dumps(proj.to_dict(compact=True)))
+        elif html_out:
+            print(proj._repr_html_())
+        else:
+            print(proj)
+    if library:
+        proj.add_to_library()
+
+
+@main.command("info")
+@click.argument(
+    "types",
+    default="ALL",
+)
+def info(types=None):
+    if types in {"ALL", "", None}:
+        from projspec.utils import class_infos
+
+        print(json.dumps(class_infos()))
+    else:
+        name = projspec.utils.camel_to_snake(types)
         cls = (
-            projspec.proj.base.registry.get(info)
-            or projspec.content.base.registry.get(info)
-            or projspec.artifact.base.registry.get(info)
+            projspec.proj.base.registry.get(name)
+            or projspec.content.base.registry.get(name)
+            or projspec.artifact.base.registry.get(name)
         )
         if cls:
             pydoc.doc(cls, output=sys.stdout)
         else:
             print("Name not found")
-        return
-    if xtypes in {"NONE", ""}:
-        xtypes = None
-    else:
-        xtypes = xtypes.split(",")
-    if storage_options:
-        storage_options = json.loads(storage_options)
-    else:
-        storage_options = None
-    proj = projspec.Project(
-        path, storage_options=storage_options, types=types, xtypes=xtypes, walk=walk
-    )
-    if make:
-        proj.make(make)
-    elif summary:
-        print(proj.text_summary())
-    elif json_out:
-        print(json.dumps(proj.to_dict(compact=True)))
-    elif html_out:
-        print(proj._repr_html_())
+
+
+@main.group("library")
+def library():
+    """Interact with the project library.
+
+    Library file location is defined by config value "library_path".
+    """
+
+
+@library.command("list")
+@click.option(
+    "--json-out", is_flag=True, default=False, help="JSON output, for projects only"
+)
+def list(json_out):
+    from projspec.library import ProjectLibrary
+
+    library = ProjectLibrary()
+    if json_out:
+        print(json.dumps({k: v.to_dict() for k, v in library.entries.items()}))
     else:
-        print(proj)
+        for url, proj in library.entries.items():
+            print(f"{proj.text_summary(bare=True)}")
+
+
+@library.command("delete")
+@click.argument("url")
+def delete(url):
+    from projspec.library import ProjectLibrary
+
+    library = ProjectLibrary()
+    library.entries.pop(url)
+    library.save()
+
+
+@main.group("config")
+def config():
+    """Interact with the projspec config."""
+    pass
+
+
+@config.command("get")
+@click.argument("key")
+def get(key):
+    from projspec.config import get_conf
+
+    print(get_conf(key))
+
+
+@config.command("show")
+def show():
+    from projspec.config import conf
+
+    # TODO: show docs and defaults for each key, from projspec.config.config_doc?
+    # TODO: allow JSON output
+    print(conf)
+
+
+@config.command("unset")
+@click.argument("key")
+def unset(key):
+    from projspec.config import set_conf
+
+    set_conf(key, None)
+
+
+@config.command("set")
+@click.argument("key")
+@click.argument("value")
+def set_(key, value):
+    from projspec.config import set_conf
+
+    set_conf(key, value)
 
 
 if __name__ == "__main__":

src/projspec/artifact/base.py

@@ -4,6 +4,7 @@
 
 import fsspec.implementations.local
 
+from projspec.config import get_conf
 from projspec.proj import Project
 from projspec.utils import camel_to_snake, is_installed
 
@@ -34,13 +35,16 @@ def _check_runner(self):
         return self.cmd[0] in is_installed
 
     @property
-    def state(self) -> Literal["clean", "done", "pending"]:
-        if self._is_clean():
-            return "clean"
-        elif self._is_done():
-            return "done"
+    def state(self) -> Literal["clean", "done", "pending", ""]:
+        if get_conf("remote_artifact_status"):
+            if self._is_clean():
+                return "clean"
+            elif self._is_done():
+                return "done"
+            else:
+                return "pending"
         else:
-            return "pending"
+            return ""
 
     def make(self, *args, **kwargs):
         """Create the artifact and any runtime it depends on"""

src/projspec/config.py

@@ -1,27 +1,39 @@
+from contextlib import contextmanager
 import json
 import os
 
 from typing import Any
 
 conf: dict[str, dict[str, Any]] = {}
 default_conf_dir = os.path.join(os.path.expanduser("~"), ".config/projspec")
-conf_dir = os.environ.get("PROJSPEC_CONFIG_DIR", default_conf_dir)
-
-defaults = {
-    # location of persisted project objects
-    "library_path": f"{conf_dir}/library.json",
-    # files automatically read before scanning
-    "scan_types": [".py", ".yaml", ".yml", ".toml", ".json"],
-    # don't scan files if more than this number in the project
-    "scan_max_files": 100,
-    # don't scan files bigger than this (in bytes)
-    # In the future we may change this to reading this many bytes from the header.
-    "scan_max_size": 5 * 2**10,
+
+
+def conf_dir():
+    return os.environ.get("PROJSPEC_CONFIG_DIR", default_conf_dir)
+
+
+def defaults():
+    return {
+        "library_path": f"{conf_dir()}/library.json",
+        "scan_types": [".py", ".yaml", ".yml", ".toml", ".json"],
+        "scan_max_files": 100,
+        "scan_max_size": 5 * 2**10,
+        "remote_artifact_status": False,
+    }
+
+
+config_doc = {
+    "library_path": "location of persisted project objects",
+    "scan_types": "files extensions automatically read for scanning",
+    "scan_max_files": "don't scan files if more than this number in the project",
+    "scan_max_size": "don't scan files bigger than this (in bytes)",
+    "remote_artifact_status": "whether to check status for remote artifacts",
 }
 
 
 def load_conf(path: str | None = None):
-    fn = f"{path or default_conf_dir}/projspec.json"
+    fn = f"{path or conf_dir()}/projspec.json"
+    conf.clear()
     if os.path.exists(fn):
         with open(fn) as f:
             conf.update(json.load(f))
@@ -32,4 +44,29 @@ def load_conf(path: str | None = None):
 
 def get_conf(name: str):
     """Fetch the value of the given conf parameter from the current config or defaults"""
-    return conf[name] if name in conf else defaults[name]
+    return conf[name] if name in conf else defaults()[name]
+
+
+def set_conf(name: str, value: Any):
+    """Set the value of the given conf parameter and save to the config file"""
+    # TODO: require new value to be of same type as default?
+    if value:
+        conf[name] = value
+    else:
+        conf.pop(name, None)
+    os.makedirs(conf_dir(), exist_ok=True)
+    with open(f"{conf_dir()}/projspec.json", "wt") as f:
+        json.dump(conf, f)
+
+
+@contextmanager
+def temp_conf(**kwargs):
+    """Temporarily set the config"""
+    old = conf.copy()
+    # TODO: only allow keys that exist in defaults()?
+    conf.update(kwargs)
+    try:
+        yield
+    finally:
+        conf.clear()
+        conf.update(old)

src/projspec/library.py

@@ -19,9 +19,9 @@ class ProjectLibrary:
 
     def __init__(self, library_path: str | None = None, auto_save: bool = True):
         self.path = library_path or get_conf("library_path")
-        self.load()
         self.entries: dict[str, Project] = {}
         self.auto_save = auto_save
+        self.load()
 
     def load(self):
         """Loads scanned project objects from JSON file"""
@@ -68,7 +68,3 @@ def _match(proj: Project, filters: list[tuple[str, str | tuple[str]]]) -> bool:
         if cat == "content" and not proj.all_contents(value):
             return False
     return True
-
-
-library = ProjectLibrary()
-library.load()