chris.models.data

  1"""
  2Dataclasses describing objects returned from CUBE.
  3
  4These classes are extended in the modules `chris.models.logged_in`
  5and `chris.models.public` with methods to get objects from links.
  6"""
  7
  8from dataclasses import dataclass
  9import datetime
 10from typing import Optional
 11
 12from serde import deserialize
 13
 14from chris.link.linked import LinkedModel
 15from chris.models.enums import PluginType, Status
 16from chris.models.types import *
 17
 18
 19@deserialize
 20@dataclass(frozen=True)
 21class UserData:
 22    """A *CUBE* user."""
 23
 24    url: UserUrl
 25    id: UserId
 26    username: Username
 27    email: str
 28
 29
 30# TODO It'd be better to use inheritance instead of optionals
 31@deserialize
 32@dataclass(frozen=True)
 33class PluginInstanceData(LinkedModel):
 34    """
 35    A *plugin instance* in _ChRIS_ is a computing job, i.e. an attempt to run
 36    a computation (a non-interactive command-line app) to produce data.
 37    """
 38
 39    url: PluginInstanceUrl
 40    id: PluginInstanceId
 41    title: str
 42    compute_resource_name: ComputeResourceName
 43    plugin_id: PluginId
 44    plugin_name: PluginName
 45    plugin_version: PluginVersion
 46    plugin_type: PluginType
 47
 48    pipeline_inst: Optional[int]
 49    feed_id: FeedId
 50    start_date: datetime.datetime
 51    end_date: datetime.datetime
 52    output_path: CubeFilePath
 53
 54    status: Status
 55
 56    summary: str
 57    raw: str
 58    owner_username: Username
 59    cpu_limit: int
 60    memory_limit: int
 61    number_of_workers: int
 62    gpu_limit: int
 63    error_code: CUBEErrorCode
 64
 65    previous: Optional[PluginInstanceUrl]
 66    feed: FeedUrl
 67    plugin: PluginUrl
 68    descendants: DescendantsUrl
 69    files: FilesUrl
 70    parameters: PluginInstanceParamtersUrl
 71    compute_resource: ComputeResourceUrl
 72    splits: SplitsUrl
 73
 74    previous_id: Optional[int] = None
 75    """
 76    FS plugins will not produce a `previous_id` value
 77    (even though they will return `"previous": null`)
 78    """
 79
 80    size: Optional[int] = None
 81    """
 82    IDK what it is the size of.
 83
 84    This field shows up when the plugin instance is maybe done,
 85    but not when the plugin instance is created.
 86    """
 87    template: Optional[dict] = None
 88    """
 89    Present only when getting a plugin instance.
 90    """
 91
 92
 93@deserialize
 94@dataclass(frozen=True)
 95class FeedData(LinkedModel):
 96    url: FeedUrl
 97    id: FeedId
 98    creation_date: datetime.datetime
 99    modification_date: datetime.datetime
100    name: str
101    creator_username: Username
102    created_jobs: int
103    waiting_jobs: int
104    scheduled_jobs: int
105    started_jobs: int
106    registering_jobs: int
107    finished_jobs: int
108    errored_jobs: int
109    cancelled_jobs: int
110    owner: list[UserUrl]
111    note: NoteUrl
112    tags: TagsUrl
113    taggings: TaggingsUrl
114    comments: CommentsUrl
115    files: FilesUrl
116    plugin_instances: PluginInstancesUrl
117
118
119@deserialize
120@dataclass(frozen=True)
121class FeedNoteData(LinkedModel):
122    url: FeedUrl
123    id: NoteId
124    title: str
125    content: str
126    feed: FeedUrl