mistralai-capabilities-backend-workflows 0.1.21__tar.gz

mistralai_capabilities_backend_workflows-0.1.21/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2025 Mistral AI
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

mistralai_capabilities_backend_workflows-0.1.21/PKG-INFO

@@ -0,0 +1,11 @@
+Metadata-Version: 2.4
+Name: mistralai-capabilities-backend-workflows
+Version: 0.1.21
+Summary: The workflows capability's toolkit: the SDK execution boundary the app imports (`client`).
+License-Expression: Apache-2.0
+License-File: LICENSE
+Requires-Dist: mistralai[workflow-payload-encryption]>=2.9.4
+Requires-Dist: mistralai-workflows>=3.15.0
+Requires-Dist: pydantic>=2
+Requires-Dist: structlog>=25
+Requires-Python: >=3.12, <3.15

mistralai_capabilities_backend_workflows-0.1.21/pyproject.toml

@@ -0,0 +1,22 @@
+[project]
+name = "mistralai-capabilities-backend-workflows"
+version = "0.1.21"
+description = "The workflows capability's toolkit: the SDK execution boundary the app imports (`client`)."
+requires-python = ">=3.12,<3.15"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+dependencies = [
+    # `mistralai-search-toolkit` caps `mistralai<2.10`; a higher floor breaks uv resolution.
+    "mistralai[workflow-payload-encryption]>=2.9.4",
+    "mistralai-workflows>=3.15.0",
+    "pydantic>=2",
+    "structlog>=25",
+]
+
+[build-system]
+requires = ["uv_build>=0.8.22,<0.9.0"]
+build-backend = "uv_build"
+
+[tool.uv.build-backend]
+module-name = "mistralai_capabilities.workflows"
+namespace = true

mistralai_capabilities_backend_workflows-0.1.21/src/mistralai_capabilities/workflows/client.py

@@ -0,0 +1,315 @@
+import asyncio
+import inspect
+import os
+from dataclasses import dataclass
+from functools import cache
+from typing import Any, get_type_hints
+
+import mistralai.workflows as workflows
+from mistralai.workflows import workflow as _wf
+from mistralai.workflows.core.config.config import (
+    RESERVED_QUERY_NAMES,
+    RESERVED_UPDATE_NAMES,
+    PayloadEncryptionConfig,
+    WorkerConfig,
+)
+from mistralai.workflows.core.config.config import config as sdk_config
+from mistralai.workflows.protocol.v1.workflow import DeploymentName
+from pydantic import BaseModel, SecretStr, TypeAdapter
+
+with _wf.unsafe.imports_passed_through():
+    import structlog
+    from env.mistral import env
+    from env.workflows import env as workflows_env
+    from mistralai.client import Mistral
+    from mistralai.client.errors import MistralError
+    from mistralai.client.models import (
+        ScheduleDefinition,
+        ScheduleInterval,
+        SchedulePolicy,
+    )
+    from mistralai.extra.workflows.encoding.config import WorkflowEncodingConfig
+    from mistralai.extra.workflows.encoding.helpers import configure_workflow_encoding
+    from mistralai.extra.workflows.encoding.payload_encoder import PayloadEncoder
+    from mistralai.workflows import ScheduleOverlapPolicy
+
+_SCHEDULE_CATCHUP_SECONDS = 86400
+
+_logger = structlog.get_logger("workflows.encryption")
+
+# Assigning a config attribute skips the SDK's validation, so the name is validated here instead.
+_DEPLOYMENT_NAME: TypeAdapter[str | None] = TypeAdapter(DeploymentName)
+
+# An SDK internal, not a published contract: it can move on a version bump.
+_ENTRYPOINT_MARKER = "__workflows_workflow_entrypoint"
+
+__all__ = [
+    "ScheduleTimingError",
+    "WorkflowCapabilities",
+    "WorkflowRun",
+    "get_client",
+    "infer_workflow_models",
+    "pause_schedule_if_present",
+    "payload_encryption",
+    "run_worker",
+    "start_workflow",
+    "upsert_schedule",
+    "workflow_capabilities",
+]
+
+
+@cache
+def payload_encryption() -> PayloadEncryptionConfig | None:
+    encryption = WorkerConfig().temporal_payload_encryption
+    if encryption is not None:
+        PayloadEncoder(WorkflowEncodingConfig(payload_encryption=encryption))
+        _logger.info(
+            "workflow payload encryption enabled",
+            mode=encryption.mode.value,
+            key_rotation=encryption.secondary_key is not None,
+        )
+        return encryption
+    _logger.info("workflow payload encryption is off")
+    legacy_mode = os.environ.get("WORKFLOWS_ENCRYPTION_MODE", "").strip()
+    if legacy_mode not in ("", "off"):
+        _logger.warning(
+            "WORKFLOWS_ENCRYPTION_MODE is no longer read, so payloads are not encrypted; set "
+            "TEMPORAL_PAYLOAD_ENCRYPTION__MODE and TEMPORAL_PAYLOAD_ENCRYPTION__MAIN_KEY to encrypt them",
+            workflows_encryption_mode=legacy_mode,
+        )
+    return None
+
+
+_clients: dict[asyncio.AbstractEventLoop, asyncio.Task[Mistral]] = {}
+
+
+async def _build_client() -> Mistral:
+    client = Mistral(api_key=env.mistral_api_key, server_url=workflows_env.workflows_base_url)
+    encryption = payload_encryption()
+    if encryption is not None:
+        await configure_workflow_encoding(WorkflowEncodingConfig(payload_encryption=encryption), client=client)
+    return client
+
+
+async def get_client() -> Mistral:
+    """The Mistral client, with payload encoding installed before its first use.
+
+    The SDK keeps the encoding config on the client instance, so the configured client itself is
+    what is cached and reused: a fresh ``Mistral`` would carry no config and send cleartext. It is
+    built as one task per event loop, so concurrent first calls share one namespace lookup. A
+    failed build is evicted, not cached, so a transient blip does not brick the process; it is
+    re-raised because proceeding puts cleartext on the wire under ``full``.
+    """
+    loop = asyncio.get_running_loop()
+    if (task := _clients.get(loop)) is None:
+        for other in list(_clients):
+            if other.is_closed():
+                _clients.pop(other, None)
+        task = _clients[loop] = loop.create_task(_build_client())
+        task.add_done_callback(_forget_failed)
+    return await asyncio.shield(task)
+
+
+def _forget_failed(task: asyncio.Task[Mistral]) -> None:
+    if (task.cancelled() or task.exception() is not None) and _clients.get(task.get_loop()) is task:
+        del _clients[task.get_loop()]
+
+
+def _call(**kwargs: Any) -> dict[str, Any]:
+    """The kwargs for one platform call: drop what the caller left unset.
+
+    Unset optionals are dropped because the SDK distinguishes an omitted parameter from an
+    explicit ``None``, which serializes as a null the server may reject.
+    """
+    return {name: value for name, value in kwargs.items() if value is not None}
+
+
+class ScheduleTimingError(ValueError):
+    """Raised when a schedule declares neither or both of an interval and a cron expression."""
+
+
+def _validated_timing(interval_seconds: int | None, cron_expressions: list[str] | None) -> None:
+    if bool(interval_seconds) == bool(cron_expressions):
+        raise ScheduleTimingError(
+            "Provide exactly one of interval_seconds or cron_expressions. Prefer cron for a fixed "
+            "time of day: an interval is anchored to the epoch, so it drifts against wall-clock time."
+        )
+
+
+@dataclass(frozen=True)
+class WorkflowRun:
+    """What starting a workflow gives back: always an id, a result only if we waited."""
+
+    execution_id: str
+    result: Any = None
+
+
+@dataclass(frozen=True)
+class WorkflowCapabilities:
+    """The command handlers a workflow class declares, as names a caller may legitimately invoke."""
+
+    signals: tuple[str, ...]
+    queries: tuple[str, ...]
+    updates: tuple[str, ...]
+
+
+def workflow_capabilities(workflow_class: type) -> WorkflowCapabilities:
+    """Which of signal, query and update a workflow actually answers.
+
+    Lets a caller-facing surface publish only the commands a workflow can serve. Framework-reserved
+    handlers are excluded: the reserved sets come from the SDK, so a new internal handler drops out
+    of the contract on the next bump. The SDK publishes no reserved-signal set, so every declared
+    signal belongs to the author. Raises the SDK's ``ValueError`` for a class never ``@workflow.define``d.
+    """
+    definition = workflows.get_workflow_definition(workflow_class)
+    return WorkflowCapabilities(
+        signals=tuple(handler.name for handler in definition.signals),
+        queries=tuple(handler.name for handler in definition.queries if handler.name not in RESERVED_QUERY_NAMES),
+        updates=tuple(handler.name for handler in definition.updates if handler.name not in RESERVED_UPDATE_NAMES),
+    )
+
+
+def infer_workflow_models(workflow_class: type) -> tuple[type[BaseModel], Any | None]:
+    """The request and response types a workflow's entrypoint declares.
+
+    Here rather than in a caller because it needs ``_ENTRYPOINT_MARKER``: ``WorkflowSpec``
+    publishes JSON schema, not the model classes. Raises ``ValueError`` like
+    :func:`workflow_capabilities`.
+    """
+    entrypoint = next(
+        (
+            method
+            for _, method in inspect.getmembers(workflow_class, predicate=inspect.isfunction)
+            if getattr(method, _ENTRYPOINT_MARKER, False)
+        ),
+        None,
+    )
+    if entrypoint is None:
+        raise ValueError(f"{workflow_class.__name__} has no workflow entrypoint")
+
+    original = inspect.unwrap(entrypoint)
+    hints = get_type_hints(original)
+    parameters = [parameter for name, parameter in inspect.signature(original).parameters.items() if name != "self"]
+    if len(parameters) != 1:
+        raise ValueError(f"{workflow_class.__name__} must take exactly one entrypoint argument, not {len(parameters)}")
+
+    request_type = hints.get(parameters[0].name)
+    if not inspect.isclass(request_type) or not issubclass(request_type, BaseModel):
+        raise ValueError(f"{workflow_class.__name__} entrypoint input must be a Pydantic model")
+
+    return request_type, hints.get("return")
+
+
+async def start_workflow(
+    workflow_class: type,
+    workflow_input: BaseModel,
+    *,
+    wait_for_result: bool,
+    timeout_seconds: float | None = None,
+    execution_id: str | None = None,
+) -> WorkflowRun:
+    """Start a workflow through the remote execution API.
+
+    ``exclude_unset`` matters: the input models give optional fields defaults the SDK also
+    defaults, and sending them explicitly is not the same request.
+
+    ``execution_id`` lets a caller name the execution before it exists, which makes "authorise
+    first, then start" possible. Omitted, ``_call`` drops it and the platform generates one.
+    """
+    response = await (await get_client()).workflows.execute_workflow_async(
+        **_call(
+            workflow_identifier=workflows.get_workflow_definition(workflow_class).name,
+            execution_id=execution_id,
+            input=workflow_input.model_dump(mode="json", exclude_unset=True),
+            wait_for_result=wait_for_result,
+            timeout_seconds=timeout_seconds,
+            deployment_name=workflows_env.deployment_name,
+        )
+    )
+    return WorkflowRun(execution_id=response.execution_id, result=getattr(response, "result", None))
+
+
+def _configure_worker() -> None:
+    """Point the SDK's module-level config at the app's own settings.
+
+    The SDK reads its settings from the environment when ``mistralai.workflows`` is imported,
+    which can be before ``env`` has loaded the repo-root ``.env``. Its own names differ too
+    (``SERVER_URL``), so without this the worker would poll the public host whatever
+    ``WORKFLOWS_BASE_URL`` says, and run under whatever key and queue the SDK happened to see.
+    """
+    worker = sdk_config.worker
+    worker.temporal_payload_encryption = payload_encryption()
+    # The agent client (and the telemetry endpoint derived from it) defaults to ``server_url`` at
+    # construction, so it only follows the move when nobody set it on purpose.
+    if worker.agent.mistral_client_server_url in (None, worker.server_url):
+        worker.agent.mistral_client_server_url = workflows_env.workflows_base_url
+    worker.server_url = workflows_env.workflows_base_url
+    if env.mistral_api_key:
+        sdk_config.common.mistral_api_key = SecretStr(env.mistral_api_key)
+    if workflows_env.deployment_name:
+        worker.deployment_name = _DEPLOYMENT_NAME.validate_python(workflows_env.deployment_name)
+
+
+async def run_worker(workflow_classes: list[type]) -> Any:
+    """Run the worker, configured from our own settings.
+
+    The config is assigned immediately before delegating. ``workflows.run_worker`` deep-copies it
+    on entry and restores that copy on exit. Config discovery is on, so it authenticates from
+    ``common.mistral_api_key``: its own ``api_key`` argument applies only with discovery off.
+    """
+    _configure_worker()
+    return await workflows.run_worker(workflow_classes)
+
+
+async def pause_schedule_if_present(*, schedule_id: str, note: str) -> bool:
+    """Pause an existing schedule; return False when there is nothing to pause.
+
+    Pausing rather than deleting keeps history and allows resume. A missing schedule surfaces as a
+    generic SDKError carrying a 404, not a typed not-found, so the status check is deliberate.
+    """
+    schedules = (await get_client()).workflows.schedules
+    try:
+        await schedules.pause_schedule_async(**_call(schedule_id=schedule_id, note=note))
+    except MistralError as error:
+        if getattr(error, "status_code", None) != 404:
+            raise
+        return False
+    return True
+
+
+async def upsert_schedule(
+    *,
+    schedule_id: str,
+    workflow_identifier: str,
+    input: dict[str, Any],
+    interval_seconds: int | None = None,
+    cron_expressions: list[str] | None = None,
+    pause_on_failure: bool = False,
+    deployment_name: str | None = None,
+) -> Any:
+    """Idempotently ensure a recurring workflow schedule exists and matches this config.
+
+    Timing is exactly one of ``interval_seconds`` or ``cron_expressions`` (5-field UTC cron); an
+    interval is anchored to the epoch and drifts. Re-running on every deploy converges, because the
+    platform resolves an existing ``schedule_id`` to an update. This cannot resume: no create or
+    update model carries ``paused``, so a paused schedule stays paused until a caller resumes it.
+    """
+    _validated_timing(interval_seconds, cron_expressions)
+    schedules = (await get_client()).workflows.schedules
+    return await schedules.schedule_workflow_async(
+        **_call(
+            schedule=ScheduleDefinition(
+                schedule_id=schedule_id,
+                input=input,
+                intervals=[ScheduleInterval(every=f"PT{interval_seconds}S")] if interval_seconds else [],
+                cron_expressions=cron_expressions or [],
+                policy=SchedulePolicy(
+                    overlap=ScheduleOverlapPolicy.SKIP,
+                    catchup_window_seconds=_SCHEDULE_CATCHUP_SECONDS,
+                    pause_on_failure=pause_on_failure,
+                ),
+            ),
+            workflow_identifier=workflow_identifier,
+            deployment_name=deployment_name,
+        )
+    )