splent-cli 1.48.2__tar.gz → 1.50.0__tar.gz

{splent_cli-1.48.2/src/splent_cli.egg-info → splent_cli-1.50.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: splent_cli
-Version: 1.48.2
+Version: 1.50.0
 Summary: SPLENT-CLI is a CLI to be able to work on your development more easily.
 Author-email: DiversoLab <diversolab@us.es>
 License-Expression: LGPL-3.0-or-later
@@ -16,7 +16,7 @@ Requires-Dist: packaging>=24.0
 Requires-Dist: python-dotenv>=1.0
 Requires-Dist: pyyaml>=6.0
 Requires-Dist: requests>=2.31.0
-Requires-Dist: splent_framework<2,>=1.22.0
+Requires-Dist: splent_framework<2,>=1.30.0
 Requires-Dist: tomli_w>=1.0.0
 Provides-Extra: dev
 Requires-Dist: setuptools==80.3.1; extra == "dev"

{splent_cli-1.48.2 → splent_cli-1.50.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "splent_cli"
-version = "1.48.2"
+version = "1.50.0"
 description = "SPLENT-CLI is a CLI to be able to work on your development more easily."
 readme = "README.md"
 requires-python = ">=3.13"
@@ -12,10 +12,6 @@ authors = [{ name = "DiversoLab", email = "diversolab@us.es" }]
 license = "LGPL-3.0-or-later"
 license-files = ["COPYING", "COPYING.LESSER"]
 
-# Everything the CLI imports at module level must be listed here (or come
-# with splent_framework, see tests/unit/test_declared_dependencies.py):
-# startup imports every command module, so one undeclared import breaks
-# `splent --help` on a clean `pip install splent_cli`.
 dependencies = [
     "click==8.1.8",
     "jinja2>=3.1",
@@ -23,15 +19,7 @@ dependencies = [
     "python-dotenv>=1.0",
     "pyyaml>=6.0",
     "requests>=2.31.0",
-    # The CLI drives the framework (paths, feature order, migrations, the
-    # app factory) and only works with the same major version of it. 1.22.0
-    # brings splent_framework.params, the [tool.splent.config_schema] reader
-    # product:validate, product:env and product:build share with the boot;
-    # 1.18.0 resolves a feature to the copy feature:test names
-    # (SPLENT_FEATURE_SOURCES) and brings the production defaults the deploy
-    # templates explain; 1.17.0 the refinement rules product:validate shares
-    # with the boot.
-    "splent_framework>=1.22.0,<2",
+    "splent_framework>=1.30.0,<2",
     "tomli_w>=1.0.0",
 ]
 
@@ -76,10 +64,6 @@ package-dir = { "" = "src" }
 [tool.setuptools.packages.find]
 where = ["src"]
 
-# The templates product:create, feature:create and the rest render. They are
-# data, not modules, so without this a wheel from PyPI shipped none of them.
-# The build context of the frontend toolchain image too, so a CLI installed
-# from PyPI can build the image a feature with frontend/ builds in.
 [tool.setuptools.package-data]
 splent_cli = ["templates/**/*", "toolchain/**/*"]
 
@@ -87,9 +71,6 @@ splent_cli = ["templates/**/*", "toolchain/**/*"]
 testpaths = ["tests"]
 pythonpath = ["src"]
 
-# Canonical formatter/linter is Ruff (`splent lint` runs `ruff check` +
-# `ruff format`). Ruff's default line length (88) is the project standard;
-# set explicitly here so it is unambiguous.
 [tool.ruff]
 line-length = 88
 

{splent_cli-1.48.2 → splent_cli-1.50.0}/src/splent_cli/cli.py

@@ -45,6 +45,41 @@ def _quiet_unless(debug: bool):
         logging.disable(logging.NOTSET)
 
 
+@contextlib.contextmanager
+def _held_logs(debug: bool):
+    """Hold what is logged while the app is built here, for a command that
+    may run in the product's web container instead.
+
+    A build that fails on a package the CLI's image lacks hands the command
+    to the web container, which builds the app again and says there all
+    the build has to say. What the attempt here logged first (the features'
+    warnings, the traceback of the import that failed) came before it, as
+    if the command had failed. Yields the records held, which
+    :func:`_replay` hands to their loggers when the command does not move
+    after all. SPLENT_DEBUG shows them as they happen.
+    """
+    held: list[tuple[logging.Logger, logging.LogRecord]] = []
+    if debug:
+        yield held
+        return
+    handle = logging.Logger.handle
+
+    def hold(logger, record):
+        held.append((logger, record))
+
+    logging.Logger.handle = hold
+    try:
+        yield held
+    finally:
+        logging.Logger.handle = handle
+
+
+def _replay(held) -> None:
+    """Log what :func:`_held_logs` held, as it would have been logged."""
+    for logger, record in held:
+        logger.handle(record)
+
+
 class SPLENTCLI(click.Group):
     """
     Main SPLENT CLI class.
@@ -211,14 +246,18 @@ class SPLENTCLI(click.Group):
             if context.is_override():
                 self._delegate_to_the_product(ctx)
 
+            debug = bool(os.getenv("SPLENT_DEBUG"))
             try:
-                app = get_app()
+                with _held_logs(debug) as held:
+                    app = get_app()
             except Exception as exc:
                 missing = _missing_module(exc)
                 if missing is None:
+                    _replay(held)
                     raise
                 # Only then: where the app builds here, the command runs here
                 # with the tools the CLI image has (ruff formats migrations).
+                # The web container builds it again and logs what it logs.
                 self._delegate_to_the_product(ctx)
                 product = context.active_app() or "The product"
                 raise click.ClickException(
@@ -227,6 +266,7 @@ class SPLENTCLI(click.Group):
                     "  Start the product (splent product:up --dev) and run the "
                     "command again: it then runs in the product's web container."
                 ) from exc
+            _replay(held)
             if getattr(command, "requires_db", False):
                 if not check_db_connection(app):
                     raise SystemExit(1)

{splent_cli-1.48.2 → splent_cli-1.50.0}/src/splent_cli/commands/cache/cache_clear.py

@@ -39,8 +39,8 @@ def _validate_feature(ctx, param, value):
         or (at and not _plain(version, _VERSION_RE))
     ):
         raise click.BadParameter(
-            "must be a feature name such as splent_feature_auth, optionally"
-            " with a namespace and a version (splent-io/splent_feature_auth@v1.2.0)."
+            "must be a feature name such as splent_feature_notes, optionally"
+            " with a namespace and a version (splent-io/splent_feature_notes@v1.2.0)."
         )
     ns, name, version = parse_feature_entry(value)
     return {

{splent_cli-1.48.2 → splent_cli-1.50.0}/src/splent_cli/commands/check/check_infra.py

@@ -366,7 +366,7 @@ def check_infra():
 
     data = load_toml(pyproject_path, what="pyproject.toml")
 
-    env = os.getenv("SPLENT_ENV", "dev")
+    env = context.resolve_env()
     features = read_features_from_data(data, env)
 
     # Every compose file is read through the product's merged .env, the same one

{splent_cli-1.48.2 → splent_cli-1.50.0}/src/splent_cli/commands/clear/clear_uploads.py

@@ -32,6 +32,13 @@ _SYSTEM_DIRS = {
     "/tmp",
     "/usr",
     "/var",
+    # macOS: its own top level, and /private, where /etc, /tmp and /var lead.
+    "/Applications",
+    "/Library",
+    "/System",
+    "/Users",
+    "/Volumes",
+    "/private",
 }
 
 # What a directory of code has at its top and a directory of uploads never
@@ -77,6 +84,12 @@ def _configured_dir(app) -> str:
     return os.getenv("PROTECTED_UPLOADS_DIR", "").strip()
 
 
+def _system_dirs() -> set:
+    """The system directories, and where each leads: on macOS /etc is a link
+    to /private/etc, which the realpath of a configured /etc gives."""
+    return _SYSTEM_DIRS | {os.path.realpath(path) for path in _SYSTEM_DIRS}
+
+
 def _refuse(path: str, real: str, why: str):
     shown = path if path == real else f"{path} (resolves to {real})"
     raise UploadsDirError(f"{shown} {why}. Nothing was deleted.")
@@ -124,7 +137,7 @@ def resolve_uploads_dir(app=None) -> str:
         )
 
     real = os.path.realpath(uploads_dir)
-    if real == os.sep or real in _SYSTEM_DIRS:
+    if real == os.sep or real in _system_dirs():
         _refuse(uploads_dir, real, "is a system directory")
     if real == os.path.realpath(os.path.expanduser("~")):
         _refuse(uploads_dir, real, "is the home directory")
@@ -289,8 +302,8 @@ def clear_uploads(env_dev, env_prod, yes):
 
     if not yes:
         click.confirm(
-            f"Delete every file in {uploads_dir}? The datasets and documents "
-            "the app serves from it cannot be recovered.",
+            f"Delete every file in {uploads_dir}? What the features stored "
+            "there, and the app serves from it, cannot be recovered.",
             abort=True,
         )
 

{splent_cli-1.48.2 → splent_cli-1.50.0}/src/splent_cli/commands/feature/feature_compat.py

@@ -735,7 +735,7 @@ def run_all_product_check(
     if not labeled_paths:
         return []
     if env is None:
-        env = os.getenv("SPLENT_ENV") or "dev"
+        env = context.resolve_env()
     labeled_contracts = [(lbl, _read_contract(path)) for lbl, path in labeled_paths]
     findings = _analyse_all(labeled_contracts) + version_floor_findings(
         labeled_paths

{splent_cli-1.48.2 → splent_cli-1.50.0}/src/splent_cli/commands/feature/feature_compile.py

@@ -1,4 +1,5 @@
 import dataclasses
+import hashlib
 import logging
 import os
 import posixpath
@@ -553,6 +554,31 @@ def _find_webpack(workspace, product, org_safe, base_name, version):
     return None
 
 
+def _one_watcher(webpack_file: str, product_root: str, shell_cmd: str) -> str:
+    """The shell line that watches ``webpack_file`` and stops its watcher
+    before, where webpack runs.
+
+    Each start of a product in development (product:run --dev) compiles
+    with --watch again, and a watcher used to outlive the one that started
+    it: eight starts left eight generations of npm, sh and webpack, 2.4 GB
+    of a 7.8 GB Docker VM. The watcher now runs in a session of its own
+    (setsid), whose id it leaves in a file named after its bundle, and the
+    next start ends that whole group first, if it is still a webpack one.
+    """
+    folder = "/tmp/splent-watch-$(id -u)"
+    name = hashlib.sha1(webpack_file.encode()).hexdigest()[:16]
+    pidfile = f"{folder}/{name}.pid"
+    inner = f'echo $$ > "{pidfile}"; exec {shell_cmd}'
+    return (
+        f'mkdir -p "{folder}"; '
+        f'if [ -f "{pidfile}" ]; then '
+        f'old="$(cat "{pidfile}")"; '
+        f'if grep -qa webpack "/proc/$old/cmdline" 2>/dev/null; then '
+        f'kill -TERM -- "-$old" 2>/dev/null || true; fi; fi; '
+        f"cd {shlex.quote(product_root)} && exec setsid bash -c {shlex.quote(inner)}"
+    )
+
+
 def _compile_in_container(
     container_id,
     feature,
@@ -645,6 +671,8 @@ def _compile_in_container(
 
     shell_cmd = " ".join(shlex.quote(p) for p in cmd_parts)
     cd_cmd = f"cd {shlex.quote(product_root)} && {shell_cmd}"
+    if watch and not production:
+        cd_cmd = _one_watcher(webpack_file, product_root, shell_cmd)
 
     # Inside a container: run webpack directly.
     # From the host: run via `docker exec` so webpack uses the container's

{splent_cli-1.48.2 → splent_cli-1.50.0}/src/splent_cli/commands/feature/feature_contract.py

@@ -21,10 +21,12 @@ from pathlib import Path
 
 from splent_cli.services import context
 from splent_cli.commands.feature.feature_release import (
+    REVISION_ID_MAX,
     _interactive,
     infer_contract,
     merge_preserved,
     requirement_problems,
+    revision_id_problems,
     write_contract,
 )
 from splent_cli.utils.feature_resolution import package_identifier, resolve_feature_ref
@@ -444,7 +446,25 @@ def feature_contract(feature_ref, write, inject_config):
         for problem in problems:
             click.secho(f"     {problem}", fg="red")
         click.echo(
-            '     Write a short name with an optional PEP 440 specifier, such as "auth>=1.20.0".'
+            '     Write a short name with an optional PEP 440 specifier, such as "notes>=1.20.0".'
+        )
+        raise SystemExit(1)
+
+    # A migration no database can record: refused here, in the dry run too,
+    # as feature:release refuses it, before anyone releases it.
+    long_ids = revision_id_problems(str(cache_path), name)
+    if long_ids:
+        click.secho(
+            f"  ❌ These revision ids are longer than the {REVISION_ID_MAX} "
+            "characters alembic_version.version_num holds:",
+            fg="red",
+        )
+        for problem in long_ids:
+            click.secho(f"     {problem}", fg="red")
+        click.echo(
+            "     The upgrade would run the migration and then fail to record "
+            "it.\n     Shorten the revision id, and every down_revision that "
+            "names it."
         )
         raise SystemExit(1)
 

{splent_cli-1.48.2 → splent_cli-1.50.0}/src/splent_cli/commands/feature/feature_install.py

@@ -230,7 +230,7 @@ def feature_install(feature_identifier, env_scope, mode, version):
     """
     product = context.require_app()
     workspace = str(context.workspace())
-    env_name = os.getenv("SPLENT_ENV", "dev")
+    env_name = context.resolve_env()
 
     # ── Parse identifier ──────────────────────────────────────────────
     namespace, namespace_github, namespace_fs, feature_name = (