# 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.
"""DolphinScheduler Project object."""
from typing import Optional
from pydolphinscheduler import configuration
from pydolphinscheduler.java_gateway import gateway
from pydolphinscheduler.models import BaseSide
[docs]
class Project(BaseSide):
"""DolphinScheduler Project object."""
def __init__(
self,
name: str = configuration.WORKFLOW_PROJECT,
description: Optional[str] = None,
code: Optional[int] = None,
):
super().__init__(name, description)
self.code = code
[docs]
def create_if_not_exists(self, user=configuration.USER_NAME) -> None:
"""Create Project if not exists."""
gateway.create_or_grant_project(user, self.name, self.description)
# TODO recover result checker
# gateway_result_checker(result, None)
[docs]
@classmethod
def get_project_by_name(cls, user=configuration.USER_NAME, name=None) -> "Project":
"""Get Project by name."""
project = gateway.query_project_by_name(user, name)
if project is None:
return cls()
return cls(
name=project.getName(),
description=project.getDescription(),
code=project.getCode(),
)
[docs]
def update(
self,
user=configuration.USER_NAME,
project_code=None,
project_name=None,
description=None,
) -> None:
"""Update Project."""
gateway.update_project(user, project_code, project_name, description)
self.name = project_name
self.description = description
[docs]
def delete(self, user=configuration.USER_NAME) -> None:
"""Delete Project."""
gateway.delete_project(user, self.code)
self.delete_all()