tracdap-runtime 0.6.2__py3-none-any.whl → 0.6.4__py3-none-any.whl

tracdap/rt/api/static_api.py

@@ -14,6 +14,7 @@
 
 from __future__ import annotations
 
+import sys
 import typing as _tp
 import types as _ts
 
@@ -111,7 +112,8 @@ def A(  # noqa
 
 def define_parameter(
         param_name: str, param_type: _tp.Union[TypeDescriptor, BasicType],
-        label: str, default_value: _tp.Optional[_tp.Any] = None) \
+        label: str, default_value: _tp.Optional[_tp.Any] = None,
+        *, param_props: _tp.Optional[_tp.Dict[str, _tp.Any]] = None) \
         -> _Named[ModelParameter]:
 
     """
@@ -128,6 +130,10 @@ def define_parameter(
     the model. TRAC will apply type coercion where possible to ensure the default value matches the parameter type,
     if the default value cannot be coerced to match the parameter type then model validation will fail.
 
+    You can use param_props to associate arbitrary key-value properties with this model parameter.
+    These properties are not used by the TRAC engine, but are stored in the model metadata for
+    the parameter and can be used as needed in 3rd-party applications.
+
     Once defined model parameters can be passed to :py:func:`define_parameters`,
     either as a list or as individual arguments, to create the set of parameters for a model.
 
@@ -135,6 +141,7 @@ def define_parameter(
     :param param_type: The parameter type, expressed in the TRAC type system
     :param label: A descriptive label for the parameter (required)
     :param default_value: A default value to use if no explicit value is supplied (optional)
+    :param param_props: Associate key-value properties with this parameter (not used by the TRAC engine)
     :return: A named model parameter, suitable for passing to :py:func:`define_parameters`
 
     :type param_name: str
@@ -142,11 +149,12 @@ def define_parameter(
                       :py:class:`BasicType <tracdap.rt.metadata.BasicType>`
     :type label: str
     :type default_value: Optional[Any]
+    :type param_props: Optional[Dict[str, Any]]
     :rtype: _Named[:py:class:`ModelParameter <tracdap.rt.metadata.ModelParameter>`]
     """
 
     sa = _StaticApiHook.get_instance()
-    return sa.define_parameter(param_name, param_type, label, default_value)
+    return sa.define_parameter(param_name, param_type, label, default_value, param_props=param_props)
 
 
 def declare_parameter(
@@ -160,6 +168,9 @@ def declare_parameter(
     .. deprecated:: 0.4.4
        Use :py:func:`define_parameter` or :py:func:`P` instead.
 
+    This function is deprecated and will be removed in a future version.
+    Please use :py:func:`define_parameter() <tracdap.rt.api.define_parameter>` instead.
+
     :type param_name: str
     :type param_type: :py:class:`TypeDescriptor <tracdap.rt.metadata.TypeDescriptor>` |
                       :py:class:`BasicType <tracdap.rt.metadata.BasicType>`
@@ -168,6 +179,8 @@ def declare_parameter(
     :rtype: _Named[:py:class:`ModelParameter <tracdap.rt.metadata.ModelParameter>`]
     """
 
+    print("TRAC Warning: declare_parameter() is deprecated, please use define_parameter()", file=sys.stderr)
+
     return define_parameter(param_name, param_type, label, default_value)
 
 
@@ -175,7 +188,8 @@ def P(  # noqa
         param_name: str,
         param_type: _tp.Union[TypeDescriptor, BasicType],
         label: str,
-        default_value: _tp.Optional[_tp.Any] = None) \
+        default_value: _tp.Optional[_tp.Any] = None,
+        *, param_props: _tp.Optional[_tp.Dict[str, _tp.Any]] = None) \
         -> _Named[ModelParameter]:
 
     """
@@ -186,12 +200,11 @@ def P(  # noqa
                       :py:class:`BasicType <tracdap.rt.metadata.BasicType>`
     :type label: str
     :type default_value: Optional[Any]
+    :type param_props: Optional[Dict[str, Any]]
     :rtype: _Named[:py:class:`ModelParameter <tracdap.rt.metadata.ModelParameter>`]
     """
 
-    return declare_parameter(
-        param_name, param_type, label,
-        default_value)
+    return define_parameter(param_name, param_type, label, default_value, param_props=param_props)
 
 
 def define_parameters(
@@ -226,11 +239,16 @@ def declare_parameters(
     .. deprecated:: 0.4.4
        Use :py:func:`define_parameters` instead.
 
+    This function is deprecated and will be removed in a future version.
+    Please use :py:func:`define_parameters() <tracdap.rt.api.define_parameters>` instead.
+
     :type params: _Named[:py:class:`ModelParameter <tracdap.rt.metadata.ModelParameter>`] |
                   List[_Named[:py:class:`ModelParameter <tracdap.rt.metadata.ModelParameter>`]]
     :rtype: Dict[str, :py:class:`ModelParameter <tracdap.rt.metadata.ModelParameter>`]
     """
 
+    print("TRAC Warning: declare_parameters() is deprecated, please use define_parameters()", file=sys.stderr)
+
     return define_parameters(*params)
 
 
@@ -278,9 +296,9 @@ def define_field(
     :type label: str
     :type business_key: bool
     :type categorical: bool
-    :type not_null: _tp.Optional[bool]
-    :type format_code: _tp.Optional[str]
-    :type field_order: _tp.Optional[int]
+    :type not_null: Optional[bool]
+    :type format_code: Optional[str]
+    :type field_order: Optional[int]
     :rtype: :py:class:`FieldSchema <tracdap.rt.metadata.FieldSchema>`
     """
 
@@ -307,17 +325,22 @@ def declare_field(
     .. deprecated:: 0.4.4
        Use :py:func:`define_field` or :py:func:`F` instead.
 
+    This function is deprecated and will be removed in a future version.
+    Please use :py:func:`define_field() <tracdap.rt.api.define_field>` instead.
+
     :type field_name: str
     :type field_type: :py:class:`BasicType <tracdap.rt.metadata.BasicType>`
     :type label: str
     :type business_key: bool
     :type categorical: bool
-    :type not_null: _tp.Optional[bool]
-    :type format_code: _tp.Optional[str]
-    :type field_order: _tp.Optional[int]
+    :type not_null: Optional[bool]
+    :type format_code: Optional[str]
+    :type field_order: Optional[int]
     :rtype: :py:class:`FieldSchema <tracdap.rt.metadata.FieldSchema>`
     """
 
+    print("TRAC Warning: declare_field() is deprecated, please use define_field()", file=sys.stderr)
+
     return define_field(
         field_name, field_type, label,
         business_key, categorical, not_null,
@@ -343,9 +366,9 @@ def F(  # noqa
     :type label: str
     :type business_key: bool
     :type categorical: bool
-    :type not_null: _tp.Optional[bool]
-    :type format_code: _tp.Optional[str]
-    :type field_order: _tp.Optional[int]
+    :type not_null: Optional[bool]
+    :type format_code: Optional[str]
+    :type field_order: Optional[int]
     :rtype: :py:class:`FieldSchema <tracdap.rt.metadata.FieldSchema>`
     """
 
@@ -428,8 +451,8 @@ def load_schema(
 
 def define_input_table(
         *fields: _tp.Union[FieldSchema, _tp.List[FieldSchema]],
-        label: _tp.Optional[str] = None,
-        optional: bool = False) \
+        label: _tp.Optional[str] = None, optional: bool = False, dynamic: bool = False,
+        input_props: _tp.Optional[_tp.Dict[str, _tp.Any]] = None) \
         -> ModelInputSchema:
 
     """
@@ -438,20 +461,31 @@ def define_input_table(
     Fields can be supplied either as individual arguments to this function or as a list.
     Individual fields should be defined using :py:func:`define_field` or the shorthand alias :py:func:`F`.
 
+    You can use input_props to associate arbitrary key-value properties with this model input.
+    These properties are not used by the TRAC engine, but are stored in the model metadata for
+    the input and can be used as needed in 3rd-party applications.
+
     :param fields: A set of fields to make up a :py:class:`TableSchema <tracdap.rt.metadata.TableSchema>`
     :param label: An optional label (of type str) for a model input schema. Default value: None.
     :param optional: Mark this input as an optional model input
+    :param dynamic: Mark this input as a dynamic model input (the list of fields must be empty)
+    :param input_props: Associate key-value properties with this input (not used by the TRAC engine)
     :return: A model input schema, suitable for returning from :py:meth:`TracModel.define_inputs`
 
     :type fields: :py:class:`FieldSchema <tracdap.rt.metadata.FieldSchema>` |
                   List[:py:class:`FieldSchema <tracdap.rt.metadata.FieldSchema>`]
-    :type label: _tp.Optional[str]
+    :type label: Optional[str]
     :type optional: bool
+    :type dynamic: bool
+    :type input_props: Optional[Dict[str, Any]]
     :rtype: :py:class:`ModelInputSchema <tracdap.rt.metadata.ModelInputSchema>`
     """
 
     sa = _StaticApiHook.get_instance()
-    return sa.define_input_table(*fields, label=label, optional=optional)
+
+    return sa.define_input_table(
+        *fields, label=label, optional=optional, dynamic=dynamic,
+        input_props=input_props)
 
 
 def declare_input_table(
@@ -462,18 +496,23 @@ def declare_input_table(
     .. deprecated:: 0.4.4
        Use :py:func:`define_input_table` instead.
 
+    This function is deprecated and will be removed in a future version.
+    Please use :py:func:`define_input_table() <tracdap.rt.api.define_input_table>` instead.
+
     :type fields: :py:class:`FieldSchema <tracdap.rt.metadata.FieldSchema>` |
                   List[:py:class:`FieldSchema <tracdap.rt.metadata.FieldSchema>`]
     :rtype: :py:class:`ModelInputSchema <tracdap.rt.metadata.ModelInputSchema>`
     """
 
+    print("TRAC Warning: declare_input_table() is deprecated, please use define_input_table()", file=sys.stderr)
+
     return define_input_table(*fields)
 
 
 def define_output_table(
         *fields: _tp.Union[FieldSchema, _tp.List[FieldSchema]],
-        label: _tp.Optional[str] = None,
-        optional: bool = False) \
+        label: _tp.Optional[str] = None, optional: bool = False, dynamic: bool = False,
+        output_props: _tp.Optional[_tp.Dict[str, _tp.Any]] = None) \
         -> ModelOutputSchema:
 
     """
@@ -482,20 +521,31 @@ def define_output_table(
     Fields can be supplied either as individual arguments to this function or as a list.
     Individual fields should be defined using :py:func:`define_field` or the shorthand alias :py:func:`F`.
 
+    You can use output_props to associate arbitrary key-value properties with this model output.
+    These properties are not used by the TRAC engine, but are stored in the model metadata for
+    the output and can be used as needed in 3rd-party applications.
+
     :param fields: A set of fields to make up a :py:class:`TableSchema <tracdap.rt.metadata.TableSchema>`
     :param label: An optional label (of type str) for a model output schema. Default value: None.
     :param optional: Mark this output as an optional model output
+    :param dynamic: Mark this output as a dynamic model output (the list of fields must be empty)
+    :param output_props: Associate key-value properties with this output (not used by the TRAC engine)
     :return: A model output schema, suitable for returning from :py:meth:`TracModel.define_outputs`
 
     :type fields: :py:class:`FieldSchema <tracdap.rt.metadata.FieldSchema>` |
                   List[:py:class:`FieldSchema <tracdap.rt.metadata.FieldSchema>`]
-    :type label: _tp.Optional[str]
+    :type label: Optional[str]
     :type optional: bool
+    :type dynamic: bool
+    :type output_props: Optional[Dict[str, Any]]
     :rtype: :py:class:`ModelOutputSchema <tracdap.rt.metadata.ModelOutputSchema>`
     """
 
     sa = _StaticApiHook.get_instance()
-    return sa.define_output_table(*fields, label=label, optional=optional)
+
+    return sa.define_output_table(
+        *fields, label=label, optional=optional, dynamic=dynamic,
+        output_props=output_props)
 
 
 def declare_output_table(
@@ -506,9 +556,17 @@ def declare_output_table(
     .. deprecated:: 0.4.4
        Use :py:func:`define_output_table` instead.
 
+    This function is deprecated and will be removed in a future version.
+    Please use :py:func:`define_output_table() <tracdap.rt.api.define_output_table>` instead.
+
+    This function is deprecated and will be removed in a future version.
+    Please use define_output_table() instead.
+
     :type fields: :py:class:`FieldSchema <tracdap.rt.metadata.FieldSchema>` |
                   List[:py:class:`FieldSchema <tracdap.rt.metadata.FieldSchema>`]
     :rtype: :py:class:`ModelOutputSchema <tracdap.rt.metadata.ModelOutputSchema>`
     """
 
+    print("TRAC Warning: declare_output_table() is deprecated, please use define_output_table()", file==sys.stderr)
+
     return define_output_table(*fields)

tracdap/rt/config/__init__.py

@@ -5,13 +5,11 @@ from .common import PluginConfig
 from .common import PlatformInfo
 from .common import AuthenticationConfig
 from .common import StorageConfig
+from .common import ServiceConfig
 
 from .runtime import RuntimeConfig
 from .runtime import SparkSettings
 
-from .result import TagUpdateList
-from .result import JobResult
-
 from .platform import RoutingProtocol
 from .platform import DeploymentLayout
 from .platform import PlatformConfig
@@ -24,7 +22,9 @@ from .platform import GatewayConfig
 from .platform import RouteConfig
 from .platform import RoutingMatch
 from .platform import RoutingTarget
-from .platform import ServiceConfig
 from .platform import DeploymentConfig
 
 from .job import JobConfig
+
+from .result import TagUpdateList
+from .result import JobResult

tracdap/rt/config/common.py

@@ -15,7 +15,7 @@ class _ConfigFile:
 @_dc.dataclass
 class PluginConfig:
 
-    protocol: str = None
+    protocol: str = ""
 
     properties: _tp.Dict[str, str] = _dc.field(default_factory=dict)
 
@@ -25,9 +25,9 @@ class PluginConfig:
 @_dc.dataclass
 class PlatformInfo:
 
-    environment: str = None
+    environment: str = ""
 
-    production: bool = None
+    production: bool = False
 
     deploymentInfo: _tp.Dict[str, str] = _dc.field(default_factory=dict)
 
@@ -35,27 +35,27 @@ class PlatformInfo:
 @_dc.dataclass
 class AuthenticationConfig:
 
-    jwtIssuer: str = None
+    jwtIssuer: str = ""
 
-    jwtExpiry: int = None
+    jwtExpiry: int = 0
 
-    jwtLimit: int = None
+    jwtLimit: int = 0
 
-    jwtRefresh: int = None
+    jwtRefresh: int = 0
 
     provider: _tp.Optional[PluginConfig] = None
 
-    disableAuth: bool = None
+    disableAuth: bool = False
 
-    disableSigning: bool = None
+    disableSigning: bool = False
 
-    systemUserId: str = None
+    systemUserId: str = ""
 
-    systemUserName: str = None
+    systemUserName: str = ""
 
-    systemTicketDuration: int = None
+    systemTicketDuration: int = 0
 
-    systemTicketRefresh: int = None
+    systemTicketRefresh: int = 0
 
 
 @_dc.dataclass
@@ -63,6 +63,16 @@ class StorageConfig:
 
     buckets: _tp.Dict[str, PluginConfig] = _dc.field(default_factory=dict)
 
-    defaultBucket: str = None
+    defaultBucket: str = ""
 
-    defaultFormat: str = None
+    defaultFormat: str = ""
+
+
+@_dc.dataclass
+class ServiceConfig:
+
+    enabled: _tp.Optional[bool] = None
+
+    alias: str = ""
+
+    port: int = 0

tracdap/rt/config/job.py

@@ -12,9 +12,9 @@ import tracdap.rt.metadata as metadata
 @_dc.dataclass
 class JobConfig:
 
-    jobId: metadata.TagHeader = None
+    jobId: metadata.TagHeader = _dc.field(default_factory=lambda: metadata.TagHeader())
 
-    job: metadata.JobDefinition = None
+    job: metadata.JobDefinition = _dc.field(default_factory=lambda: metadata.JobDefinition())
 
     resources: _tp.Dict[str, metadata.ObjectDefinition] = _dc.field(default_factory=dict)
 

tracdap/rt/config/platform.py

@@ -38,19 +38,19 @@ class PlatformConfig:
 
     config: _tp.Dict[str, str] = _dc.field(default_factory=dict)
 
-    platformInfo: PlatformInfo = None
+    platformInfo: PlatformInfo = _dc.field(default_factory=lambda: PlatformInfo())
 
-    authentication: AuthenticationConfig = None
+    authentication: AuthenticationConfig = _dc.field(default_factory=lambda: AuthenticationConfig())
 
-    metadata: MetadataConfig = None
+    metadata: MetadataConfig = _dc.field(default_factory=lambda: MetadataConfig())
 
-    storage: StorageConfig = None
+    storage: StorageConfig = _dc.field(default_factory=lambda: StorageConfig())
 
     repositories: _tp.Dict[str, PluginConfig] = _dc.field(default_factory=dict)
 
-    executor: PluginConfig = None
+    executor: PluginConfig = _dc.field(default_factory=lambda: PluginConfig())
 
-    jobCache: PluginConfig = None
+    jobCache: PluginConfig = _dc.field(default_factory=lambda: PluginConfig())
 
     tenants: _tp.Dict[str, TenantConfig] = _dc.field(default_factory=dict)
 
@@ -60,13 +60,13 @@ class PlatformConfig:
 
     services: _tp.Dict[str, ServiceConfig] = _dc.field(default_factory=dict)
 
-    deployment: DeploymentConfig = None
+    deployment: DeploymentConfig = _dc.field(default_factory=lambda: DeploymentConfig())
 
 
 @_dc.dataclass
 class MetadataConfig:
 
-    database: PluginConfig = None
+    database: PluginConfig = _dc.field(default_factory=lambda: PluginConfig())
 
     format: metadata.MetadataFormat = metadata.MetadataFormat.METADATA_FORMAT_NOT_SET
 
@@ -82,9 +82,9 @@ class TenantConfig:
 @_dc.dataclass
 class WebServerConfig:
 
-    enabled: bool = None
+    enabled: bool = False
 
-    contentRoot: PluginConfig = None
+    contentRoot: PluginConfig = _dc.field(default_factory=lambda: PluginConfig())
 
     rewriteRules: _tp.List[WebServerRewriteRule] = _dc.field(default_factory=list)
 
@@ -94,25 +94,25 @@ class WebServerConfig:
 @_dc.dataclass
 class WebServerRewriteRule:
 
-    source: str = None
+    source: str = ""
 
-    target: str = None
+    target: str = ""
 
 
 @_dc.dataclass
 class WebServerRedirect:
 
-    source: str = None
+    source: str = ""
 
-    target: str = None
+    target: str = ""
 
-    status: int = None
+    status: int = 0
 
 
 @_dc.dataclass
 class GatewayConfig:
 
-    idleTimeout: int = None
+    idleTimeout: int = 0
 
     routes: _tp.List[RouteConfig] = _dc.field(default_factory=list)
 
@@ -122,45 +122,35 @@ class GatewayConfig:
 @_dc.dataclass
 class RouteConfig:
 
-    routeName: str = None
+    routeName: str = ""
 
     routeType: RoutingProtocol = RoutingProtocol.PROTOCOL_NOT_SET
 
     protocols: _tp.List[RoutingProtocol] = _dc.field(default_factory=list)
 
-    match: RoutingMatch = None
+    match: RoutingMatch = _dc.field(default_factory=lambda: RoutingMatch())
 
-    target: RoutingTarget = None
+    target: RoutingTarget = _dc.field(default_factory=lambda: RoutingTarget())
 
 
 @_dc.dataclass
 class RoutingMatch:
 
-    host: str = None
+    host: str = ""
 
-    path: str = None
+    path: str = ""
 
 
 @_dc.dataclass
 class RoutingTarget:
 
-    scheme: str = None
+    scheme: str = ""
 
-    host: str = None
+    host: str = ""
 
-    port: int = None
+    port: int = 0
 
-    path: str = None
-
-
-@_dc.dataclass
-class ServiceConfig:
-
-    enabled: _tp.Optional[bool] = None
-
-    alias: str = None
-
-    port: int = None
+    path: str = ""
 
 
 @_dc.dataclass

tracdap/rt/config/result.py

@@ -18,10 +18,10 @@ class TagUpdateList:
 @_dc.dataclass
 class JobResult:
 
-    jobId: metadata.TagHeader = None
+    jobId: metadata.TagHeader = _dc.field(default_factory=lambda: metadata.TagHeader())
 
     statusCode: metadata.JobStatusCode = metadata.JobStatusCode.JOB_STATUS_CODE_NOT_SET
 
-    statusMessage: str = None
+    statusMessage: str = ""
 
     results: _tp.Dict[str, metadata.ObjectDefinition] = _dc.field(default_factory=dict)

tracdap/rt/config/runtime.py

@@ -14,11 +14,13 @@ class RuntimeConfig:
 
     config: _tp.Dict[str, str] = _dc.field(default_factory=dict)
 
-    storage: StorageConfig = None
+    storage: StorageConfig = _dc.field(default_factory=lambda: StorageConfig())
 
     repositories: _tp.Dict[str, PluginConfig] = _dc.field(default_factory=dict)
 
-    sparkSettings: SparkSettings = None
+    sparkSettings: SparkSettings = _dc.field(default_factory=lambda: SparkSettings())
+
+    runtimeApi: ServiceConfig = _dc.field(default_factory=lambda: ServiceConfig())
 
 
 @_dc.dataclass

tracdap/rt/ext/config.py

@@ -0,0 +1,34 @@
+#  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
+# 
+#      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.
+
+import abc as _abc
+
+
+class IConfigLoader:
+
+    @_abc.abstractmethod
+    def has_config_file(self, config_url: str) -> bool:
+        pass
+
+    @_abc.abstractmethod
+    def load_config_file(self, config_url: str) -> bytes:
+        pass
+
+    @_abc.abstractmethod
+    def has_config_dict(self, config_url: str) -> bool:
+        pass
+
+    @_abc.abstractmethod
+    def load_config_dict(self, config_url: str) -> dict:
+        pass

tracdap/rt/ext/embed.py

@@ -13,9 +13,7 @@
 #  limitations under the License.
 
 import tracdap.rt.config as _cfg
-import tracdap.rt.ext._guard as _guard
-
-# Dependency back into the main runtime implementation
+import tracdap.rt._impl.guard_rails as _guard  # noqa
 import tracdap.rt._exec.runtime as _rt  # noqa