tracdap-runtime 0.8.0b3__py3-none-any.whl → 0.8.0rc1__py3-none-any.whl

tracdap/rt/api/experimental.py

@@ -70,6 +70,8 @@ PANDAS = DataFramework.pandas()
 POLARS = DataFramework.polars()
 """Data framework constant for the Polars data library"""
 
+STRUCT_TYPE = _tp.TypeVar('STRUCT_TYPE')
+
 
 class TracContext(TracContext):
 
@@ -83,6 +85,14 @@ class TracContext(TracContext):
 
         pass
 
+    def get_struct(self, struct_name: str, python_class: _tp.Type[STRUCT_TYPE]) -> STRUCT_TYPE:
+
+        pass
+
+    def put_struct(self, struct_name: str, struct_data: STRUCT_TYPE):
+
+        pass
+
 
 def init_static():
     """Ensure TRAC's static model API is available to use (for static definitions at module or class scope)"""
@@ -108,6 +118,28 @@ def map_type(entry_type: BasicType) -> TypeDescriptor:
     return sa.map_type(entry_type)
 
 
+def define_struct(python_type: _tp.Type[STRUCT_TYPE]) -> SchemaDefinition:
+    """Build schema definition for a STRUCT"""
+    sa = _StaticApiHook.get_instance()
+    return sa.define_struct(python_type)
+
+def define_input_struct(
+        python_type: _tp.Type[STRUCT_TYPE], *,
+        label: _tp.Optional[str] = None, optional: bool = False,
+        input_props: _tp.Optional[_tp.Dict[str, _tp.Any]] = None) -> ModelInputSchema:
+
+    schema = define_struct(python_type)
+    return define_input(schema, label=label, optional=optional, input_props=input_props)
+
+def define_output_struct(
+        python_type: _tp.Type[STRUCT_TYPE], *,
+        label: _tp.Optional[str] = None, optional: bool = False,
+        output_props: _tp.Optional[_tp.Dict[str, _tp.Any]] = None) -> ModelOutputSchema:
+
+    schema = define_struct(python_type)
+    return define_output(schema, label=label, optional=optional, output_props=output_props)
+
+
 class FileType(_enum.Enum):
 
     FILE = 1

tracdap/rt/api/hook.py

@@ -121,6 +121,11 @@ class _StaticApiHook:
 
         pass
 
+    @_abc.abstractmethod
+    def define_struct(self, python_type: type) -> _meta.SchemaDefinition:
+
+        pass
+
     @_abc.abstractmethod
     def load_schema(
             self, package: _tp.Union[_ts.ModuleType, str], schema_file: str,
@@ -158,3 +163,9 @@ class _StaticApiHook:
             -> _meta.ModelOutputSchema:
 
         pass
+
+X = _tp.TypeVar("X")
+
+def do_x(x: type[X]) -> X:
+
+    return x.__new__(x)

tracdap/rt/api/static_api.py

@@ -384,6 +384,14 @@ def load_schema(
 
 def define_file_type(extension: str, mime_type: str) -> FileType:
 
+    """
+    Define a :py:class:`FileType <tracdap.rt.metadata.FileType>` for use as a model input or output
+
+    :type extension: str
+    :type mime_type: str
+    :rtype: :py:class:`FileType <tracdap.rt.metadata.FileType>`
+    """
+
     sa = _StaticApiHook.get_instance()
     return sa.define_file_type(extension, mime_type)
 
@@ -394,6 +402,17 @@ def define_input(
         optional: bool = False, dynamic: bool = False,
         input_props: _tp.Optional[_tp.Dict[str, _tp.Any]] = None):
 
+    """
+    Define a model input, which can be any type of dataset or file
+
+    :type requirement: :py:class:`SchemaDefinition <tracdap.rt.metadata.SchemaDefinition>` | :py:class:`FileType <tracdap.rt.metadata.FileType>`
+    :type label: str | None
+    :type optional: bool
+    :type dynamic: bool
+    :type input_props: dict[str, :py:class:`Value <tracdap.rt.metadata.Value>`
+    :rtype: :py:class:`ModelInputSchema <tracdap.rt.metadata.ModelInputSchema>`
+    """
+
     sa = _StaticApiHook.get_instance()
     return sa.define_input(requirement, label=label, optional=optional, dynamic=dynamic, input_props=input_props)
 
@@ -404,6 +423,17 @@ def define_output(
         optional: bool = False, dynamic: bool = False,
         output_props: _tp.Optional[_tp.Dict[str, _tp.Any]] = None):
 
+    """
+    Define a model output, which can be any type of dataset or file
+
+    :type requirement: :py:class:`SchemaDefinition <tracdap.rt.metadata.SchemaDefinition>` | :py:class:`FileType <tracdap.rt.metadata.FileType>`
+    :type label: str | None
+    :type optional: bool
+    :type dynamic: bool
+    :type output_props: dict[str, :py:class:`Value <tracdap.rt.metadata.Value>`
+    :rtype: :py:class:`ModelOutputSchema <tracdap.rt.metadata.ModelOutputSchema>`
+    """
+
     sa = _StaticApiHook.get_instance()
     return sa.define_output(requirement, label=label, optional=optional, dynamic=dynamic, output_props=output_props)
 
@@ -415,7 +445,7 @@ def define_input_table(
         -> ModelInputSchema:
 
     """
-    Define a model input with a table schema
+    Define a model input for a :py:class:`TableSchema <tracdap.rt.metadata.TableSchema>`
 
     Individual fields can be defined using :py:func:`define_field` or the shorthand alias :py:func:`F`.
     This function takes a number of fields, either as individual arguments or as a list, and uses them
@@ -460,7 +490,7 @@ def define_output_table(
         -> ModelOutputSchema:
 
     """
-    Define a model output with a table schema
+    Define a model output for a :py:class:`TableSchema <tracdap.rt.metadata.TableSchema>`
 
     Individual fields can be defined using :py:func:`define_field` or the shorthand alias :py:func:`F`.
     This function takes a number of fields, either as individual arguments or as a list, and uses them
@@ -502,6 +532,17 @@ def define_input_file(
         input_props: _tp.Optional[_tp.Dict[str, _tp.Any]] = None) \
         -> ModelInputSchema:
 
+    """
+    Define a model input for a :py:class:`FileType <tracdap.rt.metadata.FileType>`
+
+    :type extension str
+    :type mime_type: sr
+    :type label: str | None
+    :type optional: bool
+    :type input_props: dict[str, Any] | None
+    :rtype: :py:class:`ModelInputSchema <tracdap.rt.metadata.ModelInputSchema>`
+    """
+
     file_type = define_file_type(extension, mime_type)
     return define_input(file_type, label=label, optional=optional, input_props=input_props)
 
@@ -512,6 +553,17 @@ def define_output_file(
         output_props: _tp.Optional[_tp.Dict[str, _tp.Any]] = None) \
         -> ModelOutputSchema:
 
+    """
+    Define a model output for a :py:class:`FileType <tracdap.rt.metadata.FileType>`
+
+    :type extension str
+    :type mime_type: sr
+    :type label: str | None
+    :type optional: bool
+    :type output_props: dict[str, Any] | None
+    :rtype: :py:class:`ModelOutputSchema <tracdap.rt.metadata.ModelOutputSchema>`
+    """
+
     file_type = define_file_type(extension, mime_type)
     return define_output(file_type, label=label, optional=optional, output_props=output_props)
 

tracdap/rt/config/__init__.py

@@ -5,7 +5,6 @@ from .job import JobConfig
 from .common import _ConfigFile
 from .common import PluginConfig
 from .common import PlatformInfo
-from .common import AuthenticationConfig
 from .common import StorageConfig
 from .common import ServiceConfig
 
@@ -17,10 +16,8 @@ from .platform import DeploymentLayout
 from .platform import PlatformConfig
 from .platform import MetadataConfig
 from .platform import TenantConfig
-from .platform import WebServerConfig
-from .platform import WebServerRewriteRule
-from .platform import WebServerRedirect
 from .platform import GatewayConfig
+from .platform import GatewayRedirect
 from .platform import RouteConfig
 from .platform import RoutingMatch
 from .platform import RoutingTarget

tracdap/rt/config/common.py

@@ -33,40 +33,6 @@ class PlatformInfo:
     deploymentInfo: "_tp.Dict[str, str]" = _dc.field(default_factory=dict)
 
 
-@_dc.dataclass
-class AuthenticationConfig:
-
-    jwtIssuer: "str" = ""
-
-    jwtExpiry: "int" = 0
-
-    jwtLimit: "int" = 0
-
-    jwtRefresh: "int" = 0
-
-    provider: "PluginConfig" = _dc.field(default_factory=lambda: PluginConfig())
-
-    loginPath: "_tp.Optional[str]" = None
-
-    refreshPath: "_tp.Optional[str]" = None
-
-    returnPath: "_tp.Optional[str]" = None
-
-    disableAuth: "bool" = False
-
-    disableSigning: "bool" = False
-
-    systemUserId: "str" = ""
-
-    systemUserName: "str" = ""
-
-    systemTicketDuration: "int" = 0
-
-    systemTicketRefresh: "int" = 0
-
-    externalSystems: "_tp.Dict[str, PluginConfig]" = _dc.field(default_factory=dict)
-
-
 @_dc.dataclass
 class StorageConfig:
 

tracdap/rt/config/platform.py

@@ -39,8 +39,6 @@ class PlatformConfig:
 
     platformInfo: "PlatformInfo" = _dc.field(default_factory=lambda: PlatformInfo())
 
-    authentication: "AuthenticationConfig" = _dc.field(default_factory=lambda: AuthenticationConfig())
-
     metadata: "MetadataConfig" = _dc.field(default_factory=lambda: MetadataConfig())
 
     storage: "StorageConfig" = _dc.field(default_factory=lambda: StorageConfig())
@@ -53,8 +51,6 @@ class PlatformConfig:
 
     tenants: "_tp.Dict[str, TenantConfig]" = _dc.field(default_factory=dict)
 
-    webServer: "WebServerConfig" = _dc.field(default_factory=lambda: WebServerConfig())
-
     gateway: "GatewayConfig" = _dc.field(default_factory=lambda: GatewayConfig())
 
     services: "_tp.Dict[str, ServiceConfig]" = _dc.field(default_factory=dict)
@@ -63,6 +59,8 @@ class PlatformConfig:
 
     clientConfig: "_tp.Dict[str, ClientConfig]" = _dc.field(default_factory=dict)
 
+    extensions: "_tp.Dict[str, protobuf.Any]" = _dc.field(default_factory=dict)
+
 
 @_dc.dataclass
 class MetadataConfig:
@@ -81,25 +79,15 @@ class TenantConfig:
 
 
 @_dc.dataclass
-class WebServerConfig:
-
-    contentRoot: "PluginConfig" = _dc.field(default_factory=lambda: PluginConfig())
-
-    rewriteRules: "_tp.List[WebServerRewriteRule]" = _dc.field(default_factory=list)
-
-    redirects: "_tp.List[WebServerRedirect]" = _dc.field(default_factory=list)
-
-
-@_dc.dataclass
-class WebServerRewriteRule:
+class GatewayConfig:
 
-    source: "str" = ""
+    routes: "_tp.List[RouteConfig]" = _dc.field(default_factory=list)
 
-    target: "str" = ""
+    redirects: "_tp.List[GatewayRedirect]" = _dc.field(default_factory=list)
 
 
 @_dc.dataclass
-class WebServerRedirect:
+class GatewayRedirect:
 
     source: "str" = ""
 
@@ -108,14 +96,6 @@ class WebServerRedirect:
     status: "int" = 0
 
 
-@_dc.dataclass
-class GatewayConfig:
-
-    routes: "_tp.List[RouteConfig]" = _dc.field(default_factory=list)
-
-    redirects: "_tp.List[WebServerRedirect]" = _dc.field(default_factory=list)
-
-
 @_dc.dataclass
 class RouteConfig:
 

tracdap/rt/metadata/__init__.py

@@ -9,14 +9,39 @@ from .type import Value
 from .type import ArrayValue
 from .type import MapValue
 
+from .tag_update import TagOperation
+from .tag_update import TagUpdate
+
 from .object_id import ObjectType
 from .object_id import TagHeader
 from .object_id import TagSelector
 
+from .job import JobType
+from .job import JobStatusCode
+from .job import JobGroupType
+from .job import JobDefinition
+from .job import ResultDefinition
+from .job import RunModelJob
+from .job import RunFlowJob
+from .job import ImportModelJob
+from .job import ImportDataJob
+from .job import ExportDataJob
+from .job import JobGroup
+from .job import SequentialJobGroup
+from .job import ParallelJobGroup
+
+from .common import MetadataFormat
+from .common import MetadataVersion
+from .common import TenantInfo
+
+from .custom import CustomDefinition
+
 from .data import SchemaType
 from .data import PartType
 from .data import FieldSchema
 from .data import TableSchema
+from .data import StructField
+from .data import StructSchema
 from .data import SchemaDefinition
 from .data import PartKey
 from .data import DataDefinition
@@ -37,41 +62,18 @@ from .search import LogicalExpression
 from .search import SearchExpression
 from .search import SearchParameters
 
-from .tag_update import TagOperation
-from .tag_update import TagUpdate
-
 from .flow import FlowNodeType
 from .flow import FlowNode
 from .flow import FlowSocket
 from .flow import FlowEdge
 from .flow import FlowDefinition
 
-from .job import JobType
-from .job import JobStatusCode
-from .job import JobGroupType
-from .job import JobDefinition
-from .job import ResultDefinition
-from .job import RunModelJob
-from .job import RunFlowJob
-from .job import ImportModelJob
-from .job import ImportDataJob
-from .job import ExportDataJob
-from .job import JobGroup
-from .job import SequentialJobGroup
-from .job import ParallelJobGroup
-
-from .common import MetadataFormat
-from .common import MetadataVersion
-from .common import TenantInfo
-
-from .stoarge import CopyStatus
-from .stoarge import IncarnationStatus
-from .stoarge import StorageCopy
-from .stoarge import StorageIncarnation
-from .stoarge import StorageItem
-from .stoarge import StorageDefinition
-
-from .custom import CustomDefinition
+from .storage import CopyStatus
+from .storage import IncarnationStatus
+from .storage import StorageCopy
+from .storage import StorageIncarnation
+from .storage import StorageItem
+from .storage import StorageDefinition
 
 from .object import ObjectDefinition
 

tracdap/rt/metadata/data.py

@@ -25,6 +25,10 @@ class SchemaType(_enum.Enum):
 
     """Tabular data"""
 
+    STRUCT = 2
+
+    """Structured objects"""
+
 
 class PartType(_enum.Enum):
 
@@ -80,6 +84,40 @@ class TableSchema:
     fields: "_tp.List[FieldSchema]" = _dc.field(default_factory=list)
 
 
+@_dc.dataclass
+class StructField:
+
+    """Schema for an individual field in a structured object dataset"""
+
+    fieldType: "TypeDescriptor" = _dc.field(default_factory=lambda: TypeDescriptor())
+
+    label: "str" = ""
+
+    businessKey: "bool" = False
+
+    categorical: "bool" = False
+
+    notNull: "_tp.Optional[bool]" = None
+
+    """This could become mandatory with the next metadata update"""
+
+    formatCode: "_tp.Optional[str]" = None
+
+    defaultValue: "Value" = _dc.field(default_factory=lambda: Value())
+
+    structType: "_tp.Optional[str]" = None
+
+
+@_dc.dataclass
+class StructSchema:
+
+    """Schema for a structured object dataset"""
+
+    fields: "_tp.Dict[str, StructField]" = _dc.field(default_factory=dict)
+
+    namedTypes: "_tp.Dict[str, StructSchema]" = _dc.field(default_factory=dict)
+
+
 @_dc.dataclass
 class SchemaDefinition:
 
@@ -103,6 +141,8 @@ class SchemaDefinition:
 
     table: "_tp.Optional[TableSchema]" = None
 
+    struct: "_tp.Optional[StructSchema]" = None
+
 
 @_dc.dataclass
 class PartKey:

tracdap/rt/metadata/file.py

@@ -29,6 +29,8 @@ class FileDefinition:
 @_dc.dataclass
 class FileType:
 
+    """Specify a file type that is produced or consumed by a model, flow or job"""
+
     extension: "str" = ""
 
     mimeType: "str" = ""

tracdap/rt/metadata/object.py

@@ -12,7 +12,7 @@ from .flow import *  # noqa
 from .job import *  # noqa
 from .file import *  # noqa
 from .custom import *  # noqa
-from .stoarge import *  # noqa
+from .storage import *  # noqa
 
 
 

{tracdap_runtime-0.8.0b3.dist-info → tracdap_runtime-0.8.0rc1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: tracdap-runtime
-Version: 0.8.0b3
+Version: 0.8.0rc1
 Summary: Runtime package for building models on the TRAC Data & Analytics Platform
 Home-page: https://tracdap.finos.org/
 Author: Martin Traverse
@@ -13,19 +13,20 @@ Platform: any
 Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Operating System :: OS Independent
-Requires-Python: <3.13,>=3.8
+Requires-Python: <3.14,>=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: protobuf==5.28.2
-Requires-Dist: pyarrow==16.1.0
+Requires-Dist: protobuf==5.29.3
+Requires-Dist: pyarrow==18.1.0
 Requires-Dist: pyyaml==6.0.2
-Requires-Dist: dulwich==0.22.1
+Requires-Dist: dulwich==0.22.7
 Requires-Dist: requests==2.32.3
-Requires-Dist: pandas<2.3.0,>=1.2.0
-Requires-Dist: numpy<2.0.0
 Provides-Extra: grpc
-Requires-Dist: grpcio==1.66.1; extra == "grpc"
-Requires-Dist: grpcio-status==1.66.1; extra == "grpc"
+Requires-Dist: grpcio==1.70.0; extra == "grpc"
+Requires-Dist: grpcio-status==1.70.0; extra == "grpc"
+Provides-Extra: pandas
+Requires-Dist: pandas<2.3.0,>=1.2.0; extra == "pandas"
+Requires-Dist: numpy<2.3.0,>=1.20; extra == "pandas"
 Provides-Extra: polars
 Requires-Dist: polars<2.0.0,>=1.0.0; extra == "polars"
 Provides-Extra: pyspark
@@ -64,12 +65,14 @@ Documentation for the TRAC platform is available on our website at
 
 The TRAC runtime for Python has these requirements:
 
-* Python: 3.8 up to 3.12
-* Pandas: 1.2 up to 2.2
-* PySpark 3.0 up to 3.5 (optional)
+* Python: 3.9 up to 3.13
+* Pandas: 1.2 up to 2.2 (optional)
+* NumPy: 1.2 up to 2.2 (optional, required by Pandas)
+* Polars: 1.X (optional)
 
-3rd party libraries may impose additional constraints on supported versions of Python, Pandas or PySpark.
-As of February 2024, the Python libraries for GCP do not yet support Python 3.12.
+3rd party libraries may impose additional constraints on supported versions of key libraries.
+For example, Pandas 1.5 is not available for Python 3.12 or 3.13, while NumPy 2.0 is only
+compatible with Pandas 2.1 and later.
 
 ## Installing the runtime