Skip to content

Task files

CLASS DESCRIPTION
TaskFiles

Files related to a task.
FUNCTION DESCRIPTION
enrich_task_files_multisubmit

Expand TaskFiles objects with component and prefix.
task_subfolder_name

Get name of task-specific subfolder.

Classes

TaskFiles pydantic-model

Bases: BaseModel

Files related to a task.

ATTRIBUTE DESCRIPTION
root_dir_local

TYPE: Path

root_dir_remote

TYPE: Path

task_name

TYPE: str

task_order

TYPE: int

component

TYPE: str | None

prefix

TYPE: str | None

Fields:

  • root_dir_local (Path)
  • root_dir_remote (Path)
  • task_name (str)
  • task_order (int)
  • component (str | None)
  • prefix (str | None)
Source code in fractal_server/runner/task_files.py 
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
class TaskFiles(BaseModel):
    """
    Files related to a task.

    Attributes:
        root_dir_local:
        root_dir_remote:
        task_name:
        task_order:
        component:
        prefix:
    """

    # Parent directory
    root_dir_local: Path
    root_dir_remote: Path

    # Per-wftask
    task_name: str
    task_order: int

    # Per-single-component
    component: str | None = None
    prefix: str | None = None

    def _check_component(self) -> None:
        if self.component is None:
            raise ValueError("`component` cannot be None")

    @property
    def subfolder_name(self) -> str:
        order = str(self.task_order or 0)
        return task_subfolder_name(
            order=order,
            task_name=self.task_name,
        )

    @property
    def wftask_subfolder_remote(self) -> Path:
        return self.root_dir_remote / self.subfolder_name

    @property
    def wftask_subfolder_local(self) -> Path:
        return self.root_dir_local / self.subfolder_name

    @property
    def prefix_component(self) -> str | None:
        if self.prefix is None:
            return self.component
        else:
            return f"{self.prefix}-{self.component}"

    @property
    def log_file_local(self) -> str:
        self._check_component()
        return (
            self.wftask_subfolder_local / f"{self.prefix_component}-log.txt"
        ).as_posix()

    @property
    def log_file_remote_path(self) -> Path:
        self._check_component()
        return self.wftask_subfolder_remote / f"{self.prefix_component}-log.txt"

    @property
    def log_file_remote(self) -> str:
        return self.log_file_remote_path.as_posix()

    @property
    def args_file_local(self) -> str:
        self._check_component()
        return (
            self.wftask_subfolder_local / f"{self.prefix_component}-args.json"
        ).as_posix()

    @property
    def args_file_remote_path(self) -> Path:
        self._check_component()
        return (
            self.wftask_subfolder_remote / f"{self.prefix_component}-args.json"
        )

    @property
    def args_file_remote(self) -> str:
        return self.args_file_remote_path.as_posix()

    @property
    def metadiff_file_local(self) -> str:
        self._check_component()
        return (
            self.wftask_subfolder_local
            / f"{self.prefix_component}-metadiff.json"
        ).as_posix()

    @property
    def metadiff_file_remote_path(self) -> Path:
        self._check_component()
        return (
            self.wftask_subfolder_remote
            / f"{self.prefix_component}-metadiff.json"
        )

    @property
    def metadiff_file_remote(self) -> str:
        return self.metadiff_file_remote_path.as_posix()

Functions:

enrich_task_files_multisubmit(*, tot_tasks, batch_size, base_task_files)

Expand TaskFiles objects with component and prefix.

PARAMETER DESCRIPTION

tot_tasks

Total number of images to process.

TYPE: int

batch_size

Batch size, where 0 means batch_size=tot_tasks.

TYPE: int

base_task_files

Original TaskFiles object to be enriched.

TYPE: TaskFiles

Source code in fractal_server/runner/task_files.py 
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
def enrich_task_files_multisubmit(
    *,
    tot_tasks: int,
    batch_size: int,
    base_task_files: TaskFiles,
) -> list[TaskFiles]:
    """
    Expand `TaskFiles` objects with `component` and `prefix`.

    Args:
        tot_tasks: Total number of images to process.
        batch_size: Batch size, where `0` means `batch_size=tot_tasks`.
        base_task_files: Original `TaskFiles` object to be enriched.
    """

    # Replace `batch_size=0` with `batch_size=tot_tasks`
    batch_size = batch_size or tot_tasks

    new_list_task_files: list[TaskFiles] = []
    for absolute_index in range(tot_tasks):
        ind_batch = absolute_index // batch_size
        new_list_task_files.append(
            TaskFiles(
                **base_task_files.model_dump(
                    exclude={
                        "component",
                        "prefix",
                    }
                ),
                prefix=f"{MULTISUBMIT_PREFIX}-{ind_batch:06d}",
                component=_index_to_component(absolute_index),
            )
        )
    return new_list_task_files

task_subfolder_name(order, task_name)

Get name of task-specific subfolder.

PARAMETER DESCRIPTION

order

TYPE: int | str

task_name

TYPE: str

Source code in fractal_server/runner/task_files.py 
12
13
14
15
16
17
18
19
20
21
22
23
24
def task_subfolder_name(
    order: int | str,
    task_name: str,
) -> str:
    """
    Get name of task-specific subfolder.

    Args:
        order:
        task_name:
    """
    task_name_slug = sanitize_string(task_name)
    return f"{order}_{task_name_slug}"