# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you 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.
"""Task dvc."""
from copy import deepcopy
from typing import Dict
from pydolphinscheduler.constants import TaskType
from pydolphinscheduler.core.task import Task
[docs]
class DvcTaskType(str):
"""Constants for dvc task type."""
INIT = "Init DVC"
DOWNLOAD = "Download"
UPLOAD = "Upload"
[docs]
class BaseDVC(Task):
"""Base class for dvc task."""
dvc_task_type = None
_task_custom_attr = {
"dvc_task_type",
"dvc_repository",
}
_child_task_dvc_attr = set()
def __init__(self, name: str, repository: str, *args, **kwargs):
super().__init__(name, TaskType.DVC, *args, **kwargs)
self.dvc_repository = repository
@property
def task_params(self) -> Dict:
"""Return task params."""
self._task_custom_attr = deepcopy(self._task_custom_attr)
self._task_custom_attr.update(self._child_task_dvc_attr)
return super().task_params
[docs]
class DVCInit(BaseDVC):
"""Task DVC Init object, declare behavior for DVC Init task to dolphinscheduler."""
dvc_task_type = DvcTaskType.INIT
_child_task_dvc_attr = {"dvc_store_url"}
def __init__(self, name: str, repository: str, store_url: str, *args, **kwargs):
super().__init__(name, repository, *args, **kwargs)
self.dvc_store_url = store_url
[docs]
class DVCDownload(BaseDVC):
"""Task DVC Download object, declare behavior for DVC Download task to dolphinscheduler."""
dvc_task_type = DvcTaskType.DOWNLOAD
_child_task_dvc_attr = {
"dvc_load_save_data_path",
"dvc_data_location",
"dvc_version",
}
def __init__(
self,
name: str,
repository: str,
data_path_in_dvc_repository: str,
data_path_in_worker: str,
version: str,
*args,
**kwargs
):
super().__init__(name, repository, *args, **kwargs)
self.dvc_data_location = data_path_in_dvc_repository
self.dvc_load_save_data_path = data_path_in_worker
self.dvc_version = version
[docs]
class DVCUpload(BaseDVC):
"""Task DVC Upload object, declare behavior for DVC Upload task to dolphinscheduler."""
dvc_task_type = DvcTaskType.UPLOAD
_child_task_dvc_attr = {
"dvc_load_save_data_path",
"dvc_data_location",
"dvc_version",
"dvc_message",
}
def __init__(
self,
name: str,
repository: str,
data_path_in_worker: str,
data_path_in_dvc_repository: str,
version: str,
message: str,
*args,
**kwargs
):
super().__init__(name, repository, *args, **kwargs)
self.dvc_data_location = data_path_in_dvc_repository
self.dvc_load_save_data_path = data_path_in_worker
self.dvc_version = version
self.dvc_message = message