tracdap-runtime 0.6.1.dev3__py3-none-any.whl → 0.6.3__py3-none-any.whl

tracdap/rt/metadata/__init__.py

@@ -1,11 +1,5 @@
 # Code generated by TRAC
 
-from .custom import CustomDefinition
-
-from .common import MetadataFormat
-from .common import MetadataVersion
-from .common import TenantInfo
-
 from .type import BasicType
 from .type import TypeDescriptor
 from .type import DecimalValue
@@ -19,11 +13,6 @@ from .object_id import ObjectType
 from .object_id import TagHeader
 from .object_id import TagSelector
 
-from .file import FileDefinition
-
-from .tag_update import TagOperation
-from .tag_update import TagUpdate
-
 from .data import SchemaType
 from .data import PartType
 from .data import FieldSchema
@@ -32,11 +21,30 @@ from .data import SchemaDefinition
 from .data import PartKey
 from .data import DataDefinition
 
+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 .model import ModelParameter
 from .model import ModelInputSchema
 from .model import ModelOutputSchema
 from .model import ModelDefinition
 
+from .tag_update import TagOperation
+from .tag_update import TagUpdate
+
+from .job import JobType
+from .job import JobStatusCode
+from .job import JobDefinition
+from .job import RunModelJob
+from .job import RunFlowJob
+from .job import ImportModelJob
+
+from .file import FileDefinition
+
 from .search import SearchOperator
 from .search import LogicalOperator
 from .search import SearchTerm
@@ -50,20 +58,12 @@ from .flow import FlowSocket
 from .flow import FlowEdge
 from .flow import FlowDefinition
 
-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 .job import JobType
-from .job import JobStatusCode
-from .job import JobDefinition
-from .job import RunModelJob
-from .job import RunFlowJob
-from .job import ImportModelJob
+from .custom import CustomDefinition
 
 from .object import ObjectDefinition
 
 from .tag import Tag
+
+from .common import MetadataFormat
+from .common import MetadataVersion
+from .common import TenantInfo

tracdap/rt/metadata/common.py

@@ -14,13 +14,13 @@ class MetadataFormat(_enum.Enum):
     metadata stored in the metadata database.
     """
 
-    METADATA_FORMAT_NOT_SET = 0, 
+    METADATA_FORMAT_NOT_SET = 0
 
-    PROTO = 1, 
+    PROTO = 1
 
-    JSON = 2, 
+    JSON = 2
 
-    YAML = 3, 
+    YAML = 3
 
 
 class MetadataVersion(_enum.Enum):
@@ -37,11 +37,11 @@ class MetadataVersion(_enum.Enum):
     or to run upgrades of metadata stored in an older metadata format.
     """
 
-    METADATA_VERSION_NOT_SET = 0, 
+    METADATA_VERSION_NOT_SET = 0
 
-    V1 = 1, 
+    V1 = 1
 
-    CURRENT = 1, 
+    CURRENT = 1
 
 
 @_dc.dataclass

tracdap/rt/metadata/custom.py

@@ -9,6 +9,8 @@ import enum as _enum  # noqa
 @_dc.dataclass
 class CustomDefinition:
 
+    """Define a custom object that can be stored and managed in the TRAC metadata store"""
+
     customSchemaType: str = None
 
     customSchemaVersion: int = None

tracdap/rt/metadata/data.py

@@ -20,23 +20,40 @@ class SchemaType(_enum.Enum):
         :class:`SchemaDefinition <SchemaDefinition>`
     """
 
-    SCHEMA_TYPE_NOT_SET = 0, 
+    SCHEMA_TYPE_NOT_SET = 0
 
-    TABLE = 1, 
+    TABLE = 1
+
+    """Tabular data"""
 
 
 class PartType(_enum.Enum):
 
-    PART_ROOT = 0, 
+    """Partitioning scheme applied to a dataset"""
+
+    PART_ROOT = 0
+
+    """Dataset has a single partition called the root partition (this is the default)"""
+
+    PART_BY_RANGE = 1
 
-    PART_BY_RANGE = 1, 
+    """Partition by range over an ordered variable (not available yet)"""
 
-    PART_BY_VALUE = 2, 
+    PART_BY_VALUE = 2
+
+    """Partition by value over a categorical variable (not available yet)"""
 
 
 @_dc.dataclass
 class FieldSchema:
 
+    """
+    Schema for an individual field in a tabular dataset
+    
+    .. seealso::
+        :class:`TableSchema <TableSchema>`
+    """
+
     fieldName: str = None
 
     fieldOrder: int = None
@@ -59,6 +76,8 @@ class FieldSchema:
 @_dc.dataclass
 class TableSchema:
 
+    """Schema for a tabular dataset"""
+
     fields: _tp.List[FieldSchema] = _dc.field(default_factory=list)
 
 
@@ -89,6 +108,8 @@ class SchemaDefinition:
 @_dc.dataclass
 class PartKey:
 
+    """Partition key for tabular datasets"""
+
     opaqueKey: str = None
 
     partType: PartType = PartType.PART_ROOT
@@ -103,6 +124,8 @@ class PartKey:
 @_dc.dataclass
 class DataDefinition:
 
+    """Define a dataset that can be stored and managed in the TRAC platform"""
+
     @_dc.dataclass
     class Delta:
 

tracdap/rt/metadata/file.py

@@ -12,6 +12,8 @@ from .object_id import *  # noqa
 @_dc.dataclass
 class FileDefinition:
 
+    """Describes a file object stored in the TRAC platform"""
+
     name: str = None
 
     extension: str = None

tracdap/rt/metadata/flow.py

@@ -13,20 +13,48 @@ from .tag_update import *  # noqa
 
 class FlowNodeType(_enum.Enum):
 
-    NODE_TYPE_NOT_SET = 0, 
+    """
+    Specify the type of an individual flow node
+    
+    .. seealso::
+        :class:`FlowNode <FlowNode>`
+    """
 
-    INPUT_NODE = 1, 
+    NODE_TYPE_NOT_SET = 0
 
-    OUTPUT_NODE = 2, 
+    INPUT_NODE = 1
 
-    MODEL_NODE = 3, 
+    """Input nodes described inputs to the flow, such as a files or datasets"""
+
+    OUTPUT_NODE = 2
+
+    """Output nodes describe outputs the flow produces, such as a files or datasets"""
+
+    MODEL_NODE = 3
+
+    """Model nodes are placeholders for TRAC models that will be supplied at runtime"""
+
+    PARAMETER_NODE = 4
+
+    """Parameter nodes allow explicit mapping of parameters into models
+    (TRAC can infer parameters by name if they are not defined explicitly)
+    """
 
 
 @_dc.dataclass
 class FlowNode:
 
+    """
+    Describes an individual node in a flow
+    
+    .. seealso::
+        :class:`FlowDefinition <FlowDefinition>`
+    """
+
     nodeType: FlowNodeType = FlowNodeType.NODE_TYPE_NOT_SET
 
+    parameters: _tp.List[str] = _dc.field(default_factory=list)
+
     inputs: _tp.List[str] = _dc.field(default_factory=list)
 
     outputs: _tp.List[str] = _dc.field(default_factory=list)
@@ -35,12 +63,28 @@ class FlowNode:
 
     nodeAttrs: _tp.List[TagUpdate] = _dc.field(default_factory=list)
 
+    nodeProps: _tp.Dict[str, Value] = _dc.field(default_factory=dict)
+
     label: str = None
 
 
 @_dc.dataclass
 class FlowSocket:
 
+    """
+    A socket is a point of connection for wiring up the edges in a flow
+    
+    For parameter, input and output nodes the socket is just the node name and the socket field will be blank.
+    For models, the node name refers to a model node and the socket is the name of the parameter, input or output
+    being connected. E.g. these two sockets could be used to connect a flow input to a model, using an edge::
+    
+      flow_input_socket = { "node": "my_input_dataset", socket: "" }
+      model_input_socket = { "node": "my_model", "socket": "input_1" }.
+    
+    .. seealso::
+        :class:`FlowEdge <FlowEdge>`
+    """
+
     node: str = None
 
     socket: str = None
@@ -49,6 +93,13 @@ class FlowSocket:
 @_dc.dataclass
 class FlowEdge:
 
+    """
+    A connection between two nodes in a flow
+    
+    .. seealso::
+        :class:`FlowSocket <FlowSocket>`
+    """
+
     source: FlowSocket = None
 
     target: FlowSocket = None
@@ -57,6 +108,17 @@ class FlowEdge:
 @_dc.dataclass
 class FlowDefinition:
 
+    """
+    A flow defines an execution graph as a set of connections between models and data
+    
+    A flow describes the shape of the execution graph, it does not fix in advance the set
+    of models and datasets that will go into it. When a RUN_FLOW job is created, the job
+    matches the flow with a set of models, inputs, outputs and parameters.
+    
+    .. seealso::
+        :class:`JobDefinition <JobDefinition>`
+    """
+
     nodes: _tp.Dict[str, FlowNode] = _dc.field(default_factory=dict)
 
     edges: _tp.List[FlowEdge] = _dc.field(default_factory=list)

tracdap/rt/metadata/job.py

@@ -12,45 +12,79 @@ from .tag_update import *  # noqa
 
 class JobType(_enum.Enum):
 
-    JOB_TYPE_NOT_SET = 0, 
+    """Specify the type of an individual TRAC job"""
 
-    RUN_MODEL = 1, 
+    JOB_TYPE_NOT_SET = 0
 
-    RUN_FLOW = 2, 
+    RUN_MODEL = 1
 
-    IMPORT_MODEL = 3, 
+    """Run a single model, with parameters and inputs"""
 
-    IMPORT_DATA = 4, 
+    RUN_FLOW = 2
+
+    """Run a flow with all its models, parameters and inputs"""
+
+    IMPORT_MODEL = 3
+
+    """Import a model into the platform"""
+
+    IMPORT_DATA = 4
+
+    """Import data into the platform"""
 
 
 class JobStatusCode(_enum.Enum):
 
-    JOB_STATUS_CODE_NOT_SET = 0, 
+    """Indicate the status of a job in the TRAC platform"""
+
+    JOB_STATUS_CODE_NOT_SET = 0
+
+    PREPARING = 1
+
+    """The job is being set up"""
+
+    VALIDATED = 2
+
+    """The job has passed validation and is ok to run (dry-run operations may return this status)"""
 
-    PREPARING = 1, 
+    PENDING = 3
 
-    VALIDATED = 2, 
+    """The job is being set up"""
 
-    PENDING = 3, 
+    QUEUED = 4
 
-    QUEUED = 4, 
+    """The job is queued in TRAC, waiting for available resources"""
 
-    SUBMITTED = 5, 
+    SUBMITTED = 5
 
-    RUNNING = 6, 
+    """The job has been submitted for execution but has not yet started"""
 
-    FINISHING = 7, 
+    RUNNING = 6
 
-    SUCCEEDED = 8, 
+    """The job is currently running"""
 
-    FAILED = 9, 
+    FINISHING = 7
 
-    CANCELLED = 10, 
+    """Job execution completed, the platform is cleaning up and validating the outputs"""
+
+    SUCCEEDED = 8
+
+    """The job completed successfully and the results are available"""
+
+    FAILED = 9
+
+    """The job failed and has been terminated or rejected"""
+
+    CANCELLED = 10
+
+    """The job was cancelled by a user of the platform"""
 
 
 @_dc.dataclass
 class JobDefinition:
 
+    """Define a job to run on the TRAC platform"""
+
     jobType: JobType = JobType.JOB_TYPE_NOT_SET
 
     runModel: _tp.Optional[RunModelJob] = None
@@ -63,6 +97,8 @@ class JobDefinition:
 @_dc.dataclass
 class RunModelJob:
 
+    """Specification for a RuN_MODEL job"""
+
     model: TagSelector = None
 
     parameters: _tp.Dict[str, Value] = _dc.field(default_factory=dict)
@@ -79,6 +115,8 @@ class RunModelJob:
 @_dc.dataclass
 class RunFlowJob:
 
+    """Specification for a RUN_FLOW job"""
+
     flow: TagSelector = None
 
     parameters: _tp.Dict[str, Value] = _dc.field(default_factory=dict)
@@ -97,6 +135,8 @@ class RunFlowJob:
 @_dc.dataclass
 class ImportModelJob:
 
+    """Specification for an IMPORT_MODEL job"""
+
     language: str = None
 
     repository: str = None

tracdap/rt/metadata/model.py

@@ -21,6 +21,8 @@ class ModelParameter:
 
     defaultValue: _tp.Optional[Value] = None
 
+    paramProps: _tp.Dict[str, Value] = _dc.field(default_factory=dict)
+
 
 @_dc.dataclass
 class ModelInputSchema:
@@ -41,6 +43,10 @@ class ModelInputSchema:
 
     label: _tp.Optional[str] = None
 
+    optional: bool = None
+
+    inputProps: _tp.Dict[str, Value] = _dc.field(default_factory=dict)
+
 
 @_dc.dataclass
 class ModelOutputSchema:
@@ -62,6 +68,10 @@ class ModelOutputSchema:
 
     label: _tp.Optional[str] = None
 
+    optional: bool = None
+
+    outputProps: _tp.Dict[str, Value] = _dc.field(default_factory=dict)
+
 
 @_dc.dataclass
 class ModelDefinition:

tracdap/rt/metadata/object.py

@@ -6,6 +6,7 @@ import dataclasses as _dc  # noqa
 import enum as _enum  # noqa
 
 from .object_id import *  # noqa
+from .type import *  # noqa
 from .data import *  # noqa
 from .model import *  # noqa
 from .flow import *  # noqa
@@ -69,3 +70,5 @@ class ObjectDefinition:
     storage: _tp.Optional[StorageDefinition] = None
 
     schema: _tp.Optional[SchemaDefinition] = None
+
+    objectProps: _tp.Dict[str, Value] = _dc.field(default_factory=dict)

tracdap/rt/metadata/object_id.py

@@ -17,23 +17,23 @@ class ObjectType(_enum.Enum):
         :class:`ObjectDefinition <ObjectDefinition>`
     """
 
-    OBJECT_TYPE_NOT_SET = 0, 
+    OBJECT_TYPE_NOT_SET = 0
 
-    DATA = 1, 
+    DATA = 1
 
-    MODEL = 2, 
+    MODEL = 2
 
-    FLOW = 3, 
+    FLOW = 3
 
-    JOB = 4, 
+    JOB = 4
 
-    FILE = 5, 
+    FILE = 5
 
-    CUSTOM = 6, 
+    CUSTOM = 6
 
-    STORAGE = 7, 
+    STORAGE = 7
 
-    SCHEMA = 8, 
+    SCHEMA = 8
 
 
 @_dc.dataclass

tracdap/rt/metadata/search.py

@@ -18,9 +18,11 @@ class SearchOperator(_enum.Enum):
         :class:`SearchTerm <SearchTerm>`
     """
 
-    SEARCH_OPERATOR_NOT_SET = 0, 
+    SEARCH_OPERATOR_NOT_SET = 0
 
-    EQ = 1, """EQUALS
+    EQ = 1
+
+    """EQUALS
     
     The EQ operator matches a tag when the tag has an attribute that matches the
     search term exactly, i.e. attribute name, type and value all match. For
@@ -32,7 +34,9 @@ class SearchOperator(_enum.Enum):
     for this reason it is not recommended to use the EQ operator with FLOAT values.
     """
 
-    NE = 2, """DOES NOT EQUAL
+    NE = 2
+
+    """DOES NOT EQUAL
     
     The NE operator matches a tag precisely when the EQ operator does not match it.
     This could be because the tag attribute does not match the search term, or because
@@ -48,7 +52,9 @@ class SearchOperator(_enum.Enum):
     for this reason it is not recommended to use the NE operator with FLOAT values.
     """
 
-    LT = 3, """LESS THAN
+    LT = 3
+
+    """LESS THAN
     
     The LT operator matches a tag when the tag has an attribute with a value less than
     the search parameter. The LT operator will only match single-valued attributes.
@@ -58,7 +64,9 @@ class SearchOperator(_enum.Enum):
     even if one or more of the individual values matches the search term.
     """
 
-    LE = 4, """LESS THAN OR EQUAL TO
+    LE = 4
+
+    """LESS THAN OR EQUAL TO
     
     The LE operator matches a tag when the tag has an attribute with a value less than
     or equal to the search parameter. The LE operator will only match single-valued
@@ -69,7 +77,9 @@ class SearchOperator(_enum.Enum):
     even if one or more of the individual values matches the search term.
     """
 
-    GT = 5, """GREATER THAN
+    GT = 5
+
+    """GREATER THAN
     
     The GT operator matches a tag when the tag has an attribute with a value greater than
     the search parameter. The GT operator will only match single-valued attributes.
@@ -79,7 +89,9 @@ class SearchOperator(_enum.Enum):
     even if one or more of the individual values matches the search term.
     """
 
-    GE = 6, """GREATER THAN OR EQUAL TO
+    GE = 6
+
+    """GREATER THAN OR EQUAL TO
     
     The GE operator matches a tag when the tag has an attribute with a value greater than
     or equal to the search parameter. The GE operator will only match single-valued
@@ -90,7 +102,9 @@ class SearchOperator(_enum.Enum):
     even if one or more of the individual values matches the search term.
     """
 
-    IN = 7, """IN
+    IN = 7
+
+    """IN
     
     The IN operator matches a tag when the tag has an attribute whose value is matched
     exactly by an item in the list of values provided. For multi-valued attributes, the
@@ -103,7 +117,9 @@ class SearchOperator(_enum.Enum):
     for this reason it is not recommended to use the IN operator with FLOAT values.
     """
 
-    EXISTS = 8, """EXISTS
+    EXISTS = 8
+
+    """EXISTS
     
     If an attribute type is provided the EXISTS operator matches a tag of specified
     name when the tag has an attribute whose type is matched with type provided attribute
@@ -121,23 +137,29 @@ class LogicalOperator(_enum.Enum):
         :class:`LogicalExpression <LogicalExpression>`
     """
 
-    LOGICAL_OPERATOR_NOT_SET = 0, 
+    LOGICAL_OPERATOR_NOT_SET = 0
+
+    AND = 1
 
-    AND = 1, """LOGICAL AND
+    """LOGICAL AND
     
     The AND operator combines two or more search expressions, the logical expression
     will match only when all sub-expressions match. The order of sub-expressions is
     not important.
     """
 
-    OR = 2, """LOGICAL OR
+    OR = 2
+
+    """LOGICAL OR
     
     The OR operator combines two or more search expressions, the logical expression
     will match when any of the sub-expressions match. The order of sub-expressions
     is not important.
     """
 
-    NOT = 3, """LOGICAL NOT
+    NOT = 3
+
+    """LOGICAL NOT
     
     The NOT operator applies to a single sub-expression, the logical expression will
     match precisely when the sub-expression does not match.