splent-cli 1.29.1__tar.gz → 1.30.0__tar.gz

{splent_cli-1.29.1/src/splent_cli.egg-info → splent_cli-1.30.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: splent_cli
-Version: 1.29.1
+Version: 1.30.0
 Summary: SPLENT-CLI is a CLI to be able to work on your development more easily.
 Author-email: DiversoLab <diversolab@us.es>
 Project-URL: Homepage, https://github.com/diverso-lab/splent_cli

{splent_cli-1.29.1 → splent_cli-1.30.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "splent_cli"
-version = "1.29.1"
+version = "1.30.0"
 description = "SPLENT-CLI is a CLI to be able to work on your development more easily."
 readme = "README.md"
 requires-python = ">=3.13"

{splent_cli-1.29.1 → splent_cli-1.30.0}/src/splent_cli/commands/spl/spl_publish.py

@@ -21,6 +21,7 @@ saying what came back.
 
 import os
 import re
+import time
 import tomllib
 
 import click
@@ -225,6 +226,119 @@ def _concept_doi(result: dict) -> str:
     return ""
 
 
+# ---------------------------------------------------------------------------
+# Waiting for the DOI
+# ---------------------------------------------------------------------------
+
+#: Seconds between two questions about a release that is still being minted.
+POLL_INTERVAL = 5
+#: How long to keep asking about a release that is still being minted. Longer
+#: than the marketplace waits on a mint before it goes looking for the DOI.
+WAIT_LIMIT = 20 * 60
+#: How long to keep asking once the marketplace says it lost track of the
+#: mint. It looks for the DOI about once a minute, so this is a few looks.
+UNKNOWN_GRACE = 5 * 60
+#: How often to say it is still going, so a quiet terminal does not read as
+#: a hung one.
+PROGRESS_EVERY = 30
+
+#: Error codes that waiting longer cannot fix.
+_FINAL_CODES = frozenset(
+    {
+        marketplace_api.CODE_FORBIDDEN,
+        marketplace_api.CODE_NOT_FOUND,
+        marketplace_api.CODE_INVALID_REQUEST,
+    }
+)
+
+# Swapped out by the tests, so nothing there really waits.
+_sleep = time.sleep
+_clock = time.monotonic
+
+
+def _duration(seconds: float) -> str:
+    minutes, rest = divmod(int(seconds), 60)
+    return f"{minutes}m {rest:02d}s" if minutes else f"{rest}s"
+
+
+def _wait_for_release(client, spl_name: str, accepted: dict) -> dict:
+    """Ask about an accepted release until the marketplace settles it.
+
+    Returns the last answer: published or failed, or still reserved or
+    unknown once the limits above run out. Nothing is written down until it
+    says published, so stopping early, by limit or by Ctrl+C, loses nothing.
+    """
+    version = accepted.get("version")
+    if not version:
+        raise marketplace_api.MarketplaceError(
+            "The marketplace accepted the release but did not say which version it is.",
+            status=None,
+            code=marketplace_api.CODE_BAD_RESPONSE,
+        )
+    click.echo(
+        f"  Release {version} accepted. Minting its DOI, which usually takes a "
+        "minute or two."
+    )
+
+    started = last_report = _clock()
+    unknown_since = None
+    status = accepted
+    warned = False
+    while True:
+        state = str(status.get("state") or "")
+        if state not in ("reserved", "unknown"):
+            return status
+        now = _clock()
+        if state == "unknown" and unknown_since is None:
+            unknown_since = now
+        if now - started >= WAIT_LIMIT or (
+            unknown_since is not None and now - unknown_since >= UNKNOWN_GRACE
+        ):
+            return status
+        if now - last_report >= PROGRESS_EVERY:
+            click.echo(f"  Still minting ({_duration(now - started)}).")
+            last_report = now
+        _sleep(POLL_INTERVAL)
+        try:
+            status = client.release_status(spl_name, version)
+        except marketplace_api.MarketplaceError as e:
+            if e.dead_token or e.code in _FINAL_CODES:
+                raise
+            # A blip between two questions says nothing about the release,
+            # which carries on in the marketplace either way.
+            if not warned:
+                click.secho(
+                    f"  The marketplace did not answer ({e.reason or e}). "
+                    "Asking again.",
+                    fg="yellow",
+                )
+                warned = True
+
+
+def _come_back_later(spl_name: str, version, state: str) -> None:
+    """What to do about a release that has not settled yet. Always exits."""
+    click.echo()
+    if state == "unknown":
+        click.secho(
+            f"  Release {version} did not report back, so the marketplace is "
+            "looking for its DOI.",
+            fg="yellow",
+        )
+    else:
+        click.secho(
+            f"  Release {version} is still being minted. The marketplace carries "
+            "on with it.",
+            fg="yellow",
+        )
+    click.echo(
+        f"     Run splent spl:publish {spl_name} again later. The same model is "
+        "answered with its DOI once it exists, and is never minted twice."
+    )
+    click.echo("     Nothing was written down locally yet.")
+    click.echo()
+    raise SystemExit(1)
+
+
 # ---------------------------------------------------------------------------
 # Command
 # ---------------------------------------------------------------------------
@@ -315,6 +429,7 @@ def spl_publish(spl_name, registry_option, dry_run):
         click.echo()
         click.echo("  Would POST the model to /api/v1/spls/<name>/releases and:")
         click.echo("    - let the marketplace publish or version it on its own key")
+        click.echo("    - wait while it mints the DOI")
         click.echo("    - let it verify the published file byte for byte")
         click.echo("    - record the DOI it reports")
         if metadata_path:
@@ -360,6 +475,36 @@ def spl_publish(spl_name, registry_option, dry_run):
         click.echo()
         raise SystemExit(1)
 
+    if result.get("accepted"):
+        try:
+            result = _wait_for_release(client, spl_name, result)
+        except marketplace_api.MarketplaceError as e:
+            handle_error(e, url=target.url, forget=not cred.from_environment)
+            click.echo()
+            raise SystemExit(1)
+        except KeyboardInterrupt:
+            click.echo()
+            click.secho("  Stopped waiting.", fg="yellow")
+            click.echo(
+                f"     The marketplace carries on with release {result.get('version')}. "
+                f"Run splent spl:publish {spl_name} again to pick up its DOI."
+            )
+            raise SystemExit(130)
+        state = str(result.get("state") or "")
+        if state == "failed":
+            click.secho(
+                f"  Release {result.get('version')} was refused. Nothing was minted.",
+                fg="red",
+            )
+            detail = str(result.get("detail") or "").strip()
+            if detail:
+                click.echo(f"     {detail}")
+            click.echo("     Fix the model and publish it again.")
+            click.echo()
+            raise SystemExit(1)
+        if state != "published":
+            _come_back_later(spl_name, result.get("version"), state)
+
     doi, remote_file = _pointer(result)
     concept_doi = _concept_doi(result)
     if not doi:

{splent_cli-1.29.1 → splent_cli-1.30.0}/src/splent_cli/services/marketplace_api.py

@@ -17,6 +17,10 @@ extra fields and loud about missing ones)::
     GET    /api/v1/spls                 public
     GET    /api/v1/spls/<name>          public -> {name, description, uvl{...}}
     POST   /api/v1/spls/<name>/releases Bearer, multipart with the uvl file
+                                        Prefer: respond-async -> 202 {accepted,
+                                        version, state} while the DOI is minted
+    GET    /api/v1/spls/<name>/releases/<version>
+                                        Bearer -> {state, doi, uvl{...}, ...}
 
 Nothing here prints, and nothing here ever puts a token in a message: an error
 string from this module is safe to show to the user verbatim.
@@ -36,6 +40,11 @@ USER_AGENT = "splent-cli"
 DEFAULT_TIMEOUT = 15
 UPLOAD_TIMEOUT = 60
 
+#: RFC 7240. Asks the marketplace to answer a release as soon as it is
+#: reserved and mint the DOI in the background. A marketplace that predates
+#: it ignores the header and answers when the DOI exists, as it always did.
+PREFER_ASYNC = "respond-async"
+
 #: Lifetime requested for a token created by ``splent login``.
 DEFAULT_TTL_DAYS = 90
 
@@ -451,6 +460,7 @@ class MarketplaceClient:
         timeout: int | None = None,
         unauthenticated_code: str | None = None,
         sent_but_unanswered: str | None = None,
+        extra_headers: dict | None = None,
     ):
         """Perform the request. Returns parsed JSON, or None for an empty body.
 
@@ -465,7 +475,7 @@ class MarketplaceClient:
             response = requests.request(
                 method,
                 url,
-                headers=self._headers(auth=auth),
+                headers={**self._headers(auth=auth), **(extra_headers or {})},
                 json=json_body,
                 files=files,
                 data=data,
@@ -637,6 +647,10 @@ class MarketplaceClient:
         spends anything: on the far side the marketplace relays it to UVLHub
         with its own key and a DOI may be minted. ``splent spl:publish`` is its
         only caller and there is meant to be exactly one.
+
+        It asks for the answer as soon as the release is reserved. A body with
+        ``accepted`` set means the DOI is still being minted, and
+        :meth:`release_status` says how it ends.
         """
         files = {
             UVL_FIELD_NAME: (filename, uvl_bytes, "text/plain"),
@@ -651,10 +665,24 @@ class MarketplaceClient:
             sent_but_unanswered=(
                 f"The upload of {name} was sent to the marketplace at {self.base_url} "
                 f"but no answer came back within {UPLOAD_TIMEOUT} seconds. The "
-                "release may have completed, so check the product line page on "
-                "the marketplace before publishing again."
+                "release may have completed. Publishing the same model again is "
+                "safe. The marketplace answers it with the DOI it minted and "
+                "never mints a second one."
             ),
+            extra_headers={"Prefer": PREFER_ASYNC},
         )
         if payload is None:
             return {}
         return self._expect_dict(payload, "release response")
+
+    def release_status(self, name: str, version) -> dict:
+        """How one release of *name* stands: reserved, published, failed or unknown.
+
+        The path is built here from the name and the version, never taken from
+        the server's ``status_url``: the token goes with this request, and it
+        only ever goes to the marketplace it was issued by.
+        """
+        payload = self._request(
+            "GET", f"/api/v1/spls/{name}/releases/{int(version)}", auth=True
+        )
+        return self._expect_dict(payload, "release status")

{splent_cli-1.29.1 → splent_cli-1.30.0}/src/splent_cli/utils/io_utils.py

@@ -248,6 +248,11 @@ def give_tree_to_its_owner(
                 pass
 
 
+# Characters a shell sourcing a .env reads as syntax rather than as part of a
+# bare value. Double quotes make every one of them literal.
+_SHELL_SYNTAX = frozenset("<>|&;()")
+
+
 def env_line(key: str, value: str) -> str:
     """One ``KEY=value`` line for a generated .env file.
 
@@ -258,12 +263,17 @@ def env_line(key: str, value: str) -> str:
     files do not churn. A value that starts or ends with a quote is quoted
     too, or a reader would take its own quotes for the file's.
 
+    So is a value with a character the shell reads as syntax. ``product:restart``
+    sources the file with bash, and a bare ``AUTODEPLOY_SECRET=<SET>`` is a
+    redirection there: the source fails, and the app never starts.
+
     Inside the quotes backslashes are escaped before double quotes, so
     :func:`parse_env_value` (and dotenv) give back exactly ``value``.
     """
     if (
         any(c.isspace() for c in value)
         or "#" in value
+        or any(c in _SHELL_SYNTAX for c in value)
         or value[:1] in ("'", '"')
         or value[-1:] in ("'", '"')
     ):

{splent_cli-1.29.1 → splent_cli-1.30.0/src/splent_cli.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: splent_cli
-Version: 1.29.1
+Version: 1.30.0
 Summary: SPLENT-CLI is a CLI to be able to work on your development more easily.
 Author-email: DiversoLab <diversolab@us.es>
 Project-URL: Homepage, https://github.com/diverso-lab/splent_cli