orchestrator-core 2.10.0rc1__py3-none-any.whl → 3.0.0rc1__py3-none-any.whl

orchestrator/devtools/scripts/migrate_30.py

@@ -0,0 +1,61 @@
+"""Helper script to rewrite import statements in your orchestrator.
+
+Since types have been externalised in `pydantic_forms`, they were re-imported in `orchestrator.types` for backwards
+compatibility. These import statements have been removed, and therefore need to be updated in orchestrator
+implementations.
+"""
+
+import sys
+from pathlib import Path
+
+from orchestrator.devtools.scripts.shared import migrate, move_import
+
+
+def migrate_file(f: Path) -> bool:
+    imports = {
+        "JSON": move_import(f, "JSON", "orchestrator.types", "pydantic_forms.types"),
+        "AcceptData": move_import(f, "AcceptData", "orchestrator.types", "pydantic_forms.types"),
+        "AcceptItemType": move_import(f, "AcceptItemType", "orchestrator.types", "pydantic_forms.types"),
+        "FormGenerator": move_import(f, "FormGenerator", "orchestrator.types", "pydantic_forms.types"),
+        "FormGeneratorAsync": move_import(f, "FormGeneratorAsync", "orchestrator.types", "pydantic_forms.types"),
+        "InputForm": move_import(f, "InputForm", "orchestrator.types", "pydantic_forms.types"),
+        "InputFormGenerator": move_import(f, "InputFormGenerator", "orchestrator.types", "pydantic_forms.types"),
+        "InputStepFunc": move_import(f, "InputStepFunc", "orchestrator.types", "pydantic_forms.types"),
+        "SimpleInputFormGenerator": move_import(
+            f, "SimpleInputFormGenerator", "orchestrator.types", "pydantic_forms.types"
+        ),
+        "State": move_import(f, "State", "orchestrator.types", "pydantic_forms.types"),
+        "StateInputFormGenerator": move_import(
+            f, "StateInputFormGenerator", "orchestrator.types", "pydantic_forms.types"
+        ),
+        "StateInputFormGeneratorAsync": move_import(
+            f, "StateInputFormGeneratorAsync", "orchestrator.types", "pydantic_forms.types"
+        ),
+        "StateInputStepFunc": move_import(f, "StateInputStepFunc", "orchestrator.types", "pydantic_forms.types"),
+        "StateSimpleInputFormGenerator": move_import(
+            f, "StateSimpleInputFormGenerator", "orchestrator.types", "pydantic_forms.types"
+        ),
+        "SubscriptionMapping": move_import(f, "SubscriptionMapping", "orchestrator.types", "pydantic_forms.types"),
+        "SummaryData": move_import(f, "SummaryData", "orchestrator.types", "pydantic_forms.types"),
+        "UUIDstr": move_import(f, "UUIDstr", "orchestrator.types", "pydantic_forms.types"),
+        "strEnum": move_import(f, "strEnum", "orchestrator.types", "pydantic_forms.types"),
+    }
+    lines = []
+    lines.extend([f"Moved {k} import" for k, v in imports.items() if v])
+
+    if lines:
+        formatted_lines = "\n".join(f" - {line}" for line in lines)
+        print(f"Updated {f.name:50s}\n{formatted_lines}")
+
+    return bool(lines)
+
+
+if __name__ == "__main__":
+    try:
+        _target_dir = Path(sys.argv[1])
+        assert _target_dir.is_dir()
+    except Exception:
+        print("Need a directory as parameter")
+        sys.exit(1)
+
+    sys.exit(0 if migrate(_target_dir, migrate_file) else 1)

orchestrator/devtools/scripts/shared.py

@@ -0,0 +1,108 @@
+import re
+from pathlib import Path
+from subprocess import run
+from typing import Callable
+
+
+def remove_imports(text: str, module: str, symbol: str) -> tuple[str, bool]:
+    """Find imports and remove them.
+
+    Assumes code is formatted through Black to keep the regex somewhat readable.
+    """
+    text_orig = text
+
+    # single import from module (may have a #comment) -> remove line
+    rgx = r"(from %s import \b%s\b(\s*#[^\n]*)*\n)" % (re.escape(module), symbol)
+    text = re.sub(rgx, "", text)
+
+    # middle or last of multiple imports from module -> strip symbol
+    rgx = r"(from %s import .+)(, \b%s\b)" % (re.escape(module), symbol)
+    text = re.sub(rgx, r"\1", text)
+
+    # first of multiple imports from same module -> strip symbol
+    rgx = r"(from %s import )\b%s\b, " % (re.escape(module), symbol)
+    text = re.sub(rgx, r"\1", text)
+
+    # multiline import -> remove line with symbol
+    rgx_verbose = r"""(?P<before>^from\s%s\simport\s*\([^\n]*\n(?:^[^\n]+,\n)*)
+                      (^\s*\b%s\b,[^\n]*\n)
+                      (?P<after>(?:^[^\n]+,\n)*\)[^\n]*$)"""
+    text = re.sub(rgx_verbose % (re.escape(module), symbol), r"\g<before>\g<after>", text, flags=re.M | re.X)
+    return text, text_orig != text
+
+
+def insert_import(text: str, import_stmt: str) -> str:
+    # Find the first import line and add our line above that
+    # Rely on ruff & black for formatting
+    return re.sub(r"(^(?:from .+|import .+)$)", f"{import_stmt}\n" + r"\1", text, count=1, flags=re.M)
+
+
+def move_import(f: Path, symbol: str, old_module: str, new_module: str) -> bool:
+    text = f.read_text()
+    text, changed = remove_imports(text, old_module, symbol)
+    if not changed:
+        return False
+    text = insert_import(text, f"from {new_module} import {symbol}")
+    with f.open(mode="w"):
+        f.write_text(text)
+    return True
+
+
+def find_and_remove_aliases(text: str, symbol: str) -> tuple[str, list[str]]:
+    """In the given text find aliases of the given symbol and remove them.
+
+    Return updated text and aliases removed.
+    """
+    rgx = r"(\b%s as (\w+))" % (symbol,)
+    aliases = [aliasgroup for fullgroup, aliasgroup in re.findall(rgx, text)]
+    newtext = re.sub(rgx, symbol, text)
+    return newtext, aliases
+
+
+def replace_words(text: str, words: list[str], replace: str) -> str:
+    rgx = r"\b(%s)\b" % ("|".join(words),)
+    return re.sub(rgx, replace, text)
+
+
+def has_word(text: str, word: str) -> bool:
+    return bool(re.search(r"\b%s\b" % (word,), text))
+
+
+def run_tool(*args: str) -> bool:
+    cmd = " ".join(args)
+    try:
+        r = run(args, capture_output=True)  # noqa: S603
+        if r.returncode == 0:
+            return True
+        print(f"{cmd} failed:", r.stdout, r.stderr)
+    except FileNotFoundError:
+        print(f"{cmd} failed: could not find executable in the current venv")
+    return False
+
+
+def migrate(target_dir: Path, migrate_file: Callable[[Path], bool]) -> bool:
+    abs_path = str(target_dir.resolve())
+
+    def run_tools() -> bool:
+        return run_tool("ruff", "check", "--fix", abs_path) and run_tool("black", "--quiet", abs_path)
+
+    print(f"\n### Verifying files in {abs_path}... ", end="")
+    if not run_tools():
+        print("Failed to verify files, aborting migration. Please resolve errors.")
+        return False
+    print("Ok")
+
+    files_migrated = files_checked = 0
+    print(f"\n### Migrating files in {abs_path}")
+    try:
+        for f in target_dir.glob("**/*.py"):
+            if migrate_file(f):
+                files_migrated += 1
+            files_checked += 1
+    except KeyboardInterrupt:
+        print("Interrupted...")
+
+    print(f"\n### Migrated {files_migrated}/{files_checked} files in {abs_path}")
+
+    print(f"\n### Formatting files in {abs_path}")
+    return run_tools()

orchestrator/domain/base.py

@@ -55,9 +55,7 @@ from orchestrator.domain.lifecycle import (
 from orchestrator.services.products import get_product_by_id
 from orchestrator.types import (
     SAFE_USED_BY_TRANSITIONS_FOR_STATUS,
-    State,
     SubscriptionLifecycle,
-    UUIDstr,
     filter_nonetype,
     get_origin_and_args,
     get_possible_product_block_types,
@@ -69,6 +67,7 @@ from orchestrator.types import (
 )
 from orchestrator.utils.datetime import nowtz
 from orchestrator.utils.docs import make_product_block_docstring, make_subscription_model_docstring
+from pydantic_forms.types import State, UUIDstr
 
 logger = structlog.get_logger(__name__)
 

orchestrator/domain/lifecycle.py

@@ -16,7 +16,8 @@ from typing import TYPE_CHECKING, TypeVar
 import strawberry
 import structlog
 
-from orchestrator.types import SubscriptionLifecycle, strEnum
+from orchestrator.types import SubscriptionLifecycle
+from pydantic_forms.types import strEnum
 
 if TYPE_CHECKING:
     from orchestrator.domain.base import DomainModel

orchestrator/migrations/helpers.py

@@ -19,7 +19,7 @@ import sqlalchemy as sa
 import structlog
 
 from orchestrator.settings import app_settings
-from orchestrator.types import UUIDstr
+from pydantic_forms.types import UUIDstr
 
 logger = structlog.get_logger(__name__)
 

orchestrator/schemas/engine_settings.py

@@ -16,7 +16,7 @@ import strawberry
 from pydantic import ConfigDict
 
 from orchestrator.schemas.base import OrchestratorBaseModel
-from orchestrator.types import strEnum
+from pydantic_forms.types import strEnum
 
 
 @strawberry.enum

orchestrator/schemas/product.py

@@ -41,3 +41,7 @@ class ProductSchema(ProductBaseSchema):
     product_blocks: list[ProductBlockSchema]
     fixed_inputs: list[FixedInputSchema]
     workflows: list[WorkflowSchema]
+
+
+class ProductPatchSchema(OrchestratorBaseModel):
+    description: str | None = None

orchestrator/schemas/product_block.py

@@ -37,3 +37,7 @@ class ProductBlockSchema(ProductBlockBaseSchema):
     end_date: datetime | None = None
     resource_types: list[ResourceTypeSchema] | None = None  # type: ignore
     model_config = ConfigDict(from_attributes=True)
+
+
+class ProductBlockPatchSchema(OrchestratorBaseModel):
+    description: str | None = None

orchestrator/schemas/resource_type.py

@@ -27,3 +27,7 @@ class ResourceTypeBaseSchema(OrchestratorBaseModel):
 class ResourceTypeSchema(ResourceTypeBaseSchema):
     resource_type_id: UUID
     model_config = ConfigDict(from_attributes=True)
+
+
+class ResourceTypePatchSchema(OrchestratorBaseModel):
+    description: str | None = None

orchestrator/schemas/subscription.py

@@ -22,7 +22,8 @@ from orchestrator.schemas.product import ProductBaseSchema
 from orchestrator.schemas.product_block import ProductBlockSchema
 from orchestrator.schemas.resource_type import ResourceTypeSchema
 from orchestrator.schemas.subscription_descriptions import SubscriptionDescriptionSchema
-from orchestrator.types import SubscriptionLifecycle, strEnum
+from orchestrator.types import SubscriptionLifecycle
+from pydantic_forms.types import strEnum
 
 
 class PortMode(strEnum):

orchestrator/schemas/workflow.py

@@ -59,3 +59,7 @@ class SubscriptionWorkflowListsSchema(OrchestratorBaseModel):
     modify: list[WorkflowListItemSchema]
     terminate: list[WorkflowListItemSchema]
     system: list[WorkflowListItemSchema]
+
+
+class WorkflowPatchSchema(OrchestratorBaseModel):
+    description: str | None = None

orchestrator/services/celery.py

@@ -24,8 +24,8 @@ from orchestrator.api.error_handling import raise_status
 from orchestrator.db import ProcessTable, db
 from orchestrator.services.processes import create_process, delete_process
 from orchestrator.targets import Target
-from orchestrator.types import State
 from orchestrator.workflows import get_workflow
+from pydantic_forms.types import State
 
 SYSTEM_USER = "SYSTEM"
 

orchestrator/services/processes.py

@@ -39,7 +39,7 @@ from orchestrator.services.settings import get_engine_settings_for_update
 from orchestrator.services.workflows import get_workflow_by_name
 from orchestrator.settings import ExecutorType, app_settings
 from orchestrator.targets import Target
-from orchestrator.types import BroadcastFunc, State
+from orchestrator.types import BroadcastFunc
 from orchestrator.utils.datetime import nowtz
 from orchestrator.utils.errors import error_state_to_dict
 from orchestrator.websocket import broadcast_invalidate_status_counts
@@ -60,6 +60,7 @@ from orchestrator.workflows import get_workflow
 from orchestrator.workflows.removed_workflow import removed_workflow
 from pydantic_forms.core import post_form
 from pydantic_forms.exceptions import FormValidationError
+from pydantic_forms.types import State
 
 logger = structlog.get_logger(__name__)
 

orchestrator/services/products.py

@@ -18,7 +18,7 @@ from sqlalchemy import select
 from sqlalchemy.orm import joinedload
 
 from orchestrator.db import ProductTable, db
-from orchestrator.types import UUIDstr
+from pydantic_forms.types import UUIDstr
 
 
 def get_products(*, filters: list | None = None) -> list[ProductTable]:

orchestrator/services/subscriptions.py

@@ -43,9 +43,10 @@ from orchestrator.db.models import (
 )
 from orchestrator.domain.base import SubscriptionModel
 from orchestrator.targets import Target
-from orchestrator.types import SubscriptionLifecycle, UUIDstr
+from orchestrator.types import SubscriptionLifecycle
 from orchestrator.utils.datetime import nowtz
 from orchestrator.utils.helpers import is_ipaddress_type
+from pydantic_forms.types import UUIDstr
 
 logger = structlog.get_logger(__name__)
 

orchestrator/services/tasks.py

@@ -30,10 +30,11 @@ from orchestrator.services.processes import (
     safe_logstep,
     thread_resume_process,
 )
-from orchestrator.types import BroadcastFunc, State
+from orchestrator.types import BroadcastFunc
 from orchestrator.utils.json import json_dumps, json_loads
 from orchestrator.workflow import ProcessStat, ProcessStatus, Success, runwf
 from orchestrator.workflows import get_workflow
+from pydantic_forms.types import State
 
 logger = get_task_logger(__name__)
 

orchestrator/settings.py

@@ -20,7 +20,7 @@ from pydantic import PostgresDsn, RedisDsn
 from pydantic_settings import BaseSettings
 
 from oauth2_lib.settings import oauth2lib_settings
-from orchestrator.types import strEnum
+from pydantic_forms.types import strEnum
 
 
 class ExecutorType(strEnum):

orchestrator/targets.py

@@ -13,7 +13,7 @@
 
 import strawberry
 
-from orchestrator.types import strEnum
+from pydantic_forms.types import strEnum
 
 
 @strawberry.enum

orchestrator/types.py

@@ -34,59 +34,24 @@ from annotated_types import Len, MaxLen, MinLen
 from more_itertools import first, last
 from pydantic.fields import FieldInfo
 
-# TODO #428: eventually enforce code migration for downstream users to import
-# these types from pydantic_forms themselves
-from pydantic_forms.types import (
-    JSON,
-    AcceptData,
-    AcceptItemType,
-    FormGenerator,
-    FormGeneratorAsync,
-    InputForm,
-    InputFormGenerator,
-    InputStepFunc,
-    SimpleInputFormGenerator,
-    State,
-    StateInputFormGenerator,
-    StateInputFormGeneratorAsync,
-    StateInputStepFunc,
-    StateSimpleInputFormGenerator,
-    SubscriptionMapping,
-    SummaryData,
-    UUIDstr,
-    strEnum,
-)
+from pydantic_forms.types import InputForm, State, strEnum
 
 __all__ = [
-    "JSON",
+    "SAFE_USED_BY_TRANSITIONS_FOR_STATUS",
     "BroadcastFunc",
-    "AcceptData",
-    "AcceptItemType",
     "ErrorDict",
     "ErrorState",
-    "FormGenerator",
-    "FormGeneratorAsync",
-    "InputForm",
-    "InputFormGenerator",
-    "InputStepFunc",
-    "SimpleInputFormGenerator",
-    "State",
-    "StateInputFormGenerator",
-    "StateInputFormGeneratorAsync",
-    "StateInputStepFunc",
-    "StateSimpleInputFormGenerator",
     "StateStepFunc",
     "StepFunc",
     "SubscriptionLifecycle",
-    "SubscriptionMapping",
-    "SummaryData",
-    "UUIDstr",
+    "filter_nonetype",
+    "get_origin_and_args",
+    "get_possible_product_block_types",
     "is_list_type",
     "is_of_type",
     "is_optional_type",
     "is_union_type",
-    "get_possible_product_block_types",
-    "strEnum",
+    "list_factory",
 ]
 
 if TYPE_CHECKING:
@@ -97,8 +62,8 @@ def is_union(tp: type[Any] | None) -> bool:
     return tp is Union or tp is types.UnionType  # type: ignore[comparison-overlap]
 
 
-# ErrorState is either a string containing an error message, a catched Exception or a tuple containing a message and
-# a HTTP status code
+# ErrorState is either a string containing an error message, a caught Exception, or a tuple containing a message and
+# an HTTP status code
 ErrorState = Union[str, Exception, tuple[str, Union[int, HTTPStatus]]]
 # An ErrorDict should have the following keys:
 # error: str  # A message describing the error

orchestrator/utils/errors.py

@@ -18,7 +18,8 @@ from typing import Any, cast
 import structlog
 
 from nwastdlib.ex import show_ex
-from orchestrator.types import JSON, ErrorDict
+from orchestrator.types import ErrorDict
+from pydantic_forms.types import JSON
 
 logger = structlog.get_logger(__name__)
 

orchestrator/utils/state.py

@@ -19,7 +19,7 @@ from typing import Any, cast, get_args
 from uuid import UUID
 
 from orchestrator.domain.base import SubscriptionModel
-from orchestrator.types import State, StepFunc, is_list_type, is_optional_type
+from orchestrator.types import StepFunc, is_list_type, is_optional_type
 from orchestrator.utils.functional import logger
 from pydantic_forms.types import (
     FormGenerator,
@@ -27,6 +27,7 @@ from pydantic_forms.types import (
     InputFormGenerator,
     InputStepFunc,
     SimpleInputFormGenerator,
+    State,
     StateInputStepFunc,
 )
 

orchestrator/workflow.py

@@ -43,7 +43,7 @@ from orchestrator.config.assignee import Assignee
 from orchestrator.db import db, transactional
 from orchestrator.services.settings import get_engine_settings
 from orchestrator.targets import Target
-from orchestrator.types import ErrorDict, State, StepFunc, strEnum
+from orchestrator.types import ErrorDict, StepFunc
 from orchestrator.utils.docs import make_workflow_doc
 from orchestrator.utils.errors import error_state_to_dict
 from orchestrator.utils.state import form_inject_args, inject_args
@@ -52,9 +52,11 @@ from pydantic_forms.types import (
     FormGenerator,
     InputFormGenerator,
     InputStepFunc,
+    State,
     StateInputFormGenerator,
     StateInputStepFunc,
     StateSimpleInputFormGenerator,
+    strEnum,
 )
 
 logger = structlog.get_logger(__name__)

orchestrator/workflows/modify_note.py

@@ -15,12 +15,11 @@ from orchestrator.forms import SubmitFormPage
 from orchestrator.services import subscriptions
 from orchestrator.settings import app_settings
 from orchestrator.targets import Target
-from orchestrator.types import UUIDstr
 from orchestrator.utils.json import to_serializable
 from orchestrator.workflow import StepList, conditional, done, init, step, workflow
 from orchestrator.workflows.steps import cache_domain_models, store_process_subscription
 from orchestrator.workflows.utils import wrap_modify_initial_input_form
-from pydantic_forms.types import FormGenerator, State
+from pydantic_forms.types import FormGenerator, State, UUIDstr
 from pydantic_forms.validators import LongText
 
 

orchestrator/workflows/steps.py

@@ -23,11 +23,12 @@ from orchestrator.domain.base import ProductBlockModel, SubscriptionModel
 from orchestrator.services.settings import reset_search_index
 from orchestrator.services.subscriptions import build_extended_domain_model, get_subscription
 from orchestrator.targets import Target
-from orchestrator.types import State, SubscriptionLifecycle, UUIDstr
+from orchestrator.types import SubscriptionLifecycle
 from orchestrator.utils.json import to_serializable
 from orchestrator.utils.redis import delete_from_redis, to_redis
 from orchestrator.websocket import sync_invalidate_subscription_cache
 from orchestrator.workflow import Step, step
+from pydantic_forms.types import State, UUIDstr
 
 logger = structlog.get_logger(__name__)
 

orchestrator/workflows/tasks/cleanup_tasks_log.py

@@ -19,9 +19,9 @@ from sqlalchemy import select
 from orchestrator.db import ProcessTable, db
 from orchestrator.settings import app_settings
 from orchestrator.targets import Target
-from orchestrator.types import State
 from orchestrator.utils.datetime import nowtz
 from orchestrator.workflow import ProcessStatus, StepList, done, init, step, workflow
+from pydantic_forms.types import State
 
 
 @step("Clean up completed tasks older than TASK_LOG_RETENTION_DAYS")

orchestrator/workflows/tasks/resume_workflows.py

@@ -18,8 +18,8 @@ from sqlalchemy import select
 from orchestrator.db import ProcessTable, db
 from orchestrator.services import processes
 from orchestrator.targets import Target
-from orchestrator.types import State, UUIDstr
 from orchestrator.workflow import ProcessStatus, StepList, done, init, step, workflow
+from pydantic_forms.types import State, UUIDstr
 
 logger = structlog.get_logger(__name__)
 

orchestrator/workflows/tasks/validate_product_type.py

@@ -26,8 +26,8 @@ from orchestrator.services.workflows import (
     start_validation_workflow_for_workflows,
 )
 from orchestrator.targets import Target
-from orchestrator.types import FormGenerator, State
 from orchestrator.workflow import StepList, done, init, step, workflow
+from pydantic_forms.types import FormGenerator, State
 
 logger = structlog.get_logger(__name__)
 

orchestrator/workflows/tasks/validate_products.py

@@ -27,10 +27,10 @@ from orchestrator.services.products import get_products
 from orchestrator.services.translations import generate_translations
 from orchestrator.services.workflows import get_workflow_by_name, get_workflows
 from orchestrator.targets import Target
-from orchestrator.types import State
 from orchestrator.utils.errors import ProcessFailureError
 from orchestrator.utils.fixed_inputs import fixed_input_configuration as fi_configuration
 from orchestrator.workflow import StepList, done, init, step, workflow
+from pydantic_forms.types import State
 
 # Since these errors are probably programming failures we should not throw AssertionErrors
 

orchestrator/workflows/utils.py

@@ -25,7 +25,7 @@ from orchestrator.forms.validators import ProductId
 from orchestrator.services import subscriptions
 from orchestrator.settings import app_settings
 from orchestrator.targets import Target
-from orchestrator.types import State, SubscriptionLifecycle
+from orchestrator.types import SubscriptionLifecycle
 from orchestrator.utils.errors import StaleDataError
 from orchestrator.utils.redis import caching_models_enabled
 from orchestrator.utils.state import form_inject_args
@@ -41,7 +41,7 @@ from orchestrator.workflows.steps import (
     unsync_unchecked,
 )
 from pydantic_forms.core import FormPage
-from pydantic_forms.types import FormGenerator, InputForm, InputStepFunc, StateInputStepFunc
+from pydantic_forms.types import FormGenerator, InputForm, InputStepFunc, State, StateInputStepFunc
 
 
 def _generate_new_subscription_form(_workflow_target: str, workflow_name: str) -> InputForm:

{orchestrator_core-2.10.0rc1.dist-info → orchestrator_core-3.0.0rc1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: orchestrator-core
-Version: 2.10.0rc1
+Version: 3.0.0rc1
 Summary: This is the orchestrator workflow engine.
 Requires-Python: >=3.11,<3.14
 Classifier: Intended Audience :: Information Technology