tracdap-runtime 0.6.6__py3-none-any.whl → 0.7.0rc1__py3-none-any.whl

tracdap/rt/config/platform.py

@@ -1,6 +1,5 @@
 # Code generated by TRAC
 
-from __future__ import annotations
 import typing as _tp  # noqa
 import dataclasses as _dc  # noqa
 import enum as _enum  # noqa
@@ -36,124 +35,124 @@ class DeploymentLayout(_enum.Enum):
 @_dc.dataclass
 class PlatformConfig:
 
-    config: _tp.Dict[str, str] = _dc.field(default_factory=dict)
+    config: "_tp.Dict[str, str]" = _dc.field(default_factory=dict)
 
-    platformInfo: PlatformInfo = _dc.field(default_factory=lambda: PlatformInfo())
+    platformInfo: "PlatformInfo" = _dc.field(default_factory=lambda: PlatformInfo())
 
-    authentication: AuthenticationConfig = _dc.field(default_factory=lambda: AuthenticationConfig())
+    authentication: "AuthenticationConfig" = _dc.field(default_factory=lambda: AuthenticationConfig())
 
-    metadata: MetadataConfig = _dc.field(default_factory=lambda: MetadataConfig())
+    metadata: "MetadataConfig" = _dc.field(default_factory=lambda: MetadataConfig())
 
-    storage: StorageConfig = _dc.field(default_factory=lambda: StorageConfig())
+    storage: "StorageConfig" = _dc.field(default_factory=lambda: StorageConfig())
 
-    repositories: _tp.Dict[str, PluginConfig] = _dc.field(default_factory=dict)
+    repositories: "_tp.Dict[str, PluginConfig]" = _dc.field(default_factory=dict)
 
-    executor: PluginConfig = _dc.field(default_factory=lambda: PluginConfig())
+    executor: "PluginConfig" = _dc.field(default_factory=lambda: PluginConfig())
 
-    jobCache: PluginConfig = _dc.field(default_factory=lambda: PluginConfig())
+    jobCache: "PluginConfig" = _dc.field(default_factory=lambda: PluginConfig())
 
-    tenants: _tp.Dict[str, TenantConfig] = _dc.field(default_factory=dict)
+    tenants: "_tp.Dict[str, TenantConfig]" = _dc.field(default_factory=dict)
 
-    webServer: _tp.Optional[WebServerConfig] = None
+    webServer: "_tp.Optional[WebServerConfig]" = None
 
-    gateway: _tp.Optional[GatewayConfig] = None
+    gateway: "_tp.Optional[GatewayConfig]" = None
 
-    services: _tp.Dict[str, ServiceConfig] = _dc.field(default_factory=dict)
+    services: "_tp.Dict[str, ServiceConfig]" = _dc.field(default_factory=dict)
 
-    deployment: DeploymentConfig = _dc.field(default_factory=lambda: DeploymentConfig())
+    deployment: "DeploymentConfig" = _dc.field(default_factory=lambda: DeploymentConfig())
 
 
 @_dc.dataclass
 class MetadataConfig:
 
-    database: PluginConfig = _dc.field(default_factory=lambda: PluginConfig())
+    database: "PluginConfig" = _dc.field(default_factory=lambda: PluginConfig())
 
-    format: metadata.MetadataFormat = metadata.MetadataFormat.METADATA_FORMAT_NOT_SET
+    format: "metadata.MetadataFormat" = metadata.MetadataFormat.METADATA_FORMAT_NOT_SET
 
 
 @_dc.dataclass
 class TenantConfig:
 
-    defaultBucket: _tp.Optional[str] = None
+    defaultBucket: "_tp.Optional[str]" = None
 
-    defaultFormat: _tp.Optional[str] = None
+    defaultFormat: "_tp.Optional[str]" = None
 
 
 @_dc.dataclass
 class WebServerConfig:
 
-    enabled: bool = False
+    enabled: "bool" = False
 
-    contentRoot: PluginConfig = _dc.field(default_factory=lambda: PluginConfig())
+    contentRoot: "PluginConfig" = _dc.field(default_factory=lambda: PluginConfig())
 
-    rewriteRules: _tp.List[WebServerRewriteRule] = _dc.field(default_factory=list)
+    rewriteRules: "_tp.List[WebServerRewriteRule]" = _dc.field(default_factory=list)
 
-    redirects: _tp.List[WebServerRedirect] = _dc.field(default_factory=list)
+    redirects: "_tp.List[WebServerRedirect]" = _dc.field(default_factory=list)
 
 
 @_dc.dataclass
 class WebServerRewriteRule:
 
-    source: str = ""
+    source: "str" = ""
 
-    target: str = ""
+    target: "str" = ""
 
 
 @_dc.dataclass
 class WebServerRedirect:
 
-    source: str = ""
+    source: "str" = ""
 
-    target: str = ""
+    target: "str" = ""
 
-    status: int = 0
+    status: "int" = 0
 
 
 @_dc.dataclass
 class GatewayConfig:
 
-    idleTimeout: int = 0
+    idleTimeout: "int" = 0
 
-    routes: _tp.List[RouteConfig] = _dc.field(default_factory=list)
+    routes: "_tp.List[RouteConfig]" = _dc.field(default_factory=list)
 
-    redirects: _tp.List[WebServerRedirect] = _dc.field(default_factory=list)
+    redirects: "_tp.List[WebServerRedirect]" = _dc.field(default_factory=list)
 
 
 @_dc.dataclass
 class RouteConfig:
 
-    routeName: str = ""
+    routeName: "str" = ""
 
-    routeType: RoutingProtocol = RoutingProtocol.PROTOCOL_NOT_SET
+    routeType: "RoutingProtocol" = RoutingProtocol.PROTOCOL_NOT_SET
 
-    protocols: _tp.List[RoutingProtocol] = _dc.field(default_factory=list)
+    protocols: "_tp.List[RoutingProtocol]" = _dc.field(default_factory=list)
 
-    match: RoutingMatch = _dc.field(default_factory=lambda: RoutingMatch())
+    match: "RoutingMatch" = _dc.field(default_factory=lambda: RoutingMatch())
 
-    target: RoutingTarget = _dc.field(default_factory=lambda: RoutingTarget())
+    target: "RoutingTarget" = _dc.field(default_factory=lambda: RoutingTarget())
 
 
 @_dc.dataclass
 class RoutingMatch:
 
-    host: str = ""
+    host: "str" = ""
 
-    path: str = ""
+    path: "str" = ""
 
 
 @_dc.dataclass
 class RoutingTarget:
 
-    scheme: str = ""
+    scheme: "str" = ""
 
-    host: str = ""
+    host: "str" = ""
 
-    port: int = 0
+    port: "int" = 0
 
-    path: str = ""
+    path: "str" = ""
 
 
 @_dc.dataclass
 class DeploymentConfig:
 
-    layout: DeploymentLayout = DeploymentLayout.LAYOUT_NOT_SET
+    layout: "DeploymentLayout" = DeploymentLayout.LAYOUT_NOT_SET

tracdap/rt/config/result.py

@@ -1,6 +1,5 @@
 # Code generated by TRAC
 
-from __future__ import annotations
 import typing as _tp  # noqa
 import dataclasses as _dc  # noqa
 import enum as _enum  # noqa
@@ -12,16 +11,16 @@ import tracdap.rt.metadata as metadata
 @_dc.dataclass
 class TagUpdateList:
 
-    attrs: _tp.List[metadata.TagUpdate] = _dc.field(default_factory=list)
+    attrs: "_tp.List[metadata.TagUpdate]" = _dc.field(default_factory=list)
 
 
 @_dc.dataclass
 class JobResult:
 
-    jobId: metadata.TagHeader = _dc.field(default_factory=lambda: metadata.TagHeader())
+    jobId: "metadata.TagHeader" = _dc.field(default_factory=lambda: metadata.TagHeader())
 
-    statusCode: metadata.JobStatusCode = metadata.JobStatusCode.JOB_STATUS_CODE_NOT_SET
+    statusCode: "metadata.JobStatusCode" = metadata.JobStatusCode.JOB_STATUS_CODE_NOT_SET
 
-    statusMessage: str = ""
+    statusMessage: "str" = ""
 
-    results: _tp.Dict[str, metadata.ObjectDefinition] = _dc.field(default_factory=dict)
+    results: "_tp.Dict[str, metadata.ObjectDefinition]" = _dc.field(default_factory=dict)

tracdap/rt/config/runtime.py

@@ -1,6 +1,5 @@
 # Code generated by TRAC
 
-from __future__ import annotations
 import typing as _tp  # noqa
 import dataclasses as _dc  # noqa
 import enum as _enum  # noqa
@@ -12,18 +11,18 @@ from .common import *  # noqa
 @_dc.dataclass
 class RuntimeConfig:
 
-    config: _tp.Dict[str, str] = _dc.field(default_factory=dict)
+    config: "_tp.Dict[str, str]" = _dc.field(default_factory=dict)
 
-    storage: StorageConfig = _dc.field(default_factory=lambda: StorageConfig())
+    storage: "StorageConfig" = _dc.field(default_factory=lambda: StorageConfig())
 
-    repositories: _tp.Dict[str, PluginConfig] = _dc.field(default_factory=dict)
+    repositories: "_tp.Dict[str, PluginConfig]" = _dc.field(default_factory=dict)
 
-    sparkSettings: SparkSettings = _dc.field(default_factory=lambda: SparkSettings())
+    sparkSettings: "SparkSettings" = _dc.field(default_factory=lambda: SparkSettings())
 
-    runtimeApi: ServiceConfig = _dc.field(default_factory=lambda: ServiceConfig())
+    runtimeApi: "ServiceConfig" = _dc.field(default_factory=lambda: ServiceConfig())
 
 
 @_dc.dataclass
 class SparkSettings:
 
-    sparkProps: _tp.Dict[str, str] = _dc.field(default_factory=dict)
+    sparkProps: "_tp.Dict[str, str]" = _dc.field(default_factory=dict)

tracdap/rt/exceptions.py

@@ -1,8 +1,9 @@
-#  Copyright 2021 Accenture Global Solutions Limited
-#
-#  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
+#  Licensed to the Fintech Open Source Foundation (FINOS) under one or
+#  more contributor license agreements. See the NOTICE file distributed
+#  with this work for additional information regarding copyright ownership.
+#  FINOS licenses this file to you 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
 #
@@ -13,6 +14,11 @@
 #  limitations under the License.
 
 
+"""
+Error types raised by the TRAC runtime
+"""
+
+
 class ETrac(Exception):
 
     """
@@ -166,8 +172,8 @@ class EDataCorruption(EData):
     structure of the binary data stream and will be detected if that data stream cannot be
     understood.
 
-    Data corruption does not include data constraints, such as non-null or range constraints,
-    which are reported as EDataConstraint.
+    Data corruption does not include errors relating to data constraints, such as non-null
+    or range constraints, which are reported as :py:class:`EDataConformance`.
     """
 
     pass

tracdap/rt/ext/__init__.py

@@ -1,8 +1,9 @@
-#  Copyright 2022 Accenture Global Solutions Limited
-#
-#  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
+#  Licensed to the Fintech Open Source Foundation (FINOS) under one or
+#  more contributor license agreements. See the NOTICE file distributed
+#  with this work for additional information regarding copyright ownership.
+#  FINOS licenses this file to you 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
 #

tracdap/rt/ext/config.py

@@ -1,8 +1,9 @@
-#  Copyright 2024 Accenture Global Solutions Limited
-# 
-#  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
+#  Licensed to the Fintech Open Source Foundation (FINOS) under one or
+#  more contributor license agreements. See the NOTICE file distributed
+#  with this work for additional information regarding copyright ownership.
+#  FINOS licenses this file to you 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
 # 

tracdap/rt/ext/embed.py

@@ -1,8 +1,9 @@
-#  Copyright 2022 Accenture Global Solutions Limited
-#
-#  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
+#  Licensed to the Fintech Open Source Foundation (FINOS) under one or
+#  more contributor license agreements. See the NOTICE file distributed
+#  with this work for additional information regarding copyright ownership.
+#  FINOS licenses this file to you 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
 #

tracdap/rt/ext/plugins.py

@@ -1,8 +1,9 @@
-#  Copyright 2023 Accenture Global Solutions Limited
-#
-#  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
+#  Licensed to the Fintech Open Source Foundation (FINOS) under one or
+#  more contributor license agreements. See the NOTICE file distributed
+#  with this work for additional information regarding copyright ownership.
+#  FINOS licenses this file to you 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
 #

tracdap/rt/ext/repos.py

@@ -1,8 +1,9 @@
-#  Copyright 2022 Accenture Global Solutions Limited
-#
-#  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
+#  Licensed to the Fintech Open Source Foundation (FINOS) under one or
+#  more contributor license agreements. See the NOTICE file distributed
+#  with this work for additional information regarding copyright ownership.
+#  FINOS licenses this file to you 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
 #

tracdap/rt/ext/storage.py

@@ -1,8 +1,9 @@
-#  Copyright 2022 Accenture Global Solutions Limited
-#
-#  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
+#  Licensed to the Fintech Open Source Foundation (FINOS) under one or
+#  more contributor license agreements. See the NOTICE file distributed
+#  with this work for additional information regarding copyright ownership.
+#  FINOS licenses this file to you 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
 #

tracdap/rt/launch/__init__.py

@@ -1,8 +1,9 @@
-#  Copyright 2021 Accenture Global Solutions Limited
-#
-#  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
+#  Licensed to the Fintech Open Source Foundation (FINOS) under one or
+#  more contributor license agreements. See the NOTICE file distributed
+#  with this work for additional information regarding copyright ownership.
+#  FINOS licenses this file to you 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
 #
@@ -12,5 +13,9 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 
+"""
+Helper functions for launching models
+"""
+
 from .launch import launch_model
 from .launch import launch_job

tracdap/rt/launch/__main__.py

@@ -1,8 +1,9 @@
-#  Copyright 2021 Accenture Global Solutions Limited
-#
-#  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
+#  Licensed to the Fintech Open Source Foundation (FINOS) under one or
+#  more contributor license agreements. See the NOTICE file distributed
+#  with this work for additional information regarding copyright ownership.
+#  FINOS licenses this file to you 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
 #

tracdap/rt/launch/cli.py

@@ -1,8 +1,9 @@
-#  Copyright 2021 Accenture Global Solutions Limited
-#
-#  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
+#  Licensed to the Fintech Open Source Foundation (FINOS) under one or
+#  more contributor license agreements. See the NOTICE file distributed
+#  with this work for additional information regarding copyright ownership.
+#  FINOS licenses this file to you 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
 #

tracdap/rt/launch/launch.py

@@ -1,8 +1,9 @@
-#  Copyright 2022 Accenture Global Solutions Limited
-#
-#  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
+#  Licensed to the Fintech Open Source Foundation (FINOS) under one or
+#  more contributor license agreements. See the NOTICE file distributed
+#  with this work for additional information regarding copyright ownership.
+#  FINOS licenses this file to you 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
 #
@@ -68,18 +69,19 @@ def _optional_arg(launch_args: _tp.Dict[str, _tp.Any], arg_name: str) -> _tp.Any
 
 def launch_model(
         model_class: _api.TracModel.__class__,
-        job_config: _tp.Union[str, _pathlib.Path],
-        sys_config: _tp.Union[str, _pathlib.Path],
+        job_config: _tp.Union[_pathlib.Path, str],
+        sys_config: _tp.Union[_pathlib.Path, str],
         **launch_args):
 
     """
     Launch an individual model using its Python class
 
-    This launch method launches the supplied model class directly, it must be called
+    This function launches the supplied model class directly, it must be called
     from the Python codebase containing the model class. The TRAC runtime will launch
-    within the current Python process, job target and model repositories are configured
-    automatically and dev mode will be enabled. This method is mainly useful for launching
-    development and debugging runs.
+    in dev mode and execute the model inside the current Python process, a minimal
+    job definition and set of local resources will be configured automatically.
+    This method is useful for launching models during local development
+    for debugging and testing.
 
     To resolve the paths of the job and system config files, paths are tried in the
     following order:
@@ -91,7 +93,11 @@ def launch_model(
     :param model_class: The model class that will be launched
     :param job_config: Path to the job configuration file
     :param sys_config: Path to the system configuration file
-    :param launch_args: Additional keyword args to control behavior of the TRAC runtime (not normally required)
+    :param launch_args: Additional arguments to control behavior of the TRAC runtime (not normally required)
+
+    :type model_class: :py:class:`TracModel.__class__ <tracdap.rt.api.TracModel>`
+    :type job_config: :py:class:`pathlib.Path` | str
+    :type sys_config: :py:class:`pathlib.Path` | str
     """
 
     model_file = _inspect.getfile(model_class)
@@ -114,18 +120,35 @@ def launch_model(
 
 
 def launch_job(
-        job_config: _tp.Union[str, _pathlib.Path],
-        sys_config: _tp.Union[str, _pathlib.Path],
+        job_config: _tp.Union[_pathlib.Path, str],
+        sys_config: _tp.Union[_pathlib.Path, str],
         dev_mode: bool = False,
         **launch_args):
 
     """
     Launch a TRAC job using external configuration files
 
+    This function launches the job definition supplied in the job_config file,
+    which must contain enough information to describe the job along with any
+    models and other resources that it needs. It allows for running more complex
+    job types such as :py:class:`JobType.RUN_FLOW <tracdap.rt.metadata.JobType>`
+    and can be used for local development by setting dev_mode = True. If the job
+    depends on external resources, those must be specified in the sys_config file.
+
+    To resolve the paths of the job and system config files, paths are tried in the
+    following order:
+
+    1. If an absolute path is supplied, this takes priority
+    2. Resolve relative to the current working directory
+
     :param job_config: Path to the job configuration file
     :param sys_config: Path to the system configuration file
     :param dev_mode: Whether to launch in dev mode (applies dev mode translation to the job inputs)
-    :param launch_args: Additional keyword args to control behavior of the TRAC runtime (not normally required)
+    :param launch_args: Additional arguments to control behavior of the TRAC runtime (not normally required)
+
+    :type job_config: :py:class:`pathlib.Path` | str
+    :type sys_config: :py:class:`pathlib.Path` | str
+    :type dev_mode: bool
     """
 
     _sys_config = _resolve_config_file(sys_config, None)

tracdap/rt/metadata/common.py

@@ -1,6 +1,5 @@
 # Code generated by TRAC
 
-from __future__ import annotations
 import typing as _tp  # noqa
 import dataclasses as _dc  # noqa
 import enum as _enum  # noqa
@@ -49,10 +48,10 @@ class TenantInfo:
 
     """Information about a tenant that is set up on the TRAC platform."""
 
-    tenantCode: str = ""
+    tenantCode: "str" = ""
 
     """* Unique code used to identify the tenant, required by most API calls."""
 
-    description: str = ""
+    description: "str" = ""
 
     """* A short description of the tenant, suitable for displaying to users in lists."""

tracdap/rt/metadata/custom.py

@@ -1,6 +1,5 @@
 # Code generated by TRAC
 
-from __future__ import annotations
 import typing as _tp  # noqa
 import dataclasses as _dc  # noqa
 import enum as _enum  # noqa
@@ -11,8 +10,8 @@ class CustomDefinition:
 
     """Define a custom object that can be stored and managed in the TRAC metadata store"""
 
-    customSchemaType: str = ""
+    customSchemaType: "str" = ""
 
-    customSchemaVersion: int = 0
+    customSchemaVersion: "int" = 0
 
-    customData: bytes = b""
+    customData: "bytes" = b""