reorganize and rename

Author: rmorshea

idom/__init__.py

@@ -3,6 +3,7 @@
     DistributionNotFound as _DistributionNotFound,
 )
 
+from . import cli
 from .utils import Ref, html_to_vdom
 
 from .core.element import element, Element
@@ -64,4 +65,5 @@
     "VdomDict",
     "widgets",
     "client",
+    "cli",
 ]

idom/cli/__init__.py

@@ -0,0 +1,4 @@
+from .commands import main
+from . import console
+
+__all__ = ["main", "console"]

idom/cli.py idom/cli/commands.pyidom/cli.py renamed to idom/cli/commands.py

@@ -4,7 +4,7 @@
 
 import idom
 from idom.client import manage as manage_client
-from idom.client.build_config import find_build_config_in_python_source
+from idom.client.build_config import find_build_config_item_in_python_source
 
 
 main = typer.Typer()
@@ -16,7 +16,9 @@
 def build(entrypoint: str) -> None:
     """Configure and build the client"""
     if entrypoint.endswith(".py"):
-        config = find_build_config_in_python_source("__main__", Path.cwd() / entrypoint)
+        config = find_build_config_item_in_python_source(
+            "__main__", Path.cwd() / entrypoint
+        )
         if config is None:
             typer.echo(f"No build config found in {entrypoint!r}")
             manage_client.build()
@@ -36,7 +38,7 @@ def restore():
 @show.command()
 def config() -> None:
     """Show the state of IDOM's build config"""
-    typer.echo(manage_client.BUILD_STATE.show())
+    typer.echo(manage_client.BUILD_CONFIG_FILE.show())
     return None
 
 

idom/client/sh.py idom/cli/console.pyidom/client/sh.py renamed to idom/cli/console.py

@@ -6,6 +6,10 @@
 import click_spinner
 
 
+os.environ.setdefault("IDOM_CLI_SHOW_SPINNER", "1")
+os.environ.setdefault("IDOM_CLI_SHOW_OUTPUT", "1")
+
+
 def echo(message: str, message_color: Optional[str] = None, **kwargs: Any) -> None:
     if message_color is not None:
         message = typer.style(message, fg=getattr(typer.colors, message_color.upper()))
@@ -30,8 +34,8 @@ def spinner(message: str) -> Iterator[None]:
 
 
 def _show_spinner() -> bool:
-    return _show_output() and bool(int(os.environ.get("IDOM_SHOW_SPINNER", 1)))
+    return _show_output() and bool(int(os.environ["IDOM_CLI_SHOW_SPINNER"]))
 
 
 def _show_output() -> bool:
-    return bool(int(os.environ.get("IDOM_SHOW_CLIENT_MANAGEMENT_OUTPUT", 1)))
+    return bool(int(os.environ["IDOM_CLI_SHOW_OUTPUT"]))

idom/client/build_config.py

@@ -5,31 +5,20 @@
 from pathlib import Path
 from importlib.machinery import SourceFileLoader
 from pkgutil import iter_modules
-from typing import (
-    List,
-    Dict,
-    Optional,
-    Any,
-    NamedTuple,
-    Iterable,
-    TypeVar,
-    Callable,
-    Iterator,
-)
-
-from .sh import echo
-from .utils import split_package_name_and_version
+from typing import List, Dict, Optional, Any, NamedTuple, Iterable, Iterator, TypeVar
 
+from .utils import split_package_name_and_version
 
-_F = TypeVar("_F", bound=Callable[..., Any])
+from idom.cli import console
 
 
-class BuildState:
+class BuildConfigFile:
 
-    __slots__ = "save_location", "configs"
+    __slots__ = "configs", "_path"
+    _filename = ".idom-build-configs.json"
 
     def __init__(self, path: Path) -> None:
-        self.save_location = path
+        self._path = path / self._filename
         self.configs = self._load_configs()
 
     @contextmanager
@@ -45,15 +34,15 @@ def transaction(self) -> Iterator[None]:
             self.save()
 
     def add(self, build_configs: Iterable[Any], ignore_existing: bool = False) -> None:
-        for config in map(to_build_config, build_configs):
+        for config in map(BuildConfigItem.cast, build_configs):
             source_name = config.source_name
             if not ignore_existing and source_name in self.configs:
                 raise ValueError(f"A build config for {source_name!r} already exists")
             self.configs[source_name] = config
         return None
 
     def save(self) -> None:
-        with (self.save_location / ".idom-build-state.json").open("w") as f:
+        with self._path.open("w") as f:
             json.dump({name: conf._asdict() for name, conf in self.configs.items()}, f)
 
     def show(self, indent: int = 2) -> str:
@@ -65,22 +54,39 @@ def show(self, indent: int = 2) -> str:
     def clear(self) -> None:
         self.configs = {}
 
-    def _load_configs(self) -> Dict[str, "BuildConfig"]:
-        fname = self.save_location / ".idom-build-state.json"
-        if not fname.exists():
+    def _load_configs(self) -> Dict[str, "BuildConfigItem"]:
+        if not self._path.exists():
             return {}
-        with fname.open() as f:
+        with self._path.open() as f:
             content = f.read()
             if not content:
                 return {}
             else:
-                return {n: BuildConfig(**c) for n, c in json.loads(content).items()}
+                return {n: BuildConfigItem(**c) for n, c in json.loads(content).items()}
 
     def __repr__(self) -> str:
         return f"{type(self).__name__}({self.show(indent=0)})"
 
 
-class BuildConfig(NamedTuple):
+_Class = TypeVar("_Class")
+_Self = TypeVar("_Self")
+
+
+class BuildConfigItem(NamedTuple):
+    """Describes build requirements for a Python package or application"""
+
+    @classmethod
+    def cast(cls: _Class, value: Any, source_name: Optional[str] = None) -> _Class:
+        if isinstance(value, cls):
+            return value
+        elif isinstance(value, tuple):
+            return cls(*value)._validate()
+        elif isinstance(value, dict):
+            if source_name is not None:
+                value = {"source_name": source_name, **value}
+            return cls(**value)._validate()
+        else:
+            raise ValueError(f"Expected a dict or tuple, not {value!r}")
 
     source_name: str
     js_dependencies: List[str]
@@ -100,42 +106,33 @@ def aliased_js_dependencies(self) -> List[str]:
             aliased_dependencies.append(f"{name}-{idf}@npm:{dep}")
         return aliased_dependencies
 
-
-def to_build_config(config: Any, source_name: Optional[str] = None) -> BuildConfig:
-    if isinstance(config, BuildConfig):
-        return config
-
-    if not isinstance(config, dict):
-        raise ValueError(
-            f"build config must be a dictionary, but found {config!r}",
-        )
-
-    source_name = config.setdefault("source_name", source_name)
-    if not isinstance(source_name, str):
-        raise ValueError(f"'source_name' must be a string, not {source_name!r}")
-
-    js_dependencies = config.get("js_dependencies")
-    if not isinstance(js_dependencies, list):
-        raise ValueError(f"'js_dependencies' must be a list, not {js_dependencies!r}")
-    for item in js_dependencies:
-        if not isinstance(item, str):
+    def _validate(self: _Self) -> _Self:
+        if not isinstance(self.source_name, str):
             raise ValueError(
-                f"items of 'js_dependencies' must be strings, not {item!r}"
+                f"'source_name' must be a string, not {self.source_name!r}"
             )
-
-    return BuildConfig(**config)
+        if not isinstance(self.js_dependencies, list):
+            raise ValueError(
+                f"'js_dependencies' must be a list, not {self.js_dependencies!r}"
+            )
+        for item in self.js_dependencies:
+            if not isinstance(item, str):
+                raise ValueError(
+                    f"items of 'js_dependencies' must be strings, not {item!r}"
+                )
+        return self
 
 
-def find_build_config_in_python_source(
+def find_build_config_item_in_python_source(
     module_name: str, path: Path
-) -> Optional[BuildConfig]:
+) -> Optional[BuildConfigItem]:
     with path.open() as f:
-        return _parse_build_config_from_python_source(module_name, f.read())
+        return _parse_build_config_item_from_python_source(module_name, f.read())
 
 
-def find_python_packages_build_configs(
+def find_python_packages_build_config_items(
     path: Optional[str] = None,
-) -> List[BuildConfig]:
+) -> List[BuildConfigItem]:
     """Find javascript dependencies declared by Python modules
 
     Parameters:
@@ -146,20 +143,22 @@ def find_python_packages_build_configs(
     Returns:
         Mapping of module names to their corresponding list of discovered dependencies.
     """
-    build_configs: List[BuildConfig] = []
+    build_configs: List[BuildConfigItem] = []
     for module_info in iter_modules(path):
         module_loader = module_info.module_finder.find_module(module_info.name)
         if isinstance(module_loader, SourceFileLoader):
             module_src = module_loader.get_source(module_info.name)
-            conf = _parse_build_config_from_python_source(module_info.name, module_src)
+            conf = _parse_build_config_item_from_python_source(
+                module_info.name, module_src
+            )
             if conf is not None:
                 build_configs.append(conf)
     return build_configs
 
 
-def _parse_build_config_from_python_source(
+def _parse_build_config_item_from_python_source(
     module_name: str, module_src: str
-) -> Optional[BuildConfig]:
+) -> Optional[BuildConfigItem]:
     for node in ast.parse(module_src).body:
         if isinstance(node, ast.Assign) and (
             len(node.targets) == 1
@@ -175,14 +174,14 @@ def _parse_build_config_from_python_source(
                 return None
 
             try:
-                return to_build_config(raw_config, module_name)
+                return BuildConfigItem.cast(raw_config, module_name)
             except ValueError as error:
                 _echo_error(
-                    f"Failed to load build config for {module_name!r} - {error}"
+                    f"Failed to load build config for {module_name!r} because {error}"
                 )
                 return None
     return None
 
 
 def _echo_error(msg: str) -> None:
-    echo(msg, color="red")
+    console.echo(msg, color="red")

idom/client/manage.py

@@ -4,18 +4,19 @@
 from tempfile import TemporaryDirectory
 from typing import Optional, Iterable, Sequence, List
 
-from .sh import spinner
 from .build_config import (
-    BuildState,
-    BuildConfig,
-    find_python_packages_build_configs,
+    BuildConfigFile,
+    BuildConfigItem,
+    find_python_packages_build_config_items,
 )
 from .utils import open_modifiable_json, split_package_name_and_version
 
+from idom.cli import console
+
 
 APP_DIR = Path(__file__).parent / "app"
 BUILD_DIR = APP_DIR / "build"
-BUILD_STATE = BuildState(BUILD_DIR)
+BUILD_CONFIG_FILE = BuildConfigFile(BUILD_DIR)
 
 
 def find_path(url_path: str) -> Optional[Path]:
@@ -29,7 +30,7 @@ def find_path(url_path: str) -> Optional[Path]:
 
 
 def web_module_url(source_name: str, package_name: str) -> str:
-    config = BUILD_STATE.configs.get(source_name)
+    config = BUILD_CONFIG_FILE.configs.get(source_name)
     if config is None:
         return None
     alias = config.get_js_dependency_alias(package_name)
@@ -40,15 +41,17 @@ def web_module_url(source_name: str, package_name: str) -> str:
 
 
 def build(
-    configs: Optional[Iterable[BuildConfig]] = None,
+    configs: Optional[Iterable[BuildConfigItem]] = None,
     output_dir: Path = BUILD_DIR,
 ) -> None:
-    with BUILD_STATE.transaction():
+    with BUILD_CONFIG_FILE.transaction():
         if configs is not None:
-            BUILD_STATE.add(configs, ignore_existing=True)
+            BUILD_CONFIG_FILE.add(configs, ignore_existing=True)
 
-        with spinner("Discovering dependencies"):
-            BUILD_STATE.add(find_python_packages_build_configs(), ignore_existing=True)
+        with console.spinner("Discovering dependencies"):
+            BUILD_CONFIG_FILE.add(
+                find_python_packages_build_config_items(), ignore_existing=True
+            )
 
         with TemporaryDirectory() as tempdir:
             tempdir_path = Path(tempdir)
@@ -61,7 +64,7 @@ def build(
 
             packages_to_install = [
                 dep
-                for conf in BUILD_STATE.configs.values()
+                for conf in BUILD_CONFIG_FILE.configs.values()
                 for dep in conf.aliased_js_dependencies()
             ]
 
@@ -74,10 +77,10 @@ def build(
                     ]
                 )
 
-            with spinner(f"Installing {len(packages_to_install)} dependencies"):
+            with console.spinner(f"Installing {len(packages_to_install)} dependencies"):
                 _npm_install(packages_to_install, temp_app_dir)
 
-            with spinner("Building client"):
+            with console.spinner("Building client"):
                 _npm_run_build(temp_app_dir)
 
             if output_dir.exists():
@@ -87,7 +90,7 @@ def build(
 
 
 def restore() -> None:
-    with spinner("Restoring"):
+    with console.spinner("Restoring"):
         shutil.rmtree(BUILD_DIR)
         _run_subprocess(["npm", "install"], APP_DIR)
         _run_subprocess(["npm", "run", "build"], APP_DIR)

idom/client/protocol.py

@@ -2,7 +2,7 @@
 
 from typing_extensions import Protocol
 
-from idom import Ref
+from idom.utils import Ref
 
 from . import manage
 

idom/client/utils.py

@@ -7,7 +7,7 @@
 @contextmanager
 def open_modifiable_json(path: Path) -> Iterator[Any]:
     with path.open() as f:
-        data = json.load(f)
+        data = json.loads(f.read().strip() or "{}")
 
     yield data
 
@@ -24,6 +24,6 @@ def split_package_name_and_version(pkg: str) -> Tuple[str, str]:
             name, version = pkg[1:].split("@", 1)
             return ("@" + name), version
     elif at_count:
-        return pkg.split("@", 1)
+        return tuple(pkg.split("@", 1))
     else:
         return pkg, ""